v0.8.0

[0.8.0] 2022-07-12

⚠ Warning

• 分页参数的默认参数名修改为 page，前端注意对应更新, 也可以通过配置 ballcat.pageable.page-parameter-name 修改为之前版本的参数名 current
• 验证码 anji-captch 相关的配置以及依赖移除，用户根据自己需求按需添加。（相关代码示例，在 ballcat-admin-sample 和 ballcat-boot 模板仓库中可以查看）
• ballcat.upms 下指定超级管理员的 id 和 username 的配置，移动到 ballcat.system 下了
• 分页上限配置 ballcat.web.max-page-size 现在改为 ballcat.pageable.max-page-size

⭐ Features

全局调整

• 🎨 使用 @SneakyThrows 注解使用时显示指定异常类型
• 🌟 全局 starter 支持 spring-boot 2.7.x 后使用的 AutoConfiguration.imports 的方式进行自动配置的加载
  （目前依然兼容低版本 springboot 使用 spring.factories 的自动注册方法）

短信相关改动 ballcat-spring-boot-starter-sms

• 🌟 整合 aliyun 短信服务
• 🌟 调整腾讯云 sdk 版本，解决与 aliyun 依赖冲突问题

文件上传 ballcat-spring-boot-starter-file

• 🎨 FTP 文件上传切换使用 hutool 工具类实现
• 🐞 修复本地文件上传时返回的路径错误问题
• ♻ 重构 File 模块的代码结构

国际化 ballcat-i18n

• 🐞 修复 I18nData 的 resultMap 中，字段 remark 多加了一个 s 的问题
• 🌟 @I18nField 注解的 code 值支持使用 SPEL 表达式
• 🌟 添加 @I18nIgnore 注解，可以添加在 controller 的方法上，用于指定忽略 I18n 处理

数据权限 ballcat-spring-boot-starter-datascope

• ⚡ 优化 DataPermissionRule 的构建方式，添加有参构造，以及支持链式调用
• ⚡ 将编程式数据权限控制的方法从 DataPermissionHandler 的实例方法，抽取为 DataPermissionUtils 的一个静态方法，使用更加简单便捷
• 🐞 修复在 DataScope 中执行 sql 导致嵌套执行拦截器，出现匹配计数空指针的问题
• ✅ add jsqlparse table alias test

密码相关 ballcat-system ballcat-auth ballcat-common-security

• 🌟 系统用户新建和修改密码时使用 PasswordEncoder 进行加密处理，方便使用者更换密码算法
• 🌟 系统用户的密码正则规则支持使用 yml 配置进行自定义：ballcat.system.password-rule
• 🔥 移除 PasswordUtils 的 encode 以及 matches 等方法，防止用户错误使用.
• 🎨 PasswordUtils#createDelegatingPasswordEncoder 修改为 public 方法，方便外部调用
• 🎨 优化下修改密码时，密码异常的错误提示

分页查询相关 ballcat-spring-boot-starter-web ballcat-common-model

• 🌟 排序参数兼容使用尾缀 [] 的方式进行传参，例如 sort 和 sort[] 都可以做为排序参数
• 🎨 默认的当前页参数由 current 修改为 page，后续版本中将移除 PageParam 的 current 属性
• 🌟 分页参数支持自定义参数名:

  ballcat:
    pageable:
      page-parameter-name: page # 不想改动前端，这里可以修改为 current
      size-parameter-name: size
      sort-parameter-name: sort #同时会自动支持尾缀[]的参数形式，如 sort[]
      max-page-size: 100

OpenAPI 文档 ballcat-extend-openapi

• 🌟 添加对于动态分页参数的支持，会自动根据配置进行切换文档中的分页查询属性
  （在引入了 ballcat-spring-boot-starter-web 的情况下）

Redis 相关

• 🌟 缓存/缓存更新注解增强: 增加时长单位

mybatis-plus-extend

• 🐞 修复 LambdaAliasQueryWrapperX 嵌套构建条件语句时别名丢失的问题
• ✅ 添加 LambdaAliasQueryX 的测试用例
• 🎨 OtherTableColumnAliasFunction 类更名为 ColumnFunction
• 🌟 添加 ColumnFunction#create 方法，在进行连表查询时，构建第三方表的列名更方便

校验 Validator

• 新增枚举以及值范围检验的自定义注解
  • @OneOfStrings 校验值是否是指定的字符串之一
  • @OneOfInts 校验值是否是指定的 int 值之一
  • @OneOfClasses 校验值是否是指定的 class 类型之一
  • @ValueOfEnum 校验值是否满足于指定的 Enum

Xss 防注入相关 ballcat-spring-boot-starter-xss

• 🐞 修复反序列化时携带了错误的 json 可能出现的异常问题

系统管理相关

• 🌟 添加用户新建和修改时的数据校验
• 🐞 修复用户新建时无法指定为锁定状态的问题

OAuth2 ballcat-auth-biz

• 🐞 修复客户端登录模式使用 from 传参不走自定义异常处理的问题
• 🌟 验证码校验逻辑抽象，方便用户切换验证码的底层依赖
• 🔥 移除了默认的 anji-captcha 相关的依赖以及配置，用户按需添加

🔨 Dependency

• 【移除】移除了对 spring-boot-admin 的依赖管理
• 【修改】取消 spring-boot-starter-web 强制剔除 tomcat 的配置，容器选择权交给用户
• 【升级】spring-boot from 2.6.6 to 2.7.1
• 【升级】kafka from 2.5.0 to 2.6.3
• 【升级】dynamic-datasource-spring-boot-starter from 3.5.0 to 3.5.1
• 【升级】hutool from 5.7.22 to 5.8.3
• 【升级】fastjson from 1.2.79 to 1.2.80
• 【升级】springdoc-openapi from 1.6.7 to 1.6.9
• 【升级】 mybatis from 3.5.9 to 3.5.10
• 【升级】 mybatis-plus from 3.5.1 to 3.5.2
• 【升级】 xxl-job from 2.3.0 to 2.3.1
• 【升级】easyexcel from 3.0.5 to 3.1.1

0.7.1

OpenAPI 相关改动 ballcat-extend-openapi

• 🐞 swagger-api 版本冲突，依赖管理 到 2.2.0，保持和 springdoc-openapi 一致
• 🔥 弃用 ballcat.openapi.security-schemes 配置，现在使用 ballcat.openapi.components.security-schemes
• 🔥 弃用 ballcat.openapi.global-security-requirements，现在使用 ballcat.openapi.security 属性替代
• 🩹 修复部分属性 ide 中没有提示的问题

Web 相关改动 ballcat-spring-boot-starter-web

• 🐞 修复 null 值序列化处理不支持 @JsonInclude 注解的问题
• ✅ 添加 jackson null 值序列化器的测试用例
• 🌟 异常通知消息添加 RequestURI 的信息输出
• 🌟 全局异常日志打印请求URI

0.7.0

⚠️ Warning

• 此版本操作日志表有字段新增，升级前注意先执行对应的增量 SQL

• 访问日志的忽略 url 现在只需填写 servlet 内的路径了，升级后请注意调整，防止失效

• openapi 的配置文件调整，现在文档基本信息的属性添加了一个 info 的前缀

• WebSocket 组件中的 AbstractJsonWebSocketMessage 改名为 JsonWebSocketMessage，升级时如遇到 class import 失败，请注意对应修改类名

• 由于 spring-javaformat 组件的升级，现在如果在 jdk8 环境下，请在项目跟目录新建一个名为 .springjavaformatconfig 的文件，文件内容如下：

  java-baseline=8
  

⭐ New Features

日志相关改动 ballcat-common-log spring-boot-starter-log

• 🌟 访问日志的忽略 url 现在只需填写 servlet 内的路径了
• 🌟 操作日志注解增强：用户可以指定是否记录当前操作方法的参数和返回值
• 🐞 抛 BusinessException 异常时，日志记录丢失 traceId 的问题
• 🐞 CustomAccessLogHandler#getParams 改变不可变的 parameterMap 集合问题
• 🐞 修复公告图片上传时的操作日志记录异常问题

国际化 ballcat-common-i18n

• 🌟 优化下细节：在 i18n 处理失败时，也正常响应

web 服务 ballcat-spring-boot-starter-web

• 🌟 actuator 拦截器现在只在引入了 actuator 时开启，且拦截地址跟随 actuator 的 base-path 配置
• 🐞 修复默认配置下仅引入 ballcat-spring-boot-starter-web 时启动异常的问题

分页查询调整 ballcat-common-core

• 🌟 分页参数 PageParam 的 valid 校验支持
• 🌟 PageParam 分页条数上限可通过配置 ballcat.web.page-size-limit 动态修改，默认值 100
• 🌟 所有分页接口，添加 PageParam 的入参校验
• 🌟 支持带表别名的排序列
• 🌟 分页查询新增参数 sort 设置排序规则，格式为：property(,asc|desc)，支持传入多个排序字段

缓存工具 ballcat-spring-boot-starter-redis

• 🌟 redis 相关 bean 添加 @ConditionalOnMissBean 注解，方便用户替换
• 🌟 RedisHelper 工具类添加 zset 的基本操作
• 🐞 修复在没有配置 ballcat.redis.key-prefix 属性时启动报错的问题

系统管理 ballcat-system

• 🌟 组织机构树查询支持模糊查询名称
• 🌟 新增组织机构列表查询
• 🌟 菜单和组织机构的筛选都移交到前端处理了
• 🎨 解耦 system 和 websocket 模块（notify 解耦未完成，后续重构通知时处理）

Tree 工具相关改动 ballcat-common-util

• 🌟 TreeUtils 新增剪枝方法 pruneTree
• 🌟 TreeUtils 泛型调整
• 🎨 SimpleTreeNode.getChildren 方法重写，方便直接获取对应的类型数据

数据权限组件 ballcat-spring-boot-starter-datascope

• 🐞 修复 DataPermissionAnnotationHolder 只清空了 deque，没有 remove 的问题
• 🌟 添加编程式数据权限规则控制支持，可与 @DataPermission 注解嵌套使用

数据权限规则优先级，由高到低：

1. 编程式规则
2. 当前方法的注解规则
3. 当前类的注解规则
4. 调用者使用的权限规则
5. 全局默认规则

长连接组件 ballcat-websocket

• 🌟 优化下 UserSessionKeyGenerator 的 Conditional 判断，方便用户替换
• 🌟 WebSocket 的 session 存储角色，从 WebSocketSessionHolder 修改为 WebSocketSessionStore
• 🌟 现在不再默认覆盖同一 sessionKey 的 wsSession 了，方便用户进行全客户端推送
• 🌟 新增AbstractMessageDistributor， 将MessageDistributor的 default 方法下沉到该抽象类中
• 🌟 跨域配置添加 allowed-origin-patterns 属性
• 🌟 添加 SockJs 的支持
• 🎨 优化下 RedisMessageListener 的注册方式，防止误扫描导致的 bean 注册异常
• 🎨 优化 ballcat-spring-boot-starter-websocket 的配置类结构
• 🎨 精简代码层级，将接口 JsonWebSocketMessage 删除，原抽象类 AbstractJsonWebSocketMessage 改名为 JsonWebSocketMessage

幂等组件 ballcat-idemptent

• 🌟 幂等控制注解增强：可以指定消息单位以及幂等拦截时的错误提示了
• 🌟 幂等组件允许用户控制是否再异常时删除幂等标识，方便有些不允许重试的方法进行幂等控制
• ✅ 添加幂等组件的一些测试用例

接口文档 ballcat-extend-openapi

• 🌟 添加部分 OpenAPI 配置
• 🌟 文档信息的配置下沉到 info 前缀下

其他问题

• 🐞 调整 ProviderManager 的层级，以解决错误的 token 会触发两次鉴权失败异常的问题
• 🐞 修复 OSS 上传文件时不主动关闭临时的流. 导致大量文件上传时出现异常
• 🐞 公告信息分页查询 bug
• 🐞 fix jdk11 下打包异常的问题

🔨 Dependency Upgrades

• 【升级】spring-boot from 2.6.2 to 2.6.6，且后续使用官方 dependencies 进行依赖管理
• 【升级】spring-boot-admin from 2.6.0 to 2.6.6
• 【升级】spring-javaformat from 0.0.29 to 0.0.31
• 【升级】hutool from 5.7.12 to 5.7.19
• 【升级】mybatis-plus from 3.5.0 to 3.5.1
• 【升级】springdoc-openapi from 1.6.4 to 1.6.7
• 【升级】software.amazon.awssdk from 2.16.61 tp 2.17.154

0.6.0

⚠️ Warning

• Swagger2 相关注解迁移到 OpenAPI3，由于使用了 springdoc-openapi，且该项目当前版本的一些问题，如果没有在 服务中引入
  springdoc-openapi-ui 的依赖，或者配置中添加 springdoc.api-docs.enabled=false 的配置，则会导致启动报错
• 删除了 knife4j-ui 的版本管理，对于 OpenAPI3，请使用 knife4j 的 3.x 版本
• springfox 组件未适配 springboot 2.6.2 版本，如需继续使用 springfox，请添加 spring.mvc.pathmatch.matching-strategy=ant-path-matcher 配置，以及注册 SpringfoxHandlerProviderBeanPostProcessor 到 spring 容器中
• springboot 2.6.x 默认禁止循环依赖，如有循环依赖启动将会报错，请注意修改代码，或者添加配置 spring.main.allow-circular-references = true (不建议)

⭐ New Features

• 【修改】修改 jackson 脱敏支持的模块添加方式，使用为注册 JsonDesensitizeModule 的形式，以便复用 spring-boot 默认的 module 注册。
• 【修改】调整 CustomJavaTimeModule 的注册方式，防止被 JSR310 的 JavaTimeModule 覆盖
• 【删除】移除过时已久的 IPageArgumentResolver，让 starter-web 和 mybatis-plus 模块解耦。
• 【删除】移除过时的 Lov 相关代码。
• 【修改】Swagger2 相关注解迁移到 OpenAPI3
• 【修改】文档底层支持从 springfox 迁移到 springdoc-openapi
• 【添加】对于 GET 请求的入参封装类，如 xxQO，添加 @ParameterObject 注解，以便在文档上正确展示查询入参
• 【修改】由于 springfox 长久不更新，弃用基于该框架的 ballcat-spring-boot-starter-swagger 组件
• 【新增】添加 ballcat-extend-openapi，模块，基于 springdoc-openapi 做了部分扩展，参看文档
• 【删除】删除 knife4j-ui 的版本管理
• 【修改】代码优化，显示指定部分参数或返回值的泛型
• 【修改】Sonarlint 部分代码警告处理
• 【删除】移除 dependencies pom 中无用的 pluginManagement 部分
• 【修改】hutool 依赖管理改为使用 hutool 官方提供的 bom
• 【新增】添加 ballcat-extend-tesseract 扩展模块，用于 OCR 文字识别工具的调用封装
• 【修改】字典相关逻辑调整
  • 去除字典只读/可写的属性控制
  • 字典项增加启用/禁用的状态属性
  • 字典现在在有字典项的情况下不允许删除（之前会自动级联删除）
• 【修改】同步 mybtais-plus 升级 3.5.x 后，AbstractMethod 的方法名获取做的调整
• 【修改】ballcat-spring-boot-starter-oss 更新 oss 相关方法与变量. 由 path 变为 key. 符合 oss 规范，原 rootPath 属性标记为过期，修改为 objectKeyPrefix
• 【添加】ballcat-spring-boot-starter-oss 新增根据 File 直接上传的方法
• 【修改】StreamUtils 克隆流方法优化. 使用 FileOutStream 保证不会因为文件过大而内存溢出
• 【修改】OssDisabledException 父类由 Exception 修改为 RuntimeException
• 【修改】ballcat-common-idempotent 幂等组件微调
  • RedisIdempotentKeyStore 的 stringRedisTemplate 属性，改为构造器注入
  • 取消 IdempotentAspect 切面的 @component 注解，防止误注册

🐞 Bug Fixes

• 【修复】修复删除字典项时没有将变动通知到前端的问题
• 【修复】修复 FileUtils#updateTmpDir 方法中文件夹创建异常的问题

🔨 Dependency Upgrades

• 【升级】spring-boot from 2.5.6 to 2.6.2
• 【升级】lombok from 1.18.20 to 1.18.22
• 【升级】spring-javaformat from 0.0.28 to 0.0.29
• 【升级】hutool from 5.7.12 to 5.7.19
• 【升级】dynamic-datasource from 3.4.1 to 3.5.0
• 【升级】jasypt from 3.0.3 to 3.0.4
• 【升级】jsoup from 1.14.2 to 1.14.3
• 【升级】mybatis-plus from 3.4.3.4 to 3.5.0
• 【升级】mybatis from 3.5.7 to 3.5.9
• 【升级】jsqlparse from 4.2 to 4.3
• 【升级】fastjson from 1.2.76 to 1.2.79
• 【升级】spring-boot-admin from 2.5.4 to 2.6.0

0.5.0

⚠️ Warning

• 由于业务实体类的统一修改，其对应的表结构发生了变化
• 批量方法从 saveBatchSomeColumn 切换到 saveBatch 后，注意项目中的 jdbcUrl 配置，需要添加 rewriteBatchedStatements=true 条件，否则插入效率降低

⭐ New Features

• 【修改】 业务实体类添加父类 LogicDeletedBaseEntity，统一支持逻辑删除
• 【修改】 业务实体类统一修改描述、备注等属性名为 remarks
• 【修改】 业务代码批量插入部分方法从 saveBatchSomeColumn 切换到 saveBatch， 经实测，开启批处理事务以及 jdbcUrl 连接添加rewriteBatchedStatements=true 后, 循环 insert into 批量提交比 insert into values 语法速度更快。
• 【新增】 ballcat-spring-boot-starter-file 组件，支持 local 本地 和 ftp 文件上传操作
• 【添加】 TreeUtils#treeToList() 方法，支持将树平铺为列表
• 【添加】 ImageUtils#mixResolveClone() 方法，先使用快速解析，若失败回退到正常解析方法
• 【新增】 FileUtils 工具类
• 【新增】 BaseEntity 和 LogicDeletedBaseEntity 实体类基类
• 【新增】 支持定制 Redis Key 前缀的生成规则
• 【新增】 DistributeLock , 更加方便的进行分布式锁的使用
• 【新增】 AbstractMessageEventListener 类，提供默认的消息序列化处理
• 【添加】 ExtendService#saveBatch() 方法
• 【新增】 多线程对同一 websocket session 进行发送操作的支持
• 【修改】 默认提供的 MybatisPlusConfig 配置类中的自动填充处理类的条件注解修改，方便用户替换为自己的 MetaObjectHandler
• 【新增】 线程池配置 @Async 异步线程日志支持 traceId 输出
• 【添加】 TokenGrantBuilder#getAuthenticationManager() 方法，方便子类继承时获取 AuthenticationManager (#133)
• 【修改】 FileService ，OssClient 不再为必须依赖，当没有配置 Oss 时，默认回退使用 FileClient，根据配置走本地存储或者
• 【修改】 MappedStatementIdsWithoutDataScope 的 WITHOUT_MAPPED_STATEMENT_ID_MAP 属性类型为 ConcurrentHashMap
• 【修改】 TraceIdFilter 默认在响应头中返回 TraceId 参数，方便排查问题
• 【修改】 UserInfoCoordinator 从类调整为接口，并提供默认实现 DefaultUserInfoCoordinatorImpl

🐞 Bug Fixes

• 【修复】 数据权限使用 JDK动态代理或者桥接方法时无法正确找到 @DataPermission 注解的问题
• 【修复】 数据权限在 SQL 右连接，内连接失效的问题
• 【修复】 数据权限对于使用括号包裹的 sql 解析失效的问题
• 【修复】 在仅使用 ballcat.swagger.enabled=false 的情况下，swagger 没有正常关闭的问题
• 【修复】 由于跨域问题，导致 swagger 无法在聚合者 Aggregator 中对 文档提供者 Provider 进行调试的问题
• 【修复】 WebSocket 在接收普通文本属性时的异常问题，现在会回退使用 PlanTextMessageHandler 进行处理
• 【修复】 查询指定名称的组织时构建树失败的问题

🔨 Dependency Upgrades

• 【升级】 spring-boot from 2.5.4 to 2.5.6
• 【升级】 spring-boot-admin from 2.5.1 to 2.5.4

0.4.0

Warning

• mybatis-plus 升级，其对应一些 count 方法，返回值修改为了 Long 类型，项目中有使用的地方需要对应修改
• 默认登录时返回的 token 属性有所变更，原 roles 修改为 roleCodes，前端注意对应升级
• websocket 默认使用 local 进行分发，这将导致集群状态下的数据推送异常，如需集群部署，请修改对应配置
• websocket 相关接口 MessageSender 移除，该接口并入 MessageDistributor ，注意修改对应依赖引入类型

Added

• feat：ballcat-auth 授权服务器定制增强：
  • 允许用户自定义 AccessTokenConverter，修改自省端点 /check_token 的返回值
  • 允许用户定制授权处理器或者新增授权处理器，用户可以通过覆盖 TokenGrantBuilder 实现
  • 允许用户添加自己的 AuthenticationProvider 方便处理自定义的 grant_type
  • 添加 OAuth2ClientConfigurer 抽象接口，方便用户替换 ClientDetailsService 的配置方式
  • 和 ballcat-system 模块解耦，方便复用 ballcat-auth 快速搭建一个授权服务器，例如 C 端用户 和 后台用户分离登陆系统，各搭建一套基于 OAuth2 的登录。
  • 根据 OAuth2 规范，调整 check_token 端点响应，在 token 不正确时响应 200，响应体为 { active: false }，而不是返回 400
• feat：数据权限对于 jsqlparse 4.2 后，连表使用尾缀多个 OnExpression 方式的 SQL 解析支持
• feat：角色添加 scopeResource 属性，以便支持自定义数据权限设置一些信息
• feat：默认的 jackson 时间序列化添加了 Instant 类型支持，防止在使用时出现异常 InvalidDefinitionException: Java 8 date/time type java.time.Instant not supported by default

Changed

• refactor：资源服务器对于客户端凭证生产的token 解析支持，对应的 userdetails 为 ClientPrincipal

• refactor：授权服务器自省端点的 scope 属性响应调整，根据 OAuth2 自省端点协议，scope 应返回字符串，用空格间隔

• refactor：数据权限调整

  • 问题修复： fix 数据权限在表名使用 `` 转义字符时失效的问题
  • 性能优化：对于无需数据权限控制的 sql 在解析一次后进行记录，后续不再进行解析处理
  • 结构调整：防止误用以及避免歧义，DataScopeHolder 修改为 DataScopeSqlProcessor 的私有内部类

• refactor：SelectData 试图对象中的 value 修改为 Object 类型，selected 和 disabled 修改为 Boolean 类型

• refactor：系统用户相关的 service 和 mapper 层，修改使用 Collection 接收参数，方便使用

• refactor：TokenAttributeNameConstants 常量类拆分

• refactor：UserInfoDTO 属性调整，新增了 menus 用于存储用户拥有的菜单对象集合，修改 roles 属性用于存储用户拥有的角色对象集合，原 roles 属性修改为 roleCodes 存储角色标识集合

• refactor：为避免歧义，登录和自省端点返回信息中的属性名称 roles 修改为 roleCodes

• bug：修复使用 ballcat-spring-boot-starter-web 时，若没有引入 security 依赖则启动异常的问题

• refactor： system 相关事件优化调整

  1. 用户组织变动时发布 UserOrganizationChangeEvent 事件
  2. 用户新建的事件由 UserChangeEvent 修改为 UserCreatedEvent
  3. system 的 event 类从 biz 迁移到 model 模块中

• refactor：ballcat-common-websocket 移除 MessageSender 接口，将其并入消息分发器 MessageDistributor

• refactor：ballcat-spring-boot-starter-websocket 与 redis 解耦，将默认注册的消息分发器由 redis 改为 local，基于内存分发。可通过 ballcat.websocket.message-distributor 属性修改为 redis 或者 custom，值为 custom 表示，用户自己定制 MessageDistributor（如修改为使用 mq，可用性更高）

  ballcat:
      websocket:
          # 默认为 local 仅支持单节点使用，redis 基于 PUB/SUB 消息订阅支持了集群下的消息推送问题
          message-distributor: redis # local | redis | custom

• refactor：ballcat-spring-boot-starter-redis 调整 AddMessageEventListenerToContainer 的注册方式，防止用户配置包扫描导致的加载顺序异常

• refactor：有用户绑定组织时，不允许删除组织

Dependency

• Bump spring-boot from 2.4.8 to 2.5.5
• Bump lombok from 1.18.16 to 1.18.20
• Bump mybatis-plus 3.4.4 to 3.4.3.4
• Bump mybatis 3.5.6 to 3.5.7
• Bump jsqlparser 4.0 to 4.2
• Bump flatten-maven-plugin from 1.2.5 to 1.2.7
• Bump spring-javaformat from 0.0.27 to 0.0.28
• Bump hutool from 5.7.3 to 5.7.12
• Bump spring-boot-admin from 2.4.2 to 2.5.1
• Bump dynamic-datasource-spring-boot-starter from 3.3.2 to 3.4.1

0.3.0

Warning

• 多个模块包名调整，注意重新 import 对应路径
• 国际化重构，改动较大，注意对应代码调整。国际化使用文档参看：http://www.ballcat.cn/guide/feature/i18n.html
• 由于 ballcat-common-conf 的删除，非 admin 服务中的 mybatis-plus 的相关配置，如分页插件，批量插入方法的注入，需要按需添加。
• 操作日志优化，修改了 OperationLogHandler 的相关方法，如果有自定义 OperationLogHandler ，需要注意同步更新

Added

• feat: 国际化功能的默认支持，新增 ballcat-i18n 相关模块，以便提供默认的业务国际化实现方式
• feat: 登录用户名密码错误时的错误消息国际化处理
• feat: ballcat-common-redis 针对 PUB/SUB 新增 MessageEventListener 接口，ballcat-spring-boot-starter-redis 中会自动注册所有实现 MessageEventListener 接口的监听器
• feat: ballcat-common-redis 中的 @CacheDel 注解，新增 multiDel 属性，方便批量删除缓存
• feat: 新增 ballcat-common-idempotent 幂等模块
• feat: 针对 hibernate-validation 校验的提示消息，支持使用 {}，占位替代 defaultMessage
• feat: ballcat-common-core 中默认新增了 CreateGroup 和 UpdateGroup 接口，方便分组校验使用
• feat: 新增 ballcat-spring-boot-starter-web 模块，该模块基于 spring-boot-starter-web, 并使用 undertow 作为默认的嵌入式容器，且将 ballcat-common-conf 中对 web 应用的配置增强，如全局异常管理，以及 Sql 防注入处理，jackson 的默认配置等配置移动到此项目中
• feat: ballcat-extend-mybatis-plus 模块中，为了支持连表查询的条件构建，新增 OtherTableColumnAliasFunction ，方便使用 LambdaAliasQueryWrapperX 进行关联表查询条件的构建
• feat: ballcat-spring-boot-starter-easyexcel 支持导出时进行 Excel 头信息的国际化处理，使用 {} 进行占位表示，使用示例可参看 I18nData 的导出使用
• feat: ballcat-spring-boot-starter-swagger 配置的扫描路径 basePackage ，支持使用 , 进行多包名的分割扫描
• feat: ballcat-spring-boot-starter-datascope 中的数据权限控制注解 @DataPermission 扩展支持在 Mapper 之外使用，且支持方法嵌套调用时使用不同的 @DataPermission 环境

Changed

• refactor: ballcat-common-conf 内原先对于 mybati-plus 的自动填充、分页插件、以及批量插入方法注入的配置移动到 ballcat-admin-core 中

• refactor: SpELUtils 改名为 SpelUtils，并移动到 ballcat-common-util 模块中

• refactor: ApplicationContextHolder 改名为 SpringUtils，并移动到 ballcat-common-util 模块中

• refactor: ballcat-spring-boot-starter-log 中拆分出 ballcat-common-log 模块，解决在 log-biz 模块中需要引入 starter 的问题，部分代码的包名有变更

• refactor: ballcat-spring-boot-starter-redis 中拆分出 ballcat-common-redis 模块

• refactor: 重构原先的国际化 i18n 功能，新增 ballcat-common-i18n 模块，移除原先的 ballcat-extend-i18n 模块

• pref: 取消 ballcat-spring-boot-starter-web 中 spring-security-core 的传递依赖

• fix: 修复当查询一个不存在的系统配置后，由于缓存空值，导致添加配置后依然查询不到的问题

• pref: 菜单查询的返回类型修改为 SysMenuPageVO

• fix: 修复 excel 导出的 content-type 和实际文件类型不匹配的问题

• fix: 提高缓存切面的 Order，使其在事务提交后执行更新或删除操作，防止并发导致缓存数据错误

• pref: 菜单支持删除 icon

• fix: 修复当菜单 id 修改时，未级联修改其子菜单的父级 id 的问题

• pref: 优化操作日志，改为在方法执行前获取方法参数信息，防止用户在执行方法时将方法入参修改了

• pref: ballcat-admin-core 中默认扩展 springboot 默认的 TaskExecutor 配置，将拒绝策略从抛出异常修改为使用当前线程执行

• refactor: 移动 TreeNode 模型到 common-util 包中，以便减少 common-util 包的依赖

• refactor: ballcat-spring-boot-starter-xss 抽象出 XssCleaner 角色，用于控制 Xss 文本的清除行为，方便用户自定义

• pref: 用户登陆时的错误信息返回原始的细节信息，而不是全部返回用户名密码错误

• fix: ballcat-system-biz websocket 包名拼写错误修复

Removed

• 移除 ballcat-common-conf，相关代码拆分入 ballcat-spring-boot-starter-web 和 ballcat-admin-core

Dependency

• Bump jsoup from 1.13.1 to 1.14.2

0.2.0

Added

• feat: 新增 ballcat-extend-redis-module 模块，提供对布隆过滤器的操作

• feat: 新建用户时可以直接绑定用户角色，而不必分两次操作了

• feat: 支持修改菜单ID，方便转移菜单位置时，保持菜单 ID 规则

• feat: 新增 ballcat-common-security 模块

  • 新增 CustomRedisTokenStore 用于在序列化异常时，直接清除缓存。避免每次修改 UserDetails 时都需要用户手动去删除所有缓存信息
  • 迁移 PasswordUtils 从 common-util 到 common-security，且 PasswordEncoder 使用 DelegatingPasswordEncoder, 方便未来切换密码加密算法
  • 迁移 OAuth 相关的异常处理，从 ballcat-oauth-controller 到 common-secutiy
  • 新增 ResourceServer 相关配置以及基础组件，基于 SpringSecurity 5.X
  • SysUserDetails rename to User, sysUser 中的相关属性，现在直接写在 User 类中，同时删除了 userResource 和 userAttributes 属性，新增了 attributes 属性。

Changed

• refactor: 数据权限 dataScopes 通过 ThreadLocal 进行方法间传递

• refactor: 拆分 admin-websocket 模块，方便用户剔除不需要的组件.

• refactor: ballcat-spring-boot-starter-websocket 模块中 websocket 相关的封装代码抽取到 ballcat-commo-websocket 模块，starter 仅保留自动配置相关代码

• pref: 菜单的逻辑删除属性使用 mybatis-plus 的自动填充功能，且当菜单 ID 已使用时提示详情

• pref: 精简了一些 common 模块中不需要的依赖

• refactor: OAuth2 ResourceServer 底层从 spring-security-oauth2 依赖迁移至 SpringSecurity 5.x

• pref: common-conf 中现在默认注册 jackson 的脱敏序列化器了，用户可以通过注册 name 为 ”desensitizeCustomizer“ 的 Jackson2ObjectMapperBuilderCustomizer bean，覆盖默认配置

• refactor: ballcat-spring-boot-starter-log 和业务解耦，操作日志的生产和存储全部交由业务项目自己处理，ballcat-log-biz 模块中提供了默认的操作日志实体类，以及 OperationLogHandler 的默认实现

• refactor: 由于 common-security 的抽取， ballcat-oauth 模块只剩下了授权相关，故更名为 ballcat-auth，同时做了一些结构上的调整，方便后续独立部署授权服务器。

  • 配置 ballcat.upms.loginCaptchaEnabled 现在调整为 ballcat.security.oauth2.authorizationserver.loginCaptchaEnabled ，用以控制登录验证码的开关
  • 配置 ballcat.security.ignoreUrls 现在调整为 ballcat.security.oauth2.resourceserver.ignoreUrls 用以控制资源服务器对部分 url 的鉴权忽略
  • 配置 ballcat.security.iframeDeny 现在调整为 ballcat.security.oauth2.resourceserver.iframeDeny 用于开启资源服务器的嵌入 iframe 允许
  • 新增 @EnableOauth2AuthorizationServer 注解，用以开启授权服务器 (ballcat-admin-core 模块中默认开启）

Removed

• 移除 ballcat-oauth-model，相关代码迁入 ballcat-common-security

Dependency

• Bump spring-boot from 2.4.3 to 2.4.8
• knife4j from 2.0.8 to 2.0.9
• hutool from 5.5.8 to 5.7.3
• fastjson from 1.2.75 to 1.2.76
• dynamic-datasource from 3.3.1 to 3.3.2
• spring-boot-admin from 2.4.1 to 2.4.2
• anji-captcha from 1.2.8 to 1.2.9

0.1.0

Warning

• 此版本重构了前端路由部分，服务端权限表 sys_permission 改为 sys_menu，改动较大，迁移时建议先备份原始数据，执行增量 sql 后若出现问题，再进行比对处理
• 调整了模块名，sys => system，后续包名也都尽量不再使用缩写，注意修改对应类的引用包路径
• 项目部分配置添加 ballcat. 前缀
  • 文件存储现在修改为了对象存储（OssProperties.java），配置前缀为 ballcat.oss
  • 登录验证码开关和超级管理员指定的配置（UpmsProperties.java），前缀为 ballcat.upms
  • 登录密码的 AES 加解密密钥，忽略鉴权的 url 列表，iframe 嵌入配置开关等安全相关的配置 （SecurityProperties.java），前缀为 ballcat.security
• 模块拆分重构，原 admin.modules 下的 log、system、notify 相关代码，全部独立模块。目前拆分为 model，biz，controller 三层，方便按需引入。ballcat-admin-core 依然默认集成所有模块
  • log 模块涉及的表名以及类名修改，原 AdminXXXLog 类，全部去除 Admin 开头。表名前缀由 admin_ 修改为 log_
  • log 中的登录日志也不再默认开启，需要登录日志，可手动注册 LoginLogHandler 类，代码示例可参考 ballcat-sample-admin 项目中的 LogHandlerConfig。
  • 同样访问日志和操作日志也需对应注册 handler，且在启动类上添加 @EnableXXXLog 注解
  • mapper.xml 文件移动，由于模块拆分，目前各模块的 mapper.xml 直接放置在了 mapper 文件夹下，对应的文件扫描配置 mybatis-plus.mapper-locations 需要修改为 classpath*:/mapper/**/*Mapper.xml

    mybatis-plus:
      mapper-locations: classpath*:/mapper/**/*Mapper.xml

Added

• feat: 新增了国际化插件 i18n extend 和 i18n starter
• feat: BusinessException 的错误消息支持占位符了
• feat: PageParam 分页查询参数对象，支持用户自定义其子类以便做额外的功能处理
• feat: TreeUtils 现在构建树时，支持传入 Comprator，进行自定义排序
• feat: 新增 SmsUtils，以及 GSMCharst 类，用于短信长度计算
• feat: 新增了一个根据用户id查询 UserInfo 的接口
• feat: ballcat-extend-mybatis-plus 模块中添加普通枚举类型处理. 根据 name() 返回值判断枚举值
• feat: ballcat-spring-boot-starter-easyexcel 新增 @RequestExcel 注解，方便导入 excel 直接解析为实体对象
• feat: 新增了一个接口用于组织机构树形层级和深度的错误数据校正

Changed

• refactor: SysPermission 移除，新增 SysMenu 类，相关关联类同步修改，减少了大部分的配置属性，转交由前端处理
• refactor: Lov 实体修改为 SysLov
• refactor: 移除 AdminRuleProperties.java，adminRule 相关配置与登陆验证码开关控制一并合入 UpmsProperties, 密码加密密钥配置并入 SecurityProperties，并将其配置前缀统一添加 ballcat.
• refactor: SysUserDetailsServiceImpl.getUserDetailsByUserInfo 方法调整为 public 级别, 便于以api方式登录的请求注入用户信息
• refactor: 重构了 excel 自定义头生成器的使用方式
• refactor: 修改 AbstractRedisThread.getObjType 默认实现, 使其更符合大多数情况(获取失败的情况下子类重写此方法)
• refactor: 文件存储 starter-storage 重构，修改为对象存储，使用 S3 协议和云端交互，所有支持 S3 协议的云存储都可以使用，如亚马逊、阿里云、腾讯云、七牛云
• refactor: 移除 userInfoDTO 中的 roleIds 属性
• refactor: 系统配置添加缓存注解，提升查询效率，更新和删除修改为使用 confKey, 而不是 ID
• pref: 根据 mapstruct 官方文档，调整了 lombok 和 mapstruct 的依赖引入方式
• pref: 所有 @RequestParam 和 @PathVariable 注解，指定 value 值，避免因环境问题，编译未保存参数名称，导致的参数绑定异常
• pref: 简化微信原生支付方法
• pref: 前后端交互密码解密异常时的错误日志以及响应信息优化
• fix: 禁止删除有子节点的组织，以及不能修改父组织为自己的子组织
• fix: 修复由于 mapstruct 的引入方式修改，导致 yml 中配置信息不提示的问题
• fix: 修复 easyexcel 添加 password 后会导致 excel 文件打开异常的问题
• pref: starter-log 和 starter-oss 模块包名拼写错误修复，commom -> common
• refactor: AccessLogSaveThread 不再默认启动，AbstractQueueThread 中对非活动状态的线程进行启动，避免重复启动异常
• fix: 修复组织架构移动到子层级时，导致其他节点的层级和深度被错误修改的问题（之前的错误数据可用此版本新增的校正功能修复）
• fix: 修复操作日志添加参数忽略类型的异常问题

Dependency

• Bump spring-boot-admin from 2.4.1 to 2.4.1
• Bump virtual-currency from 0.4.1 to 0.4.2

0.0.9

Warning

• 由于用户属性和用户资源类的抽象，更新版本后，需要删除原来缓存的用户数据，否则会造成反序列化移除
• ExtendService#selectByPage 方法移除，原本使用此方法的分页查询，需要更改为使用 baseMapper#selectPage
• 部分类路径有修改，注意迁移
• 代码生成器独立到新的仓库：https://github.com/ballcat-projects/ballcat-codegen
• 示例使用迁移到新的仓库：https://github.com/ballcat-projects/ballcat-samples

Added

• feat: RedisHelper 工具类新增 list 的 rightPush 和 leftPop 方法
• feat: 新增了一个基于 Redis 的线程队列
• feat: 新增解绑用户角色关联关系的功能
• feat: ExtendService#saveBatchSomeColumn 现在支持分批批量插入了
• feat: admin-websocket 新增了 Lov 弹窗选择器修改时的 websocket 推送

Changed

• refactor: 用户属性和用户资源抽象出接口，不再使用 Map 存储，具体使用类交由使用方进行构造，类似于 UserDetails

• refactor: common-desensitize 优化，支持自定义注解脱敏

• refactor: 抽象 AbstractThread 类. 让下级自定义 poll 和 put 方法.

• refactor: AbstractQueueThread 添加程序关闭时的处理方法，防止停机时的数据丢失问题

• refactor: 简化了支付宝和微信的回调类，并添加了验签方法

• refactor: 使用 Jackson2ObjectMapperBuilder 构造 ObjectMapper，保留使用配置文件配置 jackson 属性的能力，以及方便用户增加自定义配置

• refactor: xss 防注入重构，抽取成一个 starter，限制基于 jsoup 的白名单过滤，可自定义排除路径和请求类型的配置，admin-core 包现在默认集成此 starter

• refactor: 工具类添加 finnal 关键字和私有构造

• refactor: 修改 extends 下的三个支付模块的类路径, 把 starter 修改为 extend

• refactor: 优化 JsonUtils 的类型转换

• fix: 修复 LambdaQueryWrapperX#inIfPresent 参数错误处理成流，导致的 sql 拼接异常

• fix: 修复当没有字典项时，无法正常删除字典的 bug

• fix: 修复几次版本更新导致的代码生成器的各种 bug，如目录项拖动，以及zip 文件流末端损坏等

• fix: 操作日志记录时，参数为 null 导致的空指针问题

Removed

• 移除新酷卡短信组件
• 移除 mybatis-plus-extend 中的 selectByPage 方法，因为其无法真正修改返回类型，现在使用 page.convert 进行 数据转换

Dependency

• Bump virtual-currency from 0.3.2 to 0.4.1
• Bump spring-boot-admin from 2.4.0 to 2.3.1