配置 #

应用相关的配置说明，所有的配置都可以在项目启动时通过通过环境变量覆盖 yml 文件内的配置。 例： yml 文件中： spring.app.cors.enabled=false ， 对应的启动环境变量 java -Dspring.app.cors.enabled=false -jar app.jar

目录 #

Configuration #

ApplicationConfiguration.java #

项目全局配置 ApplicationConfiguration#exception 全局异常捕获，异常消息写入 app.error.log 表，将异常转化为自定义编码异常。

AppConfiguration.java #

服务级配置

CommonConfiguration.java #

服务基本配置信息

CommonConfiguration#id 服务id，启动时由 redisson 生成

CommonConfiguration#env 当前环境：[local:本地开发环境|dev:远程开发环境|sit:系统测试|uat:验收测试|prod:生产]

CommonConfiguration#domain 应用域名

CommonConfiguration#hostIp 主机ip

CommonConfiguration#hostName 主机名

CommonConfiguration#name 应用名

CommonConfiguration#version 当前运行版本号: '@version@'

CommonConfiguration#buildTime 项目编译打包时间，发布完成之后检查打包时间是否是一致的，避免版本更新失败: '@maven.build.timestamp@'

CommonConfiguration#gitCommitId git 提交记录 id 前 8 位: '@git.commit.id.abbrev@' CommonConfiguration#gitCommitTime git 提交时间: '@git.commit.time@'

CommonConfiguration#startTime 项目启动时间

CommonConfiguration#objectMapper api 请求响应 jackson 数据序列化和反序列化规则定义

CommonConfiguration#multiThreadExecutorService 多线程 bean 配置初始化。

CommonConfiguration#singleThreadExecutorService 单线程 bean 配置初始化。

SecurityConfiguration.java #

Spring Security 权限控制。
中文文档：https://springcloud.cc/spring-security-zhcn.html
官方文档：https://docs.spring.io/spring-security/site/docs/current/reference/html5/

@EnableWebSecurity 开启 Security 权限控制

@EnableGlobalMethodSecurity(securedEnabled = true, prePostEnabled = true)
securedEnabled = true 启用注解：@Secured； [@Secured("ROLE_USER"), @Secured("IS_AUTHENTICATED_ANONYMOUSLY")]
prePostEnabled = true 启用注解：@PreAuthorize； [@PreAuthorize("hasAuthority('ROLE_USER')"), @PreAuthorize("isAnonymous()")]

SecurityConfiguration#corsConfigurationSource 跨域配置， spring.app.cors.enabled=true 时跨域才生效。

AppConfiguration#StaticAssetConfiguration 静态资源映射配置，swagger 页面、 druid页面等；这里配置映射之后，需要在 SecurityConfiguration#staticSecurityFilterChain 配置白名单放过静态资源。

AppConfiguration#staticSecurityFilterChain 静态资源白名单， 配合 AppConfiguration#StaticAssetConfiguration 一起使用。

SecurityConfiguration#tokenOpenSecurityFilterChain 开放接口白名单，无需登录授权，所有使用 /open/ 前缀的接口不需要登录就能访问，如果已登录的用户访问 /open/，会将 token 解析得到的用户信息放到 app.security.starter.vo.TokenVO 对象， Controller 方法可以注入 @Parameter(hidden = true) @AuthenticationPrincipal IUser user 对象，该对象只包含 token 中携带的用户信息，不会包含全量的用户信息。

SecurityConfiguration#feignSecurityFilterChain feign服务调用拦截，填充用户信息

SecurityConfiguration#loginSecurityFilterChain 封闭接口，需登录授权，com.ccx.demo.enums.TokenClient 定义了所有客户端，一个用户在每个客户端有且仅有一个有效 x-toekn。登录成功之后响应头会返回 x-token ，客户端从响应头获取到 x-token 之后写入本地缓存，后面每次发送 http 请求时，需要将 x-token 加入请求头。authTokenFilter 会从请求头提取 x-token 验证 token 是否有效，如果 token 无效，则会响应 401 ，客户端收到 401 状态之后需要重新执行登录。

SecurityConfiguration#LoginUserAuthenticationToken token 认证用户授权对象

SecurityConfiguration#rsaBCryptPasswordEncoder api接口用户登录、注册密码 RSA 解密，spring.app.encrypt.pwd.enabled=true 时生效。注意:这里的 RSA 不是数据库存储加密，数据库存储加密依然使用org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder

ScheduleConfiguration.java #

定时任务配置初始化。
ScheduleConfiguration#threadPoolTaskScheduler 定义定时任务执行线程池。
ScheduleConfiguration#scheduledExecutorService 延时任务线程池。 SchedulingConfigurerService#configureTasks 注册定时任务并触发启动时需要执行一次的任务。

RedissonCacheConfiguration.java #

RedissonClient 写入应用信息检查 redis 是否可用

JPAAutoConfiguration.java #

JPA 集成 QueryDSL 配置。
@EnableJpaRepositories(basePackages = {"com.ccx.demo.**.dao.jpa"}) 指定扫描包路径。
JPAAutoConfiguration#jpaQueryFactory 初始化 QueryDSL 查询对象 JPAAutoConfiguration#getQueryFactory 暴露公共静态方法，用于DAO层查询

JAP 参考配置：https://docs.spring.io/spring-data/jpa/docs/current/reference/html/
JAP Hibernate 命名策略可自定义，参考配置：https://www.baeldung.com/hibernate-naming-strategy
JAP QueryDSL 参考配置：http://www.querydsl.com/static/querydsl/latest/reference/html_single/#jpa_integration
BlazeQueryDSL 参考配置：https://persistence.blazebit.com/documentation/1.5/core/manual/en_US/index.html#querydsl-integration
QueryDSL SQL Spring: 参考配置：http://www.querydsl.com/static/querydsl/latest/reference/html/ch02s03.html
Spring Data MongoDB 配置, AbstractMongoConfiguration 已经默认实现了 mongoTemplate和mongoFactoryBean，参考配置：https://docs.spring.io/spring-data/mongodb/docs/current/reference/html/#reference
Spring Data MongoDB QueryDSL 参考配置： http://www.querydsl.com/static/querydsl/latest/reference/html_single/#mongodb_integration

DbEncryptConfiguration.java #

数据库敏感字段加解密配置初始化，参考：配置属性

DomainEncryptConfiguration.java #

数据实体对象 id 和 数据版本加解密配置，依赖 DbEncryptConfiguration.java 的配置属性；参考：配置属性

DomainEncryptConfiguration#postConstruct 全局jackson对象和缓存jackson对象注册忽略加解密注解 DomainEncryptConfiguration#addArgumentResolvers 注册 Controller 参数解密转换器

ApiEncryptConfiguration.java #

api 请求响应数据包加解密，spring.app.encrypt.api.enabled=true 时生效。；参考：配置属性

ApiEncryptConfiguration#AesApiEncryptResponseBodyAop 响应结果为 Result<T> 包装对象时执行加密逻辑。 ApiEncryptConfiguration#AesApiDecryptRequestBodyAop 请求参数解密， 只有 POST PUT DELETE PATCH 请求，且 body 不为空的情况才需要解密。 上传文件也不会走解密逻辑

NfsConfiguration.java #

NAS或本地磁盘存储；参考：配置属性

NfsOssAliConfiguration.java #

阿里 oss 对象存储，spring.app.nfs.oss.enabled=true 时生效，依赖NfsConfiguration.java，覆盖本地磁盘存储实现逻辑；参考：配置属性

NfsObsHuaWeiConfiguration.java #

华为 obs 对象存储，spring.app.nfs.obs.enabled=true 时生效，依赖NfsConfiguration.java，覆盖本地磁盘存储实现逻辑；参考：配置属性

NfsMinioConfiguration.java #

minio 对象存储，spring.app.nfs.minio.enabled=true 时生效，依赖NfsConfiguration.java，覆盖本地磁盘存储实现逻辑；参考：配置属性

SwaggerConfiguration #

Swagger + Knife4j 接口文档配置， springdoc.enabled=true 时生效。
@EnableSwagger2 开启 swagger 文档。
@EnableKnife4j 开启 Knife4j ui。
Knife4j 官方文档： https://doc.xiaominfo.com
Knife4j demo： https://gitee.com/xiaoym/swagger-bootstrap-ui-demo.git

SmsConfiguration.java #

短信发送；参考：配置属性

FeignConfiguration.java #

RabbitMqConfiguration.java #

配置属性 #

spring.profiles.active #

系统运行环境配置，加载不同环境的配置文件。默认值：local。 application-${spring.profiles.active}.yml。 环境变量--spring.profiles.active=prod

spring.application.name #

应用名。

spring.app.domain #

应用域名，目前没使用。

spring.app.version #

当前运行版本号，取值根 pom -> version。

spring.app.buildTime #

项目编译打包时间，发布完成之后检查打包时间是否是一致的，避免版本更新失败。

spring.app.gitCommitId #

git 提交记录前 8 位，项目打包发布之后可以通过 /version 接口检查是是否同 git 一致。

jasypt.encryptor.password #

配置文件加密密钥。 环境变量-Djasypt.encryptor.password=6782bc11b94c4c788e4b731471e6c103。 建议新项目初始化之后立即修改密钥，且为不同环境配置不同的密钥。密钥加解密测试类JasyptTest.java

spring.app.cors.enabled #

是否开启跨域开关。默认值：false。

spring.app.verifyCodeEnabled #

是否开启图片验证码校验，是否开启手机验证码校验。默认值：true。 开发环境关闭该开关可以用任意验证码登录，一般用于自动化测试和开发环境，生产环境请启用该配置 true：是，false：否.。 环境变量-Dspring.app.verifyCodeEnabled=false

springdoc.enabled #

是否开启 swagger 文档。默认值：false。

spring.servlet.multipart #

文件上传配置

spring.app.encrypt #

spring.app.encrypt.pwd #

登录、注册api接口密码传输加密配置。

spring.app.encrypt.pwd.enabled

spring.app.encrypt.pwd.type

spring.app.encrypt.api #

api 接口请求参数和响应数据包加解密配置。

spring.app.encrypt.api.enabled

spring.app.encrypt.db #

数据库敏感字段加解密配置。

spring.app.encrypt.db.enabled

spring.app.autoTask #

spring.app.autoTask.enabled #

定时任务总开关，开启后 spring.app.autoTask.services 定义的定时任务服务才会注册。 默认值：true。

spring.app.autoTask.services #

定时任务服务列表，定时任务总开关spring.app.autoTask.enabled=true打开时才会注册定时任务服务。 服务注册配置类com.ccx.demo.config.ScheduleConfiguration。 定时任务服务必须实现 com.utils.IAutoTask 接口。

spring.app.autoTask.services.${springBeanNameAutoTaskService}.cron

spring.app.autoTask.services.${springBeanNameAutoTaskService}.lockExpired

spring.app.nfs #

spring.app.nfs.type #

应用文件存储方式。 环境变量-Dspring.app.nfs.type=disk。

spring.app.nfs.disk #

spring.app.nfs.oss #

spring.app.nfs.obs #

spring.app.nfs.minio #

spring.app.nfs.directory #

当前启用的文件储存应用文件根目录，基于 spring.app.nfs.type 动态加载 ，默认值：${spring.app.nfs.${spring.app.nfs.type}.directory}

spring.app.nfs.server #

当前启用的文件储存文件访问地址，基于 spring.app.nfs.type 动态加载 ，默认值：${spring.app.nfs.${spring.app.nfs.type}.server}

spring.app.nfs.{folderName} #

定义应用中文件，按文件夹分类

spring.app.cache #

缓存配置定义，配置文件定义之后，需要在 CacheConfiguration.java 中注册缓存，并在对应的 Service + DAO 层启用缓存相关的代码和注解

spring.app.cache.${缓存模块名}.expired