你的用户名
3 weeks ago
commit
f9d3333214
@ -0,0 +1,54 @@ |
||||
###################################################################### |
||||
# Build Tools |
||||
|
||||
.gradle |
||||
/build/ |
||||
!gradle/wrapper/gradle-wrapper.jar |
||||
|
||||
target/ |
||||
!.mvn/wrapper/maven-wrapper.jar |
||||
|
||||
.flattened-pom.xml |
||||
|
||||
###################################################################### |
||||
# IDE |
||||
|
||||
### STS ### |
||||
.apt_generated |
||||
.classpath |
||||
.factorypath |
||||
.project |
||||
.settings |
||||
.springBeans |
||||
|
||||
### IntelliJ IDEA ### |
||||
.idea |
||||
*.iws |
||||
*.iml |
||||
*.ipr |
||||
|
||||
### NetBeans ### |
||||
nbproject/private/ |
||||
build/* |
||||
nbbuild/ |
||||
dist/ |
||||
nbdist/ |
||||
.nb-gradle/ |
||||
|
||||
###################################################################### |
||||
# Others |
||||
*.log |
||||
*.xml.versionsBackup |
||||
*.swp |
||||
|
||||
!*/build/*.java |
||||
!*/build/*.html |
||||
!*/build/*.xml |
||||
|
||||
### JRebel ### |
||||
rebel.xml |
||||
|
||||
application-my.yaml |
||||
|
||||
/soochowlife-ui-app/unpackage/ |
||||
**/.DS_Store |
||||
@ -0,0 +1,20 @@ |
||||
The MIT License (MIT) |
||||
|
||||
Copyright (c) 2021 ruoyi-vue-pro |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of |
||||
this software and associated documentation files (the "Software"), to deal in |
||||
the Software without restriction, including without limitation the rights to |
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of |
||||
the Software, and to permit persons to whom the Software is furnished to do so, |
||||
subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all |
||||
copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS |
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR |
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER |
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||
@ -0,0 +1,4 @@ |
||||
config.stopBubbling = true |
||||
lombok.tostring.callsuper=CALL |
||||
lombok.equalsandhashcode.callsuper=CALL |
||||
lombok.accessors.chain=true |
||||
@ -0,0 +1,172 @@ |
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" |
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> |
||||
<modelVersion>4.0.0</modelVersion> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-web</artifactId> |
||||
<version>${revision}</version> |
||||
<packaging>pom</packaging> |
||||
<modules> |
||||
<module>soochowlife-dependencies</module> |
||||
<module>soochowlife-framework</module> |
||||
<!-- Server 主项目 --> |
||||
<module>soochowlife-server</module> |
||||
<!-- 各种 module 拓展 --> |
||||
<module>soochowlife-module-system</module> |
||||
<module>soochowlife-module-infra</module> |
||||
<module>soochowlife-module-test</module> |
||||
<!-- <module>soochowlife-module-member</module>--> |
||||
<!-- <module>soochowlife-module-bpm</module>--> |
||||
<!-- <module>soochowlife-module-report</module>--> |
||||
<!-- <module>soochowlife-module-mp</module>--> |
||||
<!-- <module>soochowlife-module-pay</module>--> |
||||
<!-- <module>soochowlife-module-mall</module>--> |
||||
<!-- <module>soochowlife-module-crm</module>--> |
||||
<!-- <module>soochowlife-module-erp</module>--> |
||||
<!-- <module>soochowlife-module-ai</module>--> |
||||
<!-- <module>soochowlife-module-iot</module>--> |
||||
</modules> |
||||
|
||||
<name>${project.artifactId}</name> |
||||
<description>soochowlife项目基础脚手架</description> |
||||
<url>https://github.com/YunaiV/ruoyi-vue-pro</url> |
||||
|
||||
<properties> |
||||
<revision>2.6.0-SNAPSHOT</revision> |
||||
<!-- Maven 相关 --> |
||||
<java.version>17</java.version> |
||||
<maven.compiler.source>${java.version}</maven.compiler.source> |
||||
<maven.compiler.target>${java.version}</maven.compiler.target> |
||||
<maven-surefire-plugin.version>3.2.2</maven-surefire-plugin.version> |
||||
<maven-compiler-plugin.version>3.14.0</maven-compiler-plugin.version> |
||||
<flatten-maven-plugin.version>1.6.0</flatten-maven-plugin.version> |
||||
<!-- 看看咋放到 bom 里 --> |
||||
<lombok.version>1.18.36</lombok.version> |
||||
<spring.boot.version>3.4.5</spring.boot.version> |
||||
<mapstruct.version>1.6.3</mapstruct.version> |
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> |
||||
</properties> |
||||
|
||||
<dependencyManagement> |
||||
<dependencies> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-dependencies</artifactId> |
||||
<version>${revision}</version> |
||||
<type>pom</type> |
||||
<scope>import</scope> |
||||
</dependency> |
||||
</dependencies> |
||||
</dependencyManagement> |
||||
|
||||
<build> |
||||
<pluginManagement> |
||||
<plugins> |
||||
<!-- maven-surefire-plugin 插件，用于运行单元测试。 --> |
||||
<!-- 注意，需要使用 3.0.X+，因为要支持 Junit 5 版本 --> |
||||
<plugin> |
||||
<groupId>org.apache.maven.plugins</groupId> |
||||
<artifactId>maven-surefire-plugin</artifactId> |
||||
<version>${maven-surefire-plugin.version}</version> |
||||
</plugin> |
||||
<!-- maven-compiler-plugin 插件，解决 spring-boot-configuration-processor + Lombok + MapStruct 组合 --> |
||||
<!-- https://stackoverflow.com/questions/33483697/re-run-spring-boot-configuration-annotation-processor-to-update-generated-metada --> |
||||
<plugin> |
||||
<groupId>org.apache.maven.plugins</groupId> |
||||
<artifactId>maven-compiler-plugin</artifactId> |
||||
<version>${maven-compiler-plugin.version}</version> |
||||
<configuration> |
||||
<annotationProcessorPaths> |
||||
<path> |
||||
<groupId>org.springframework.boot</groupId> |
||||
<artifactId>spring-boot-configuration-processor</artifactId> |
||||
<version>${spring.boot.version}</version> |
||||
</path> |
||||
<path> |
||||
<groupId>org.projectlombok</groupId> |
||||
<artifactId>lombok</artifactId> |
||||
<version>${lombok.version}</version> |
||||
</path> |
||||
<path> |
||||
<groupId>org.mapstruct</groupId> |
||||
<artifactId>mapstruct-processor</artifactId> |
||||
<version>${mapstruct.version}</version> |
||||
</path> |
||||
</annotationProcessorPaths> |
||||
<!-- 编译参数写在 arg 内，解决 Spring Boot 3.2 的 Parameter Name Discovery 问题 --> |
||||
<debug>false</debug> |
||||
<compilerArgs> |
||||
<arg>-parameters</arg> |
||||
</compilerArgs> |
||||
</configuration> |
||||
</plugin> |
||||
<plugin> |
||||
<groupId>org.codehaus.mojo</groupId> |
||||
<artifactId>flatten-maven-plugin</artifactId> |
||||
</plugin> |
||||
</plugins> |
||||
</pluginManagement> |
||||
|
||||
<plugins> |
||||
<!-- 统一 revision 版本 --> |
||||
<plugin> |
||||
<groupId>org.codehaus.mojo</groupId> |
||||
<artifactId>flatten-maven-plugin</artifactId> |
||||
<version>${flatten-maven-plugin.version}</version> |
||||
<configuration> |
||||
<flattenMode>oss</flattenMode> |
||||
<updatePomFile>true</updatePomFile> |
||||
</configuration> |
||||
<executions> |
||||
<execution> |
||||
<goals> |
||||
<goal>flatten</goal> |
||||
</goals> |
||||
<id>flatten</id> |
||||
<phase>process-resources</phase> |
||||
</execution> |
||||
<execution> |
||||
<goals> |
||||
<goal>clean</goal> |
||||
</goals> |
||||
<id>flatten.clean</id> |
||||
<phase>clean</phase> |
||||
</execution> |
||||
</executions> |
||||
</plugin> |
||||
</plugins> |
||||
</build> |
||||
|
||||
<!-- 使用 huawei / aliyun 的 Maven 源，提升下载速度 --> |
||||
<repositories> |
||||
<repository> |
||||
<id>huaweicloud</id> |
||||
<name>huawei</name> |
||||
<url>https://mirrors.huaweicloud.com/repository/maven/</url> |
||||
</repository> |
||||
<repository> |
||||
<id>aliyunmaven</id> |
||||
<name>aliyun</name> |
||||
<url>https://maven.aliyun.com/repository/public</url> |
||||
</repository> |
||||
|
||||
<repository> |
||||
<id>spring-milestones</id> |
||||
<name>Spring Milestones</name> |
||||
<url>https://repo.spring.io/milestone</url> |
||||
<snapshots> |
||||
<enabled>false</enabled> |
||||
</snapshots> |
||||
</repository> |
||||
<repository> |
||||
<id>spring-snapshots</id> |
||||
<name>Spring Snapshots</name> |
||||
<url>https://repo.spring.io/snapshot</url> |
||||
<releases> |
||||
<enabled>false</enabled> |
||||
</releases> |
||||
</repository> |
||||
</repositories> |
||||
|
||||
</project> |
||||
@ -0,0 +1,49 @@ |
||||
# Docker Build & Up |
||||
|
||||
目标: 快速部署体验系统，帮助了解系统之间的依赖关系。 |
||||
依赖：docker compose v2，删除`name: soochowlife-system`，降低`version`版本为`3.3`以下，支持`docker-compose`。 |
||||
|
||||
## 功能文件列表 |
||||
|
||||
```text |
||||
. |
||||
├── Docker-HOWTO.md |
||||
├── docker-compose.yml |
||||
├── docker.env <-- 提供docker-compose环境变量配置 |
||||
├── soochowlife-server |
||||
│ └── Dockerfile |
||||
└── soochowlife-ui-admin |
||||
├── .dockerignore |
||||
├── Dockerfile |
||||
└── nginx.conf <-- 提供基础配置，gzip压缩、api转发 |
||||
``` |
||||
|
||||
## 构建 jar 包 |
||||
|
||||
```shell |
||||
# 创建maven缓存volume |
||||
docker volume create --name soochowlife-maven-repo |
||||
|
||||
docker run -it --rm --name soochowlife-maven \ |
||||
-v soochowlife-maven-repo:/root/.m2 \ |
||||
-v $PWD:/usr/src/mymaven \ |
||||
-w /usr/src/mymaven \ |
||||
maven mvn clean install package '-Dmaven.test.skip=true' |
||||
``` |
||||
|
||||
## 构建启动服务 |
||||
|
||||
```shell |
||||
docker compose --env-file docker.env up -d |
||||
``` |
||||
|
||||
首次运行会自动构建容器。可以通过`docker compose build [service]`来手动构建所有或某个docker镜像 |
||||
|
||||
`--env-file docker.env`为可选参数，只是展示了通过`.env`文件配置容器启动的环境变量，`docker-compose.yml`本身已经提供足够的默认参数来正常运行系统。 |
||||
|
||||
## 服务器的宿主机端口映射 |
||||
|
||||
- admin ui: http://localhost:8080 |
||||
- api server: http://localhost:48080 |
||||
- mysql: root/123456, port: 3306 |
||||
- redis: port: 6379 |
||||
@ -0,0 +1,84 @@ |
||||
version: "3.4" |
||||
|
||||
name: soochowlife-system |
||||
|
||||
services: |
||||
mysql: |
||||
container_name: soochowlife-mysql |
||||
image: mysql:8 |
||||
restart: unless-stopped |
||||
tty: true |
||||
ports: |
||||
- "3306:3306" |
||||
environment: |
||||
MYSQL_DATABASE: ${MYSQL_DATABASE:-ruoyi-vue-pro} |
||||
MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD:-123456} |
||||
volumes: |
||||
- mysql:/var/lib/mysql/ |
||||
- ./sql/mysql/ruoyi-vue-pro.sql:/docker-entrypoint-initdb.d/ruoyi-vue-pro.sql:ro |
||||
|
||||
redis: |
||||
container_name: soochowlife-redis |
||||
image: redis:6-alpine |
||||
restart: unless-stopped |
||||
ports: |
||||
- "6379:6379" |
||||
volumes: |
||||
- redis:/data |
||||
|
||||
server: |
||||
container_name: soochowlife-server |
||||
build: |
||||
context: ./soochowlife-server/ |
||||
image: soochowlife-server |
||||
restart: unless-stopped |
||||
ports: |
||||
- "48080:48080" |
||||
environment: |
||||
# https://github.com/polovyivan/docker-pass-configs-to-container |
||||
SPRING_PROFILES_ACTIVE: local |
||||
JAVA_OPTS: |
||||
${JAVA_OPTS:- |
||||
-Xms512m |
||||
-Xmx512m |
||||
-Djava.security.egd=file:/dev/./urandom |
||||
} |
||||
ARGS: |
||||
--spring.datasource.dynamic.datasource.master.url=${MASTER_DATASOURCE_URL:-jdbc:mysql://soochowlife-mysql:3306/ruoyi-vue-pro?useSSL=false&serverTimezone=Asia/Shanghai&allowPublicKeyRetrieval=true&nullCatalogMeansCurrent=true} |
||||
--spring.datasource.dynamic.datasource.master.username=${MASTER_DATASOURCE_USERNAME:-root} |
||||
--spring.datasource.dynamic.datasource.master.password=${MASTER_DATASOURCE_PASSWORD:-123456} |
||||
--spring.datasource.dynamic.datasource.slave.url=${SLAVE_DATASOURCE_URL:-jdbc:mysql://soochowlife-mysql:3306/ruoyi-vue-pro?useSSL=false&serverTimezone=Asia/Shanghai&allowPublicKeyRetrieval=true&nullCatalogMeansCurrent=true} |
||||
--spring.datasource.dynamic.datasource.slave.username=${SLAVE_DATASOURCE_USERNAME:-root} |
||||
--spring.datasource.dynamic.datasource.slave.password=${SLAVE_DATASOURCE_PASSWORD:-123456} |
||||
--spring.data.redis.host=${REDIS_HOST:-soochowlife-redis} |
||||
depends_on: |
||||
- mysql |
||||
- redis |
||||
|
||||
admin: |
||||
container_name: soochowlife-admin |
||||
build: |
||||
context: ./soochowlife-ui-admin |
||||
args: |
||||
NODE_ENV: |
||||
ENV=${NODE_ENV:-production} |
||||
PUBLIC_PATH=${PUBLIC_PATH:-/} |
||||
VUE_APP_TITLE=${VUE_APP_TITLE:-soochowlife管理系统} |
||||
VUE_APP_BASE_API=${VUE_APP_BASE_API:-/prod-api} |
||||
VUE_APP_APP_NAME=${VUE_APP_APP_NAME:-/} |
||||
VUE_APP_TENANT_ENABLE=${VUE_APP_TENANT_ENABLE:-true} |
||||
VUE_APP_CAPTCHA_ENABLE=${VUE_APP_CAPTCHA_ENABLE:-true} |
||||
VUE_APP_DOC_ENABLE=${VUE_APP_DOC_ENABLE:-true} |
||||
VUE_APP_BAIDU_CODE=${VUE_APP_BAIDU_CODE:-fadc1bd5db1a1d6f581df60a1807f8ab} |
||||
image: soochowlife-admin |
||||
restart: unless-stopped |
||||
ports: |
||||
- "8080:80" |
||||
depends_on: |
||||
- server |
||||
|
||||
volumes: |
||||
mysql: |
||||
driver: local |
||||
redis: |
||||
driver: local |
||||
@ -0,0 +1,25 @@ |
||||
## mysql |
||||
MYSQL_DATABASE=ruoyi-vue-pro |
||||
MYSQL_ROOT_PASSWORD=123456 |
||||
|
||||
## server |
||||
JAVA_OPTS=-Xms512m -Xmx512m -Djava.security.egd=file:/dev/./urandom |
||||
|
||||
MASTER_DATASOURCE_URL=jdbc:mysql://soochowlife-mysql:3306/${MYSQL_DATABASE}?useSSL=false&serverTimezone=Asia/Shanghai&allowPublicKeyRetrieval=true&nullCatalogMeansCurrent=true |
||||
MASTER_DATASOURCE_USERNAME=root |
||||
MASTER_DATASOURCE_PASSWORD=${MYSQL_ROOT_PASSWORD} |
||||
SLAVE_DATASOURCE_URL=${MASTER_DATASOURCE_URL} |
||||
SLAVE_DATASOURCE_USERNAME=${MASTER_DATASOURCE_USERNAME} |
||||
SLAVE_DATASOURCE_PASSWORD=${MASTER_DATASOURCE_PASSWORD} |
||||
REDIS_HOST=soochowlife-redis |
||||
|
||||
## admin |
||||
NODE_ENV=production |
||||
PUBLIC_PATH=/ |
||||
VUE_APP_TITLE=soochowlife管理系统 |
||||
VUE_APP_BASE_API=/prod-api |
||||
VUE_APP_APP_NAME=/ |
||||
VUE_APP_TENANT_ENABLE=true |
||||
VUE_APP_CAPTCHA_ENABLE=true |
||||
VUE_APP_DOC_ENABLE=true |
||||
VUE_APP_BAIDU_CODE=fadc1bd5db1a1d6f581df60a1807f8ab |
||||
@ -0,0 +1,20 @@ |
||||
{ |
||||
"local": { |
||||
"baseUrl": "http://127.0.0.1:48080/admin-api", |
||||
"token": "test1", |
||||
"adminTenantId": "1", |
||||
|
||||
"appApi": "http://127.0.0.1:48080/app-api", |
||||
"appToken": "test247", |
||||
"appTenantId": "1" |
||||
}, |
||||
"gateway": { |
||||
"baseUrl": "http://127.0.0.1:8888/admin-api", |
||||
"token": "test1", |
||||
"adminTenantId": "1", |
||||
|
||||
"appApi": "http://127.0.0.1:8888/app-api", |
||||
"appToken": "test1", |
||||
"appTenantId": "1" |
||||
} |
||||
} |
||||
@ -0,0 +1,60 @@ |
||||
#!groovy |
||||
pipeline { |
||||
|
||||
agent any |
||||
|
||||
parameters { |
||||
string(name: 'TAG_NAME', defaultValue: '', description: '') |
||||
} |
||||
|
||||
environment { |
||||
// DockerHub 凭证 ID(登录您的 DockerHub) |
||||
DOCKER_CREDENTIAL_ID = 'dockerhub-id' |
||||
// GitHub 凭证 ID (推送 tag 到 GitHub 仓库) |
||||
GITHUB_CREDENTIAL_ID = 'github-id' |
||||
// kubeconfig 凭证 ID (访问接入正在运行的 Kubernetes 集群) |
||||
KUBECONFIG_CREDENTIAL_ID = 'demo-kubeconfig' |
||||
// 镜像的推送 |
||||
REGISTRY = 'docker.io' |
||||
// DockerHub 账号名 |
||||
DOCKERHUB_NAMESPACE = 'docker_username' |
||||
// GitHub 账号名 |
||||
GITHUB_ACCOUNT = 'https://gitee.com/zhijiantianya/ruoyi-vue-pro' |
||||
// 应用名称 |
||||
APP_NAME = 'soochowlife-server' |
||||
// 应用部署路径 |
||||
APP_DEPLOY_BASE_DIR = '/media/pi/KINGTON/data/work/projects/' |
||||
} |
||||
|
||||
stages { |
||||
stage('检出') { |
||||
steps { |
||||
git url: "https://gitee.com/will-we/ruoyi-vue-pro.git", |
||||
branch: "devops" |
||||
} |
||||
} |
||||
|
||||
stage('构建') { |
||||
steps { |
||||
// TODO 解决多环境链接、密码不同配置临时方案 |
||||
sh 'if [ ! -d "' + "${env.HOME}" + '/resources" ];then\n' + |
||||
' echo "配置文件不存在无需修改"\n' + |
||||
'else\n' + |
||||
' cp -rf ' + "${env.HOME}" + '/resources/*.yaml ' + "${env.APP_NAME}" + '/src/main/resources\n' + |
||||
' echo "配置文件替换"\n' + |
||||
'fi' |
||||
sh 'mvn clean package -Dmaven.test.skip=true' |
||||
} |
||||
} |
||||
|
||||
stage('部署') { |
||||
steps { |
||||
sh 'cp -f ' + ' bin/deploy.sh ' + "${env.APP_DEPLOY_BASE_DIR}" + "${env.APP_NAME}" |
||||
sh 'cp -f ' + "${env.APP_NAME}" + '/target/*.jar ' + "${env.APP_DEPLOY_BASE_DIR}" + "${env.APP_NAME}" +'/build/' |
||||
archiveArtifacts "${env.APP_NAME}" + '/target/*.jar' |
||||
sh 'chmod +x ' + "${env.APP_DEPLOY_BASE_DIR}" + "${env.APP_NAME}" + '/deploy.sh' |
||||
sh 'bash ' + "${env.APP_DEPLOY_BASE_DIR}" + "${env.APP_NAME}" + '/deploy.sh' |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,160 @@ |
||||
#!/bin/bash |
||||
set -e |
||||
|
||||
DATE=$(date +%Y%m%d%H%M) |
||||
# 基础路径 |
||||
BASE_PATH=/work/projects/soochowlife-server |
||||
# 编译后 jar 的地址。部署时，Jenkins 会上传 jar 包到该目录下 |
||||
SOURCE_PATH=$BASE_PATH/build |
||||
# 服务名称。同时约定部署服务的 jar 包名字也为它。 |
||||
SERVER_NAME=soochowlife-server |
||||
# 环境 |
||||
PROFILES_ACTIVE=development |
||||
# 健康检查 URL |
||||
HEALTH_CHECK_URL=http://127.0.0.1:48080/actuator/health/ |
||||
|
||||
# heapError 存放路径 |
||||
HEAP_ERROR_PATH=$BASE_PATH/heapError |
||||
# JVM 参数 |
||||
JAVA_OPS="-Xms512m -Xmx512m -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=$HEAP_ERROR_PATH" |
||||
|
||||
# SkyWalking Agent 配置 |
||||
#export SW_AGENT_NAME=$SERVER_NAME |
||||
#export SW_AGENT_COLLECTOR_BACKEND_SERVICES=192.168.0.84:11800 |
||||
#export SW_GRPC_LOG_SERVER_HOST=192.168.0.84 |
||||
#export SW_AGENT_TRACE_IGNORE_PATH="Redisson/PING,/actuator/**,/admin/**" |
||||
#export JAVA_AGENT=-javaagent:/work/skywalking/apache-skywalking-apm-bin/agent/skywalking-agent.jar |
||||
|
||||
# 备份 |
||||
function backup() { |
||||
# 如果不存在，则无需备份 |
||||
if [ ! -f "$BASE_PATH/$SERVER_NAME.jar" ]; then |
||||
echo "[backup] $BASE_PATH/$SERVER_NAME.jar 不存在，跳过备份" |
||||
# 如果存在，则备份到 backup 目录下，使用时间作为后缀 |
||||
else |
||||
echo "[backup] 开始备份 $SERVER_NAME ..." |
||||
cp $BASE_PATH/$SERVER_NAME.jar $BASE_PATH/backup/$SERVER_NAME-$DATE.jar |
||||
echo "[backup] 备份 $SERVER_NAME 完成" |
||||
fi |
||||
} |
||||
|
||||
# 最新构建代码 移动到项目环境 |
||||
function transfer() { |
||||
echo "[transfer] 开始转移 $SERVER_NAME.jar" |
||||
|
||||
# 删除原 jar 包 |
||||
if [ ! -f "$BASE_PATH/$SERVER_NAME.jar" ]; then |
||||
echo "[transfer] $BASE_PATH/$SERVER_NAME.jar 不存在，跳过删除" |
||||
else |
||||
echo "[transfer] 移除 $BASE_PATH/$SERVER_NAME.jar 完成" |
||||
rm $BASE_PATH/$SERVER_NAME.jar |
||||
fi |
||||
|
||||
# 复制新 jar 包 |
||||
echo "[transfer] 从 $SOURCE_PATH 中获取 $SERVER_NAME.jar 并迁移至 $BASE_PATH ...." |
||||
cp $SOURCE_PATH/$SERVER_NAME.jar $BASE_PATH |
||||
|
||||
echo "[transfer] 转移 $SERVER_NAME.jar 完成" |
||||
} |
||||
|
||||
# 停止：优雅关闭之前已经启动的服务 |
||||
function stop() { |
||||
echo "[stop] 开始停止 $BASE_PATH/$SERVER_NAME" |
||||
PID=$(ps -ef | grep $BASE_PATH/$SERVER_NAME | grep -v "grep" | awk '{print $2}') |
||||
# 如果 Java 服务启动中，则进行关闭 |
||||
if [ -n "$PID" ]; then |
||||
# 正常关闭 |
||||
echo "[stop] $BASE_PATH/$SERVER_NAME 运行中，开始 kill [$PID]" |
||||
kill -15 $PID |
||||
# 等待最大 120 秒，直到关闭完成。 |
||||
for ((i = 0; i < 120; i++)) |
||||
do |
||||
sleep 1 |
||||
PID=$(ps -ef | grep $BASE_PATH/$SERVER_NAME | grep -v "grep" | awk '{print $2}') |
||||
if [ -n "$PID" ]; then |
||||
echo -e ".\c" |
||||
else |
||||
echo "[stop] 停止 $BASE_PATH/$SERVER_NAME 成功" |
||||
break |
||||
fi |
||||
done |
||||
|
||||
# 如果正常关闭失败，那么进行强制 kill -9 进行关闭 |
||||
if [ -n "$PID" ]; then |
||||
echo "[stop] $BASE_PATH/$SERVER_NAME 失败，强制 kill -9 $PID" |
||||
kill -9 $PID |
||||
fi |
||||
# 如果 Java 服务未启动，则无需关闭 |
||||
else |
||||
echo "[stop] $BASE_PATH/$SERVER_NAME 未启动，无需停止" |
||||
fi |
||||
} |
||||
|
||||
# 启动：启动后端项目 |
||||
function start() { |
||||
# 开启启动前，打印启动参数 |
||||
echo "[start] 开始启动 $BASE_PATH/$SERVER_NAME" |
||||
echo "[start] JAVA_OPS: $JAVA_OPS" |
||||
echo "[start] JAVA_AGENT: $JAVA_AGENT" |
||||
echo "[start] PROFILES: $PROFILES_ACTIVE" |
||||
|
||||
# 开始启动 |
||||
BUILD_ID=dontKillMe nohup java -server $JAVA_OPS $JAVA_AGENT -jar $BASE_PATH/$SERVER_NAME.jar --spring.profiles.active=$PROFILES_ACTIVE & |
||||
echo "[start] 启动 $BASE_PATH/$SERVER_NAME 完成" |
||||
} |
||||
|
||||
# 健康检查：自动判断后端项目是否正常启动 |
||||
function healthCheck() { |
||||
# 如果配置健康检查，则进行健康检查 |
||||
if [ -n "$HEALTH_CHECK_URL" ]; then |
||||
# 健康检查最大 120 秒，直到健康检查通过 |
||||
echo "[healthCheck] 开始通过 $HEALTH_CHECK_URL 地址，进行健康检查"; |
||||
for ((i = 0; i < 120; i++)) |
||||
do |
||||
# 请求健康检查地址，只获取状态码。 |
||||
result=`curl -I -m 10 -o /dev/null -s -w %{http_code} $HEALTH_CHECK_URL || echo "000"` |
||||
# 如果状态码为 200，则说明健康检查通过 |
||||
if [ "$result" == "200" ]; then |
||||
echo "[healthCheck] 健康检查通过"; |
||||
break |
||||
# 如果状态码非 200，则说明未通过。sleep 1 秒后，继续重试 |
||||
else |
||||
echo -e ".\c" |
||||
sleep 1 |
||||
fi |
||||
done |
||||
|
||||
# 健康检查未通过，则异常退出 shell 脚本，不继续部署。 |
||||
if [ ! "$result" == "200" ]; then |
||||
echo "[healthCheck] 健康检查不通过，可能部署失败。查看日志，自行判断是否启动成功"; |
||||
tail -n 10 nohup.out |
||||
exit 1; |
||||
# 健康检查通过，打印最后 10 行日志，可能部署的人想看下日志。 |
||||
else |
||||
tail -n 10 nohup.out |
||||
fi |
||||
# 如果未配置健康检查，则 sleep 120 秒，人工看日志是否部署成功。 |
||||
else |
||||
echo "[healthCheck] HEALTH_CHECK_URL 未配置，开始 sleep 120 秒"; |
||||
sleep 120 |
||||
echo "[healthCheck] sleep 120 秒完成，查看日志，自行判断是否启动成功"; |
||||
tail -n 50 nohup.out |
||||
fi |
||||
} |
||||
|
||||
# 部署 |
||||
function deploy() { |
||||
cd $BASE_PATH |
||||
# 备份原 jar |
||||
backup |
||||
# 停止 Java 服务 |
||||
stop |
||||
# 部署新 jar |
||||
transfer |
||||
# 启动 Java 服务 |
||||
start |
||||
# 健康检查 |
||||
healthCheck |
||||
} |
||||
|
||||
deploy |
||||
@ -0,0 +1,677 @@ |
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" |
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> |
||||
<modelVersion>4.0.0</modelVersion> |
||||
|
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-dependencies</artifactId> |
||||
<version>${revision}</version> |
||||
<packaging>pom</packaging> |
||||
|
||||
<name>${project.artifactId}</name> |
||||
<description>基础 bom 文件，管理整个项目的依赖版本</description> |
||||
<url>https://github.com/YunaiV/ruoyi-vue-pro</url> |
||||
|
||||
<properties> |
||||
<revision>2.6.0-SNAPSHOT</revision> |
||||
<flatten-maven-plugin.version>1.6.0</flatten-maven-plugin.version> |
||||
<!-- 统一依赖管理 --> |
||||
<spring.boot.version>3.5.3</spring.boot.version> |
||||
<!-- Web 相关 --> |
||||
<springdoc.version>2.8.3</springdoc.version> |
||||
<knife4j.version>4.6.0</knife4j.version> |
||||
<!-- DB 相关 --> |
||||
<druid.version>1.2.24</druid.version> |
||||
<mybatis.version>3.5.19</mybatis.version> |
||||
<mybatis-plus.version>3.5.10.1</mybatis-plus.version> |
||||
<dynamic-datasource.version>4.3.1</dynamic-datasource.version> |
||||
<mybatis-plus-join.version>1.4.13</mybatis-plus-join.version> |
||||
<easy-trans.version>3.0.6</easy-trans.version> |
||||
<redisson.version>3.41.0</redisson.version> |
||||
<dm8.jdbc.version>8.1.3.140</dm8.jdbc.version> |
||||
<kingbase.jdbc.version>8.6.0</kingbase.jdbc.version> |
||||
<opengauss.jdbc.version>5.1.0</opengauss.jdbc.version> |
||||
<taos.version>3.3.3</taos.version> |
||||
<!-- 消息队列 --> |
||||
<rocketmq-spring.version>2.3.2</rocketmq-spring.version> |
||||
<!-- 服务保障相关 --> |
||||
<lock4j.version>2.2.7</lock4j.version> |
||||
<!-- 监控相关 --> |
||||
<skywalking.version>9.0.0</skywalking.version> |
||||
<spring-boot-admin.version>3.4.5</spring-boot-admin.version> |
||||
<opentracing.version>0.33.0</opentracing.version> |
||||
<!-- Test 测试相关 --> |
||||
<podam.version>8.0.2.RELEASE</podam.version> |
||||
<jedis-mock.version>1.1.8</jedis-mock.version> |
||||
<mockito-inline.version>5.2.0</mockito-inline.version> |
||||
<!-- Bpm 工作流相关 --> |
||||
<flowable.version>7.0.1</flowable.version> |
||||
<!-- 工具类相关 --> |
||||
<anji-plus-captcha.version>1.4.0</anji-plus-captcha.version> |
||||
<jsoup.version>1.18.3</jsoup.version> |
||||
<lombok.version>1.18.36</lombok.version> |
||||
<mapstruct.version>1.6.3</mapstruct.version> |
||||
<hutool-5.version>5.8.35</hutool-5.version> |
||||
<hutool-6.version>6.0.0-M19</hutool-6.version> |
||||
<easyexcel.version>4.0.3</easyexcel.version> |
||||
<velocity.version>2.4.1</velocity.version> |
||||
<fastjson.version>1.2.83</fastjson.version> |
||||
<guava.version>33.4.8-jre</guava.version> |
||||
<transmittable-thread-local.version>2.14.5</transmittable-thread-local.version> |
||||
<commons-net.version>3.11.1</commons-net.version> |
||||
<jsch.version>0.1.55</jsch.version> |
||||
<tika-core.version>3.1.0</tika-core.version> |
||||
<ip2region.version>2.7.0</ip2region.version> |
||||
<bizlog-sdk.version>3.0.6</bizlog-sdk.version> |
||||
<netty.version>4.1.116.Final</netty.version> |
||||
<mqtt.version>1.2.5</mqtt.version> |
||||
<pf4j-spring.version>0.9.0</pf4j-spring.version> |
||||
<vertx.version>4.5.13</vertx.version> |
||||
<!-- 三方云服务相关 --> |
||||
<commons-io.version>2.17.0</commons-io.version> |
||||
<commons-compress.version>1.27.1</commons-compress.version> |
||||
<awssdk.version>2.30.14</awssdk.version> |
||||
<justauth.version>1.16.7</justauth.version> |
||||
<justauth-starter.version>1.4.0</justauth-starter.version> |
||||
<jimureport.version>1.9.4</jimureport.version> |
||||
<weixin-java.version>4.7.5.B</weixin-java.version> |
||||
</properties> |
||||
|
||||
<dependencyManagement> |
||||
<dependencies> |
||||
<!-- 统一依赖管理 --> |
||||
<dependency> |
||||
<groupId>io.netty</groupId> |
||||
<artifactId>netty-bom</artifactId> |
||||
<version>${netty.version}</version> |
||||
<type>pom</type> |
||||
<scope>import</scope> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.springframework.boot</groupId> |
||||
<artifactId>spring-boot-dependencies</artifactId> |
||||
<version>${spring.boot.version}</version> |
||||
<type>pom</type> |
||||
<scope>import</scope> |
||||
</dependency> |
||||
|
||||
<!-- 业务组件 --> |
||||
<dependency> |
||||
<groupId>io.github.mouzt</groupId> |
||||
<artifactId>bizlog-sdk</artifactId> |
||||
<version>${bizlog-sdk.version}</version> |
||||
<exclusions> |
||||
<exclusion> <!-- 排除掉springboot依赖使用项目的 --> |
||||
<groupId>org.springframework.boot</groupId> |
||||
<artifactId>spring-boot-starter</artifactId> |
||||
</exclusion> |
||||
</exclusions> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-biz-tenant</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-biz-data-permission</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-biz-ip</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<!-- Spring 核心 --> |
||||
<dependency> |
||||
<!-- 用于生成自定义的 Spring @ConfigurationProperties 配置类的说明文件 --> |
||||
<groupId>org.springframework.boot</groupId> |
||||
<artifactId>spring-boot-configuration-processor</artifactId> |
||||
<version>${spring.boot.version}</version> |
||||
</dependency> |
||||
|
||||
<!-- Web 相关 --> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-web</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-security</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-websocket</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.github.xingfudeshi</groupId> <!-- TODO Alex：https://github.com/xiaoymin/knife4j/issues/874 --> |
||||
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId> |
||||
<version>${knife4j.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.springdoc</groupId> |
||||
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId> |
||||
<version>${springdoc.version}</version> |
||||
</dependency> |
||||
|
||||
<!-- DB 相关 --> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-mybatis</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.alibaba</groupId> |
||||
<artifactId>druid-spring-boot-3-starter</artifactId> |
||||
<version>${druid.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<!-- 注意：必须声明，避免 flowable 和 mybatis-plus 引入的 mybatis 版本不一致！！！ --> |
||||
<groupId>org.mybatis</groupId> |
||||
<artifactId>mybatis</artifactId> |
||||
<version>${mybatis.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.baomidou</groupId> |
||||
<artifactId>mybatis-plus-spring-boot3-starter</artifactId> |
||||
<version>${mybatis-plus.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.baomidou</groupId> |
||||
<artifactId>mybatis-plus-jsqlparser</artifactId> |
||||
<version>${mybatis-plus.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.baomidou</groupId> |
||||
<artifactId>mybatis-plus-generator</artifactId> <!-- 代码生成器，使用它解析表结构 --> |
||||
<version>${mybatis-plus.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.baomidou</groupId> |
||||
<artifactId>dynamic-datasource-spring-boot3-starter</artifactId> <!-- 多数据源 --> |
||||
<version>${dynamic-datasource.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.github.yulichang</groupId> |
||||
<artifactId>mybatis-plus-join-boot-starter</artifactId> <!-- MyBatis 联表查询 --> |
||||
<version>${mybatis-plus-join.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.fhs-opensource</groupId> <!-- VO 数据翻译 --> |
||||
<artifactId>easy-trans-spring-boot-starter</artifactId> |
||||
<version>${easy-trans.version}</version> |
||||
<exclusions> |
||||
<exclusion> |
||||
<groupId>org.springframework</groupId> |
||||
<artifactId>spring-context</artifactId> |
||||
</exclusion> |
||||
<exclusion> |
||||
<groupId>org.springframework.cloud</groupId> |
||||
<artifactId>spring-cloud-commons</artifactId> |
||||
</exclusion> |
||||
</exclusions> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.fhs-opensource</groupId> |
||||
<artifactId>easy-trans-mybatis-plus-extend</artifactId> |
||||
<version>${easy-trans.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.fhs-opensource</groupId> |
||||
<artifactId>easy-trans-anno</artifactId> |
||||
<version>${easy-trans.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-redis</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.redisson</groupId> |
||||
<artifactId>redisson-spring-boot-starter</artifactId> |
||||
<version>${redisson.version}</version> |
||||
<exclusions> |
||||
<exclusion> |
||||
<groupId>org.springframework.boot</groupId> |
||||
<artifactId>spring-boot-starter-actuator</artifactId> |
||||
</exclusion> |
||||
</exclusions> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.dameng</groupId> |
||||
<artifactId>DmJdbcDriver18</artifactId> |
||||
<version>${dm8.jdbc.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.opengauss</groupId> |
||||
<artifactId>opengauss-jdbc</artifactId> |
||||
<version>${opengauss.jdbc.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>cn.com.kingbase</groupId> |
||||
<artifactId>kingbase8</artifactId> |
||||
<version>${kingbase.jdbc.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.taosdata.jdbc</groupId> |
||||
<artifactId>taos-jdbcdriver</artifactId> |
||||
<version>${taos.version}</version> |
||||
</dependency> |
||||
|
||||
<!-- Job 定时任务相关 --> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-job</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<!-- 消息队列相关 --> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-mq</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.apache.rocketmq</groupId> |
||||
<artifactId>rocketmq-spring-boot-starter</artifactId> |
||||
<version>${rocketmq-spring.version}</version> |
||||
</dependency> |
||||
|
||||
<!-- 服务保障相关 --> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-protection</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.baomidou</groupId> |
||||
<artifactId>lock4j-redisson-spring-boot-starter</artifactId> |
||||
<version>${lock4j.version}</version> |
||||
<exclusions> |
||||
<exclusion> |
||||
<artifactId>redisson-spring-boot-starter</artifactId> |
||||
<groupId>org.redisson</groupId> |
||||
</exclusion> |
||||
</exclusions> |
||||
</dependency> |
||||
|
||||
<!-- 监控相关 --> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-monitor</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.apache.skywalking</groupId> |
||||
<artifactId>apm-toolkit-trace</artifactId> |
||||
<version>${skywalking.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.apache.skywalking</groupId> |
||||
<artifactId>apm-toolkit-logback-1.x</artifactId> |
||||
<version>${skywalking.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.apache.skywalking</groupId> |
||||
<artifactId>apm-toolkit-opentracing</artifactId> |
||||
<version>${skywalking.version}</version> |
||||
<!-- <exclusions>--> |
||||
<!-- <exclusion>--> |
||||
<!-- <artifactId>opentracing-api</artifactId>--> |
||||
<!-- <groupId>io.opentracing</groupId>--> |
||||
<!-- </exclusion>--> |
||||
<!-- <exclusion>--> |
||||
<!-- <artifactId>opentracing-util</artifactId>--> |
||||
<!-- <groupId>io.opentracing</groupId>--> |
||||
<!-- </exclusion>--> |
||||
<!-- </exclusions>--> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>io.opentracing</groupId> |
||||
<artifactId>opentracing-api</artifactId> |
||||
<version>${opentracing.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>io.opentracing</groupId> |
||||
<artifactId>opentracing-util</artifactId> |
||||
<version>${opentracing.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>io.opentracing</groupId> |
||||
<artifactId>opentracing-noop</artifactId> |
||||
<version>${opentracing.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>de.codecentric</groupId> |
||||
<artifactId>spring-boot-admin-starter-server</artifactId> <!-- 实现 Spring Boot Admin Server 服务端 --> |
||||
<version>${spring-boot-admin.version}</version> |
||||
<exclusions> |
||||
<exclusion> |
||||
<groupId>de.codecentric</groupId> |
||||
<artifactId>spring-boot-admin-server-cloud</artifactId> |
||||
</exclusion> |
||||
</exclusions> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>de.codecentric</groupId> |
||||
<artifactId>spring-boot-admin-starter-client</artifactId> <!-- 实现 Spring Boot Admin Server 服务端 --> |
||||
<version>${spring-boot-admin.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.mockito</groupId> |
||||
<artifactId>mockito-inline</artifactId> |
||||
<version>${mockito-inline.version}</version> <!-- 支持 Mockito 的 final 类与 static 方法的 mock --> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.springframework.boot</groupId> |
||||
<artifactId>spring-boot-starter-test</artifactId> |
||||
<version>${spring.boot.version}</version> |
||||
<exclusions> |
||||
<exclusion> |
||||
<artifactId>asm</artifactId> |
||||
<groupId>org.ow2.asm</groupId> |
||||
</exclusion> |
||||
<exclusion> |
||||
<groupId>org.mockito</groupId> |
||||
<artifactId>mockito-core</artifactId> |
||||
</exclusion> |
||||
</exclusions> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.github.fppt</groupId> <!-- 单元测试，我们采用内嵌的 Redis 数据库 --> |
||||
<artifactId>jedis-mock</artifactId> |
||||
<version>${jedis-mock.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>uk.co.jemos.podam</groupId> <!-- 单元测试，随机生成 POJO 类 --> |
||||
<artifactId>podam</artifactId> |
||||
<version>${podam.version}</version> |
||||
</dependency> |
||||
|
||||
<!-- 工作流相关 --> |
||||
<dependency> |
||||
<groupId>org.flowable</groupId> |
||||
<artifactId>flowable-spring-boot-starter-process</artifactId> |
||||
<version>${flowable.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.flowable</groupId> |
||||
<artifactId>flowable-spring-boot-starter-actuator</artifactId> |
||||
<version>${flowable.version}</version> |
||||
</dependency> |
||||
<!-- 工作流相关结束 --> |
||||
|
||||
<!-- 工具类相关 --> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-common</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-excel</artifactId> |
||||
<version>${revision}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.projectlombok</groupId> |
||||
<artifactId>lombok</artifactId> |
||||
<version>${lombok.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.mapstruct</groupId> |
||||
<artifactId>mapstruct</artifactId> <!-- use mapstruct-jdk8 for Java 8 or higher --> |
||||
<version>${mapstruct.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.mapstruct</groupId> |
||||
<artifactId>mapstruct-jdk8</artifactId> |
||||
<version>${mapstruct.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.mapstruct</groupId> |
||||
<artifactId>mapstruct-processor</artifactId> |
||||
<version>${mapstruct.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>cn.hutool</groupId> |
||||
<artifactId>hutool-all</artifactId> |
||||
<version>${hutool-5.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.dromara.hutool</groupId> |
||||
<artifactId>hutool-extra</artifactId> |
||||
<version>${hutool-6.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.alibaba</groupId> |
||||
<artifactId>easyexcel</artifactId> |
||||
<version>${easyexcel.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>commons-io</groupId> |
||||
<artifactId>commons-io</artifactId> |
||||
<version>${commons-io.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.apache.commons</groupId> |
||||
<artifactId>commons-compress</artifactId> |
||||
<version>${commons-compress.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.apache.tika</groupId> |
||||
<artifactId>tika-core</artifactId> <!-- 文件类型的识别 --> |
||||
<version>${tika-core.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.apache.velocity</groupId> |
||||
<artifactId>velocity-engine-core</artifactId> |
||||
<version>${velocity.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.alibaba</groupId> |
||||
<artifactId>fastjson</artifactId> |
||||
<version>${fastjson.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.google.guava</groupId> |
||||
<artifactId>guava</artifactId> |
||||
<version>${guava.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.alibaba</groupId> |
||||
<artifactId>transmittable-thread-local</artifactId> <!-- 解决 ThreadLocal 父子线程的传值问题 --> |
||||
<version>${transmittable-thread-local.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>commons-net</groupId> |
||||
<artifactId>commons-net</artifactId> <!-- 解决 ftp 连接 --> |
||||
<version>${commons-net.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.jcraft</groupId> |
||||
<artifactId>jsch</artifactId> <!-- 解决 sftp 连接 --> |
||||
<version>${jsch.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.anji-plus</groupId> |
||||
<artifactId>captcha-spring-boot-starter</artifactId> <!-- 验证码，一般用于登录使用 --> |
||||
<version>${anji-plus-captcha.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.lionsoul</groupId> |
||||
<artifactId>ip2region</artifactId> |
||||
<version>${ip2region.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.jsoup</groupId> |
||||
<artifactId>jsoup</artifactId> |
||||
<version>${jsoup.version}</version> |
||||
</dependency> |
||||
|
||||
<!-- 三方云服务相关 --> |
||||
<dependency> |
||||
<groupId>software.amazon.awssdk</groupId> |
||||
<artifactId>s3</artifactId> |
||||
<version>${awssdk.version}</version> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>me.zhyd.oauth</groupId> |
||||
<artifactId>JustAuth</artifactId> <!-- 社交登陆（例如说，个人微信、企业微信等等） --> |
||||
<version>${justauth.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.xkcoding.justauth</groupId> |
||||
<artifactId>justauth-spring-boot-starter</artifactId> |
||||
<version>${justauth-starter.version}</version> |
||||
<exclusions> |
||||
<!-- 移除，避免和项目里的 hutool-all 冲突 --> |
||||
<exclusion> |
||||
<groupId>cn.hutool</groupId> |
||||
<artifactId>hutool-core</artifactId> |
||||
</exclusion> |
||||
</exclusions> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.github.binarywang</groupId> |
||||
<artifactId>weixin-java-pay</artifactId> |
||||
<version>${weixin-java.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.github.binarywang</groupId> |
||||
<artifactId>wx-java-mp-spring-boot-starter</artifactId> |
||||
<version>${weixin-java.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.github.binarywang</groupId> |
||||
<artifactId>wx-java-miniapp-spring-boot-starter</artifactId> |
||||
<version>${weixin-java.version}</version> |
||||
</dependency> |
||||
|
||||
<!-- 积木报表--> |
||||
<dependency> |
||||
<groupId>org.jeecgframework.jimureport</groupId> |
||||
<artifactId>jimureport-spring-boot3-starter-fastjson2</artifactId> |
||||
<version>${jimureport.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.jeecgframework.jimureport</groupId> |
||||
<artifactId>jimubi-spring-boot3-starter</artifactId> |
||||
<version>${jimureport.version}</version> |
||||
<exclusions> |
||||
<exclusion> |
||||
<groupId>com.github.jsqlparser</groupId> |
||||
<artifactId>jsqlparser</artifactId> |
||||
</exclusion> |
||||
</exclusions> |
||||
</dependency> |
||||
|
||||
<!-- PF4J --> |
||||
<dependency> |
||||
<groupId>org.pf4j</groupId> |
||||
<artifactId>pf4j-spring</artifactId> |
||||
<version>${pf4j-spring.version}</version> |
||||
<exclusions> |
||||
<exclusion> |
||||
<groupId>org.slf4j</groupId> |
||||
<artifactId>slf4j-log4j12</artifactId> |
||||
</exclusion> |
||||
</exclusions> |
||||
</dependency> |
||||
|
||||
<!-- Vert.x --> |
||||
<dependency> |
||||
<groupId>io.vertx</groupId> |
||||
<artifactId>vertx-core</artifactId> |
||||
<version>${vertx.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>io.vertx</groupId> |
||||
<artifactId>vertx-web</artifactId> |
||||
<version>${vertx.version}</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>io.vertx</groupId> |
||||
<artifactId>vertx-mqtt</artifactId> |
||||
<version>${vertx.version}</version> |
||||
</dependency> |
||||
|
||||
<!-- MQTT --> |
||||
<dependency> |
||||
<groupId>org.eclipse.paho</groupId> |
||||
<artifactId>org.eclipse.paho.client.mqttv3</artifactId> |
||||
<version>${mqtt.version}</version> |
||||
</dependency> |
||||
</dependencies> |
||||
</dependencyManagement> |
||||
|
||||
<build> |
||||
<plugins> |
||||
<!-- 统一 revision 版本 --> |
||||
<plugin> |
||||
<groupId>org.codehaus.mojo</groupId> |
||||
<artifactId>flatten-maven-plugin</artifactId> |
||||
<version>${flatten-maven-plugin.version}</version> |
||||
<configuration> |
||||
<flattenMode>bom</flattenMode> |
||||
<updatePomFile>true</updatePomFile> |
||||
</configuration> |
||||
<executions> |
||||
<execution> |
||||
<goals> |
||||
<goal>flatten</goal> |
||||
</goals> |
||||
<id>flatten</id> |
||||
<phase>process-resources</phase> |
||||
</execution> |
||||
<execution> |
||||
<goals> |
||||
<goal>clean</goal> |
||||
</goals> |
||||
<id>flatten.clean</id> |
||||
<phase>clean</phase> |
||||
</execution> |
||||
</executions> |
||||
</plugin> |
||||
</plugins> |
||||
</build> |
||||
|
||||
</project> |
||||
@ -0,0 +1,45 @@ |
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" |
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> |
||||
<modelVersion>4.0.0</modelVersion> |
||||
<parent> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-web</artifactId> |
||||
<version>${revision}</version> |
||||
</parent> |
||||
<packaging>pom</packaging> |
||||
<modules> |
||||
<module>soochowlife-common</module> |
||||
<module>soochowlife-spring-boot-starter-biz-data-permission</module> |
||||
<module>soochowlife-spring-boot-starter-redis</module> |
||||
<module>soochowlife-spring-boot-starter-web</module> |
||||
<module>soochowlife-spring-boot-starter-security</module> |
||||
<module>soochowlife-spring-boot-starter-websocket</module> |
||||
|
||||
<module>soochowlife-spring-boot-starter-monitor</module> |
||||
<module>soochowlife-spring-boot-starter-protection</module> |
||||
<module>soochowlife-spring-boot-starter-job</module> |
||||
<module>soochowlife-spring-boot-starter-mq</module> |
||||
|
||||
<module>soochowlife-spring-boot-starter-excel</module> |
||||
|
||||
<module>soochowlife-spring-boot-starter-biz-tenant</module> |
||||
<module>soochowlife-spring-boot-starter-mybatis</module> |
||||
<module>soochowlife-spring-boot-starter-biz-ip</module> |
||||
</modules> |
||||
|
||||
<artifactId>soochowlife-framework</artifactId> |
||||
<description> |
||||
该包是技术组件，每个子包，代表一个组件。每个组件包括两部分： |
||||
1. core 包：是该组件的核心封装 |
||||
2. config 包：是该组件基于 Spring 的配置 |
||||
|
||||
技术组件，也分成两类： |
||||
1. 框架组件：和我们熟悉的 MyBatis、Redis 等等的拓展 |
||||
2. 业务组件：和业务相关的组件的封装，例如说数据字典、操作日志等等。 |
||||
如果是业务组件，Maven 名字会包含 biz |
||||
</description> |
||||
<url>https://github.com/YunaiV/ruoyi-vue-pro</url> |
||||
|
||||
</project> |
||||
@ -0,0 +1,149 @@ |
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" |
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> |
||||
<parent> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-framework</artifactId> |
||||
<version>${revision}</version> |
||||
</parent> |
||||
<modelVersion>4.0.0</modelVersion> |
||||
<artifactId>soochowlife-common</artifactId> |
||||
<packaging>jar</packaging> |
||||
|
||||
<name>${project.artifactId}</name> |
||||
<description>定义基础 pojo 类、枚举、工具类等等</description> |
||||
<url>https://github.com/YunaiV/ruoyi-vue-pro</url> |
||||
|
||||
<dependencies> |
||||
<!-- Spring 核心 --> |
||||
<dependency> |
||||
<groupId>org.springframework</groupId> |
||||
<artifactId>spring-core</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.springframework</groupId> |
||||
<artifactId>spring-expression</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.springframework</groupId> |
||||
<artifactId>spring-aop</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.aspectj</groupId> |
||||
<artifactId>aspectjweaver</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<!-- 用于生成自定义的 Spring @ConfigurationProperties 配置类的说明文件 --> |
||||
<groupId>org.springframework.boot</groupId> |
||||
<artifactId>spring-boot-configuration-processor</artifactId> |
||||
<optional>true</optional> |
||||
</dependency> |
||||
|
||||
<!-- Web 相关 --> |
||||
<dependency> |
||||
<groupId>org.springframework</groupId> |
||||
<artifactId>spring-web</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>jakarta.servlet</groupId> |
||||
<artifactId>jakarta.servlet-api</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.springdoc</groupId> |
||||
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，主要是 PageParam 使用到 --> |
||||
</dependency> |
||||
|
||||
<!-- 监控相关 --> |
||||
<dependency> |
||||
<groupId>org.apache.skywalking</groupId> |
||||
<artifactId>apm-toolkit-trace</artifactId> |
||||
</dependency> |
||||
|
||||
<!-- 工具类相关 --> |
||||
<dependency> |
||||
<groupId>org.projectlombok</groupId> |
||||
<artifactId>lombok</artifactId> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.mapstruct</groupId> |
||||
<artifactId>mapstruct</artifactId> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.mapstruct</groupId> |
||||
<artifactId>mapstruct-jdk8</artifactId> <!-- use mapstruct-jdk8 for Java 8 or higher --> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>org.mapstruct</groupId> |
||||
<artifactId>mapstruct-processor</artifactId> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.google.guava</groupId> |
||||
<artifactId>guava</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.fasterxml.jackson.core</groupId> |
||||
<artifactId>jackson-databind</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.fasterxml.jackson.core</groupId> |
||||
<artifactId>jackson-core</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>com.fasterxml.jackson.datatype</groupId> |
||||
<artifactId>jackson-datatype-jsr310</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>org.slf4j</groupId> |
||||
<artifactId>slf4j-api</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，只有工具类需要使用到 --> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>jakarta.validation</groupId> |
||||
<artifactId>jakarta.validation-api</artifactId> |
||||
<scope>provided</scope> <!-- 设置为 provided，主要是 PageParam 使用到 --> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>cn.hutool</groupId> |
||||
<artifactId>hutool-all</artifactId> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.alibaba</groupId> |
||||
<artifactId>transmittable-thread-local</artifactId> |
||||
</dependency> |
||||
|
||||
<dependency> |
||||
<groupId>com.fhs-opensource</groupId> <!-- VO 数据翻译 --> |
||||
<artifactId>easy-trans-anno</artifactId> <!-- 默认引入的原因，方便 xxx-module-api 包使用 --> |
||||
</dependency> |
||||
|
||||
<!-- Test 测试相关 --> |
||||
<dependency> |
||||
<groupId>org.springframework.boot</groupId> |
||||
<artifactId>spring-boot-starter-test</artifactId> |
||||
<scope>test</scope> |
||||
</dependency> |
||||
</dependencies> |
||||
|
||||
</project> |
||||
@ -0,0 +1,31 @@ |
||||
package com.soochowlife.web.framework.common.biz.infra.logger; |
||||
|
||||
import com.soochowlife.web.framework.common.biz.infra.logger.dto.ApiAccessLogCreateReqDTO; |
||||
import jakarta.validation.Valid; |
||||
import org.springframework.scheduling.annotation.Async; |
||||
|
||||
/** |
||||
* API 访问日志的 API 接口 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface ApiAccessLogCommonApi { |
||||
|
||||
/** |
||||
* 创建 API 访问日志 |
||||
* |
||||
* @param createDTO 创建信息 |
||||
*/ |
||||
void createApiAccessLog(@Valid ApiAccessLogCreateReqDTO createDTO); |
||||
|
||||
/** |
||||
* 【异步】创建 API 访问日志 |
||||
* |
||||
* @param createDTO 访问日志 DTO |
||||
*/ |
||||
@Async |
||||
default void createApiAccessLogAsync(ApiAccessLogCreateReqDTO createDTO) { |
||||
createApiAccessLog(createDTO); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,32 @@ |
||||
package com.soochowlife.web.framework.common.biz.infra.logger; |
||||
|
||||
import com.soochowlife.web.framework.common.biz.infra.logger.dto.ApiErrorLogCreateReqDTO; |
||||
|
||||
import jakarta.validation.Valid; |
||||
import org.springframework.scheduling.annotation.Async; |
||||
|
||||
/** |
||||
* API 错误日志的 API 接口 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface ApiErrorLogCommonApi { |
||||
|
||||
/** |
||||
* 创建 API 错误日志 |
||||
* |
||||
* @param createDTO 创建信息 |
||||
*/ |
||||
void createApiErrorLog(@Valid ApiErrorLogCreateReqDTO createDTO); |
||||
|
||||
/** |
||||
* 【异步】创建 API 异常日志 |
||||
* |
||||
* @param createDTO 异常日志 DTO |
||||
*/ |
||||
@Async |
||||
default void createApiErrorLogAsync(ApiErrorLogCreateReqDTO createDTO) { |
||||
createApiErrorLog(createDTO); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,103 @@ |
||||
package com.soochowlife.web.framework.common.biz.infra.logger.dto; |
||||
|
||||
import jakarta.validation.constraints.NotNull; |
||||
import lombok.Data; |
||||
|
||||
import java.time.LocalDateTime; |
||||
|
||||
/** |
||||
* API 访问日志 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Data |
||||
public class ApiAccessLogCreateReqDTO { |
||||
|
||||
/** |
||||
* 链路追踪编号 |
||||
*/ |
||||
private String traceId; |
||||
/** |
||||
* 用户编号 |
||||
*/ |
||||
private Long userId; |
||||
/** |
||||
* 用户类型 |
||||
*/ |
||||
private Integer userType; |
||||
/** |
||||
* 应用名 |
||||
*/ |
||||
@NotNull(message = "应用名不能为空") |
||||
private String applicationName; |
||||
|
||||
/** |
||||
* 请求方法名 |
||||
*/ |
||||
@NotNull(message = "http 请求方法不能为空") |
||||
private String requestMethod; |
||||
/** |
||||
* 访问地址 |
||||
*/ |
||||
@NotNull(message = "访问地址不能为空") |
||||
private String requestUrl; |
||||
/** |
||||
* 请求参数 |
||||
*/ |
||||
private String requestParams; |
||||
/** |
||||
* 响应结果 |
||||
*/ |
||||
private String responseBody; |
||||
/** |
||||
* 用户 IP |
||||
*/ |
||||
@NotNull(message = "ip 不能为空") |
||||
private String userIp; |
||||
/** |
||||
* 浏览器 UA |
||||
*/ |
||||
@NotNull(message = "User-Agent 不能为空") |
||||
private String userAgent; |
||||
|
||||
/** |
||||
* 操作模块 |
||||
*/ |
||||
private String operateModule; |
||||
/** |
||||
* 操作名 |
||||
*/ |
||||
private String operateName; |
||||
/** |
||||
* 操作分类 |
||||
* |
||||
* 枚举，参见 OperateTypeEnum 类 |
||||
*/ |
||||
private Integer operateType; |
||||
|
||||
/** |
||||
* 开始请求时间 |
||||
*/ |
||||
@NotNull(message = "开始请求时间不能为空") |
||||
private LocalDateTime beginTime; |
||||
/** |
||||
* 结束请求时间 |
||||
*/ |
||||
@NotNull(message = "结束请求时间不能为空") |
||||
private LocalDateTime endTime; |
||||
/** |
||||
* 执行时长，单位：毫秒 |
||||
*/ |
||||
@NotNull(message = "执行时长不能为空") |
||||
private Integer duration; |
||||
/** |
||||
* 结果码 |
||||
*/ |
||||
@NotNull(message = "错误码不能为空") |
||||
private Integer resultCode; |
||||
/** |
||||
* 结果提示 |
||||
*/ |
||||
private String resultMsg; |
||||
|
||||
} |
||||
@ -0,0 +1,107 @@ |
||||
package com.soochowlife.web.framework.common.biz.infra.logger.dto; |
||||
|
||||
import lombok.Data; |
||||
|
||||
import jakarta.validation.constraints.NotNull; |
||||
import java.time.LocalDateTime; |
||||
|
||||
/** |
||||
* API 错误日志 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Data |
||||
public class ApiErrorLogCreateReqDTO { |
||||
|
||||
/** |
||||
* 链路编号 |
||||
*/ |
||||
private String traceId; |
||||
/** |
||||
* 账号编号 |
||||
*/ |
||||
private Long userId; |
||||
/** |
||||
* 用户类型 |
||||
*/ |
||||
private Integer userType; |
||||
/** |
||||
* 应用名 |
||||
*/ |
||||
@NotNull(message = "应用名不能为空") |
||||
private String applicationName; |
||||
|
||||
/** |
||||
* 请求方法名 |
||||
*/ |
||||
@NotNull(message = "http 请求方法不能为空") |
||||
private String requestMethod; |
||||
/** |
||||
* 访问地址 |
||||
*/ |
||||
@NotNull(message = "访问地址不能为空") |
||||
private String requestUrl; |
||||
/** |
||||
* 请求参数 |
||||
*/ |
||||
@NotNull(message = "请求参数不能为空") |
||||
private String requestParams; |
||||
/** |
||||
* 用户 IP |
||||
*/ |
||||
@NotNull(message = "ip 不能为空") |
||||
private String userIp; |
||||
/** |
||||
* 浏览器 UA |
||||
*/ |
||||
@NotNull(message = "User-Agent 不能为空") |
||||
private String userAgent; |
||||
|
||||
/** |
||||
* 异常时间 |
||||
*/ |
||||
@NotNull(message = "异常时间不能为空") |
||||
private LocalDateTime exceptionTime; |
||||
/** |
||||
* 异常名 |
||||
*/ |
||||
@NotNull(message = "异常名不能为空") |
||||
private String exceptionName; |
||||
/** |
||||
* 异常发生的类全名 |
||||
*/ |
||||
@NotNull(message = "异常发生的类全名不能为空") |
||||
private String exceptionClassName; |
||||
/** |
||||
* 异常发生的类文件 |
||||
*/ |
||||
@NotNull(message = "异常发生的类文件不能为空") |
||||
private String exceptionFileName; |
||||
/** |
||||
* 异常发生的方法名 |
||||
*/ |
||||
@NotNull(message = "异常发生的方法名不能为空") |
||||
private String exceptionMethodName; |
||||
/** |
||||
* 异常发生的方法所在行 |
||||
*/ |
||||
@NotNull(message = "异常发生的方法所在行不能为空") |
||||
private Integer exceptionLineNumber; |
||||
/** |
||||
* 异常的栈轨迹异常的栈轨迹 |
||||
*/ |
||||
@NotNull(message = "异常的栈轨迹不能为空") |
||||
private String exceptionStackTrace; |
||||
/** |
||||
* 异常导致的根消息 |
||||
*/ |
||||
@NotNull(message = "异常导致的根消息不能为空") |
||||
private String exceptionRootCauseMessage; |
||||
/** |
||||
* 异常导致的消息 |
||||
*/ |
||||
@NotNull(message = "异常导致的消息不能为空") |
||||
private String exceptionMessage; |
||||
|
||||
|
||||
} |
||||
@ -0,0 +1,4 @@ |
||||
/** |
||||
* 针对 infra 模块的 api 包 |
||||
*/ |
||||
package com.soochowlife.web.framework.common.biz.infra; |
||||
@ -0,0 +1,4 @@ |
||||
/** |
||||
* 特殊：用于 framework 下，starter 需要调用 biz 业务模块的接口定义！ |
||||
*/ |
||||
package com.soochowlife.web.framework.common.biz; |
||||
@ -0,0 +1,22 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.dict; |
||||
|
||||
import com.soochowlife.web.framework.common.biz.system.dict.dto.DictDataRespDTO; |
||||
|
||||
import java.util.List; |
||||
|
||||
/** |
||||
* 字典数据 API 接口 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface DictDataCommonApi { |
||||
|
||||
/** |
||||
* 获得指定字典类型的字典数据列表 |
||||
* |
||||
* @param dictType 字典类型 |
||||
* @return 字典数据列表 |
||||
*/ |
||||
List<DictDataRespDTO> getDictDataList(String dictType); |
||||
|
||||
} |
||||
@ -0,0 +1,33 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.dict.dto; |
||||
|
||||
import com.soochowlife.web.framework.common.enums.CommonStatusEnum; |
||||
import lombok.Data; |
||||
|
||||
/** |
||||
* 字典数据 Response DTO |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Data |
||||
public class DictDataRespDTO { |
||||
|
||||
/** |
||||
* 字典标签 |
||||
*/ |
||||
private String label; |
||||
/** |
||||
* 字典值 |
||||
*/ |
||||
private String value; |
||||
/** |
||||
* 字典类型 |
||||
*/ |
||||
private String dictType; |
||||
/** |
||||
* 状态 |
||||
* |
||||
* 枚举 {@link CommonStatusEnum} |
||||
*/ |
||||
private Integer status; |
||||
|
||||
} |
||||
@ -0,0 +1,31 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.logger; |
||||
|
||||
import com.soochowlife.web.framework.common.biz.system.logger.dto.OperateLogCreateReqDTO; |
||||
import jakarta.validation.Valid; |
||||
import org.springframework.scheduling.annotation.Async; |
||||
|
||||
/** |
||||
* 操作日志 API 接口 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface OperateLogCommonApi { |
||||
|
||||
/** |
||||
* 创建操作日志 |
||||
* |
||||
* @param createReqDTO 请求 |
||||
*/ |
||||
void createOperateLog(@Valid OperateLogCreateReqDTO createReqDTO); |
||||
|
||||
/** |
||||
* 【异步】创建操作日志 |
||||
* |
||||
* @param createReqDTO 请求 |
||||
*/ |
||||
@Async |
||||
default void createOperateLogAsync(OperateLogCreateReqDTO createReqDTO) { |
||||
createOperateLog(createReqDTO); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,84 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.logger.dto; |
||||
|
||||
import com.soochowlife.web.framework.common.enums.UserTypeEnum; |
||||
import jakarta.validation.constraints.NotEmpty; |
||||
import jakarta.validation.constraints.NotNull; |
||||
import lombok.Data; |
||||
|
||||
/** |
||||
* 系统操作日志 Create Request DTO |
||||
* |
||||
* @author HUIHUI |
||||
*/ |
||||
@Data |
||||
public class OperateLogCreateReqDTO { |
||||
|
||||
/** |
||||
* 链路追踪编号 |
||||
* |
||||
* 一般来说，通过链路追踪编号，可以将访问日志，错误日志，链路追踪日志，logger 打印日志等，结合在一起，从而进行排错。 |
||||
*/ |
||||
private String traceId; |
||||
/** |
||||
* 用户编号 |
||||
* |
||||
* 关联 MemberUserDO 的 id 属性，或者 AdminUserDO 的 id 属性 |
||||
*/ |
||||
@NotNull(message = "用户编号不能为空") |
||||
private Long userId; |
||||
/** |
||||
* 用户类型 |
||||
* |
||||
* 关联 {@link UserTypeEnum} |
||||
*/ |
||||
@NotNull(message = "用户类型不能为空") |
||||
private Integer userType; |
||||
/** |
||||
* 操作模块类型 |
||||
*/ |
||||
@NotEmpty(message = "操作模块类型不能为空") |
||||
private String type; |
||||
/** |
||||
* 操作名 |
||||
*/ |
||||
@NotEmpty(message = "操作名不能为空") |
||||
private String subType; |
||||
/** |
||||
* 操作模块业务编号 |
||||
*/ |
||||
@NotNull(message = "操作模块业务编号不能为空") |
||||
private Long bizId; |
||||
/** |
||||
* 操作内容，记录整个操作的明细 |
||||
* 例如说，修改编号为 1 的用户信息，将性别从男改成女，将姓名从soochowlife改成源码。 |
||||
*/ |
||||
@NotEmpty(message = "操作内容不能为空") |
||||
private String action; |
||||
/** |
||||
* 拓展字段，有些复杂的业务，需要记录一些字段 ( JSON 格式 ) |
||||
* 例如说，记录订单编号，{ orderId: "1"} |
||||
*/ |
||||
private String extra; |
||||
|
||||
/** |
||||
* 请求方法名 |
||||
*/ |
||||
@NotEmpty(message = "请求方法名不能为空") |
||||
private String requestMethod; |
||||
/** |
||||
* 请求地址 |
||||
*/ |
||||
@NotEmpty(message = "请求地址不能为空") |
||||
private String requestUrl; |
||||
/** |
||||
* 用户 IP |
||||
*/ |
||||
@NotEmpty(message = "用户 IP 不能为空") |
||||
private String userIp; |
||||
/** |
||||
* 浏览器 UA |
||||
*/ |
||||
@NotEmpty(message = "浏览器 UA 不能为空") |
||||
private String userAgent; |
||||
|
||||
} |
||||
@ -0,0 +1,49 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.oauth2; |
||||
|
||||
import com.soochowlife.web.framework.common.biz.system.oauth2.dto.OAuth2AccessTokenCheckRespDTO; |
||||
import com.soochowlife.web.framework.common.biz.system.oauth2.dto.OAuth2AccessTokenCreateReqDTO; |
||||
import com.soochowlife.web.framework.common.biz.system.oauth2.dto.OAuth2AccessTokenRespDTO; |
||||
|
||||
import jakarta.validation.Valid; |
||||
|
||||
/** |
||||
* OAuth2.0 Token API 接口 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface OAuth2TokenCommonApi { |
||||
|
||||
/** |
||||
* 创建访问令牌 |
||||
* |
||||
* @param reqDTO 访问令牌的创建信息 |
||||
* @return 访问令牌的信息 |
||||
*/ |
||||
OAuth2AccessTokenRespDTO createAccessToken(@Valid OAuth2AccessTokenCreateReqDTO reqDTO); |
||||
|
||||
/** |
||||
* 校验访问令牌 |
||||
* |
||||
* @param accessToken 访问令牌 |
||||
* @return 访问令牌的信息 |
||||
*/ |
||||
OAuth2AccessTokenCheckRespDTO checkAccessToken(String accessToken); |
||||
|
||||
/** |
||||
* 移除访问令牌 |
||||
* |
||||
* @param accessToken 访问令牌 |
||||
* @return 访问令牌的信息 |
||||
*/ |
||||
OAuth2AccessTokenRespDTO removeAccessToken(String accessToken); |
||||
|
||||
/** |
||||
* 刷新访问令牌 |
||||
* |
||||
* @param refreshToken 刷新令牌 |
||||
* @param clientId 客户端编号 |
||||
* @return 访问令牌的信息 |
||||
*/ |
||||
OAuth2AccessTokenRespDTO refreshAccessToken(String refreshToken, String clientId); |
||||
|
||||
} |
||||
@ -0,0 +1,43 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.oauth2.dto; |
||||
|
||||
import lombok.Data; |
||||
|
||||
import java.io.Serializable; |
||||
import java.time.LocalDateTime; |
||||
import java.util.List; |
||||
import java.util.Map; |
||||
|
||||
/** |
||||
* OAuth2.0 访问令牌的校验 Response DTO |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Data |
||||
public class OAuth2AccessTokenCheckRespDTO implements Serializable { |
||||
|
||||
/** |
||||
* 用户编号 |
||||
*/ |
||||
private Long userId; |
||||
/** |
||||
* 用户类型 |
||||
*/ |
||||
private Integer userType; |
||||
/** |
||||
* 用户信息 |
||||
*/ |
||||
private Map<String, String> userInfo; |
||||
/** |
||||
* 租户编号 |
||||
*/ |
||||
private Long tenantId; |
||||
/** |
||||
* 授权范围的数组 |
||||
*/ |
||||
private List<String> scopes; |
||||
/** |
||||
* 过期时间 |
||||
*/ |
||||
private LocalDateTime expiresTime; |
||||
|
||||
} |
||||
@ -0,0 +1,40 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.oauth2.dto; |
||||
|
||||
import com.soochowlife.web.framework.common.enums.UserTypeEnum; |
||||
import com.soochowlife.web.framework.common.validation.InEnum; |
||||
import lombok.Data; |
||||
|
||||
import jakarta.validation.constraints.NotNull; |
||||
import java.io.Serializable; |
||||
import java.util.List; |
||||
|
||||
/** |
||||
* OAuth2.0 访问令牌创建 Request DTO |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Data |
||||
public class OAuth2AccessTokenCreateReqDTO implements Serializable { |
||||
|
||||
/** |
||||
* 用户编号 |
||||
*/ |
||||
@NotNull(message = "用户编号不能为空") |
||||
private Long userId; |
||||
/** |
||||
* 用户类型 |
||||
*/ |
||||
@NotNull(message = "用户类型不能为空") |
||||
@InEnum(value = UserTypeEnum.class, message = "用户类型必须是 {value}") |
||||
private Integer userType; |
||||
/** |
||||
* 客户端编号 |
||||
*/ |
||||
@NotNull(message = "客户端编号不能为空") |
||||
private String clientId; |
||||
/** |
||||
* 授权范围 |
||||
*/ |
||||
private List<String> scopes; |
||||
|
||||
} |
||||
@ -0,0 +1,39 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.oauth2.dto; |
||||
|
||||
import lombok.Data; |
||||
import lombok.experimental.Accessors; |
||||
|
||||
import java.io.Serializable; |
||||
import java.time.LocalDateTime; |
||||
|
||||
/** |
||||
* OAuth2.0 访问令牌的信息 Response DTO |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Data |
||||
@Accessors(chain = true) |
||||
public class OAuth2AccessTokenRespDTO implements Serializable { |
||||
|
||||
/** |
||||
* 访问令牌 |
||||
*/ |
||||
private String accessToken; |
||||
/** |
||||
* 刷新令牌 |
||||
*/ |
||||
private String refreshToken; |
||||
/** |
||||
* 用户编号 |
||||
*/ |
||||
private Long userId; |
||||
/** |
||||
* 用户类型 |
||||
*/ |
||||
private Integer userType; |
||||
/** |
||||
* 过期时间 |
||||
*/ |
||||
private LocalDateTime expiresTime; |
||||
|
||||
} |
||||
@ -0,0 +1,4 @@ |
||||
/** |
||||
* 针对 system 模块的 api 包 |
||||
*/ |
||||
package com.soochowlife.web.framework.common.biz.system; |
||||
@ -0,0 +1,38 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.permission; |
||||
|
||||
import com.soochowlife.web.framework.common.biz.system.permission.dto.DeptDataPermissionRespDTO; |
||||
|
||||
/** |
||||
* 权限 API 接口 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface PermissionCommonApi { |
||||
|
||||
/** |
||||
* 判断是否有权限，任一一个即可 |
||||
* |
||||
* @param userId 用户编号 |
||||
* @param permissions 权限 |
||||
* @return 是否 |
||||
*/ |
||||
boolean hasAnyPermissions(Long userId, String... permissions); |
||||
|
||||
/** |
||||
* 判断是否有角色，任一一个即可 |
||||
* |
||||
* @param userId 用户编号 |
||||
* @param roles 角色数组 |
||||
* @return 是否 |
||||
*/ |
||||
boolean hasAnyRoles(Long userId, String... roles); |
||||
|
||||
/** |
||||
* 获得登陆用户的部门数据权限 |
||||
* |
||||
* @param userId 用户编号 |
||||
* @return 部门数据权限 |
||||
*/ |
||||
DeptDataPermissionRespDTO getDeptDataPermission(Long userId); |
||||
|
||||
} |
||||
@ -0,0 +1,35 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.permission.dto; |
||||
|
||||
import lombok.Data; |
||||
|
||||
import java.util.HashSet; |
||||
import java.util.Set; |
||||
|
||||
/** |
||||
* 部门的数据权限 Response DTO |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Data |
||||
public class DeptDataPermissionRespDTO { |
||||
|
||||
/** |
||||
* 是否可查看全部数据 |
||||
*/ |
||||
private Boolean all; |
||||
/** |
||||
* 是否可查看自己的数据 |
||||
*/ |
||||
private Boolean self; |
||||
/** |
||||
* 可查看的部门编号数组 |
||||
*/ |
||||
private Set<Long> deptIds; |
||||
|
||||
public DeptDataPermissionRespDTO() { |
||||
this.all = false; |
||||
this.self = false; |
||||
this.deptIds = new HashSet<>(); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,26 @@ |
||||
package com.soochowlife.web.framework.common.biz.system.tenant; |
||||
|
||||
import java.util.List; |
||||
|
||||
/** |
||||
* 多租户的 API 接口 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface TenantCommonApi { |
||||
|
||||
/** |
||||
* 获得所有租户 |
||||
* |
||||
* @return 租户编号数组 |
||||
*/ |
||||
List<Long> getTenantIdList(); |
||||
|
||||
/** |
||||
* 校验租户是否合法 |
||||
* |
||||
* @param id 租户编号 |
||||
*/ |
||||
void validateTenant(Long id); |
||||
|
||||
} |
||||
@ -0,0 +1,15 @@ |
||||
package com.soochowlife.web.framework.common.core; |
||||
|
||||
/** |
||||
* 可生成 T 数组的接口 |
||||
* |
||||
* @author HUIHUI |
||||
*/ |
||||
public interface ArrayValuable<T> { |
||||
|
||||
/** |
||||
* @return 数组 |
||||
*/ |
||||
T[] array(); |
||||
|
||||
} |
||||
@ -0,0 +1,22 @@ |
||||
package com.soochowlife.web.framework.common.core; |
||||
|
||||
import lombok.AllArgsConstructor; |
||||
import lombok.Data; |
||||
import lombok.NoArgsConstructor; |
||||
|
||||
import java.io.Serializable; |
||||
|
||||
/** |
||||
* Key Value 的键值对 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Data |
||||
@NoArgsConstructor |
||||
@AllArgsConstructor |
||||
public class KeyValue<K, V> implements Serializable { |
||||
|
||||
private K key; |
||||
private V value; |
||||
|
||||
} |
||||
@ -0,0 +1,46 @@ |
||||
package com.soochowlife.web.framework.common.enums; |
||||
|
||||
import cn.hutool.core.util.ObjUtil; |
||||
import com.soochowlife.web.framework.common.core.ArrayValuable; |
||||
import lombok.AllArgsConstructor; |
||||
import lombok.Getter; |
||||
|
||||
import java.util.Arrays; |
||||
|
||||
/** |
||||
* 通用状态枚举 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Getter |
||||
@AllArgsConstructor |
||||
public enum CommonStatusEnum implements ArrayValuable<Integer> { |
||||
|
||||
ENABLE(0, "开启"), |
||||
DISABLE(1, "关闭"); |
||||
|
||||
public static final Integer[] ARRAYS = Arrays.stream(values()).map(CommonStatusEnum::getStatus).toArray(Integer[]::new); |
||||
|
||||
/** |
||||
* 状态值 |
||||
*/ |
||||
private final Integer status; |
||||
/** |
||||
* 状态名 |
||||
*/ |
||||
private final String name; |
||||
|
||||
@Override |
||||
public Integer[] array() { |
||||
return ARRAYS; |
||||
} |
||||
|
||||
public static boolean isEnable(Integer status) { |
||||
return ObjUtil.equal(ENABLE.status, status); |
||||
} |
||||
|
||||
public static boolean isDisable(Integer status) { |
||||
return ObjUtil.equal(DISABLE.status, status); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,46 @@ |
||||
package com.soochowlife.web.framework.common.enums; |
||||
|
||||
import cn.hutool.core.util.ArrayUtil; |
||||
import com.soochowlife.web.framework.common.core.ArrayValuable; |
||||
import lombok.AllArgsConstructor; |
||||
import lombok.Getter; |
||||
|
||||
import java.util.Arrays; |
||||
|
||||
/** |
||||
* 时间间隔的枚举 |
||||
* |
||||
* @author dhb52 |
||||
*/ |
||||
@Getter |
||||
@AllArgsConstructor |
||||
public enum DateIntervalEnum implements ArrayValuable<Integer> { |
||||
|
||||
DAY(1, "天"), |
||||
WEEK(2, "周"), |
||||
MONTH(3, "月"), |
||||
QUARTER(4, "季度"), |
||||
YEAR(5, "年") |
||||
; |
||||
|
||||
public static final Integer[] ARRAYS = Arrays.stream(values()).map(DateIntervalEnum::getInterval).toArray(Integer[]::new); |
||||
|
||||
/** |
||||
* 类型 |
||||
*/ |
||||
private final Integer interval; |
||||
/** |
||||
* 名称 |
||||
*/ |
||||
private final String name; |
||||
|
||||
@Override |
||||
public Integer[] array() { |
||||
return ARRAYS; |
||||
} |
||||
|
||||
public static DateIntervalEnum valueOf(Integer interval) { |
||||
return ArrayUtil.firstMatch(item -> item.getInterval().equals(interval), DateIntervalEnum.values()); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,21 @@ |
||||
package com.soochowlife.web.framework.common.enums; |
||||
|
||||
import lombok.AllArgsConstructor; |
||||
import lombok.Getter; |
||||
|
||||
/** |
||||
* 文档地址 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Getter |
||||
@AllArgsConstructor |
||||
public enum DocumentEnum { |
||||
|
||||
REDIS_INSTALL("https://gitee.com/zhijiantianya/ruoyi-vue-pro/issues/I4VCSJ", "Redis 安装文档"), |
||||
TENANT("https://doc.iocoder.cn", "SaaS 多租户文档"); |
||||
|
||||
private final String url; |
||||
private final String memo; |
||||
|
||||
} |
||||
@ -0,0 +1,32 @@ |
||||
package com.soochowlife.web.framework.common.enums; |
||||
|
||||
/** |
||||
* 返回编码集 |
||||
* |
||||
*/ |
||||
public enum ResultEnums { |
||||
|
||||
SUCCESS("0000", "请求成功"), |
||||
ERROR("1111", "请求失败"), |
||||
SYSTEM_ERROR("1000", "系统异常"), |
||||
BUSSINESS_ERROR("2001", "业务逻辑错误"), |
||||
PARAM_ERROR("2002", "业务参数错误"), |
||||
CONSUMPOTION_ERROR("3001","消息消费失败"), |
||||
CONSUMPOTION_SUCCESS("3002","消费消息成功"); |
||||
|
||||
private String code; |
||||
private String msg; |
||||
|
||||
ResultEnums(String code, String msg) { |
||||
this.code = code; |
||||
this.msg = msg; |
||||
} |
||||
|
||||
public String getCode() { |
||||
return code; |
||||
} |
||||
|
||||
public String getMsg() { |
||||
return msg; |
||||
} |
||||
} |
||||
@ -0,0 +1,17 @@ |
||||
package com.soochowlife.web.framework.common.enums; |
||||
|
||||
/** |
||||
* RPC 相关的枚举 |
||||
* |
||||
* 虽然放在 soochowlife-spring-boot-starter-rpc 会相对合适，但是每个 API 模块需要使用到，所以暂时只好放在此处 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class RpcConstants { |
||||
|
||||
/** |
||||
* RPC API 的前缀 |
||||
*/ |
||||
public static final String RPC_API_PREFIX = "/rpc-api"; |
||||
|
||||
} |
||||
@ -0,0 +1,40 @@ |
||||
package com.soochowlife.web.framework.common.enums; |
||||
|
||||
import com.soochowlife.web.framework.common.core.ArrayValuable; |
||||
import lombok.Getter; |
||||
import lombok.RequiredArgsConstructor; |
||||
|
||||
import java.util.Arrays; |
||||
|
||||
/** |
||||
* 终端的枚举 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@RequiredArgsConstructor |
||||
@Getter |
||||
public enum TerminalEnum implements ArrayValuable<Integer> { |
||||
|
||||
UNKNOWN(0, "未知"), // 目的：在无法解析到 terminal 时，使用它
|
||||
WECHAT_MINI_PROGRAM(10, "微信小程序"), |
||||
WECHAT_WAP(11, "微信公众号"), |
||||
H5(20, "H5 网页"), |
||||
APP(31, "手机 App"), |
||||
; |
||||
|
||||
public static final Integer[] ARRAYS = Arrays.stream(values()).map(TerminalEnum::getTerminal).toArray(Integer[]::new); |
||||
|
||||
/** |
||||
* 终端 |
||||
*/ |
||||
private final Integer terminal; |
||||
/** |
||||
* 终端名 |
||||
*/ |
||||
private final String name; |
||||
|
||||
@Override |
||||
public Integer[] array() { |
||||
return ARRAYS; |
||||
} |
||||
} |
||||
@ -0,0 +1,39 @@ |
||||
package com.soochowlife.web.framework.common.enums; |
||||
|
||||
import cn.hutool.core.util.ArrayUtil; |
||||
import com.soochowlife.web.framework.common.core.ArrayValuable; |
||||
import lombok.AllArgsConstructor; |
||||
import lombok.Getter; |
||||
|
||||
import java.util.Arrays; |
||||
|
||||
/** |
||||
* 全局用户类型枚举 |
||||
*/ |
||||
@AllArgsConstructor |
||||
@Getter |
||||
public enum UserTypeEnum implements ArrayValuable<Integer> { |
||||
|
||||
MEMBER(1, "会员"), // 面向 c 端，普通用户
|
||||
ADMIN(2, "管理员"); // 面向 b 端，管理后台
|
||||
|
||||
public static final Integer[] ARRAYS = Arrays.stream(values()).map(UserTypeEnum::getValue).toArray(Integer[]::new); |
||||
|
||||
/** |
||||
* 类型 |
||||
*/ |
||||
private final Integer value; |
||||
/** |
||||
* 类型名 |
||||
*/ |
||||
private final String name; |
||||
|
||||
public static UserTypeEnum valueOf(Integer value) { |
||||
return ArrayUtil.firstMatch(userType -> userType.getValue().equals(value), UserTypeEnum.values()); |
||||
} |
||||
|
||||
@Override |
||||
public Integer[] array() { |
||||
return ARRAYS; |
||||
} |
||||
} |
||||
@ -0,0 +1,34 @@ |
||||
package com.soochowlife.web.framework.common.enums; |
||||
|
||||
/** |
||||
* Web 过滤器顺序的枚举类，保证过滤器按照符合我们的预期 |
||||
* |
||||
* 考虑到每个 starter 都需要用到该工具类，所以放到 common 模块下的 enums 包下 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface WebFilterOrderEnum { |
||||
|
||||
int CORS_FILTER = Integer.MIN_VALUE; |
||||
|
||||
int TRACE_FILTER = CORS_FILTER + 1; |
||||
|
||||
int REQUEST_BODY_CACHE_FILTER = Integer.MIN_VALUE + 500; |
||||
|
||||
// OrderedRequestContextFilter 默认为 -105，用于国际化上下文等等
|
||||
|
||||
int TENANT_CONTEXT_FILTER = - 104; // 需要保证在 ApiAccessLogFilter 前面
|
||||
|
||||
int API_ACCESS_LOG_FILTER = -103; // 需要保证在 RequestBodyCacheFilter 后面
|
||||
|
||||
int XSS_FILTER = -102; // 需要保证在 RequestBodyCacheFilter 后面
|
||||
|
||||
// Spring Security Filter 默认为 -100，可见 org.springframework.boot.autoconfigure.security.SecurityProperties 配置属性类
|
||||
|
||||
int TENANT_SECURITY_FILTER = -99; // 需要保证在 Spring Security 过滤器后面
|
||||
|
||||
int FLOWABLE_FILTER = -98; // 需要保证在 Spring Security 过滤后面
|
||||
|
||||
int DEMO_FILTER = Integer.MAX_VALUE; |
||||
|
||||
} |
||||
@ -0,0 +1,32 @@ |
||||
package com.soochowlife.web.framework.common.exception; |
||||
|
||||
import com.soochowlife.web.framework.common.exception.enums.GlobalErrorCodeConstants; |
||||
import com.soochowlife.web.framework.common.exception.enums.ServiceErrorCodeRange; |
||||
import lombok.Data; |
||||
|
||||
/** |
||||
* 错误码对象 |
||||
* |
||||
* 全局错误码，占用 [0, 999], 参见 {@link GlobalErrorCodeConstants} |
||||
* 业务异常错误码，占用 [1 000 000 000, +∞)，参见 {@link ServiceErrorCodeRange} |
||||
* |
||||
* TODO 错误码设计成对象的原因，为未来的 i18 国际化做准备 |
||||
*/ |
||||
@Data |
||||
public class ErrorCode { |
||||
|
||||
/** |
||||
* 错误码 |
||||
*/ |
||||
private final Integer code; |
||||
/** |
||||
* 错误提示 |
||||
*/ |
||||
private final String msg; |
||||
|
||||
public ErrorCode(Integer code, String message) { |
||||
this.code = code; |
||||
this.msg = message; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,60 @@ |
||||
package com.soochowlife.web.framework.common.exception; |
||||
|
||||
import com.soochowlife.web.framework.common.exception.enums.GlobalErrorCodeConstants; |
||||
import lombok.Data; |
||||
import lombok.EqualsAndHashCode; |
||||
|
||||
/** |
||||
* 服务器异常 Exception |
||||
*/ |
||||
@Data |
||||
@EqualsAndHashCode(callSuper = true) |
||||
public final class ServerException extends RuntimeException { |
||||
|
||||
/** |
||||
* 全局错误码 |
||||
* |
||||
* @see GlobalErrorCodeConstants |
||||
*/ |
||||
private Integer code; |
||||
/** |
||||
* 错误提示 |
||||
*/ |
||||
private String message; |
||||
|
||||
/** |
||||
* 空构造方法，避免反序列化问题 |
||||
*/ |
||||
public ServerException() { |
||||
} |
||||
|
||||
public ServerException(ErrorCode errorCode) { |
||||
this.code = errorCode.getCode(); |
||||
this.message = errorCode.getMsg(); |
||||
} |
||||
|
||||
public ServerException(Integer code, String message) { |
||||
this.code = code; |
||||
this.message = message; |
||||
} |
||||
|
||||
public Integer getCode() { |
||||
return code; |
||||
} |
||||
|
||||
public ServerException setCode(Integer code) { |
||||
this.code = code; |
||||
return this; |
||||
} |
||||
|
||||
@Override |
||||
public String getMessage() { |
||||
return message; |
||||
} |
||||
|
||||
public ServerException setMessage(String message) { |
||||
this.message = message; |
||||
return this; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,60 @@ |
||||
package com.soochowlife.web.framework.common.exception; |
||||
|
||||
import com.soochowlife.web.framework.common.exception.enums.ServiceErrorCodeRange; |
||||
import lombok.Data; |
||||
import lombok.EqualsAndHashCode; |
||||
|
||||
/** |
||||
* 业务逻辑异常 Exception |
||||
*/ |
||||
@Data |
||||
@EqualsAndHashCode(callSuper = true) |
||||
public final class ServiceException extends RuntimeException { |
||||
|
||||
/** |
||||
* 业务错误码 |
||||
* |
||||
* @see ServiceErrorCodeRange |
||||
*/ |
||||
private Integer code; |
||||
/** |
||||
* 错误提示 |
||||
*/ |
||||
private String message; |
||||
|
||||
/** |
||||
* 空构造方法，避免反序列化问题 |
||||
*/ |
||||
public ServiceException() { |
||||
} |
||||
|
||||
public ServiceException(ErrorCode errorCode) { |
||||
this.code = errorCode.getCode(); |
||||
this.message = errorCode.getMsg(); |
||||
} |
||||
|
||||
public ServiceException(Integer code, String message) { |
||||
this.code = code; |
||||
this.message = message; |
||||
} |
||||
|
||||
public Integer getCode() { |
||||
return code; |
||||
} |
||||
|
||||
public ServiceException setCode(Integer code) { |
||||
this.code = code; |
||||
return this; |
||||
} |
||||
|
||||
@Override |
||||
public String getMessage() { |
||||
return message; |
||||
} |
||||
|
||||
public ServiceException setMessage(String message) { |
||||
this.message = message; |
||||
return this; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,41 @@ |
||||
package com.soochowlife.web.framework.common.exception.enums; |
||||
|
||||
import com.soochowlife.web.framework.common.exception.ErrorCode; |
||||
|
||||
/** |
||||
* 全局错误码枚举 |
||||
* 0-999 系统异常编码保留 |
||||
* |
||||
* 一般情况下，使用 HTTP 响应状态码 https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Status
|
||||
* 虽然说，HTTP 响应状态码作为业务使用表达能力偏弱，但是使用在系统层面还是非常不错的 |
||||
* 比较特殊的是，因为之前一直使用 0 作为成功，就不使用 200 啦。 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface GlobalErrorCodeConstants { |
||||
|
||||
ErrorCode SUCCESS = new ErrorCode(0, "成功"); |
||||
|
||||
// ========== 客户端错误段 ==========
|
||||
|
||||
ErrorCode BAD_REQUEST = new ErrorCode(400, "请求参数不正确"); |
||||
ErrorCode UNAUTHORIZED = new ErrorCode(401, "账号未登录"); |
||||
ErrorCode FORBIDDEN = new ErrorCode(403, "没有该操作权限"); |
||||
ErrorCode NOT_FOUND = new ErrorCode(404, "请求未找到"); |
||||
ErrorCode METHOD_NOT_ALLOWED = new ErrorCode(405, "请求方法不正确"); |
||||
ErrorCode LOCKED = new ErrorCode(423, "请求失败，请稍后重试"); // 并发请求，不允许
|
||||
ErrorCode TOO_MANY_REQUESTS = new ErrorCode(429, "请求过于频繁，请稍后重试"); |
||||
|
||||
// ========== 服务端错误段 ==========
|
||||
|
||||
ErrorCode INTERNAL_SERVER_ERROR = new ErrorCode(500, "系统异常"); |
||||
ErrorCode NOT_IMPLEMENTED = new ErrorCode(501, "功能未实现/未开启"); |
||||
ErrorCode ERROR_CONFIGURATION = new ErrorCode(502, "错误的配置项"); |
||||
|
||||
// ========== 自定义错误段 ==========
|
||||
ErrorCode REPEATED_REQUESTS = new ErrorCode(900, "重复请求，请稍后重试"); // 重复请求
|
||||
ErrorCode DEMO_DENY = new ErrorCode(901, "演示模式，禁止写操作"); |
||||
|
||||
ErrorCode UNKNOWN = new ErrorCode(999, "未知错误"); |
||||
|
||||
} |
||||
@ -0,0 +1,48 @@ |
||||
package com.soochowlife.web.framework.common.exception.enums; |
||||
|
||||
/** |
||||
* 业务异常的错误码区间，解决：解决各模块错误码定义，避免重复，在此只声明不做实际使用 |
||||
* |
||||
* 一共 10 位，分成四段 |
||||
* |
||||
* 第一段，1 位，类型 |
||||
* 1 - 业务级别异常 |
||||
* x - 预留 |
||||
* 第二段，3 位，系统类型 |
||||
* 001 - 用户系统 |
||||
* 002 - 商品系统 |
||||
* 003 - 订单系统 |
||||
* 004 - 支付系统 |
||||
* 005 - 优惠劵系统 |
||||
* ... - ... |
||||
* 第三段，3 位，模块 |
||||
* 不限制规则。 |
||||
* 一般建议，每个系统里面，可能有多个模块，可以再去做分段。以用户系统为例子： |
||||
* 001 - OAuth2 模块 |
||||
* 002 - User 模块 |
||||
* 003 - MobileCode 模块 |
||||
* 第四段，3 位，错误码 |
||||
* 不限制规则。 |
||||
* 一般建议，每个模块自增。 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class ServiceErrorCodeRange { |
||||
|
||||
// 模块 infra 错误码区间 [1-001-000-000 ~ 1-002-000-000)
|
||||
// 模块 system 错误码区间 [1-002-000-000 ~ 1-003-000-000)
|
||||
// 模块 report 错误码区间 [1-003-000-000 ~ 1-004-000-000)
|
||||
// 模块 member 错误码区间 [1-004-000-000 ~ 1-005-000-000)
|
||||
// 模块 mp 错误码区间 [1-006-000-000 ~ 1-007-000-000)
|
||||
// 模块 pay 错误码区间 [1-007-000-000 ~ 1-008-000-000)
|
||||
// 模块 bpm 错误码区间 [1-009-000-000 ~ 1-010-000-000)
|
||||
|
||||
// 模块 product 错误码区间 [1-008-000-000 ~ 1-009-000-000)
|
||||
// 模块 trade 错误码区间 [1-011-000-000 ~ 1-012-000-000)
|
||||
// 模块 promotion 错误码区间 [1-013-000-000 ~ 1-014-000-000)
|
||||
|
||||
// 模块 crm 错误码区间 [1-020-000-000 ~ 1-021-000-000)
|
||||
|
||||
// 模块 ai 错误码区间 [1-022-000-000 ~ 1-023-000-000)
|
||||
|
||||
} |
||||
@ -0,0 +1,77 @@ |
||||
package com.soochowlife.web.framework.common.exception.util; |
||||
|
||||
import com.soochowlife.web.framework.common.exception.ErrorCode; |
||||
import com.soochowlife.web.framework.common.exception.ServiceException; |
||||
import com.soochowlife.web.framework.common.exception.enums.GlobalErrorCodeConstants; |
||||
import com.google.common.annotations.VisibleForTesting; |
||||
import lombok.extern.slf4j.Slf4j; |
||||
|
||||
/** |
||||
* {@link ServiceException} 工具类 |
||||
* |
||||
* 目的在于，格式化异常信息提示。 |
||||
* 考虑到 String.format 在参数不正确时会报错，因此使用 {} 作为占位符，并使用 {@link #doFormat(int, String, Object...)} 方法来格式化 |
||||
* |
||||
*/ |
||||
@Slf4j |
||||
public class ServiceExceptionUtil { |
||||
|
||||
// ========== 和 ServiceException 的集成 ==========
|
||||
|
||||
public static ServiceException exception(ErrorCode errorCode) { |
||||
return exception0(errorCode.getCode(), errorCode.getMsg()); |
||||
} |
||||
|
||||
public static ServiceException exception(ErrorCode errorCode, Object... params) { |
||||
return exception0(errorCode.getCode(), errorCode.getMsg(), params); |
||||
} |
||||
|
||||
public static ServiceException exception0(Integer code, String messagePattern, Object... params) { |
||||
String message = doFormat(code, messagePattern, params); |
||||
return new ServiceException(code, message); |
||||
} |
||||
|
||||
public static ServiceException invalidParamException(String messagePattern, Object... params) { |
||||
return exception0(GlobalErrorCodeConstants.BAD_REQUEST.getCode(), messagePattern, params); |
||||
} |
||||
|
||||
// ========== 格式化方法 ==========
|
||||
|
||||
/** |
||||
* 将错误编号对应的消息使用 params 进行格式化。 |
||||
* |
||||
* @param code 错误编号 |
||||
* @param messagePattern 消息模版 |
||||
* @param params 参数 |
||||
* @return 格式化后的提示 |
||||
*/ |
||||
@VisibleForTesting |
||||
public static String doFormat(int code, String messagePattern, Object... params) { |
||||
StringBuilder sbuf = new StringBuilder(messagePattern.length() + 50); |
||||
int i = 0; |
||||
int j; |
||||
int l; |
||||
for (l = 0; l < params.length; l++) { |
||||
j = messagePattern.indexOf("{}", i); |
||||
if (j == -1) { |
||||
log.error("[doFormat][参数过多：错误码({})|错误内容({})|参数({})", code, messagePattern, params); |
||||
if (i == 0) { |
||||
return messagePattern; |
||||
} else { |
||||
sbuf.append(messagePattern.substring(i)); |
||||
return sbuf.toString(); |
||||
} |
||||
} else { |
||||
sbuf.append(messagePattern, i, j); |
||||
sbuf.append(params[l]); |
||||
i = j + 2; |
||||
} |
||||
} |
||||
if (messagePattern.indexOf("{}", i) != -1) { |
||||
log.error("[doFormat][参数过少：错误码({})|错误内容({})|参数({})", code, messagePattern, params); |
||||
} |
||||
sbuf.append(messagePattern.substring(i)); |
||||
return sbuf.toString(); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,6 @@ |
||||
/** |
||||
* 基础的通用类，和框架无关 |
||||
* |
||||
* 例如说，CommonResult 为通用返回 |
||||
*/ |
||||
package com.soochowlife.web.framework.common; |
||||
@ -0,0 +1,121 @@ |
||||
package com.soochowlife.web.framework.common.pojo; |
||||
|
||||
import cn.hutool.core.lang.Assert; |
||||
import com.soochowlife.web.framework.common.exception.ErrorCode; |
||||
import com.soochowlife.web.framework.common.exception.ServiceException; |
||||
import com.soochowlife.web.framework.common.exception.enums.GlobalErrorCodeConstants; |
||||
import com.soochowlife.web.framework.common.exception.util.ServiceExceptionUtil; |
||||
import com.fasterxml.jackson.annotation.JsonIgnore; |
||||
import lombok.Data; |
||||
|
||||
import java.io.Serializable; |
||||
import java.util.Objects; |
||||
|
||||
/** |
||||
* 通用返回 |
||||
* |
||||
* @param <T> 数据泛型 |
||||
*/ |
||||
@Data |
||||
public class CommonResult<T> implements Serializable { |
||||
|
||||
/** |
||||
* 错误码 |
||||
* |
||||
* @see ErrorCode#getCode() |
||||
*/ |
||||
private Integer code; |
||||
/** |
||||
* 返回数据 |
||||
*/ |
||||
private T data; |
||||
/** |
||||
* 错误提示，用户可阅读 |
||||
* |
||||
* @see ErrorCode#getMsg() () |
||||
*/ |
||||
private String msg; |
||||
|
||||
/** |
||||
* 将传入的 result 对象，转换成另外一个泛型结果的对象 |
||||
* |
||||
* 因为 A 方法返回的 CommonResult 对象，不满足调用其的 B 方法的返回，所以需要进行转换。 |
||||
* |
||||
* @param result 传入的 result 对象 |
||||
* @param <T> 返回的泛型 |
||||
* @return 新的 CommonResult 对象 |
||||
*/ |
||||
public static <T> CommonResult<T> error(CommonResult<?> result) { |
||||
return error(result.getCode(), result.getMsg()); |
||||
} |
||||
|
||||
public static <T> CommonResult<T> error(Integer code, String message) { |
||||
Assert.notEquals(GlobalErrorCodeConstants.SUCCESS.getCode(), code, "code 必须是错误的！"); |
||||
CommonResult<T> result = new CommonResult<>(); |
||||
result.code = code; |
||||
result.msg = message; |
||||
return result; |
||||
} |
||||
|
||||
public static <T> CommonResult<T> error(ErrorCode errorCode, Object... params) { |
||||
Assert.notEquals(GlobalErrorCodeConstants.SUCCESS.getCode(), errorCode.getCode(), "code 必须是错误的！"); |
||||
CommonResult<T> result = new CommonResult<>(); |
||||
result.code = errorCode.getCode(); |
||||
result.msg = ServiceExceptionUtil.doFormat(errorCode.getCode(), errorCode.getMsg(), params); |
||||
return result; |
||||
} |
||||
|
||||
public static <T> CommonResult<T> error(ErrorCode errorCode) { |
||||
return error(errorCode.getCode(), errorCode.getMsg()); |
||||
} |
||||
|
||||
public static <T> CommonResult<T> success(T data) { |
||||
CommonResult<T> result = new CommonResult<>(); |
||||
result.code = GlobalErrorCodeConstants.SUCCESS.getCode(); |
||||
result.data = data; |
||||
result.msg = ""; |
||||
return result; |
||||
} |
||||
|
||||
public static boolean isSuccess(Integer code) { |
||||
return Objects.equals(code, GlobalErrorCodeConstants.SUCCESS.getCode()); |
||||
} |
||||
|
||||
@JsonIgnore // 避免 jackson 序列化
|
||||
public boolean isSuccess() { |
||||
return isSuccess(code); |
||||
} |
||||
|
||||
@JsonIgnore // 避免 jackson 序列化
|
||||
public boolean isError() { |
||||
return !isSuccess(); |
||||
} |
||||
|
||||
// ========= 和 Exception 异常体系集成 =========
|
||||
|
||||
/** |
||||
* 判断是否有异常。如果有，则抛出 {@link ServiceException} 异常 |
||||
*/ |
||||
public void checkError() throws ServiceException { |
||||
if (isSuccess()) { |
||||
return; |
||||
} |
||||
// 业务异常
|
||||
throw new ServiceException(code, msg); |
||||
} |
||||
|
||||
/** |
||||
* 判断是否有异常。如果有，则抛出 {@link ServiceException} 异常 |
||||
* 如果没有，则返回 {@link #data} 数据 |
||||
*/ |
||||
@JsonIgnore // 避免 jackson 序列化
|
||||
public T getCheckedData() { |
||||
checkError(); |
||||
return data; |
||||
} |
||||
|
||||
public static <T> CommonResult<T> error(ServiceException serviceException) { |
||||
return error(serviceException.getCode(), serviceException.getMessage()); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,36 @@ |
||||
package com.soochowlife.web.framework.common.pojo; |
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema; |
||||
import lombok.Data; |
||||
|
||||
import jakarta.validation.constraints.Min; |
||||
import jakarta.validation.constraints.Max; |
||||
import jakarta.validation.constraints.NotNull; |
||||
import java.io.Serializable; |
||||
|
||||
@Schema(description="分页参数") |
||||
@Data |
||||
public class PageParam implements Serializable { |
||||
|
||||
private static final Integer PAGE_NO = 1; |
||||
private static final Integer PAGE_SIZE = 10; |
||||
|
||||
/** |
||||
* 每页条数 - 不分页 |
||||
* |
||||
* 例如说，导出接口，可以设置 {@link #pageSize} 为 -1 不分页，查询所有数据。 |
||||
*/ |
||||
public static final Integer PAGE_SIZE_NONE = -1; |
||||
|
||||
@Schema(description = "页码，从 1 开始", requiredMode = Schema.RequiredMode.REQUIRED,example = "1") |
||||
@NotNull(message = "页码不能为空") |
||||
@Min(value = 1, message = "页码最小值为 1") |
||||
private Integer pageNo = PAGE_NO; |
||||
|
||||
@Schema(description = "每页条数，最大值为 100", requiredMode = Schema.RequiredMode.REQUIRED, example = "10") |
||||
@NotNull(message = "每页条数不能为空") |
||||
@Min(value = 1, message = "每页条数最小值为 1") |
||||
@Max(value = 100, message = "每页条数最大值为 100") |
||||
private Integer pageSize = PAGE_SIZE; |
||||
|
||||
} |
||||
@ -0,0 +1,41 @@ |
||||
package com.soochowlife.web.framework.common.pojo; |
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema; |
||||
import lombok.Data; |
||||
|
||||
import java.io.Serializable; |
||||
import java.util.ArrayList; |
||||
import java.util.List; |
||||
|
||||
@Schema(description = "分页结果") |
||||
@Data |
||||
public final class PageResult<T> implements Serializable { |
||||
|
||||
@Schema(description = "数据", requiredMode = Schema.RequiredMode.REQUIRED) |
||||
private List<T> list; |
||||
|
||||
@Schema(description = "总量", requiredMode = Schema.RequiredMode.REQUIRED) |
||||
private Long total; |
||||
|
||||
public PageResult() { |
||||
} |
||||
|
||||
public PageResult(List<T> list, Long total) { |
||||
this.list = list; |
||||
this.total = total; |
||||
} |
||||
|
||||
public PageResult(Long total) { |
||||
this.list = new ArrayList<>(); |
||||
this.total = total; |
||||
} |
||||
|
||||
public static <T> PageResult<T> empty() { |
||||
return new PageResult<>(0L); |
||||
} |
||||
|
||||
public static <T> PageResult<T> empty(Long total) { |
||||
return new PageResult<>(total); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,35 @@ |
||||
package com.soochowlife.web.framework.common.pojo; |
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema; |
||||
import lombok.Data; |
||||
|
||||
import java.io.Serializable; |
||||
import java.util.List; |
||||
|
||||
@Schema(description = "分页结果") |
||||
@Data |
||||
public final class ResultPage<T> implements Serializable { |
||||
|
||||
@Schema(description = "数据", requiredMode = Schema.RequiredMode.REQUIRED) |
||||
private List<T> list; |
||||
|
||||
@Schema(description = "总量", requiredMode = Schema.RequiredMode.REQUIRED) |
||||
private Long total; |
||||
|
||||
|
||||
|
||||
public static <T> ResultPage<T> successPage(List<T> data) { |
||||
ResultPage<T> rspData = new ResultPage<>(); |
||||
//rspData.setTotal(new PageInfo<>(data).getTotal());
|
||||
rspData.setList(data); |
||||
return rspData; |
||||
} |
||||
|
||||
public static <T> ResultPage<T> successPage(List<T> data,Long total) { |
||||
ResultPage<T> rspData = new ResultPage<>(); |
||||
rspData.setTotal(total); |
||||
rspData.setList(data); |
||||
return rspData; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,48 @@ |
||||
package com.soochowlife.web.framework.common.pojo; |
||||
|
||||
|
||||
import com.soochowlife.web.framework.common.enums.ResultEnums; |
||||
import lombok.AllArgsConstructor; |
||||
import lombok.Data; |
||||
import lombok.NoArgsConstructor; |
||||
|
||||
@Data |
||||
@AllArgsConstructor |
||||
@NoArgsConstructor |
||||
public class ResultVo<T> { |
||||
|
||||
private String code; // 状态码
|
||||
private String message; // 返回信息
|
||||
private T data; // 返回数据
|
||||
private Long total; // 返回数据总条数（可选）
|
||||
|
||||
// 成功时调用的方法 快速返回
|
||||
public static <T> ResultVo success() { |
||||
return new ResultVo<>(ResultEnums.SUCCESS.getCode(), "操作成功", ResultEnums.SUCCESS.getCode(), 0L); |
||||
} |
||||
|
||||
// 成功时调用的方法
|
||||
public static <T> ResultVo success(T data) { |
||||
return new ResultVo<>(ResultEnums.SUCCESS.getCode(), "操作成功", data, 0L); |
||||
} |
||||
|
||||
|
||||
|
||||
// 自定义状态码和信息的成功方法
|
||||
public static <T> ResultVo success(String code, String message, T data) { |
||||
return new ResultVo<>(code, message, data, 0L); |
||||
} |
||||
|
||||
|
||||
// 失败时调用的方法
|
||||
public static <T> ResultVo error(String message) { |
||||
return new ResultVo<>(ResultEnums.ERROR.getCode(), message, ResultEnums.ERROR.getCode(), 0L); |
||||
} |
||||
|
||||
// 失败时调用的方法
|
||||
public static <T> ResultVo error(String message, T data) { |
||||
return new ResultVo<>(ResultEnums.ERROR.getCode(), message, data, 0L); |
||||
} |
||||
|
||||
|
||||
} |
||||
@ -0,0 +1,19 @@ |
||||
package com.soochowlife.web.framework.common.pojo; |
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema; |
||||
import lombok.Data; |
||||
import lombok.EqualsAndHashCode; |
||||
import lombok.ToString; |
||||
|
||||
import java.util.List; |
||||
|
||||
@Schema(description = "可排序的分页参数") |
||||
@Data |
||||
@EqualsAndHashCode(callSuper = true) |
||||
@ToString(callSuper = true) |
||||
public class SortablePageParam extends PageParam { |
||||
|
||||
@Schema(description = "排序字段") |
||||
private List<SortingField> sortingFields; |
||||
|
||||
} |
||||
@ -0,0 +1,37 @@ |
||||
package com.soochowlife.web.framework.common.pojo; |
||||
|
||||
import lombok.AllArgsConstructor; |
||||
import lombok.Data; |
||||
import lombok.NoArgsConstructor; |
||||
|
||||
import java.io.Serializable; |
||||
|
||||
/** |
||||
* 排序字段 DTO |
||||
* |
||||
* 类名加了 ing 的原因是，避免和 ES SortField 重名。 |
||||
*/ |
||||
@Data |
||||
@NoArgsConstructor |
||||
@AllArgsConstructor |
||||
public class SortingField implements Serializable { |
||||
|
||||
/** |
||||
* 顺序 - 升序 |
||||
*/ |
||||
public static final String ORDER_ASC = "asc"; |
||||
/** |
||||
* 顺序 - 降序 |
||||
*/ |
||||
public static final String ORDER_DESC = "desc"; |
||||
|
||||
/** |
||||
* 字段 |
||||
*/ |
||||
private String field; |
||||
/** |
||||
* 顺序 |
||||
*/ |
||||
private String order; |
||||
|
||||
} |
||||
@ -0,0 +1,49 @@ |
||||
package com.soochowlife.web.framework.common.util.cache; |
||||
|
||||
import com.google.common.cache.CacheBuilder; |
||||
import com.google.common.cache.CacheLoader; |
||||
import com.google.common.cache.LoadingCache; |
||||
|
||||
import java.time.Duration; |
||||
import java.util.concurrent.Executors; |
||||
|
||||
/** |
||||
* Cache 工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class CacheUtils { |
||||
|
||||
/** |
||||
* 构建异步刷新的 LoadingCache 对象 |
||||
* |
||||
* 注意：如果你的缓存和 ThreadLocal 有关系，要么自己处理 ThreadLocal 的传递，要么使用 {@link #buildCache(Duration, CacheLoader)} 方法 |
||||
* |
||||
* 或者简单理解： |
||||
* 1、和“人”相关的，使用 {@link #buildCache(Duration, CacheLoader)} 方法 |
||||
* 2、和“全局”、“系统”相关的，使用当前缓存方法 |
||||
* |
||||
* @param duration 过期时间 |
||||
* @param loader CacheLoader 对象 |
||||
* @return LoadingCache 对象 |
||||
*/ |
||||
public static <K, V> LoadingCache<K, V> buildAsyncReloadingCache(Duration duration, CacheLoader<K, V> loader) { |
||||
return CacheBuilder.newBuilder() |
||||
// 只阻塞当前数据加载线程，其他线程返回旧值
|
||||
.refreshAfterWrite(duration) |
||||
// 通过 asyncReloading 实现全异步加载，包括 refreshAfterWrite 被阻塞的加载线程
|
||||
.build(CacheLoader.asyncReloading(loader, Executors.newCachedThreadPool())); // TODO Alex：可能要思考下，未来要不要做成可配置
|
||||
} |
||||
|
||||
/** |
||||
* 构建同步刷新的 LoadingCache 对象 |
||||
* |
||||
* @param duration 过期时间 |
||||
* @param loader CacheLoader 对象 |
||||
* @return LoadingCache 对象 |
||||
*/ |
||||
public static <K, V> LoadingCache<K, V> buildCache(Duration duration, CacheLoader<K, V> loader) { |
||||
return CacheBuilder.newBuilder().refreshAfterWrite(duration).build(loader); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,58 @@ |
||||
package com.soochowlife.web.framework.common.util.collection; |
||||
|
||||
import cn.hutool.core.collection.CollectionUtil; |
||||
import cn.hutool.core.collection.IterUtil; |
||||
import cn.hutool.core.util.ArrayUtil; |
||||
|
||||
import java.util.Collection; |
||||
import java.util.function.Consumer; |
||||
import java.util.function.Function; |
||||
|
||||
import static com.soochowlife.web.framework.common.util.collection.CollectionUtils.convertList; |
||||
|
||||
/** |
||||
* Array 工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class ArrayUtils { |
||||
|
||||
/** |
||||
* 将 object 和 newElements 合并成一个数组 |
||||
* |
||||
* @param object 对象 |
||||
* @param newElements 数组 |
||||
* @param <T> 泛型 |
||||
* @return 结果数组 |
||||
*/ |
||||
@SafeVarargs |
||||
public static <T> Consumer<T>[] append(Consumer<T> object, Consumer<T>... newElements) { |
||||
if (object == null) { |
||||
return newElements; |
||||
} |
||||
Consumer<T>[] result = ArrayUtil.newArray(Consumer.class, 1 + newElements.length); |
||||
result[0] = object; |
||||
System.arraycopy(newElements, 0, result, 1, newElements.length); |
||||
return result; |
||||
} |
||||
|
||||
public static <T, V> V[] toArray(Collection<T> from, Function<T, V> mapper) { |
||||
return toArray(convertList(from, mapper)); |
||||
} |
||||
|
||||
@SuppressWarnings("unchecked") |
||||
public static <T> T[] toArray(Collection<T> from) { |
||||
if (CollectionUtil.isEmpty(from)) { |
||||
return (T[]) (new Object[0]); |
||||
} |
||||
return ArrayUtil.toArray(from, (Class<T>) IterUtil.getElementType(from.iterator())); |
||||
} |
||||
|
||||
public static <T> T get(T[] array, int index) { |
||||
if (null == array || index >= array.length) { |
||||
return null; |
||||
} |
||||
return array[index]; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,352 @@ |
||||
package com.soochowlife.web.framework.common.util.collection; |
||||
|
||||
import cn.hutool.core.collection.CollUtil; |
||||
import cn.hutool.core.collection.CollectionUtil; |
||||
import cn.hutool.core.util.ArrayUtil; |
||||
import com.soochowlife.web.framework.common.pojo.PageResult; |
||||
import com.google.common.collect.ImmutableMap; |
||||
|
||||
import java.util.*; |
||||
import java.util.function.*; |
||||
import java.util.stream.Collectors; |
||||
import java.util.stream.Stream; |
||||
|
||||
import static cn.hutool.core.convert.Convert.toCollection; |
||||
import static java.util.Arrays.asList; |
||||
|
||||
/** |
||||
* Collection 工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class CollectionUtils { |
||||
|
||||
public static boolean containsAny(Object source, Object... targets) { |
||||
return asList(targets).contains(source); |
||||
} |
||||
|
||||
public static boolean isAnyEmpty(Collection<?>... collections) { |
||||
return Arrays.stream(collections).anyMatch(CollectionUtil::isEmpty); |
||||
} |
||||
|
||||
public static <T> boolean anyMatch(Collection<T> from, Predicate<T> predicate) { |
||||
return from.stream().anyMatch(predicate); |
||||
} |
||||
|
||||
public static <T> List<T> filterList(Collection<T> from, Predicate<T> predicate) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new ArrayList<>(); |
||||
} |
||||
return from.stream().filter(predicate).collect(Collectors.toList()); |
||||
} |
||||
|
||||
public static <T, R> List<T> distinct(Collection<T> from, Function<T, R> keyMapper) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new ArrayList<>(); |
||||
} |
||||
return distinct(from, keyMapper, (t1, t2) -> t1); |
||||
} |
||||
|
||||
public static <T, R> List<T> distinct(Collection<T> from, Function<T, R> keyMapper, BinaryOperator<T> cover) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new ArrayList<>(); |
||||
} |
||||
return new ArrayList<>(convertMap(from, keyMapper, Function.identity(), cover).values()); |
||||
} |
||||
|
||||
public static <T, U> List<U> convertList(T[] from, Function<T, U> func) { |
||||
if (ArrayUtil.isEmpty(from)) { |
||||
return new ArrayList<>(); |
||||
} |
||||
return convertList(Arrays.asList(from), func); |
||||
} |
||||
|
||||
public static <T, U> List<U> convertList(Collection<T> from, Function<T, U> func) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new ArrayList<>(); |
||||
} |
||||
return from.stream().map(func).filter(Objects::nonNull).collect(Collectors.toList()); |
||||
} |
||||
|
||||
public static <T, U> List<U> convertList(Collection<T> from, Function<T, U> func, Predicate<T> filter) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new ArrayList<>(); |
||||
} |
||||
return from.stream().filter(filter).map(func).filter(Objects::nonNull).collect(Collectors.toList()); |
||||
} |
||||
|
||||
public static <T, U> PageResult<U> convertPage(PageResult<T> from, Function<T, U> func) { |
||||
if (ArrayUtil.isEmpty(from)) { |
||||
return new PageResult<>(from.getTotal()); |
||||
} |
||||
return new PageResult<>(convertList(from.getList(), func), from.getTotal()); |
||||
} |
||||
|
||||
public static <T, U> List<U> convertListByFlatMap(Collection<T> from, |
||||
Function<T, ? extends Stream<? extends U>> func) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new ArrayList<>(); |
||||
} |
||||
return from.stream().filter(Objects::nonNull).flatMap(func).filter(Objects::nonNull).collect(Collectors.toList()); |
||||
} |
||||
|
||||
public static <T, U, R> List<R> convertListByFlatMap(Collection<T> from, |
||||
Function<? super T, ? extends U> mapper, |
||||
Function<U, ? extends Stream<? extends R>> func) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new ArrayList<>(); |
||||
} |
||||
return from.stream().map(mapper).filter(Objects::nonNull).flatMap(func).filter(Objects::nonNull).collect(Collectors.toList()); |
||||
} |
||||
|
||||
public static <K, V> List<V> mergeValuesFromMap(Map<K, List<V>> map) { |
||||
return map.values() |
||||
.stream() |
||||
.flatMap(List::stream) |
||||
.collect(Collectors.toList()); |
||||
} |
||||
|
||||
public static <T> Set<T> convertSet(Collection<T> from) { |
||||
return convertSet(from, v -> v); |
||||
} |
||||
|
||||
public static <T, U> Set<U> convertSet(Collection<T> from, Function<T, U> func) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashSet<>(); |
||||
} |
||||
return from.stream().map(func).filter(Objects::nonNull).collect(Collectors.toSet()); |
||||
} |
||||
|
||||
public static <T, U> Set<U> convertSet(Collection<T> from, Function<T, U> func, Predicate<T> filter) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashSet<>(); |
||||
} |
||||
return from.stream().filter(filter).map(func).filter(Objects::nonNull).collect(Collectors.toSet()); |
||||
} |
||||
|
||||
public static <T, K> Map<K, T> convertMapByFilter(Collection<T> from, Predicate<T> filter, Function<T, K> keyFunc) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashMap<>(); |
||||
} |
||||
return from.stream().filter(filter).collect(Collectors.toMap(keyFunc, v -> v)); |
||||
} |
||||
|
||||
public static <T, U> Set<U> convertSetByFlatMap(Collection<T> from, |
||||
Function<T, ? extends Stream<? extends U>> func) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashSet<>(); |
||||
} |
||||
return from.stream().filter(Objects::nonNull).flatMap(func).filter(Objects::nonNull).collect(Collectors.toSet()); |
||||
} |
||||
|
||||
public static <T, U, R> Set<R> convertSetByFlatMap(Collection<T> from, |
||||
Function<? super T, ? extends U> mapper, |
||||
Function<U, ? extends Stream<? extends R>> func) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashSet<>(); |
||||
} |
||||
return from.stream().map(mapper).filter(Objects::nonNull).flatMap(func).filter(Objects::nonNull).collect(Collectors.toSet()); |
||||
} |
||||
|
||||
public static <T, K> Map<K, T> convertMap(Collection<T> from, Function<T, K> keyFunc) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashMap<>(); |
||||
} |
||||
return convertMap(from, keyFunc, Function.identity()); |
||||
} |
||||
|
||||
public static <T, K> Map<K, T> convertMap(Collection<T> from, Function<T, K> keyFunc, Supplier<? extends Map<K, T>> supplier) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return supplier.get(); |
||||
} |
||||
return convertMap(from, keyFunc, Function.identity(), supplier); |
||||
} |
||||
|
||||
public static <T, K, V> Map<K, V> convertMap(Collection<T> from, Function<T, K> keyFunc, Function<T, V> valueFunc) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashMap<>(); |
||||
} |
||||
return convertMap(from, keyFunc, valueFunc, (v1, v2) -> v1); |
||||
} |
||||
|
||||
public static <T, K, V> Map<K, V> convertMap(Collection<T> from, Function<T, K> keyFunc, Function<T, V> valueFunc, BinaryOperator<V> mergeFunction) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashMap<>(); |
||||
} |
||||
return convertMap(from, keyFunc, valueFunc, mergeFunction, HashMap::new); |
||||
} |
||||
|
||||
public static <T, K, V> Map<K, V> convertMap(Collection<T> from, Function<T, K> keyFunc, Function<T, V> valueFunc, Supplier<? extends Map<K, V>> supplier) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return supplier.get(); |
||||
} |
||||
return convertMap(from, keyFunc, valueFunc, (v1, v2) -> v1, supplier); |
||||
} |
||||
|
||||
public static <T, K, V> Map<K, V> convertMap(Collection<T> from, Function<T, K> keyFunc, Function<T, V> valueFunc, BinaryOperator<V> mergeFunction, Supplier<? extends Map<K, V>> supplier) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashMap<>(); |
||||
} |
||||
return from.stream().collect(Collectors.toMap(keyFunc, valueFunc, mergeFunction, supplier)); |
||||
} |
||||
|
||||
public static <T, K> Map<K, List<T>> convertMultiMap(Collection<T> from, Function<T, K> keyFunc) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashMap<>(); |
||||
} |
||||
return from.stream().collect(Collectors.groupingBy(keyFunc, Collectors.mapping(t -> t, Collectors.toList()))); |
||||
} |
||||
|
||||
public static <T, K, V> Map<K, List<V>> convertMultiMap(Collection<T> from, Function<T, K> keyFunc, Function<T, V> valueFunc) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashMap<>(); |
||||
} |
||||
return from.stream() |
||||
.collect(Collectors.groupingBy(keyFunc, Collectors.mapping(valueFunc, Collectors.toList()))); |
||||
} |
||||
|
||||
// 暂时没想好名字，先以 2 结尾噶
|
||||
public static <T, K, V> Map<K, Set<V>> convertMultiMap2(Collection<T> from, Function<T, K> keyFunc, Function<T, V> valueFunc) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return new HashMap<>(); |
||||
} |
||||
return from.stream().collect(Collectors.groupingBy(keyFunc, Collectors.mapping(valueFunc, Collectors.toSet()))); |
||||
} |
||||
|
||||
public static <T, K> Map<K, T> convertImmutableMap(Collection<T> from, Function<T, K> keyFunc) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return Collections.emptyMap(); |
||||
} |
||||
ImmutableMap.Builder<K, T> builder = ImmutableMap.builder(); |
||||
from.forEach(item -> builder.put(keyFunc.apply(item), item)); |
||||
return builder.build(); |
||||
} |
||||
|
||||
/** |
||||
* 对比老、新两个列表，找出新增、修改、删除的数据 |
||||
* |
||||
* @param oldList 老列表 |
||||
* @param newList 新列表 |
||||
* @param sameFunc 对比函数，返回 true 表示相同，返回 false 表示不同 |
||||
* 注意，same 是通过每个元素的“标识”，判断它们是不是同一个数据 |
||||
* @return [新增列表、修改列表、删除列表] |
||||
*/ |
||||
public static <T> List<List<T>> diffList(Collection<T> oldList, Collection<T> newList, |
||||
BiFunction<T, T, Boolean> sameFunc) { |
||||
List<T> createList = new LinkedList<>(newList); // 默认都认为是新增的，后续会进行移除
|
||||
List<T> updateList = new ArrayList<>(); |
||||
List<T> deleteList = new ArrayList<>(); |
||||
|
||||
// 通过以 oldList 为主遍历，找出 updateList 和 deleteList
|
||||
for (T oldObj : oldList) { |
||||
// 1. 寻找是否有匹配的
|
||||
T foundObj = null; |
||||
for (Iterator<T> iterator = createList.iterator(); iterator.hasNext(); ) { |
||||
T newObj = iterator.next(); |
||||
// 1.1 不匹配，则直接跳过
|
||||
if (!sameFunc.apply(oldObj, newObj)) { |
||||
continue; |
||||
} |
||||
// 1.2 匹配，则移除，并结束寻找
|
||||
iterator.remove(); |
||||
foundObj = newObj; |
||||
break; |
||||
} |
||||
// 2. 匹配添加到 updateList；不匹配则添加到 deleteList 中
|
||||
if (foundObj != null) { |
||||
updateList.add(foundObj); |
||||
} else { |
||||
deleteList.add(oldObj); |
||||
} |
||||
} |
||||
return asList(createList, updateList, deleteList); |
||||
} |
||||
|
||||
public static boolean containsAny(Collection<?> source, Collection<?> candidates) { |
||||
return org.springframework.util.CollectionUtils.containsAny(source, candidates); |
||||
} |
||||
|
||||
public static <T> T getFirst(List<T> from) { |
||||
return !CollectionUtil.isEmpty(from) ? from.get(0) : null; |
||||
} |
||||
|
||||
public static <T> T findFirst(Collection<T> from, Predicate<T> predicate) { |
||||
return findFirst(from, predicate, Function.identity()); |
||||
} |
||||
|
||||
public static <T, U> U findFirst(Collection<T> from, Predicate<T> predicate, Function<T, U> func) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return null; |
||||
} |
||||
return from.stream().filter(predicate).findFirst().map(func).orElse(null); |
||||
} |
||||
|
||||
public static <T, V extends Comparable<? super V>> V getMaxValue(Collection<T> from, Function<T, V> valueFunc) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return null; |
||||
} |
||||
assert !from.isEmpty(); // 断言，避免告警
|
||||
T t = from.stream().max(Comparator.comparing(valueFunc)).get(); |
||||
return valueFunc.apply(t); |
||||
} |
||||
|
||||
public static <T, V extends Comparable<? super V>> V getMinValue(List<T> from, Function<T, V> valueFunc) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return null; |
||||
} |
||||
assert from.size() > 0; // 断言，避免告警
|
||||
T t = from.stream().min(Comparator.comparing(valueFunc)).get(); |
||||
return valueFunc.apply(t); |
||||
} |
||||
|
||||
public static <T, V extends Comparable<? super V>> T getMinObject(List<T> from, Function<T, V> valueFunc) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return null; |
||||
} |
||||
assert from.size() > 0; // 断言，避免告警
|
||||
return from.stream().min(Comparator.comparing(valueFunc)).get(); |
||||
} |
||||
|
||||
public static <T, V extends Comparable<? super V>> V getSumValue(Collection<T> from, Function<T, V> valueFunc, |
||||
BinaryOperator<V> accumulator) { |
||||
return getSumValue(from, valueFunc, accumulator, null); |
||||
} |
||||
|
||||
public static <T, V extends Comparable<? super V>> V getSumValue(Collection<T> from, Function<T, V> valueFunc, |
||||
BinaryOperator<V> accumulator, V defaultValue) { |
||||
if (CollUtil.isEmpty(from)) { |
||||
return defaultValue; |
||||
} |
||||
assert !from.isEmpty(); // 断言，避免告警
|
||||
return from.stream().map(valueFunc).filter(Objects::nonNull).reduce(accumulator).orElse(defaultValue); |
||||
} |
||||
|
||||
public static <T> void addIfNotNull(Collection<T> coll, T item) { |
||||
if (item == null) { |
||||
return; |
||||
} |
||||
coll.add(item); |
||||
} |
||||
|
||||
public static <T> Collection<T> singleton(T obj) { |
||||
return obj == null ? Collections.emptyList() : Collections.singleton(obj); |
||||
} |
||||
|
||||
public static <T> List<T> newArrayList(List<List<T>> list) { |
||||
return list.stream().filter(Objects::nonNull).flatMap(Collection::stream).collect(Collectors.toList()); |
||||
} |
||||
|
||||
/** |
||||
* 转换为 LinkedHashSet |
||||
* |
||||
* @param <T> 元素类型 |
||||
* @param elementType 集合中元素类型 |
||||
* @param value 被转换的值 |
||||
* @return {@link LinkedHashSet} |
||||
*/ |
||||
@SuppressWarnings("unchecked") |
||||
public static <T> LinkedHashSet<T> toLinkedHashSet(Class<T> elementType, Object value) { |
||||
return (LinkedHashSet<T>) toCollection(LinkedHashSet.class, elementType, value); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,68 @@ |
||||
package com.soochowlife.web.framework.common.util.collection; |
||||
|
||||
import cn.hutool.core.collection.CollUtil; |
||||
import cn.hutool.core.collection.CollectionUtil; |
||||
import cn.hutool.core.util.ObjUtil; |
||||
import com.soochowlife.web.framework.common.core.KeyValue; |
||||
import com.google.common.collect.Maps; |
||||
import com.google.common.collect.Multimap; |
||||
|
||||
import java.util.ArrayList; |
||||
import java.util.Collection; |
||||
import java.util.List; |
||||
import java.util.Map; |
||||
import java.util.function.Consumer; |
||||
|
||||
/** |
||||
* Map 工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class MapUtils { |
||||
|
||||
/** |
||||
* 从哈希表表中，获得 keys 对应的所有 value 数组 |
||||
* |
||||
* @param multimap 哈希表 |
||||
* @param keys keys |
||||
* @return value 数组 |
||||
*/ |
||||
public static <K, V> List<V> getList(Multimap<K, V> multimap, Collection<K> keys) { |
||||
List<V> result = new ArrayList<>(); |
||||
keys.forEach(k -> { |
||||
Collection<V> values = multimap.get(k); |
||||
if (CollectionUtil.isEmpty(values)) { |
||||
return; |
||||
} |
||||
result.addAll(values); |
||||
}); |
||||
return result; |
||||
} |
||||
|
||||
/** |
||||
* 从哈希表查找到 key 对应的 value，然后进一步处理 |
||||
* key 为 null 时, 不处理 |
||||
* 注意，如果查找到的 value 为 null 时，不进行处理 |
||||
* |
||||
* @param map 哈希表 |
||||
* @param key key |
||||
* @param consumer 进一步处理的逻辑 |
||||
*/ |
||||
public static <K, V> void findAndThen(Map<K, V> map, K key, Consumer<V> consumer) { |
||||
if (ObjUtil.isNull(key) || CollUtil.isEmpty(map)) { |
||||
return; |
||||
} |
||||
V value = map.get(key); |
||||
if (value == null) { |
||||
return; |
||||
} |
||||
consumer.accept(value); |
||||
} |
||||
|
||||
public static <K, V> Map<K, V> convertMap(List<KeyValue<K, V>> keyValues) { |
||||
Map<K, V> map = Maps.newLinkedHashMapWithExpectedSize(keyValues.size()); |
||||
keyValues.forEach(keyValue -> map.put(keyValue.getKey(), keyValue.getValue())); |
||||
return map; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,19 @@ |
||||
package com.soochowlife.web.framework.common.util.collection; |
||||
|
||||
import cn.hutool.core.collection.CollUtil; |
||||
|
||||
import java.util.Set; |
||||
|
||||
/** |
||||
* Set 工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class SetUtils { |
||||
|
||||
@SafeVarargs |
||||
public static <T> Set<T> asSet(T... objs) { |
||||
return CollUtil.newHashSet(objs); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,149 @@ |
||||
package com.soochowlife.web.framework.common.util.date; |
||||
|
||||
import cn.hutool.core.date.LocalDateTimeUtil; |
||||
|
||||
import java.time.*; |
||||
import java.util.Calendar; |
||||
import java.util.Date; |
||||
|
||||
/** |
||||
* 时间工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class DateUtils { |
||||
|
||||
/** |
||||
* 时区 - 默认 |
||||
*/ |
||||
public static final String TIME_ZONE_DEFAULT = "GMT+8"; |
||||
|
||||
/** |
||||
* 秒转换成毫秒 |
||||
*/ |
||||
public static final long SECOND_MILLIS = 1000; |
||||
|
||||
public static final String FORMAT_YEAR_MONTH_DAY = "yyyy-MM-dd"; |
||||
|
||||
public static final String FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND = "yyyy-MM-dd HH:mm:ss"; |
||||
|
||||
/** |
||||
* 将 LocalDateTime 转换成 Date |
||||
* |
||||
* @param date LocalDateTime |
||||
* @return LocalDateTime |
||||
*/ |
||||
public static Date of(LocalDateTime date) { |
||||
if (date == null) { |
||||
return null; |
||||
} |
||||
// 将此日期时间与时区相结合以创建 ZonedDateTime
|
||||
ZonedDateTime zonedDateTime = date.atZone(ZoneId.systemDefault()); |
||||
// 本地时间线 LocalDateTime 到即时时间线 Instant 时间戳
|
||||
Instant instant = zonedDateTime.toInstant(); |
||||
// UTC时间(世界协调时间,UTC + 00:00)转北京(北京,UTC + 8:00)时间
|
||||
return Date.from(instant); |
||||
} |
||||
|
||||
/** |
||||
* 将 Date 转换成 LocalDateTime |
||||
* |
||||
* @param date Date |
||||
* @return LocalDateTime |
||||
*/ |
||||
public static LocalDateTime of(Date date) { |
||||
if (date == null) { |
||||
return null; |
||||
} |
||||
// 转为时间戳
|
||||
Instant instant = date.toInstant(); |
||||
// UTC时间(世界协调时间,UTC + 00:00)转北京(北京,UTC + 8:00)时间
|
||||
return LocalDateTime.ofInstant(instant, ZoneId.systemDefault()); |
||||
} |
||||
|
||||
public static Date addTime(Duration duration) { |
||||
return new Date(System.currentTimeMillis() + duration.toMillis()); |
||||
} |
||||
|
||||
public static boolean isExpired(LocalDateTime time) { |
||||
LocalDateTime now = LocalDateTime.now(); |
||||
return now.isAfter(time); |
||||
} |
||||
|
||||
/** |
||||
* 创建指定时间 |
||||
* |
||||
* @param year 年 |
||||
* @param mouth 月 |
||||
* @param day 日 |
||||
* @return 指定时间 |
||||
*/ |
||||
public static Date buildTime(int year, int mouth, int day) { |
||||
return buildTime(year, mouth, day, 0, 0, 0); |
||||
} |
||||
|
||||
/** |
||||
* 创建指定时间 |
||||
* |
||||
* @param year 年 |
||||
* @param mouth 月 |
||||
* @param day 日 |
||||
* @param hour 小时 |
||||
* @param minute 分钟 |
||||
* @param second 秒 |
||||
* @return 指定时间 |
||||
*/ |
||||
public static Date buildTime(int year, int mouth, int day, |
||||
int hour, int minute, int second) { |
||||
Calendar calendar = Calendar.getInstance(); |
||||
calendar.set(Calendar.YEAR, year); |
||||
calendar.set(Calendar.MONTH, mouth - 1); |
||||
calendar.set(Calendar.DAY_OF_MONTH, day); |
||||
calendar.set(Calendar.HOUR_OF_DAY, hour); |
||||
calendar.set(Calendar.MINUTE, minute); |
||||
calendar.set(Calendar.SECOND, second); |
||||
calendar.set(Calendar.MILLISECOND, 0); // 一般情况下，都是 0 毫秒
|
||||
return calendar.getTime(); |
||||
} |
||||
|
||||
public static Date max(Date a, Date b) { |
||||
if (a == null) { |
||||
return b; |
||||
} |
||||
if (b == null) { |
||||
return a; |
||||
} |
||||
return a.compareTo(b) > 0 ? a : b; |
||||
} |
||||
|
||||
public static LocalDateTime max(LocalDateTime a, LocalDateTime b) { |
||||
if (a == null) { |
||||
return b; |
||||
} |
||||
if (b == null) { |
||||
return a; |
||||
} |
||||
return a.isAfter(b) ? a : b; |
||||
} |
||||
|
||||
/** |
||||
* 是否今天 |
||||
* |
||||
* @param date 日期 |
||||
* @return 是否 |
||||
*/ |
||||
public static boolean isToday(LocalDateTime date) { |
||||
return LocalDateTimeUtil.isSameDay(date, LocalDateTime.now()); |
||||
} |
||||
|
||||
/** |
||||
* 是否昨天 |
||||
* |
||||
* @param date 日期 |
||||
* @return 是否 |
||||
*/ |
||||
public static boolean isYesterday(LocalDateTime date) { |
||||
return LocalDateTimeUtil.isSameDay(date, LocalDateTime.now().minusDays(1)); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,315 @@ |
||||
package com.soochowlife.web.framework.common.util.date; |
||||
|
||||
import cn.hutool.core.collection.CollUtil; |
||||
import cn.hutool.core.date.DatePattern; |
||||
import cn.hutool.core.date.LocalDateTimeUtil; |
||||
import cn.hutool.core.lang.Assert; |
||||
import cn.hutool.core.util.StrUtil; |
||||
import com.soochowlife.web.framework.common.enums.DateIntervalEnum; |
||||
|
||||
import java.time.*; |
||||
import java.time.format.DateTimeFormatter; |
||||
import java.time.format.DateTimeParseException; |
||||
import java.time.temporal.ChronoUnit; |
||||
import java.time.temporal.TemporalAdjusters; |
||||
import java.util.ArrayList; |
||||
import java.util.List; |
||||
|
||||
import static cn.hutool.core.date.DatePattern.UTC_MS_WITH_XXX_OFFSET_PATTERN; |
||||
import static cn.hutool.core.date.DatePattern.createFormatter; |
||||
|
||||
/** |
||||
* 时间工具类，用于 {@link java.time.LocalDateTime} |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class LocalDateTimeUtils { |
||||
|
||||
/** |
||||
* 空的 LocalDateTime 对象，主要用于 DB 唯一索引的默认值 |
||||
*/ |
||||
public static LocalDateTime EMPTY = buildTime(1970, 1, 1); |
||||
|
||||
public static DateTimeFormatter UTC_MS_WITH_XXX_OFFSET_FORMATTER = createFormatter(UTC_MS_WITH_XXX_OFFSET_PATTERN); |
||||
|
||||
/** |
||||
* 解析时间 |
||||
* |
||||
* 相比 {@link LocalDateTimeUtil#parse(CharSequence)} 方法来说，会尽量去解析，直到成功 |
||||
* |
||||
* @param time 时间 |
||||
* @return 时间字符串 |
||||
*/ |
||||
public static LocalDateTime parse(String time) { |
||||
try { |
||||
return LocalDateTimeUtil.parse(time, DatePattern.NORM_DATE_PATTERN); |
||||
} catch (DateTimeParseException e) { |
||||
return LocalDateTimeUtil.parse(time); |
||||
} |
||||
} |
||||
|
||||
public static LocalDateTime addTime(Duration duration) { |
||||
return LocalDateTime.now().plus(duration); |
||||
} |
||||
|
||||
public static LocalDateTime minusTime(Duration duration) { |
||||
return LocalDateTime.now().minus(duration); |
||||
} |
||||
|
||||
public static boolean beforeNow(LocalDateTime date) { |
||||
return date.isBefore(LocalDateTime.now()); |
||||
} |
||||
|
||||
public static boolean afterNow(LocalDateTime date) { |
||||
return date.isAfter(LocalDateTime.now()); |
||||
} |
||||
|
||||
/** |
||||
* 创建指定时间 |
||||
* |
||||
* @param year 年 |
||||
* @param mouth 月 |
||||
* @param day 日 |
||||
* @return 指定时间 |
||||
*/ |
||||
public static LocalDateTime buildTime(int year, int mouth, int day) { |
||||
return LocalDateTime.of(year, mouth, day, 0, 0, 0); |
||||
} |
||||
|
||||
public static LocalDateTime[] buildBetweenTime(int year1, int mouth1, int day1, |
||||
int year2, int mouth2, int day2) { |
||||
return new LocalDateTime[]{buildTime(year1, mouth1, day1), buildTime(year2, mouth2, day2)}; |
||||
} |
||||
|
||||
/** |
||||
* 判指定断时间，是否在该时间范围内 |
||||
* |
||||
* @param startTime 开始时间 |
||||
* @param endTime 结束时间 |
||||
* @param time 指定时间 |
||||
* @return 是否 |
||||
*/ |
||||
public static boolean isBetween(LocalDateTime startTime, LocalDateTime endTime, String time) { |
||||
if (startTime == null || endTime == null || time == null) { |
||||
return false; |
||||
} |
||||
return LocalDateTimeUtil.isIn(parse(time), startTime, endTime); |
||||
} |
||||
|
||||
/** |
||||
* 判断当前时间是否在该时间范围内 |
||||
* |
||||
* @param startTime 开始时间 |
||||
* @param endTime 结束时间 |
||||
* @return 是否 |
||||
*/ |
||||
public static boolean isBetween(LocalDateTime startTime, LocalDateTime endTime) { |
||||
if (startTime == null || endTime == null) { |
||||
return false; |
||||
} |
||||
return LocalDateTimeUtil.isIn(LocalDateTime.now(), startTime, endTime); |
||||
} |
||||
|
||||
/** |
||||
* 判断当前时间是否在该时间范围内 |
||||
* |
||||
* @param startTime 开始时间 |
||||
* @param endTime 结束时间 |
||||
* @return 是否 |
||||
*/ |
||||
public static boolean isBetween(String startTime, String endTime) { |
||||
if (startTime == null || endTime == null) { |
||||
return false; |
||||
} |
||||
LocalDate nowDate = LocalDate.now(); |
||||
return LocalDateTimeUtil.isIn(LocalDateTime.now(), |
||||
LocalDateTime.of(nowDate, LocalTime.parse(startTime)), |
||||
LocalDateTime.of(nowDate, LocalTime.parse(endTime))); |
||||
} |
||||
|
||||
/** |
||||
* 判断时间段是否重叠 |
||||
* |
||||
* @param startTime1 开始 time1 |
||||
* @param endTime1 结束 time1 |
||||
* @param startTime2 开始 time2 |
||||
* @param endTime2 结束 time2 |
||||
* @return 重叠：true 不重叠：false |
||||
*/ |
||||
public static boolean isOverlap(LocalTime startTime1, LocalTime endTime1, LocalTime startTime2, LocalTime endTime2) { |
||||
LocalDate nowDate = LocalDate.now(); |
||||
return LocalDateTimeUtil.isOverlap(LocalDateTime.of(nowDate, startTime1), LocalDateTime.of(nowDate, endTime1), |
||||
LocalDateTime.of(nowDate, startTime2), LocalDateTime.of(nowDate, endTime2)); |
||||
} |
||||
|
||||
/** |
||||
* 获取指定日期所在的月份的开始时间 |
||||
* 例如：2023-09-30 00:00:00,000 |
||||
* |
||||
* @param date 日期 |
||||
* @return 月份的开始时间 |
||||
*/ |
||||
public static LocalDateTime beginOfMonth(LocalDateTime date) { |
||||
return date.with(TemporalAdjusters.firstDayOfMonth()).with(LocalTime.MIN); |
||||
} |
||||
|
||||
/** |
||||
* 获取指定日期所在的月份的最后时间 |
||||
* 例如：2023-09-30 23:59:59,999 |
||||
* |
||||
* @param date 日期 |
||||
* @return 月份的结束时间 |
||||
*/ |
||||
public static LocalDateTime endOfMonth(LocalDateTime date) { |
||||
return date.with(TemporalAdjusters.lastDayOfMonth()).with(LocalTime.MAX); |
||||
} |
||||
|
||||
/** |
||||
* 获得指定日期所在季度 |
||||
* |
||||
* @param date 日期 |
||||
* @return 所在季度 |
||||
*/ |
||||
public static int getQuarterOfYear(LocalDateTime date) { |
||||
return (date.getMonthValue() - 1) / 3 + 1; |
||||
} |
||||
|
||||
/** |
||||
* 获取指定日期到现在过了几天，如果指定日期在当前日期之后，获取结果为负 |
||||
* |
||||
* @param dateTime 日期 |
||||
* @return 相差天数 |
||||
*/ |
||||
public static Long between(LocalDateTime dateTime) { |
||||
return LocalDateTimeUtil.between(dateTime, LocalDateTime.now(), ChronoUnit.DAYS); |
||||
} |
||||
|
||||
/** |
||||
* 获取今天的开始时间 |
||||
* |
||||
* @return 今天 |
||||
*/ |
||||
public static LocalDateTime getToday() { |
||||
return LocalDateTimeUtil.beginOfDay(LocalDateTime.now()); |
||||
} |
||||
|
||||
/** |
||||
* 获取昨天的开始时间 |
||||
* |
||||
* @return 昨天 |
||||
*/ |
||||
public static LocalDateTime getYesterday() { |
||||
return LocalDateTimeUtil.beginOfDay(LocalDateTime.now().minusDays(1)); |
||||
} |
||||
|
||||
/** |
||||
* 获取本月的开始时间 |
||||
* |
||||
* @return 本月 |
||||
*/ |
||||
public static LocalDateTime getMonth() { |
||||
return beginOfMonth(LocalDateTime.now()); |
||||
} |
||||
|
||||
/** |
||||
* 获取本年的开始时间 |
||||
* |
||||
* @return 本年 |
||||
*/ |
||||
public static LocalDateTime getYear() { |
||||
return LocalDateTime.now().with(TemporalAdjusters.firstDayOfYear()).with(LocalTime.MIN); |
||||
} |
||||
|
||||
public static List<LocalDateTime[]> getDateRangeList(LocalDateTime startTime, |
||||
LocalDateTime endTime, |
||||
Integer interval) { |
||||
// 1.1 找到枚举
|
||||
DateIntervalEnum intervalEnum = DateIntervalEnum.valueOf(interval); |
||||
Assert.notNull(intervalEnum, "interval({}} 找不到对应的枚举", interval); |
||||
// 1.2 将时间对齐
|
||||
startTime = LocalDateTimeUtil.beginOfDay(startTime); |
||||
endTime = LocalDateTimeUtil.endOfDay(endTime); |
||||
|
||||
// 2. 循环，生成时间范围
|
||||
List<LocalDateTime[]> timeRanges = new ArrayList<>(); |
||||
switch (intervalEnum) { |
||||
case DAY: |
||||
while (startTime.isBefore(endTime)) { |
||||
timeRanges.add(new LocalDateTime[]{startTime, startTime.plusDays(1).minusNanos(1)}); |
||||
startTime = startTime.plusDays(1); |
||||
} |
||||
break; |
||||
case WEEK: |
||||
while (startTime.isBefore(endTime)) { |
||||
LocalDateTime endOfWeek = startTime.with(DayOfWeek.SUNDAY).plusDays(1).minusNanos(1); |
||||
timeRanges.add(new LocalDateTime[]{startTime, endOfWeek}); |
||||
startTime = endOfWeek.plusNanos(1); |
||||
} |
||||
break; |
||||
case MONTH: |
||||
while (startTime.isBefore(endTime)) { |
||||
LocalDateTime endOfMonth = startTime.with(TemporalAdjusters.lastDayOfMonth()).plusDays(1).minusNanos(1); |
||||
timeRanges.add(new LocalDateTime[]{startTime, endOfMonth}); |
||||
startTime = endOfMonth.plusNanos(1); |
||||
} |
||||
break; |
||||
case QUARTER: |
||||
while (startTime.isBefore(endTime)) { |
||||
int quarterOfYear = getQuarterOfYear(startTime); |
||||
LocalDateTime quarterEnd = quarterOfYear == 4 |
||||
? startTime.with(TemporalAdjusters.lastDayOfYear()).plusDays(1).minusNanos(1) |
||||
: startTime.withMonth(quarterOfYear * 3 + 1).withDayOfMonth(1).minusNanos(1); |
||||
timeRanges.add(new LocalDateTime[]{startTime, quarterEnd}); |
||||
startTime = quarterEnd.plusNanos(1); |
||||
} |
||||
break; |
||||
case YEAR: |
||||
while (startTime.isBefore(endTime)) { |
||||
LocalDateTime endOfYear = startTime.with(TemporalAdjusters.lastDayOfYear()).plusDays(1).minusNanos(1); |
||||
timeRanges.add(new LocalDateTime[]{startTime, endOfYear}); |
||||
startTime = endOfYear.plusNanos(1); |
||||
} |
||||
break; |
||||
default: |
||||
throw new IllegalArgumentException("Invalid interval: " + interval); |
||||
} |
||||
// 3. 兜底，最后一个时间，需要保持在 endTime 之前
|
||||
LocalDateTime[] lastTimeRange = CollUtil.getLast(timeRanges); |
||||
if (lastTimeRange != null) { |
||||
lastTimeRange[1] = endTime; |
||||
} |
||||
return timeRanges; |
||||
} |
||||
|
||||
/** |
||||
* 格式化时间范围 |
||||
* |
||||
* @param startTime 开始时间 |
||||
* @param endTime 结束时间 |
||||
* @param interval 时间间隔 |
||||
* @return 时间范围 |
||||
*/ |
||||
public static String formatDateRange(LocalDateTime startTime, LocalDateTime endTime, Integer interval) { |
||||
// 1. 找到枚举
|
||||
DateIntervalEnum intervalEnum = DateIntervalEnum.valueOf(interval); |
||||
Assert.notNull(intervalEnum, "interval({}} 找不到对应的枚举", interval); |
||||
|
||||
// 2. 循环，生成时间范围
|
||||
switch (intervalEnum) { |
||||
case DAY: |
||||
return LocalDateTimeUtil.format(startTime, DatePattern.NORM_DATE_PATTERN); |
||||
case WEEK: |
||||
return LocalDateTimeUtil.format(startTime, DatePattern.NORM_DATE_PATTERN) |
||||
+ StrUtil.format("(第 {} 周)", LocalDateTimeUtil.weekOfYear(startTime)); |
||||
case MONTH: |
||||
return LocalDateTimeUtil.format(startTime, DatePattern.NORM_MONTH_PATTERN); |
||||
case QUARTER: |
||||
return StrUtil.format("{}-Q{}", startTime.getYear(), getQuarterOfYear(startTime)); |
||||
case YEAR: |
||||
return LocalDateTimeUtil.format(startTime, DatePattern.NORM_YEAR_PATTERN); |
||||
default: |
||||
throw new IllegalArgumentException("Invalid interval: " + interval); |
||||
} |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,175 @@ |
||||
package com.soochowlife.web.framework.common.util.http; |
||||
|
||||
import cn.hutool.core.codec.Base64; |
||||
import cn.hutool.core.map.TableMap; |
||||
import cn.hutool.core.net.url.UrlBuilder; |
||||
import cn.hutool.core.util.ReflectUtil; |
||||
import cn.hutool.core.util.StrUtil; |
||||
import cn.hutool.http.HttpRequest; |
||||
import cn.hutool.http.HttpResponse; |
||||
import jakarta.servlet.http.HttpServletRequest; |
||||
import org.springframework.util.StringUtils; |
||||
import org.springframework.web.util.UriComponents; |
||||
import org.springframework.web.util.UriComponentsBuilder; |
||||
|
||||
import java.net.URI; |
||||
import java.net.URLEncoder; |
||||
import java.nio.charset.Charset; |
||||
import java.nio.charset.StandardCharsets; |
||||
import java.util.Map; |
||||
|
||||
/** |
||||
* HTTP 工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class HttpUtils { |
||||
|
||||
/** |
||||
* 编码 URL 参数 |
||||
* |
||||
* @param value 参数 |
||||
* @return 编码后的参数 |
||||
*/ |
||||
public static String encodeUtf8(String value) { |
||||
return URLEncoder.encode(value, StandardCharsets.UTF_8); |
||||
} |
||||
|
||||
@SuppressWarnings("unchecked") |
||||
public static String replaceUrlQuery(String url, String key, String value) { |
||||
UrlBuilder builder = UrlBuilder.of(url, Charset.defaultCharset()); |
||||
// 先移除
|
||||
TableMap<CharSequence, CharSequence> query = (TableMap<CharSequence, CharSequence>) |
||||
ReflectUtil.getFieldValue(builder.getQuery(), "query"); |
||||
query.remove(key); |
||||
// 后添加
|
||||
builder.addQuery(key, value); |
||||
return builder.build(); |
||||
} |
||||
|
||||
private String append(String base, Map<String, ?> query, boolean fragment) { |
||||
return append(base, query, null, fragment); |
||||
} |
||||
|
||||
/** |
||||
* 拼接 URL |
||||
* |
||||
* copy from Spring Security OAuth2 的 AuthorizationEndpoint 类的 append 方法 |
||||
* |
||||
* @param base 基础 URL |
||||
* @param query 查询参数 |
||||
* @param keys query 的 key，对应的原本的 key 的映射。例如说 query 里有个 key 是 xx，实际它的 key 是 extra_xx，则通过 keys 里添加这个映射 |
||||
* @param fragment URL 的 fragment，即拼接到 # 中 |
||||
* @return 拼接后的 URL |
||||
*/ |
||||
public static String append(String base, Map<String, ?> query, Map<String, String> keys, boolean fragment) { |
||||
UriComponentsBuilder template = UriComponentsBuilder.newInstance(); |
||||
UriComponentsBuilder builder = UriComponentsBuilder.fromUriString(base); |
||||
URI redirectUri; |
||||
try { |
||||
// assume it's encoded to start with (if it came in over the wire)
|
||||
redirectUri = builder.build(true).toUri(); |
||||
} catch (Exception e) { |
||||
// ... but allow client registrations to contain hard-coded non-encoded values
|
||||
redirectUri = builder.build().toUri(); |
||||
builder = UriComponentsBuilder.fromUri(redirectUri); |
||||
} |
||||
template.scheme(redirectUri.getScheme()).port(redirectUri.getPort()).host(redirectUri.getHost()) |
||||
.userInfo(redirectUri.getUserInfo()).path(redirectUri.getPath()); |
||||
|
||||
if (fragment) { |
||||
StringBuilder values = new StringBuilder(); |
||||
if (redirectUri.getFragment() != null) { |
||||
String append = redirectUri.getFragment(); |
||||
values.append(append); |
||||
} |
||||
for (String key : query.keySet()) { |
||||
if (values.length() > 0) { |
||||
values.append("&"); |
||||
} |
||||
String name = key; |
||||
if (keys != null && keys.containsKey(key)) { |
||||
name = keys.get(key); |
||||
} |
||||
values.append(name).append("={").append(key).append("}"); |
||||
} |
||||
if (values.length() > 0) { |
||||
template.fragment(values.toString()); |
||||
} |
||||
UriComponents encoded = template.build().expand(query).encode(); |
||||
builder.fragment(encoded.getFragment()); |
||||
} else { |
||||
for (String key : query.keySet()) { |
||||
String name = key; |
||||
if (keys != null && keys.containsKey(key)) { |
||||
name = keys.get(key); |
||||
} |
||||
template.queryParam(name, "{" + key + "}"); |
||||
} |
||||
template.fragment(redirectUri.getFragment()); |
||||
UriComponents encoded = template.build().expand(query).encode(); |
||||
builder.query(encoded.getQuery()); |
||||
} |
||||
return builder.build().toUriString(); |
||||
} |
||||
|
||||
public static String[] obtainBasicAuthorization(HttpServletRequest request) { |
||||
String clientId; |
||||
String clientSecret; |
||||
// 先从 Header 中获取
|
||||
String authorization = request.getHeader("Authorization"); |
||||
authorization = StrUtil.subAfter(authorization, "Basic ", true); |
||||
if (StringUtils.hasText(authorization)) { |
||||
authorization = Base64.decodeStr(authorization); |
||||
clientId = StrUtil.subBefore(authorization, ":", false); |
||||
clientSecret = StrUtil.subAfter(authorization, ":", false); |
||||
// 再从 Param 中获取
|
||||
} else { |
||||
clientId = request.getParameter("client_id"); |
||||
clientSecret = request.getParameter("client_secret"); |
||||
} |
||||
|
||||
// 如果两者非空，则返回
|
||||
if (StrUtil.isNotEmpty(clientId) && StrUtil.isNotEmpty(clientSecret)) { |
||||
return new String[]{clientId, clientSecret}; |
||||
} |
||||
return null; |
||||
} |
||||
|
||||
/** |
||||
* HTTP post 请求，基于 {@link cn.hutool.http.HttpUtil} 实现 |
||||
* |
||||
* 为什么要封装该方法，因为 HttpUtil 默认封装的方法，没有允许传递 headers 参数 |
||||
* |
||||
* @param url URL |
||||
* @param headers 请求头 |
||||
* @param requestBody 请求体 |
||||
* @return 请求结果 |
||||
*/ |
||||
public static String post(String url, Map<String, String> headers, String requestBody) { |
||||
try (HttpResponse response = HttpRequest.post(url) |
||||
.addHeaders(headers) |
||||
.body(requestBody) |
||||
.execute()) { |
||||
return response.body(); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* HTTP get 请求，基于 {@link cn.hutool.http.HttpUtil} 实现 |
||||
* |
||||
* 为什么要封装该方法，因为 HttpUtil 默认封装的方法，没有允许传递 headers 参数 |
||||
* |
||||
* @param url URL |
||||
* @param headers 请求头 |
||||
* @return 请求结果 |
||||
*/ |
||||
public static String get(String url, Map<String, String> headers) { |
||||
try (HttpResponse response = HttpRequest.get(url) |
||||
.addHeaders(headers) |
||||
.execute()) { |
||||
return response.body(); |
||||
} |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,61 @@ |
||||
package com.soochowlife.web.framework.common.util.io; |
||||
|
||||
import cn.hutool.core.io.FileUtil; |
||||
import cn.hutool.core.util.IdUtil; |
||||
import lombok.SneakyThrows; |
||||
|
||||
import java.io.File; |
||||
|
||||
/** |
||||
* 文件工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class FileUtils { |
||||
|
||||
/** |
||||
* 创建临时文件 |
||||
* 该文件会在 JVM 退出时，进行删除 |
||||
* |
||||
* @param data 文件内容 |
||||
* @return 文件 |
||||
*/ |
||||
@SneakyThrows |
||||
public static File createTempFile(String data) { |
||||
File file = createTempFile(); |
||||
// 写入内容
|
||||
FileUtil.writeUtf8String(data, file); |
||||
return file; |
||||
} |
||||
|
||||
/** |
||||
* 创建临时文件 |
||||
* 该文件会在 JVM 退出时，进行删除 |
||||
* |
||||
* @param data 文件内容 |
||||
* @return 文件 |
||||
*/ |
||||
@SneakyThrows |
||||
public static File createTempFile(byte[] data) { |
||||
File file = createTempFile(); |
||||
// 写入内容
|
||||
FileUtil.writeBytes(data, file); |
||||
return file; |
||||
} |
||||
|
||||
/** |
||||
* 创建临时文件，无内容 |
||||
* 该文件会在 JVM 退出时，进行删除 |
||||
* |
||||
* @return 文件 |
||||
*/ |
||||
@SneakyThrows |
||||
public static File createTempFile() { |
||||
// 创建文件，通过 UUID 保证唯一
|
||||
File file = File.createTempFile(IdUtil.simpleUUID(), null); |
||||
// 标记 JVM 退出时，自动删除
|
||||
file.deleteOnExit(); |
||||
return file; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,28 @@ |
||||
package com.soochowlife.web.framework.common.util.io; |
||||
|
||||
import cn.hutool.core.io.IORuntimeException; |
||||
import cn.hutool.core.io.IoUtil; |
||||
import cn.hutool.core.util.StrUtil; |
||||
|
||||
import java.io.InputStream; |
||||
|
||||
/** |
||||
* IO 工具类，用于 {@link cn.hutool.core.io.IoUtil} 缺失的方法 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class IoUtils { |
||||
|
||||
/** |
||||
* 从流中读取 UTF8 编码的内容 |
||||
* |
||||
* @param in 输入流 |
||||
* @param isClose 是否关闭 |
||||
* @return 内容 |
||||
* @throws IORuntimeException IO 异常 |
||||
*/ |
||||
public static String readUtf8(InputStream in, boolean isClose) throws IORuntimeException { |
||||
return StrUtil.utf8Str(IoUtil.read(in, isClose)); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,210 @@ |
||||
package com.soochowlife.web.framework.common.util.json; |
||||
|
||||
import cn.hutool.core.util.ArrayUtil; |
||||
import cn.hutool.core.util.StrUtil; |
||||
import cn.hutool.json.JSONUtil; |
||||
import com.fasterxml.jackson.annotation.JsonInclude; |
||||
import com.fasterxml.jackson.core.type.TypeReference; |
||||
import com.fasterxml.jackson.databind.DeserializationFeature; |
||||
import com.fasterxml.jackson.databind.JsonNode; |
||||
import com.fasterxml.jackson.databind.ObjectMapper; |
||||
import com.fasterxml.jackson.databind.SerializationFeature; |
||||
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; |
||||
import lombok.SneakyThrows; |
||||
import lombok.extern.slf4j.Slf4j; |
||||
|
||||
import java.io.IOException; |
||||
import java.lang.reflect.Type; |
||||
import java.util.ArrayList; |
||||
import java.util.List; |
||||
|
||||
/** |
||||
* JSON 工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Slf4j |
||||
public class JsonUtils { |
||||
|
||||
private static ObjectMapper objectMapper = new ObjectMapper(); |
||||
|
||||
static { |
||||
objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false); |
||||
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); |
||||
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); // 忽略 null 值
|
||||
objectMapper.registerModules(new JavaTimeModule()); // 解决 LocalDateTime 的序列化
|
||||
} |
||||
|
||||
/** |
||||
* 初始化 objectMapper 属性 |
||||
* <p> |
||||
* 通过这样的方式，使用 Spring 创建的 ObjectMapper Bean |
||||
* |
||||
* @param objectMapper ObjectMapper 对象 |
||||
*/ |
||||
public static void init(ObjectMapper objectMapper) { |
||||
JsonUtils.objectMapper = objectMapper; |
||||
} |
||||
|
||||
@SneakyThrows |
||||
public static String toJsonString(Object object) { |
||||
return objectMapper.writeValueAsString(object); |
||||
} |
||||
|
||||
@SneakyThrows |
||||
public static byte[] toJsonByte(Object object) { |
||||
return objectMapper.writeValueAsBytes(object); |
||||
} |
||||
|
||||
@SneakyThrows |
||||
public static String toJsonPrettyString(Object object) { |
||||
return objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(object); |
||||
} |
||||
|
||||
public static <T> T parseObject(String text, Class<T> clazz) { |
||||
if (StrUtil.isEmpty(text)) { |
||||
return null; |
||||
} |
||||
try { |
||||
return objectMapper.readValue(text, clazz); |
||||
} catch (IOException e) { |
||||
log.error("json parse err,json:{}", text, e); |
||||
throw new RuntimeException(e); |
||||
} |
||||
} |
||||
|
||||
public static <T> T parseObject(String text, String path, Class<T> clazz) { |
||||
if (StrUtil.isEmpty(text)) { |
||||
return null; |
||||
} |
||||
try { |
||||
JsonNode treeNode = objectMapper.readTree(text); |
||||
JsonNode pathNode = treeNode.path(path); |
||||
return objectMapper.readValue(pathNode.toString(), clazz); |
||||
} catch (IOException e) { |
||||
log.error("json parse err,json:{}", text, e); |
||||
throw new RuntimeException(e); |
||||
} |
||||
} |
||||
|
||||
public static <T> T parseObject(String text, Type type) { |
||||
if (StrUtil.isEmpty(text)) { |
||||
return null; |
||||
} |
||||
try { |
||||
return objectMapper.readValue(text, objectMapper.getTypeFactory().constructType(type)); |
||||
} catch (IOException e) { |
||||
log.error("json parse err,json:{}", text, e); |
||||
throw new RuntimeException(e); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* 将字符串解析成指定类型的对象 |
||||
* 使用 {@link #parseObject(String, Class)} 时，在@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS) 的场景下， |
||||
* 如果 text 没有 class 属性，则会报错。此时，使用这个方法，可以解决。 |
||||
* |
||||
* @param text 字符串 |
||||
* @param clazz 类型 |
||||
* @return 对象 |
||||
*/ |
||||
public static <T> T parseObject2(String text, Class<T> clazz) { |
||||
if (StrUtil.isEmpty(text)) { |
||||
return null; |
||||
} |
||||
return JSONUtil.toBean(text, clazz); |
||||
} |
||||
|
||||
public static <T> T parseObject(byte[] bytes, Class<T> clazz) { |
||||
if (ArrayUtil.isEmpty(bytes)) { |
||||
return null; |
||||
} |
||||
try { |
||||
return objectMapper.readValue(bytes, clazz); |
||||
} catch (IOException e) { |
||||
log.error("json parse err,json:{}", bytes, e); |
||||
throw new RuntimeException(e); |
||||
} |
||||
} |
||||
|
||||
public static <T> T parseObject(String text, TypeReference<T> typeReference) { |
||||
try { |
||||
return objectMapper.readValue(text, typeReference); |
||||
} catch (IOException e) { |
||||
log.error("json parse err,json:{}", text, e); |
||||
throw new RuntimeException(e); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* 解析 JSON 字符串成指定类型的对象，如果解析失败，则返回 null |
||||
* |
||||
* @param text 字符串 |
||||
* @param typeReference 类型引用 |
||||
* @return 指定类型的对象 |
||||
*/ |
||||
public static <T> T parseObjectQuietly(String text, TypeReference<T> typeReference) { |
||||
try { |
||||
return objectMapper.readValue(text, typeReference); |
||||
} catch (IOException e) { |
||||
return null; |
||||
} |
||||
} |
||||
|
||||
public static <T> List<T> parseArray(String text, Class<T> clazz) { |
||||
if (StrUtil.isEmpty(text)) { |
||||
return new ArrayList<>(); |
||||
} |
||||
try { |
||||
return objectMapper.readValue(text, objectMapper.getTypeFactory().constructCollectionType(List.class, clazz)); |
||||
} catch (IOException e) { |
||||
log.error("json parse err,json:{}", text, e); |
||||
throw new RuntimeException(e); |
||||
} |
||||
} |
||||
|
||||
public static <T> List<T> parseArray(String text, String path, Class<T> clazz) { |
||||
if (StrUtil.isEmpty(text)) { |
||||
return null; |
||||
} |
||||
try { |
||||
JsonNode treeNode = objectMapper.readTree(text); |
||||
JsonNode pathNode = treeNode.path(path); |
||||
return objectMapper.readValue(pathNode.toString(), objectMapper.getTypeFactory().constructCollectionType(List.class, clazz)); |
||||
} catch (IOException e) { |
||||
log.error("json parse err,json:{}", text, e); |
||||
throw new RuntimeException(e); |
||||
} |
||||
} |
||||
|
||||
public static JsonNode parseTree(String text) { |
||||
try { |
||||
return objectMapper.readTree(text); |
||||
} catch (IOException e) { |
||||
log.error("json parse err,json:{}", text, e); |
||||
throw new RuntimeException(e); |
||||
} |
||||
} |
||||
|
||||
public static JsonNode parseTree(byte[] text) { |
||||
try { |
||||
return objectMapper.readTree(text); |
||||
} catch (IOException e) { |
||||
log.error("json parse err,json:{}", text, e); |
||||
throw new RuntimeException(e); |
||||
} |
||||
} |
||||
|
||||
public static boolean isJson(String text) { |
||||
return JSONUtil.isTypeJSON(text); |
||||
} |
||||
|
||||
/** |
||||
* 判断字符串是否为 JSON 类型的字符串 |
||||
* @param str 字符串 |
||||
*/ |
||||
public static boolean isJsonObject(String str) { |
||||
return JSONUtil.isTypeJSONObject(str); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,37 @@ |
||||
package com.soochowlife.web.framework.common.util.json.databind; |
||||
|
||||
import com.fasterxml.jackson.core.JsonGenerator; |
||||
import com.fasterxml.jackson.databind.SerializerProvider; |
||||
import com.fasterxml.jackson.databind.annotation.JacksonStdImpl; |
||||
|
||||
import java.io.IOException; |
||||
|
||||
/** |
||||
* Long 序列化规则 |
||||
* |
||||
* 会将超长 long 值转换为 string，解决前端 JavaScript 最大安全整数是 2^53-1 的问题 |
||||
* |
||||
* @author 星语 |
||||
*/ |
||||
@JacksonStdImpl |
||||
public class NumberSerializer extends com.fasterxml.jackson.databind.ser.std.NumberSerializer { |
||||
|
||||
private static final long MAX_SAFE_INTEGER = 9007199254740991L; |
||||
private static final long MIN_SAFE_INTEGER = -9007199254740991L; |
||||
|
||||
public static final NumberSerializer INSTANCE = new NumberSerializer(Number.class); |
||||
|
||||
public NumberSerializer(Class<? extends Number> rawType) { |
||||
super(rawType); |
||||
} |
||||
|
||||
@Override |
||||
public void serialize(Number value, JsonGenerator gen, SerializerProvider serializers) throws IOException { |
||||
// 超出范围 序列化位字符串
|
||||
if (value.longValue() > MIN_SAFE_INTEGER && value.longValue() < MAX_SAFE_INTEGER) { |
||||
super.serialize(value, gen, serializers); |
||||
} else { |
||||
gen.writeString(value.toString()); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,27 @@ |
||||
package com.soochowlife.web.framework.common.util.json.databind; |
||||
|
||||
import com.fasterxml.jackson.core.JsonParser; |
||||
import com.fasterxml.jackson.databind.DeserializationContext; |
||||
import com.fasterxml.jackson.databind.JsonDeserializer; |
||||
|
||||
import java.io.IOException; |
||||
import java.time.Instant; |
||||
import java.time.LocalDateTime; |
||||
import java.time.ZoneId; |
||||
|
||||
/** |
||||
* 基于时间戳的 LocalDateTime 反序列化器 |
||||
* |
||||
* @author 老五 |
||||
*/ |
||||
public class TimestampLocalDateTimeDeserializer extends JsonDeserializer<LocalDateTime> { |
||||
|
||||
public static final TimestampLocalDateTimeDeserializer INSTANCE = new TimestampLocalDateTimeDeserializer(); |
||||
|
||||
@Override |
||||
public LocalDateTime deserialize(JsonParser p, DeserializationContext ctxt) throws IOException { |
||||
// 将 Long 时间戳，转换为 LocalDateTime 对象
|
||||
return LocalDateTime.ofInstant(Instant.ofEpochMilli(p.getValueAsLong()), ZoneId.systemDefault()); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,26 @@ |
||||
package com.soochowlife.web.framework.common.util.json.databind; |
||||
|
||||
import com.fasterxml.jackson.core.JsonGenerator; |
||||
import com.fasterxml.jackson.databind.JsonSerializer; |
||||
import com.fasterxml.jackson.databind.SerializerProvider; |
||||
|
||||
import java.io.IOException; |
||||
import java.time.LocalDateTime; |
||||
import java.time.ZoneId; |
||||
|
||||
/** |
||||
* 基于时间戳的 LocalDateTime 序列化器 |
||||
* |
||||
* @author 老五 |
||||
*/ |
||||
public class TimestampLocalDateTimeSerializer extends JsonSerializer<LocalDateTime> { |
||||
|
||||
public static final TimestampLocalDateTimeSerializer INSTANCE = new TimestampLocalDateTimeSerializer(); |
||||
|
||||
@Override |
||||
public void serialize(LocalDateTime value, JsonGenerator gen, SerializerProvider serializers) throws IOException { |
||||
// 将 LocalDateTime 对象，转换为 Long 时间戳
|
||||
gen.writeNumber(value.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli()); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,30 @@ |
||||
package com.soochowlife.web.framework.common.util.monitor; |
||||
|
||||
import org.apache.skywalking.apm.toolkit.trace.TraceContext; |
||||
|
||||
/** |
||||
* 链路追踪工具类 |
||||
* |
||||
* 考虑到每个 starter 都需要用到该工具类，所以放到 common 模块下的 util 包下 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class TracerUtils { |
||||
|
||||
/** |
||||
* 私有化构造方法 |
||||
*/ |
||||
private TracerUtils() { |
||||
} |
||||
|
||||
/** |
||||
* 获得链路追踪编号，直接返回 SkyWalking 的 TraceId。 |
||||
* 如果不存在的话为空字符串！！！ |
||||
* |
||||
* @return 链路追踪编号 |
||||
*/ |
||||
public static String getTraceId() { |
||||
return TraceContext.traceId(); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,131 @@ |
||||
package com.soochowlife.web.framework.common.util.number; |
||||
|
||||
import cn.hutool.core.math.Money; |
||||
import cn.hutool.core.util.NumberUtil; |
||||
|
||||
import java.math.BigDecimal; |
||||
import java.math.RoundingMode; |
||||
|
||||
/** |
||||
* 金额工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class MoneyUtils { |
||||
|
||||
/** |
||||
* 金额的小数位数 |
||||
*/ |
||||
private static final int PRICE_SCALE = 2; |
||||
|
||||
/** |
||||
* 百分比对应的 BigDecimal 对象 |
||||
*/ |
||||
public static final BigDecimal PERCENT_100 = BigDecimal.valueOf(100); |
||||
|
||||
/** |
||||
* 计算百分比金额，四舍五入 |
||||
* |
||||
* @param price 金额 |
||||
* @param rate 百分比，例如说 56.77% 则传入 56.77 |
||||
* @return 百分比金额 |
||||
*/ |
||||
public static Integer calculateRatePrice(Integer price, Double rate) { |
||||
return calculateRatePrice(price, rate, 0, RoundingMode.HALF_UP).intValue(); |
||||
} |
||||
|
||||
/** |
||||
* 计算百分比金额，向下传入 |
||||
* |
||||
* @param price 金额 |
||||
* @param rate 百分比，例如说 56.77% 则传入 56.77 |
||||
* @return 百分比金额 |
||||
*/ |
||||
public static Integer calculateRatePriceFloor(Integer price, Double rate) { |
||||
return calculateRatePrice(price, rate, 0, RoundingMode.FLOOR).intValue(); |
||||
} |
||||
|
||||
/** |
||||
* 计算百分比金额 |
||||
* |
||||
* @param price 金额（单位分） |
||||
* @param count 数量 |
||||
* @param percent 折扣（单位分），列如 60.2%，则传入 6020 |
||||
* @return 商品总价 |
||||
*/ |
||||
public static Integer calculator(Integer price, Integer count, Integer percent) { |
||||
price = price * count; |
||||
if (percent == null) { |
||||
return price; |
||||
} |
||||
return MoneyUtils.calculateRatePriceFloor(price, (double) (percent / 100)); |
||||
} |
||||
|
||||
/** |
||||
* 计算百分比金额 |
||||
* |
||||
* @param price 金额 |
||||
* @param rate 百分比，例如说 56.77% 则传入 56.77 |
||||
* @param scale 保留小数位数 |
||||
* @param roundingMode 舍入模式 |
||||
*/ |
||||
public static BigDecimal calculateRatePrice(Number price, Number rate, int scale, RoundingMode roundingMode) { |
||||
return NumberUtil.toBigDecimal(price).multiply(NumberUtil.toBigDecimal(rate)) // 乘以
|
||||
.divide(BigDecimal.valueOf(100), scale, roundingMode); // 除以 100
|
||||
} |
||||
|
||||
/** |
||||
* 分转元 |
||||
* |
||||
* @param fen 分 |
||||
* @return 元 |
||||
*/ |
||||
public static BigDecimal fenToYuan(int fen) { |
||||
return new Money(0, fen).getAmount(); |
||||
} |
||||
|
||||
/** |
||||
* 分转元（字符串） |
||||
* |
||||
* 例如说 fen 为 1 时，则结果为 0.01 |
||||
* |
||||
* @param fen 分 |
||||
* @return 元 |
||||
*/ |
||||
public static String fenToYuanStr(int fen) { |
||||
return new Money(0, fen).toString(); |
||||
} |
||||
|
||||
/** |
||||
* 金额相乘，默认进行四舍五入 |
||||
* |
||||
* 位数：{@link #PRICE_SCALE} |
||||
* |
||||
* @param price 金额 |
||||
* @param count 数量 |
||||
* @return 金额相乘结果 |
||||
*/ |
||||
public static BigDecimal priceMultiply(BigDecimal price, BigDecimal count) { |
||||
if (price == null || count == null) { |
||||
return null; |
||||
} |
||||
return price.multiply(count).setScale(PRICE_SCALE, RoundingMode.HALF_UP); |
||||
} |
||||
|
||||
/** |
||||
* 金额相乘（百分比），默认进行四舍五入 |
||||
* |
||||
* 位数：{@link #PRICE_SCALE} |
||||
* |
||||
* @param price 金额 |
||||
* @param percent 百分比 |
||||
* @return 金额相乘结果 |
||||
*/ |
||||
public static BigDecimal priceMultiplyPercent(BigDecimal price, BigDecimal percent) { |
||||
if (price == null || percent == null) { |
||||
return null; |
||||
} |
||||
return price.multiply(percent).divide(PERCENT_100, PRICE_SCALE, RoundingMode.HALF_UP); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,78 @@ |
||||
package com.soochowlife.web.framework.common.util.number; |
||||
|
||||
import cn.hutool.core.collection.CollUtil; |
||||
import cn.hutool.core.util.NumberUtil; |
||||
import cn.hutool.core.util.StrUtil; |
||||
|
||||
import java.math.BigDecimal; |
||||
import java.util.List; |
||||
|
||||
/** |
||||
* 数字的工具类，补全 {@link cn.hutool.core.util.NumberUtil} 的功能 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class NumberUtils { |
||||
|
||||
public static Long parseLong(String str) { |
||||
return StrUtil.isNotEmpty(str) ? Long.valueOf(str) : null; |
||||
} |
||||
|
||||
public static Integer parseInt(String str) { |
||||
return StrUtil.isNotEmpty(str) ? Integer.valueOf(str) : null; |
||||
} |
||||
|
||||
public static boolean isAllNumber(List<String> values) { |
||||
if (CollUtil.isEmpty(values)) { |
||||
return false; |
||||
} |
||||
for (String value : values) { |
||||
if (!NumberUtil.isNumber(value)) { |
||||
return false; |
||||
} |
||||
} |
||||
return true; |
||||
} |
||||
|
||||
/** |
||||
* 通过经纬度获取地球上两点之间的距离 |
||||
* |
||||
* 参考 <<a href="https://gitee.com/dromara/hutool/blob/1caabb586b1f95aec66a21d039c5695df5e0f4c1/hutool-core/src/main/java/cn/hutool/core/util/DistanceUtil.java">DistanceUtil</a>> 实现，目前它已经被 hutool 删除 |
||||
* |
||||
* @param lat1 经度1 |
||||
* @param lng1 纬度1 |
||||
* @param lat2 经度2 |
||||
* @param lng2 纬度2 |
||||
* @return 距离，单位：千米 |
||||
*/ |
||||
public static double getDistance(double lat1, double lng1, double lat2, double lng2) { |
||||
double radLat1 = lat1 * Math.PI / 180.0; |
||||
double radLat2 = lat2 * Math.PI / 180.0; |
||||
double a = radLat1 - radLat2; |
||||
double b = lng1 * Math.PI / 180.0 - lng2 * Math.PI / 180.0; |
||||
double distance = 2 * Math.asin(Math.sqrt(Math.pow(Math.sin(a / 2), 2) |
||||
+ Math.cos(radLat1) * Math.cos(radLat2) |
||||
* Math.pow(Math.sin(b / 2), 2))); |
||||
distance = distance * 6378.137; |
||||
distance = Math.round(distance * 10000d) / 10000d; |
||||
return distance; |
||||
} |
||||
|
||||
/** |
||||
* 提供精确的乘法运算 |
||||
* |
||||
* 和 hutool {@link NumberUtil#mul(BigDecimal...)} 的差别是，如果存在 null，则返回 null |
||||
* |
||||
* @param values 多个被乘值 |
||||
* @return 积 |
||||
*/ |
||||
public static BigDecimal mul(BigDecimal... values) { |
||||
for (BigDecimal value : values) { |
||||
if (value == null) { |
||||
return null; |
||||
} |
||||
} |
||||
return NumberUtil.mul(values); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,69 @@ |
||||
package com.soochowlife.web.framework.common.util.object; |
||||
|
||||
import cn.hutool.core.bean.BeanUtil; |
||||
import com.soochowlife.web.framework.common.pojo.PageResult; |
||||
import com.soochowlife.web.framework.common.util.collection.CollectionUtils; |
||||
|
||||
import java.util.List; |
||||
import java.util.function.Consumer; |
||||
|
||||
/** |
||||
* Bean 工具类 |
||||
* |
||||
* 1. 默认使用 {@link cn.hutool.core.bean.BeanUtil} 作为实现类，虽然不同 bean 工具的性能有差别，但是对绝大多数同学的项目，不用在意这点性能 |
||||
* 2. 针对复杂的对象转换，可以搜参考 AuthConvert 实现，通过 mapstruct + default 配合实现 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class BeanUtils { |
||||
|
||||
public static <T> T toBean(Object source, Class<T> targetClass) { |
||||
return BeanUtil.toBean(source, targetClass); |
||||
} |
||||
|
||||
public static <T> T toBean(Object source, Class<T> targetClass, Consumer<T> peek) { |
||||
T target = toBean(source, targetClass); |
||||
if (target != null) { |
||||
peek.accept(target); |
||||
} |
||||
return target; |
||||
} |
||||
|
||||
public static <S, T> List<T> toBean(List<S> source, Class<T> targetType) { |
||||
if (source == null) { |
||||
return null; |
||||
} |
||||
return CollectionUtils.convertList(source, s -> toBean(s, targetType)); |
||||
} |
||||
|
||||
public static <S, T> List<T> toBean(List<S> source, Class<T> targetType, Consumer<T> peek) { |
||||
List<T> list = toBean(source, targetType); |
||||
if (list != null) { |
||||
list.forEach(peek); |
||||
} |
||||
return list; |
||||
} |
||||
|
||||
public static <S, T> PageResult<T> toBean(PageResult<S> source, Class<T> targetType) { |
||||
return toBean(source, targetType, null); |
||||
} |
||||
|
||||
public static <S, T> PageResult<T> toBean(PageResult<S> source, Class<T> targetType, Consumer<T> peek) { |
||||
if (source == null) { |
||||
return null; |
||||
} |
||||
List<T> list = toBean(source.getList(), targetType); |
||||
if (peek != null) { |
||||
list.forEach(peek); |
||||
} |
||||
return new PageResult<>(list, source.getTotal()); |
||||
} |
||||
|
||||
public static void copyProperties(Object source, Object target) { |
||||
if (source == null || target == null) { |
||||
return; |
||||
} |
||||
BeanUtil.copyProperties(source, target, false); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,63 @@ |
||||
package com.soochowlife.web.framework.common.util.object; |
||||
|
||||
import cn.hutool.core.util.ObjectUtil; |
||||
import cn.hutool.core.util.ReflectUtil; |
||||
|
||||
import java.lang.reflect.Field; |
||||
import java.util.Arrays; |
||||
import java.util.function.Consumer; |
||||
|
||||
/** |
||||
* Object 工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class ObjectUtils { |
||||
|
||||
/** |
||||
* 复制对象，并忽略 Id 编号 |
||||
* |
||||
* @param object 被复制对象 |
||||
* @param consumer 消费者，可以二次编辑被复制对象 |
||||
* @return 复制后的对象 |
||||
*/ |
||||
public static <T> T cloneIgnoreId(T object, Consumer<T> consumer) { |
||||
T result = ObjectUtil.clone(object); |
||||
// 忽略 id 编号
|
||||
Field field = ReflectUtil.getField(object.getClass(), "id"); |
||||
if (field != null) { |
||||
ReflectUtil.setFieldValue(result, field, null); |
||||
} |
||||
// 二次编辑
|
||||
if (result != null) { |
||||
consumer.accept(result); |
||||
} |
||||
return result; |
||||
} |
||||
|
||||
public static <T extends Comparable<T>> T max(T obj1, T obj2) { |
||||
if (obj1 == null) { |
||||
return obj2; |
||||
} |
||||
if (obj2 == null) { |
||||
return obj1; |
||||
} |
||||
return obj1.compareTo(obj2) > 0 ? obj1 : obj2; |
||||
} |
||||
|
||||
@SafeVarargs |
||||
public static <T> T defaultIfNull(T... array) { |
||||
for (T item : array) { |
||||
if (item != null) { |
||||
return item; |
||||
} |
||||
} |
||||
return null; |
||||
} |
||||
|
||||
@SafeVarargs |
||||
public static <T> boolean equalsAny(T obj, T... array) { |
||||
return Arrays.asList(array).contains(obj); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,67 @@ |
||||
package com.soochowlife.web.framework.common.util.object; |
||||
|
||||
import cn.hutool.core.collection.CollUtil; |
||||
import cn.hutool.core.lang.func.Func1; |
||||
import cn.hutool.core.lang.func.LambdaUtil; |
||||
import cn.hutool.core.util.ArrayUtil; |
||||
import com.soochowlife.web.framework.common.pojo.PageParam; |
||||
import com.soochowlife.web.framework.common.pojo.SortablePageParam; |
||||
import com.soochowlife.web.framework.common.pojo.SortingField; |
||||
import org.springframework.util.Assert; |
||||
|
||||
import static java.util.Collections.singletonList; |
||||
|
||||
/** |
||||
* {@link PageParam} 工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class PageUtils { |
||||
|
||||
private static final Object[] ORDER_TYPES = new String[]{SortingField.ORDER_ASC, SortingField.ORDER_DESC}; |
||||
|
||||
public static int getStart(PageParam pageParam) { |
||||
return (pageParam.getPageNo() - 1) * pageParam.getPageSize(); |
||||
} |
||||
|
||||
/** |
||||
* 构建排序字段（默认倒序） |
||||
* |
||||
* @param func 排序字段的 Lambda 表达式 |
||||
* @param <T> 排序字段所属的类型 |
||||
* @return 排序字段 |
||||
*/ |
||||
public static <T> SortingField buildSortingField(Func1<T, ?> func) { |
||||
return buildSortingField(func, SortingField.ORDER_DESC); |
||||
} |
||||
|
||||
/** |
||||
* 构建排序字段 |
||||
* |
||||
* @param func 排序字段的 Lambda 表达式 |
||||
* @param order 排序类型 {@link SortingField#ORDER_ASC} {@link SortingField#ORDER_DESC} |
||||
* @param <T> 排序字段所属的类型 |
||||
* @return 排序字段 |
||||
*/ |
||||
public static <T> SortingField buildSortingField(Func1<T, ?> func, String order) { |
||||
Assert.isTrue(ArrayUtil.contains(ORDER_TYPES, order), String.format("字段的排序类型只能是 %s/%s", ORDER_TYPES)); |
||||
|
||||
String fieldName = LambdaUtil.getFieldName(func); |
||||
return new SortingField(fieldName, order); |
||||
} |
||||
|
||||
/** |
||||
* 构建默认的排序字段 |
||||
* 如果排序字段为空，则设置排序字段；否则忽略 |
||||
* |
||||
* @param sortablePageParam 排序分页查询参数 |
||||
* @param func 排序字段的 Lambda 表达式 |
||||
* @param <T> 排序字段所属的类型 |
||||
*/ |
||||
public static <T> void buildDefaultSortingField(SortablePageParam sortablePageParam, Func1<T, ?> func) { |
||||
if (sortablePageParam != null && CollUtil.isEmpty(sortablePageParam.getSortingFields())) { |
||||
sortablePageParam.setSortingFields(singletonList(buildSortingField(func))); |
||||
} |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,7 @@ |
||||
/** |
||||
* 对于工具类的选择，优先查找 Hutool 中有没对应的方法 |
||||
* 如果没有，则自己封装对应的工具类，以 Utils 结尾，用于区分 |
||||
* |
||||
* ps：如果担心 Hutool 存在坑的问题，可以阅读 Hutool 的实现源码，以确保可靠性。并且，可以补充相关的单元测试。 |
||||
*/ |
||||
package com.soochowlife.web.framework.common.util; |
||||
@ -0,0 +1,105 @@ |
||||
package com.soochowlife.web.framework.common.util.servlet; |
||||
|
||||
import cn.hutool.core.util.StrUtil; |
||||
import cn.hutool.extra.servlet.JakartaServletUtil; |
||||
import com.soochowlife.web.framework.common.util.json.JsonUtils; |
||||
import jakarta.servlet.ServletRequest; |
||||
import jakarta.servlet.http.HttpServletRequest; |
||||
import jakarta.servlet.http.HttpServletResponse; |
||||
import org.springframework.http.MediaType; |
||||
import org.springframework.web.context.request.RequestAttributes; |
||||
import org.springframework.web.context.request.RequestContextHolder; |
||||
import org.springframework.web.context.request.ServletRequestAttributes; |
||||
|
||||
import java.util.Map; |
||||
|
||||
/** |
||||
* 客户端工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class ServletUtils { |
||||
|
||||
/** |
||||
* 返回 JSON 字符串 |
||||
* |
||||
* @param response 响应 |
||||
* @param object 对象，会序列化成 JSON 字符串 |
||||
*/ |
||||
@SuppressWarnings("deprecation") // 必须使用 APPLICATION_JSON_UTF8_VALUE，否则会乱码
|
||||
public static void writeJSON(HttpServletResponse response, Object object) { |
||||
String content = JsonUtils.toJsonString(object); |
||||
JakartaServletUtil.write(response, content, MediaType.APPLICATION_JSON_UTF8_VALUE); |
||||
} |
||||
|
||||
/** |
||||
* @param request 请求 |
||||
* @return ua |
||||
*/ |
||||
public static String getUserAgent(HttpServletRequest request) { |
||||
String ua = request.getHeader("User-Agent"); |
||||
return ua != null ? ua : ""; |
||||
} |
||||
|
||||
/** |
||||
* 获得请求 |
||||
* |
||||
* @return HttpServletRequest |
||||
*/ |
||||
public static HttpServletRequest getRequest() { |
||||
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes(); |
||||
if (!(requestAttributes instanceof ServletRequestAttributes)) { |
||||
return null; |
||||
} |
||||
return ((ServletRequestAttributes) requestAttributes).getRequest(); |
||||
} |
||||
|
||||
public static String getUserAgent() { |
||||
HttpServletRequest request = getRequest(); |
||||
if (request == null) { |
||||
return null; |
||||
} |
||||
return getUserAgent(request); |
||||
} |
||||
|
||||
public static String getClientIP() { |
||||
HttpServletRequest request = getRequest(); |
||||
if (request == null) { |
||||
return null; |
||||
} |
||||
return JakartaServletUtil.getClientIP(request); |
||||
} |
||||
|
||||
public static boolean isJsonRequest(ServletRequest request) { |
||||
return StrUtil.startWithIgnoreCase(request.getContentType(), MediaType.APPLICATION_JSON_VALUE); |
||||
} |
||||
|
||||
public static String getBody(HttpServletRequest request) { |
||||
// 只有在 json 请求在读取，因为只有 CacheRequestBodyFilter 才会进行缓存，支持重复读取
|
||||
if (isJsonRequest(request)) { |
||||
return JakartaServletUtil.getBody(request); |
||||
} |
||||
return null; |
||||
} |
||||
|
||||
public static byte[] getBodyBytes(HttpServletRequest request) { |
||||
// 只有在 json 请求在读取，因为只有 CacheRequestBodyFilter 才会进行缓存，支持重复读取
|
||||
if (isJsonRequest(request)) { |
||||
return JakartaServletUtil.getBodyBytes(request); |
||||
} |
||||
return null; |
||||
} |
||||
|
||||
public static String getClientIP(HttpServletRequest request) { |
||||
return JakartaServletUtil.getClientIP(request); |
||||
} |
||||
|
||||
public static Map<String, String> getParamMap(HttpServletRequest request) { |
||||
return JakartaServletUtil.getParamMap(request); |
||||
} |
||||
|
||||
public static Map<String, String> getHeaderMap(HttpServletRequest request) { |
||||
return JakartaServletUtil.getHeaderMap(request); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,123 @@ |
||||
package com.soochowlife.web.framework.common.util.spring; |
||||
|
||||
import cn.hutool.core.collection.CollUtil; |
||||
import cn.hutool.core.map.MapUtil; |
||||
import cn.hutool.core.util.ArrayUtil; |
||||
import cn.hutool.core.util.StrUtil; |
||||
import cn.hutool.extra.spring.SpringUtil; |
||||
import org.aspectj.lang.JoinPoint; |
||||
import org.aspectj.lang.reflect.MethodSignature; |
||||
import org.springframework.context.expression.BeanFactoryResolver; |
||||
import org.springframework.core.DefaultParameterNameDiscoverer; |
||||
import org.springframework.core.ParameterNameDiscoverer; |
||||
import org.springframework.expression.EvaluationContext; |
||||
import org.springframework.expression.Expression; |
||||
import org.springframework.expression.ExpressionParser; |
||||
import org.springframework.expression.spel.standard.SpelExpressionParser; |
||||
import org.springframework.expression.spel.support.StandardEvaluationContext; |
||||
|
||||
import java.lang.reflect.Method; |
||||
import java.util.Collections; |
||||
import java.util.List; |
||||
import java.util.Map; |
||||
|
||||
/** |
||||
* Spring EL 表达式的工具类 |
||||
* |
||||
* @author mashu |
||||
*/ |
||||
public class SpringExpressionUtils { |
||||
|
||||
/** |
||||
* Spring EL 表达式解析器 |
||||
*/ |
||||
private static final ExpressionParser EXPRESSION_PARSER = new SpelExpressionParser(); |
||||
/** |
||||
* 参数名发现器 |
||||
*/ |
||||
private static final ParameterNameDiscoverer PARAMETER_NAME_DISCOVERER = new DefaultParameterNameDiscoverer(); |
||||
|
||||
private SpringExpressionUtils() { |
||||
} |
||||
|
||||
/** |
||||
* 从切面中，单个解析 EL 表达式的结果 |
||||
* |
||||
* @param joinPoint 切面点 |
||||
* @param expressionString EL 表达式数组 |
||||
* @return 执行界面 |
||||
*/ |
||||
public static Object parseExpression(JoinPoint joinPoint, String expressionString) { |
||||
Map<String, Object> result = parseExpressions(joinPoint, Collections.singletonList(expressionString)); |
||||
return result.get(expressionString); |
||||
} |
||||
|
||||
/** |
||||
* 从切面中，批量解析 EL 表达式的结果 |
||||
* |
||||
* @param joinPoint 切面点 |
||||
* @param expressionStrings EL 表达式数组 |
||||
* @return 结果，key 为表达式，value 为对应值 |
||||
*/ |
||||
public static Map<String, Object> parseExpressions(JoinPoint joinPoint, List<String> expressionStrings) { |
||||
// 如果为空，则不进行解析
|
||||
if (CollUtil.isEmpty(expressionStrings)) { |
||||
return MapUtil.newHashMap(); |
||||
} |
||||
|
||||
// 第一步，构建解析的上下文 EvaluationContext
|
||||
// 通过 joinPoint 获取被注解方法
|
||||
MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature(); |
||||
Method method = methodSignature.getMethod(); |
||||
// 使用 spring 的 ParameterNameDiscoverer 获取方法形参名数组
|
||||
String[] paramNames = PARAMETER_NAME_DISCOVERER.getParameterNames(method); |
||||
// Spring 的表达式上下文对象
|
||||
EvaluationContext context = new StandardEvaluationContext(); |
||||
// 给上下文赋值
|
||||
if (ArrayUtil.isNotEmpty(paramNames)) { |
||||
Object[] args = joinPoint.getArgs(); |
||||
for (int i = 0; i < paramNames.length; i++) { |
||||
context.setVariable(paramNames[i], args[i]); |
||||
} |
||||
} |
||||
|
||||
// 第二步，逐个参数解析
|
||||
Map<String, Object> result = MapUtil.newHashMap(expressionStrings.size(), true); |
||||
expressionStrings.forEach(key -> { |
||||
Object value = EXPRESSION_PARSER.parseExpression(key).getValue(context); |
||||
result.put(key, value); |
||||
}); |
||||
return result; |
||||
} |
||||
|
||||
/** |
||||
* 从 Bean 工厂，解析 EL 表达式的结果 |
||||
* |
||||
* @param expressionString EL 表达式 |
||||
* @return 执行界面 |
||||
*/ |
||||
public static Object parseExpression(String expressionString) { |
||||
return parseExpression(expressionString, null); |
||||
} |
||||
|
||||
/** |
||||
* 从 Bean 工厂，解析 EL 表达式的结果 |
||||
* |
||||
* @param expressionString EL 表达式 |
||||
* @param variables 变量 |
||||
* @return 执行界面 |
||||
*/ |
||||
public static Object parseExpression(String expressionString, Map<String, Object> variables) { |
||||
if (StrUtil.isBlank(expressionString)) { |
||||
return null; |
||||
} |
||||
Expression expression = EXPRESSION_PARSER.parseExpression(expressionString); |
||||
StandardEvaluationContext context = new StandardEvaluationContext(); |
||||
context.setBeanResolver(new BeanFactoryResolver(SpringUtil.getApplicationContext())); |
||||
if (MapUtil.isNotEmpty(variables)) { |
||||
context.setVariables(variables); |
||||
} |
||||
return expression.getValue(context); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,24 @@ |
||||
package com.soochowlife.web.framework.common.util.spring; |
||||
|
||||
import cn.hutool.extra.spring.SpringUtil; |
||||
|
||||
import java.util.Objects; |
||||
|
||||
/** |
||||
* Spring 工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class SpringUtils extends SpringUtil { |
||||
|
||||
/** |
||||
* 是否为生产环境 |
||||
* |
||||
* @return 是否生产环境 |
||||
*/ |
||||
public static boolean isProd() { |
||||
String activeProfile = getActiveProfile(); |
||||
return Objects.equals("prod", activeProfile); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,107 @@ |
||||
package com.soochowlife.web.framework.common.util.string; |
||||
|
||||
import cn.hutool.core.text.StrPool; |
||||
import cn.hutool.core.util.ArrayUtil; |
||||
import cn.hutool.core.util.StrUtil; |
||||
import org.aspectj.lang.JoinPoint; |
||||
|
||||
import java.util.Arrays; |
||||
import java.util.Collection; |
||||
import java.util.List; |
||||
import java.util.Set; |
||||
import java.util.stream.Collectors; |
||||
|
||||
/** |
||||
* 字符串工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class StrUtils { |
||||
|
||||
public static String maxLength(CharSequence str, int maxLength) { |
||||
return StrUtil.maxLength(str, maxLength - 3); // -3 的原因，是该方法会补充 ... 恰好
|
||||
} |
||||
|
||||
/** |
||||
* 给定字符串是否以任何一个字符串开始 |
||||
* 给定字符串和数组为空都返回 false |
||||
* |
||||
* @param str 给定字符串 |
||||
* @param prefixes 需要检测的开始字符串 |
||||
* @since 3.0.6 |
||||
*/ |
||||
public static boolean startWithAny(String str, Collection<String> prefixes) { |
||||
if (StrUtil.isEmpty(str) || ArrayUtil.isEmpty(prefixes)) { |
||||
return false; |
||||
} |
||||
|
||||
for (CharSequence suffix : prefixes) { |
||||
if (StrUtil.startWith(str, suffix, false)) { |
||||
return true; |
||||
} |
||||
} |
||||
return false; |
||||
} |
||||
|
||||
public static List<Long> splitToLong(String value, CharSequence separator) { |
||||
long[] longs = StrUtil.splitToLong(value, separator); |
||||
return Arrays.stream(longs).boxed().collect(Collectors.toList()); |
||||
} |
||||
|
||||
public static Set<Long> splitToLongSet(String value) { |
||||
return splitToLongSet(value, StrPool.COMMA); |
||||
} |
||||
|
||||
public static Set<Long> splitToLongSet(String value, CharSequence separator) { |
||||
long[] longs = StrUtil.splitToLong(value, separator); |
||||
return Arrays.stream(longs).boxed().collect(Collectors.toSet()); |
||||
} |
||||
|
||||
public static List<Integer> splitToInteger(String value, CharSequence separator) { |
||||
int[] integers = StrUtil.splitToInt(value, separator); |
||||
return Arrays.stream(integers).boxed().collect(Collectors.toList()); |
||||
} |
||||
|
||||
/** |
||||
* 移除字符串中，包含指定字符串的行 |
||||
* |
||||
* @param content 字符串 |
||||
* @param sequence 包含的字符串 |
||||
* @return 移除后的字符串 |
||||
*/ |
||||
public static String removeLineContains(String content, String sequence) { |
||||
if (StrUtil.isEmpty(content) || StrUtil.isEmpty(sequence)) { |
||||
return content; |
||||
} |
||||
return Arrays.stream(content.split("\n")) |
||||
.filter(line -> !line.contains(sequence)) |
||||
.collect(Collectors.joining("\n")); |
||||
} |
||||
|
||||
/** |
||||
* 拼接方法的参数 |
||||
* |
||||
* 特殊：排除一些无法序列化的参数，如 ServletRequest、ServletResponse、MultipartFile |
||||
* |
||||
* @param joinPoint 连接点 |
||||
* @return 拼接后的参数 |
||||
*/ |
||||
public static String joinMethodArgs(JoinPoint joinPoint) { |
||||
Object[] args = joinPoint.getArgs(); |
||||
if (ArrayUtil.isEmpty(args)) { |
||||
return ""; |
||||
} |
||||
return ArrayUtil.join(args, ",", item -> { |
||||
if (item == null) { |
||||
return ""; |
||||
} |
||||
// 讨论可见：https://t.zsxq.com/XUJVk、https://t.zsxq.com/MnKcL
|
||||
String clazzName = item.getClass().getName(); |
||||
if (StrUtil.startWithAny(clazzName, "javax.servlet", "jakarta.servlet", "org.springframework.web")) { |
||||
return ""; |
||||
} |
||||
return item; |
||||
}); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,55 @@ |
||||
package com.soochowlife.web.framework.common.util.validation; |
||||
|
||||
import cn.hutool.core.collection.CollUtil; |
||||
import cn.hutool.core.lang.Assert; |
||||
import org.springframework.util.StringUtils; |
||||
|
||||
import jakarta.validation.ConstraintViolation; |
||||
import jakarta.validation.ConstraintViolationException; |
||||
import jakarta.validation.Validation; |
||||
import jakarta.validation.Validator; |
||||
import java.util.Set; |
||||
import java.util.regex.Pattern; |
||||
|
||||
/** |
||||
* 校验工具类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class ValidationUtils { |
||||
|
||||
private static final Pattern PATTERN_MOBILE = Pattern.compile("^(?:(?:\\+|00)86)?1(?:(?:3[\\d])|(?:4[0,1,4-9])|(?:5[0-3,5-9])|(?:6[2,5-7])|(?:7[0-8])|(?:8[\\d])|(?:9[0-3,5-9]))\\d{8}$"); |
||||
|
||||
private static final Pattern PATTERN_URL = Pattern.compile("^(https?|ftp|file)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"); |
||||
|
||||
private static final Pattern PATTERN_XML_NCNAME = Pattern.compile("[a-zA-Z_][\\-_.0-9_a-zA-Z$]*"); |
||||
|
||||
public static boolean isMobile(String mobile) { |
||||
return StringUtils.hasText(mobile) |
||||
&& PATTERN_MOBILE.matcher(mobile).matches(); |
||||
} |
||||
|
||||
public static boolean isURL(String url) { |
||||
return StringUtils.hasText(url) |
||||
&& PATTERN_URL.matcher(url).matches(); |
||||
} |
||||
|
||||
public static boolean isXmlNCName(String str) { |
||||
return StringUtils.hasText(str) |
||||
&& PATTERN_XML_NCNAME.matcher(str).matches(); |
||||
} |
||||
|
||||
public static void validate(Object object, Class<?>... groups) { |
||||
Validator validator = Validation.buildDefaultValidatorFactory().getValidator(); |
||||
Assert.notNull(validator); |
||||
validate(validator, object, groups); |
||||
} |
||||
|
||||
public static void validate(Validator validator, Object object, Class<?>... groups) { |
||||
Set<ConstraintViolation<Object>> constraintViolations = validator.validate(object, groups); |
||||
if (CollUtil.isNotEmpty(constraintViolations)) { |
||||
throw new ConstraintViolationException(constraintViolations); |
||||
} |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,35 @@ |
||||
package com.soochowlife.web.framework.common.validation; |
||||
|
||||
import com.soochowlife.web.framework.common.core.ArrayValuable; |
||||
import jakarta.validation.Constraint; |
||||
import jakarta.validation.Payload; |
||||
|
||||
import java.lang.annotation.*; |
||||
|
||||
@Target({ |
||||
ElementType.METHOD, |
||||
ElementType.FIELD, |
||||
ElementType.ANNOTATION_TYPE, |
||||
ElementType.CONSTRUCTOR, |
||||
ElementType.PARAMETER, |
||||
ElementType.TYPE_USE |
||||
}) |
||||
@Retention(RetentionPolicy.RUNTIME) |
||||
@Documented |
||||
@Constraint( |
||||
validatedBy = {InEnumValidator.class, InEnumCollectionValidator.class} |
||||
) |
||||
public @interface InEnum { |
||||
|
||||
/** |
||||
* @return 实现 ArrayValuable 接口的类 |
||||
*/ |
||||
Class<? extends ArrayValuable<?>> value(); |
||||
|
||||
String message() default "必须在指定范围 {value}"; |
||||
|
||||
Class<?>[] groups() default {}; |
||||
|
||||
Class<? extends Payload>[] payload() default {}; |
||||
|
||||
} |
||||
@ -0,0 +1,44 @@ |
||||
package com.soochowlife.web.framework.common.validation; |
||||
|
||||
import cn.hutool.core.collection.CollUtil; |
||||
import com.soochowlife.web.framework.common.core.ArrayValuable; |
||||
import jakarta.validation.ConstraintValidator; |
||||
import jakarta.validation.ConstraintValidatorContext; |
||||
|
||||
import java.util.Arrays; |
||||
import java.util.Collection; |
||||
import java.util.Collections; |
||||
import java.util.List; |
||||
|
||||
public class InEnumCollectionValidator implements ConstraintValidator<InEnum, Collection<?>> { |
||||
|
||||
private List<?> values; |
||||
|
||||
@Override |
||||
public void initialize(InEnum annotation) { |
||||
ArrayValuable<?>[] values = annotation.value().getEnumConstants(); |
||||
if (values.length == 0) { |
||||
this.values = Collections.emptyList(); |
||||
} else { |
||||
this.values = Arrays.asList(values[0].array()); |
||||
} |
||||
} |
||||
|
||||
@Override |
||||
public boolean isValid(Collection<?> list, ConstraintValidatorContext context) { |
||||
if (list == null) { |
||||
return true; |
||||
} |
||||
// 校验通过
|
||||
if (CollUtil.containsAll(values, list)) { |
||||
return true; |
||||
} |
||||
// 校验不通过，自定义提示语句
|
||||
context.disableDefaultConstraintViolation(); // 禁用默认的 message 的值
|
||||
context.buildConstraintViolationWithTemplate(context.getDefaultConstraintMessageTemplate() |
||||
.replaceAll("\\{value}", CollUtil.join(list, ","))).addConstraintViolation(); // 重新添加错误提示语句
|
||||
return false; |
||||
} |
||||
|
||||
} |
||||
|
||||
@ -0,0 +1,43 @@ |
||||
package com.soochowlife.web.framework.common.validation; |
||||
|
||||
import com.soochowlife.web.framework.common.core.ArrayValuable; |
||||
import jakarta.validation.ConstraintValidator; |
||||
import jakarta.validation.ConstraintValidatorContext; |
||||
|
||||
import java.util.Arrays; |
||||
import java.util.Collections; |
||||
import java.util.List; |
||||
|
||||
public class InEnumValidator implements ConstraintValidator<InEnum, Object> { |
||||
|
||||
private List<?> values; |
||||
|
||||
@Override |
||||
public void initialize(InEnum annotation) { |
||||
ArrayValuable<?>[] values = annotation.value().getEnumConstants(); |
||||
if (values.length == 0) { |
||||
this.values = Collections.emptyList(); |
||||
} else { |
||||
this.values = Arrays.asList(values[0].array()); |
||||
} |
||||
} |
||||
|
||||
@Override |
||||
public boolean isValid(Object value, ConstraintValidatorContext context) { |
||||
// 为空时，默认不校验，即认为通过
|
||||
if (value == null) { |
||||
return true; |
||||
} |
||||
// 校验通过
|
||||
if (values.contains(value)) { |
||||
return true; |
||||
} |
||||
// 校验不通过，自定义提示语句
|
||||
context.disableDefaultConstraintViolation(); // 禁用默认的 message 的值
|
||||
context.buildConstraintViolationWithTemplate(context.getDefaultConstraintMessageTemplate() |
||||
.replaceAll("\\{value}", values.toString())).addConstraintViolation(); // 重新添加错误提示语句
|
||||
return false; |
||||
} |
||||
|
||||
} |
||||
|
||||
@ -0,0 +1,28 @@ |
||||
package com.soochowlife.web.framework.common.validation; |
||||
|
||||
import jakarta.validation.Constraint; |
||||
import jakarta.validation.Payload; |
||||
import java.lang.annotation.*; |
||||
|
||||
@Target({ |
||||
ElementType.METHOD, |
||||
ElementType.FIELD, |
||||
ElementType.ANNOTATION_TYPE, |
||||
ElementType.CONSTRUCTOR, |
||||
ElementType.PARAMETER, |
||||
ElementType.TYPE_USE |
||||
}) |
||||
@Retention(RetentionPolicy.RUNTIME) |
||||
@Documented |
||||
@Constraint( |
||||
validatedBy = MobileValidator.class |
||||
) |
||||
public @interface Mobile { |
||||
|
||||
String message() default "手机号格式不正确"; |
||||
|
||||
Class<?>[] groups() default {}; |
||||
|
||||
Class<? extends Payload>[] payload() default {}; |
||||
|
||||
} |
||||
@ -0,0 +1,25 @@ |
||||
package com.soochowlife.web.framework.common.validation; |
||||
|
||||
import cn.hutool.core.util.StrUtil; |
||||
import com.soochowlife.web.framework.common.util.validation.ValidationUtils; |
||||
|
||||
import jakarta.validation.ConstraintValidator; |
||||
import jakarta.validation.ConstraintValidatorContext; |
||||
|
||||
public class MobileValidator implements ConstraintValidator<Mobile, String> { |
||||
|
||||
@Override |
||||
public void initialize(Mobile annotation) { |
||||
} |
||||
|
||||
@Override |
||||
public boolean isValid(String value, ConstraintValidatorContext context) { |
||||
// 如果手机号为空，默认不校验，即校验通过
|
||||
if (StrUtil.isEmpty(value)) { |
||||
return true; |
||||
} |
||||
// 校验手机
|
||||
return ValidationUtils.isMobile(value); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,28 @@ |
||||
package com.soochowlife.web.framework.common.validation; |
||||
|
||||
import jakarta.validation.Constraint; |
||||
import jakarta.validation.Payload; |
||||
import java.lang.annotation.*; |
||||
|
||||
@Target({ |
||||
ElementType.METHOD, |
||||
ElementType.FIELD, |
||||
ElementType.ANNOTATION_TYPE, |
||||
ElementType.CONSTRUCTOR, |
||||
ElementType.PARAMETER, |
||||
ElementType.TYPE_USE |
||||
}) |
||||
@Retention(RetentionPolicy.RUNTIME) |
||||
@Documented |
||||
@Constraint( |
||||
validatedBy = TelephoneValidator.class |
||||
) |
||||
public @interface Telephone { |
||||
|
||||
String message() default "电话格式不正确"; |
||||
|
||||
Class<?>[] groups() default {}; |
||||
|
||||
Class<? extends Payload>[] payload() default {}; |
||||
|
||||
} |
||||
@ -0,0 +1,25 @@ |
||||
package com.soochowlife.web.framework.common.validation; |
||||
|
||||
import cn.hutool.core.text.CharSequenceUtil; |
||||
import cn.hutool.core.util.PhoneUtil; |
||||
|
||||
import jakarta.validation.ConstraintValidator; |
||||
import jakarta.validation.ConstraintValidatorContext; |
||||
|
||||
public class TelephoneValidator implements ConstraintValidator<Telephone, String> { |
||||
|
||||
@Override |
||||
public void initialize(Telephone annotation) { |
||||
} |
||||
|
||||
@Override |
||||
public boolean isValid(String value, ConstraintValidatorContext context) { |
||||
// 如果手机号为空，默认不校验，即校验通过
|
||||
if (CharSequenceUtil.isEmpty(value)) { |
||||
return true; |
||||
} |
||||
// 校验手机
|
||||
return PhoneUtil.isTel(value) || PhoneUtil.isPhone(value); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,4 @@ |
||||
/** |
||||
* 使用 Hibernate Validator 实现参数校验 |
||||
*/ |
||||
package com.soochowlife.web.framework.common.validation; |
||||
@ -0,0 +1,38 @@ |
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" |
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> |
||||
<parent> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-framework</artifactId> |
||||
<version>${revision}</version> |
||||
</parent> |
||||
<modelVersion>4.0.0</modelVersion> |
||||
<artifactId>soochowlife-spring-boot-starter-biz-data-permission</artifactId> |
||||
<packaging>jar</packaging> |
||||
|
||||
<name>${project.artifactId}</name> |
||||
<description>数据权限</description> |
||||
<url>https://github.com/YunaiV/ruoyi-vue-pro</url> |
||||
|
||||
<dependencies> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-common</artifactId> |
||||
</dependency> |
||||
|
||||
<!-- Web 相关 --> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-security</artifactId> |
||||
<optional>true</optional> <!-- 可选，如果使用 DeptDataPermissionRule 必须提供 --> |
||||
</dependency> |
||||
|
||||
<!-- DB 相关 --> |
||||
<dependency> |
||||
<groupId>com.soochowlife.boot</groupId> |
||||
<artifactId>soochowlife-spring-boot-starter-mybatis</artifactId> |
||||
</dependency> |
||||
</dependencies> |
||||
|
||||
</project> |
||||
@ -0,0 +1,46 @@ |
||||
package com.soochowlife.web.framework.datapermission.config; |
||||
|
||||
import com.soochowlife.web.framework.datapermission.core.aop.DataPermissionAnnotationAdvisor; |
||||
import com.soochowlife.web.framework.datapermission.core.db.DataPermissionRuleHandler; |
||||
import com.soochowlife.web.framework.datapermission.core.rule.DataPermissionRule; |
||||
import com.soochowlife.web.framework.datapermission.core.rule.DataPermissionRuleFactory; |
||||
import com.soochowlife.web.framework.datapermission.core.rule.DataPermissionRuleFactoryImpl; |
||||
import com.soochowlife.web.framework.mybatis.core.util.MyBatisUtils; |
||||
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor; |
||||
import com.baomidou.mybatisplus.extension.plugins.inner.DataPermissionInterceptor; |
||||
import org.springframework.boot.autoconfigure.AutoConfiguration; |
||||
import org.springframework.context.annotation.Bean; |
||||
|
||||
import java.util.List; |
||||
|
||||
/** |
||||
* 数据权限的自动配置类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@AutoConfiguration |
||||
public class SoochowlifeDataPermissionAutoConfiguration { |
||||
|
||||
@Bean |
||||
public DataPermissionRuleFactory dataPermissionRuleFactory(List<DataPermissionRule> rules) { |
||||
return new DataPermissionRuleFactoryImpl(rules); |
||||
} |
||||
|
||||
@Bean |
||||
public DataPermissionRuleHandler dataPermissionRuleHandler(MybatisPlusInterceptor interceptor, |
||||
DataPermissionRuleFactory ruleFactory) { |
||||
// 创建 DataPermissionInterceptor 拦截器
|
||||
DataPermissionRuleHandler handler = new DataPermissionRuleHandler(ruleFactory); |
||||
DataPermissionInterceptor inner = new DataPermissionInterceptor(handler); |
||||
// 添加到 interceptor 中
|
||||
// 需要加在首个，主要是为了在分页插件前面。这个是 MyBatis Plus 的规定
|
||||
MyBatisUtils.addInterceptor(interceptor, inner, 0); |
||||
return handler; |
||||
} |
||||
|
||||
@Bean |
||||
public DataPermissionAnnotationAdvisor dataPermissionAnnotationAdvisor() { |
||||
return new DataPermissionAnnotationAdvisor(); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,34 @@ |
||||
package com.soochowlife.web.framework.datapermission.config; |
||||
|
||||
import com.soochowlife.web.framework.common.biz.system.permission.PermissionCommonApi; |
||||
import com.soochowlife.web.framework.datapermission.core.rule.dept.DeptDataPermissionRule; |
||||
import com.soochowlife.web.framework.datapermission.core.rule.dept.DeptDataPermissionRuleCustomizer; |
||||
import com.soochowlife.web.framework.security.core.LoginUser; |
||||
import org.springframework.boot.autoconfigure.AutoConfiguration; |
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; |
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; |
||||
import org.springframework.context.annotation.Bean; |
||||
|
||||
import java.util.List; |
||||
|
||||
/** |
||||
* 基于部门的数据权限 AutoConfiguration |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@AutoConfiguration |
||||
@ConditionalOnClass(LoginUser.class) |
||||
@ConditionalOnBean(value = {PermissionCommonApi.class, DeptDataPermissionRuleCustomizer.class}) |
||||
public class SoochowlifeDeptDataPermissionAutoConfiguration { |
||||
|
||||
@Bean |
||||
public DeptDataPermissionRule deptDataPermissionRule(PermissionCommonApi permissionApi, |
||||
List<DeptDataPermissionRuleCustomizer> customizers) { |
||||
// 创建 DeptDataPermissionRule 对象
|
||||
DeptDataPermissionRule rule = new DeptDataPermissionRule(permissionApi); |
||||
// 补全表配置
|
||||
customizers.forEach(customizer -> customizer.customize(rule)); |
||||
return rule; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,35 @@ |
||||
package com.soochowlife.web.framework.datapermission.core.annotation; |
||||
|
||||
import com.soochowlife.web.framework.datapermission.core.rule.DataPermissionRule; |
||||
|
||||
import java.lang.annotation.*; |
||||
|
||||
/** |
||||
* 数据权限注解 |
||||
* 可声明在类或者方法上，标识使用的数据权限规则 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Target({ElementType.TYPE, ElementType.METHOD}) |
||||
@Retention(RetentionPolicy.RUNTIME) |
||||
@Documented |
||||
public @interface DataPermission { |
||||
|
||||
/** |
||||
* 当前类或方法是否开启数据权限 |
||||
* 即使不添加 @DataPermission 注解，默认是开启状态 |
||||
* 可通过设置 enable 为 false 禁用 |
||||
*/ |
||||
boolean enable() default true; |
||||
|
||||
/** |
||||
* 生效的数据权限规则数组，优先级高于 {@link #excludeRules()} |
||||
*/ |
||||
Class<? extends DataPermissionRule>[] includeRules() default {}; |
||||
|
||||
/** |
||||
* 排除的数据权限规则数组，优先级最低 |
||||
*/ |
||||
Class<? extends DataPermissionRule>[] excludeRules() default {}; |
||||
|
||||
} |
||||
@ -0,0 +1,36 @@ |
||||
package com.soochowlife.web.framework.datapermission.core.aop; |
||||
|
||||
import com.soochowlife.web.framework.datapermission.core.annotation.DataPermission; |
||||
import lombok.EqualsAndHashCode; |
||||
import lombok.Getter; |
||||
import org.aopalliance.aop.Advice; |
||||
import org.springframework.aop.Pointcut; |
||||
import org.springframework.aop.support.AbstractPointcutAdvisor; |
||||
import org.springframework.aop.support.ComposablePointcut; |
||||
import org.springframework.aop.support.annotation.AnnotationMatchingPointcut; |
||||
|
||||
/** |
||||
* {@link DataPermission} 注解的 Advisor 实现类 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@Getter |
||||
@EqualsAndHashCode(callSuper = true) |
||||
public class DataPermissionAnnotationAdvisor extends AbstractPointcutAdvisor { |
||||
|
||||
private final Advice advice; |
||||
|
||||
private final Pointcut pointcut; |
||||
|
||||
public DataPermissionAnnotationAdvisor() { |
||||
this.advice = new DataPermissionAnnotationInterceptor(); |
||||
this.pointcut = this.buildPointcut(); |
||||
} |
||||
|
||||
protected Pointcut buildPointcut() { |
||||
Pointcut classPointcut = new AnnotationMatchingPointcut(DataPermission.class, true); |
||||
Pointcut methodPointcut = new AnnotationMatchingPointcut(null, DataPermission.class, true); |
||||
return new ComposablePointcut(classPointcut).union(methodPointcut); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,72 @@ |
||||
package com.soochowlife.web.framework.datapermission.core.aop; |
||||
|
||||
import com.soochowlife.web.framework.datapermission.core.annotation.DataPermission; |
||||
import lombok.Getter; |
||||
import org.aopalliance.intercept.MethodInterceptor; |
||||
import org.aopalliance.intercept.MethodInvocation; |
||||
import org.springframework.core.MethodClassKey; |
||||
import org.springframework.core.annotation.AnnotationUtils; |
||||
|
||||
import java.lang.reflect.Method; |
||||
import java.util.Map; |
||||
import java.util.concurrent.ConcurrentHashMap; |
||||
|
||||
/** |
||||
* {@link DataPermission} 注解的拦截器 |
||||
* 1. 在执行方法前，将 @DataPermission 注解入栈 |
||||
* 2. 在执行方法后，将 @DataPermission 注解出栈 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@DataPermission // 该注解，用于 {@link DATA_PERMISSION_NULL} 的空对象
|
||||
public class DataPermissionAnnotationInterceptor implements MethodInterceptor { |
||||
|
||||
/** |
||||
* DataPermission 空对象，用于方法无 {@link DataPermission} 注解时，使用 DATA_PERMISSION_NULL 进行占位 |
||||
*/ |
||||
static final DataPermission DATA_PERMISSION_NULL = DataPermissionAnnotationInterceptor.class.getAnnotation(DataPermission.class); |
||||
|
||||
@Getter |
||||
private final Map<MethodClassKey, DataPermission> dataPermissionCache = new ConcurrentHashMap<>(); |
||||
|
||||
@Override |
||||
public Object invoke(MethodInvocation methodInvocation) throws Throwable { |
||||
// 入栈
|
||||
DataPermission dataPermission = this.findAnnotation(methodInvocation); |
||||
if (dataPermission != null) { |
||||
DataPermissionContextHolder.add(dataPermission); |
||||
} |
||||
try { |
||||
// 执行逻辑
|
||||
return methodInvocation.proceed(); |
||||
} finally { |
||||
// 出栈
|
||||
if (dataPermission != null) { |
||||
DataPermissionContextHolder.remove(); |
||||
} |
||||
} |
||||
} |
||||
|
||||
private DataPermission findAnnotation(MethodInvocation methodInvocation) { |
||||
// 1. 从缓存中获取
|
||||
Method method = methodInvocation.getMethod(); |
||||
Object targetObject = methodInvocation.getThis(); |
||||
Class<?> clazz = targetObject != null ? targetObject.getClass() : method.getDeclaringClass(); |
||||
MethodClassKey methodClassKey = new MethodClassKey(method, clazz); |
||||
DataPermission dataPermission = dataPermissionCache.get(methodClassKey); |
||||
if (dataPermission != null) { |
||||
return dataPermission != DATA_PERMISSION_NULL ? dataPermission : null; |
||||
} |
||||
|
||||
// 2.1 从方法中获取
|
||||
dataPermission = AnnotationUtils.findAnnotation(method, DataPermission.class); |
||||
// 2.2 从类上获取
|
||||
if (dataPermission == null) { |
||||
dataPermission = AnnotationUtils.findAnnotation(clazz, DataPermission.class); |
||||
} |
||||
// 2.3 添加到缓存中
|
||||
dataPermissionCache.put(methodClassKey, dataPermission != null ? dataPermission : DATA_PERMISSION_NULL); |
||||
return dataPermission; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,72 @@ |
||||
package com.soochowlife.web.framework.datapermission.core.aop; |
||||
|
||||
import com.soochowlife.web.framework.datapermission.core.annotation.DataPermission; |
||||
import com.alibaba.ttl.TransmittableThreadLocal; |
||||
|
||||
import java.util.LinkedList; |
||||
import java.util.List; |
||||
|
||||
/** |
||||
* {@link DataPermission} 注解的 Context 上下文 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public class DataPermissionContextHolder { |
||||
|
||||
/** |
||||
* 使用 List 的原因，可能存在方法的嵌套调用 |
||||
*/ |
||||
private static final ThreadLocal<LinkedList<DataPermission>> DATA_PERMISSIONS = |
||||
TransmittableThreadLocal.withInitial(LinkedList::new); |
||||
|
||||
/** |
||||
* 获得当前的 DataPermission 注解 |
||||
* |
||||
* @return DataPermission 注解 |
||||
*/ |
||||
public static DataPermission get() { |
||||
return DATA_PERMISSIONS.get().peekLast(); |
||||
} |
||||
|
||||
/** |
||||
* 入栈 DataPermission 注解 |
||||
* |
||||
* @param dataPermission DataPermission 注解 |
||||
*/ |
||||
public static void add(DataPermission dataPermission) { |
||||
DATA_PERMISSIONS.get().addLast(dataPermission); |
||||
} |
||||
|
||||
/** |
||||
* 出栈 DataPermission 注解 |
||||
* |
||||
* @return DataPermission 注解 |
||||
*/ |
||||
public static DataPermission remove() { |
||||
DataPermission dataPermission = DATA_PERMISSIONS.get().removeLast(); |
||||
// 无元素时，清空 ThreadLocal
|
||||
if (DATA_PERMISSIONS.get().isEmpty()) { |
||||
DATA_PERMISSIONS.remove(); |
||||
} |
||||
return dataPermission; |
||||
} |
||||
|
||||
/** |
||||
* 获得所有 DataPermission |
||||
* |
||||
* @return DataPermission 队列 |
||||
*/ |
||||
public static List<DataPermission> getAll() { |
||||
return DATA_PERMISSIONS.get(); |
||||
} |
||||
|
||||
/** |
||||
* 清空上下文 |
||||
* |
||||
* 目前仅仅用于单测 |
||||
*/ |
||||
public static void clear() { |
||||
DATA_PERMISSIONS.remove(); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,63 @@ |
||||
package com.soochowlife.web.framework.datapermission.core.db; |
||||
|
||||
import cn.hutool.core.collection.CollUtil; |
||||
import com.soochowlife.web.framework.datapermission.core.rule.DataPermissionRule; |
||||
import com.soochowlife.web.framework.datapermission.core.rule.DataPermissionRuleFactory; |
||||
import com.soochowlife.web.framework.mybatis.core.util.MyBatisUtils; |
||||
import com.baomidou.mybatisplus.extension.plugins.handler.MultiDataPermissionHandler; |
||||
import com.soochowlife.web.framework.security.core.util.SecurityFrameworkUtils; |
||||
import lombok.RequiredArgsConstructor; |
||||
import net.sf.jsqlparser.expression.Expression; |
||||
import net.sf.jsqlparser.expression.operators.conditional.AndExpression; |
||||
import net.sf.jsqlparser.schema.Table; |
||||
|
||||
import java.util.List; |
||||
|
||||
/** |
||||
* 基于 {@link DataPermissionRule} 的数据权限处理器 |
||||
* |
||||
* 它的底层，是基于 MyBatis Plus 的 <a href="https://baomidou.com/plugins/data-permission/">数据权限插件</a> |
||||
* 核心原理：它会在 SQL 执行前拦截 SQL 语句，并根据用户权限动态添加权限相关的 SQL 片段。这样，只有用户有权限访问的数据才会被查询出来 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
@RequiredArgsConstructor |
||||
public class DataPermissionRuleHandler implements MultiDataPermissionHandler { |
||||
|
||||
private final DataPermissionRuleFactory ruleFactory; |
||||
|
||||
@Override |
||||
public Expression getSqlSegment(Table table, Expression where, String mappedStatementId) { |
||||
// 特殊：跨租户访问
|
||||
if (SecurityFrameworkUtils.skipPermissionCheck()) { |
||||
return null; |
||||
} |
||||
|
||||
// 获得 Mapper 对应的数据权限的规则
|
||||
List<DataPermissionRule> rules = ruleFactory.getDataPermissionRule(mappedStatementId); |
||||
if (CollUtil.isEmpty(rules)) { |
||||
return null; |
||||
} |
||||
|
||||
// 生成条件
|
||||
Expression allExpression = null; |
||||
for (DataPermissionRule rule : rules) { |
||||
// 判断表名是否匹配
|
||||
String tableName = MyBatisUtils.getTableName(table); |
||||
if (!rule.getTableNames().contains(tableName)) { |
||||
continue; |
||||
} |
||||
|
||||
// 单条规则的条件
|
||||
Expression oneExpress = rule.getExpression(tableName, table.getAlias()); |
||||
if (oneExpress == null) { |
||||
continue; |
||||
} |
||||
// 拼接到 allExpression 中
|
||||
allExpression = allExpression == null ? oneExpress |
||||
: new AndExpression(allExpression, oneExpress); |
||||
} |
||||
return allExpression; |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,36 @@ |
||||
package com.soochowlife.web.framework.datapermission.core.rule; |
||||
|
||||
import com.baomidou.mybatisplus.core.metadata.TableInfoHelper; |
||||
import net.sf.jsqlparser.expression.Alias; |
||||
import net.sf.jsqlparser.expression.Expression; |
||||
|
||||
import java.util.Set; |
||||
|
||||
/** |
||||
* 数据权限规则接口 |
||||
* 通过实现接口，自定义数据规则。例如说， |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface DataPermissionRule { |
||||
|
||||
/** |
||||
* 返回需要生效的表名数组 |
||||
* 为什么需要该方法？Data Permission 数组基于 SQL 重写，通过 Where 返回只有权限的数据 |
||||
* |
||||
* 如果需要基于实体名获得表名，可调用 {@link TableInfoHelper#getTableInfo(Class)} 获得 |
||||
* |
||||
* @return 表名数组 |
||||
*/ |
||||
Set<String> getTableNames(); |
||||
|
||||
/** |
||||
* 根据表名和别名，生成对应的 WHERE / OR 过滤条件 |
||||
* |
||||
* @param tableName 表名 |
||||
* @param tableAlias 别名，可能为空 |
||||
* @return 过滤条件 Expression 表达式 |
||||
*/ |
||||
Expression getExpression(String tableName, Alias tableAlias); |
||||
|
||||
} |
||||
@ -0,0 +1,28 @@ |
||||
package com.soochowlife.web.framework.datapermission.core.rule; |
||||
|
||||
import java.util.List; |
||||
|
||||
/** |
||||
* {@link DataPermissionRule} 工厂接口 |
||||
* 作为 {@link DataPermissionRule} 的容器，提供管理能力 |
||||
* |
||||
* @author Alex |
||||
*/ |
||||
public interface DataPermissionRuleFactory { |
||||
|
||||
/** |
||||
* 获得所有数据权限规则数组 |
||||
* |
||||
* @return 数据权限规则数组 |
||||
*/ |
||||
List<DataPermissionRule> getDataPermissionRules(); |
||||
|
||||
/** |
||||
* 获得指定 Mapper 的数据权限规则数组 |
||||
* |
||||
* @param mappedStatementId 指定 Mapper 的编号 |
||||
* @return 数据权限规则数组 |
||||
*/ |
||||
List<DataPermissionRule> getDataPermissionRule(String mappedStatementId); |
||||
|
||||
} |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue