4 Star 6 Fork 3

ChinaLym / shoulder-framework

2020-12-06 22:22
ChinaLym

0.5(2020年12月6日)

拓展新功能,维护已有模块的设计,对接错误码等规范,修复多个缺陷。

亮点:

  • 分布式id生成器性能提升(魔改雪花算法吊打各家实现)
  • 基于SpringSecurity 安全的认证,该版本已经稳定,且实现了部分默认配置。目前支持 session / common token / jwt / jwk。
  • 分布式锁(兼容jdk接口:可重入的redis实现,兼顾嵌套事务的数据库实现)
  • 快速接入批量业务
  • 操作日志框架支持嵌套调用(参考了 Spring 的事务传播)

大概改动

  • 批量业务抽象支持

    • csv / excel 解析
    • 批量校验、查询进度、导入、查询进度、查询导入历史、导入详情
    • 导出
  • 全局id生成器

    • 性能提升
    • 增加透支消费上限配置、智能阻塞
    • 超高压力下识别缓存buffer过度消费(只在单节点亿级/s以上的压测中才可能出现)
  • web

    • 全局异常拦截:现在会对 JSR303 校验框架抛出的异常做详细日志记录以及返回值封装
    • 日志记录:支持记录 MultiPartFile 类型参数信息
  • 校验框架

    • 参数相关错误码移动至 validate
    • 提供默认翻译项(通过插件生成)
    • @MimeType 改为 @FileType 并增加更多校验能力
      • 文件类型检查从 mime 类型,改为后缀名 allowList -> allowSuffix
      • 增加对文件头的检查
      • 增加对文件大小的检查
      • 增加对文件名称格式限制检查(支持正则,包含允许字符检查、禁止字符检查)
      • 增加对批量文件上传校验支持
  • 日志框架

    • 为 debug、info、warn 级别增加类似 errorWitErrorCode 的方法,支持更低级别打印错误码
    • core 中提供 LogHelper 用于生成方法栈目标栈的跳转链接(从 http 的 HttpLogHelper 迁移)
  • 优化基础包中的非必选强依赖

    • 如 spring,降低最小使用依赖成本
  • 默认使用 Undertow 而非 Tomcat

    • 取消各个模块对 tomcat 的依赖
    • 注意 undertow 不支持jsp
    • 废弃该需求,不实现:默认 tomcat、若希望使用 undertow 使用者自行排除即可
  • 分布式锁

    • 提供锁的概念、接口定义
    • 默认实现
      • JDK 适配(非分布式)
      • 基于内存(伪分布式,默认)
      • 基于数据库(依赖了数据库则默认使用该方式)
      • 基于 Redis
  • 加解密

    • 修复本地存储加解密中-文件存储-未配置存储路径时未能正确新建
    • 本地存储加解密中-文件存储-支持多个工程同时启动且共享一个文件
    • 本地存储加解密中-文件存储-内容为空(如手动清空,但不删除该文件)导致的加载失败
    • 修复密钥交换流程错误bug
    • 密钥交换流程增加额外处理:服务器缓存意外失效后,客户端自动清理无效缓存并重新发起协商(如 redis 宕机重启,且恰好服务端密钥交换缓存丢失,而客户端密钥交换缓存还在)
    • 删除加解密门面接口,因为可能未使用所有加密方式
    • 默认项目启动后,异步初始化本地加解密,以提升第一次调用性能
  • 安全与认证

    • 提供 Token 认证方式默认实现和装配
    • 完善 session 认证中条件装配
    • 添加基于 Session 认证 Demo
    • 添加基于 Token 认证 Demo
  • 验证码框架

    • 支持一个 url 需要校验多种验证码
  • 操作日志框架

    • 支持加了该注解的方法 A 中调用 加了该注解的方法 B 时
    • 支持自定义业务传播行为(日志上下文创建策略),接口:OperationContextStrategy
    • 调整日志上下文的包名、创建器类名 OperationLogBuilder -> OperationLogFactory
Last committed message: doc(0.5) 调整插件,发布 0.5
2020-09-25 20:40
ChinaLym
  • 数据库功能增强:分页、自动补充创建者、修改者、创建时间、修改时间
  • 更简单的服务间安全传输(基于ECDH,jdk15中才加的功能,shoulder已经在jdk8中实现,且为Spring Boot 提供了开箱即用的能力)
  • 增加 ColorStringBuilder,方便构建彩色输出
  • 优化新增自动日志与美化(自动区分本地和生产环境)
    • HTTP 接口自动记录日志支持单行格式
    • 自动记录 RestTemplate 接口调用,默认支持彩色和单行两种
    • 重构日志自动记录类关系,便于二次扩展,自定义日志规则(如某些用户记录、特定请求记录等)与格式
  • 完善安全认证实现,browser可用
  • 完善验证码框架,可用
  • 增加监控模块(线程池监控、错误码、异常监控),基于 micrometer,可使用 Prometheus 等对接
  • 升级依赖 Spring Boot-> 2.3.4, Cloud-> H.S8,修复 RFD 漏洞
  • 废弃 trace、minio、aopx 三个模块,移动至 shoulder-platform 中,Spring 高级特性使用保留原生用法
Last committed message: deploy(0.3): 去除编译警告
2020-09-11 01:26
ChinaLym

0.2(2020年9月10日)

  • 数据库功能支撑
    • 连接池选型为 beeCP,近似 spring boot 默认连接池两倍性能
    • 引入 mybatis-plus 增强 mybatis
    • 数据源动态切换
  • 更舒服的控制台日志(针对开发阶段、基于色彩学,DEBUG=淡灰色;INFO=控制台默认色;Warn=蓝色;异常/Error=粗体、红色;行号:蓝色;线程名称/线程id/时间=跟随日志级别)
  • JSON 工具支持自动扩展
  • 新增http接口自动记录日志 Controller日志
    • 开发阶段更好的调试体验
    • 支持IDE点击打印日志,自动跳转代码位置
  • 可监控、动态调整的线程池
    • 可实现负载告警、动态扩容、资源释放、执行统计
  • 将 spring-web 日志级别提高为INFO,防止无用日志过多
  • 添加监控对接技术方案
Last committed message: doc(0.2) 准备0.2版本发布
2020-08-09 17:34
ChinaLym

Shoulder 的第一个可用的版本包含

  • shoulder-base(功能实现)
    • shoulder-core
      • 核心包(日志、错误码、翻译、标准DTO、工具、应用基本信息、常用转换器)
    • shoulder-validation
      • 参数校验相关
    • shoulder-web
      • web 项目功能增强
    • shoulder-operation-log
      • 记录操作日志
    • shoulder-crypto
      • 加解密相关
    • shoulder-operation-log
      • 记录操作日志
  • shoulder-starters(利用 spring-boot 进行自动装配,方便更简单的使用)
    • shoulder-autoconfiguration
      • 自动配置包(定位类似 spring-boot-autoconfiguration)
    • shoulder-starter
      • 包含 shoulder-core shoulder-autoconfiguration(定位类似 spring-boot-starter)
    • shoulder-starter-web
      • web 项目功能增强,spring boot 项目直接引入这个(定位类似 spring-boot-starter-web)
    • shoulder-starter-beanmap

示例工程: github gitee

Shoulder 更多模块正在迭代中,现在仍然处于1.0.0之前的版本,为了更好的使用或维护仍有可能进行重构~

Last committed message: add tag.sh
Java
1
https://gitee.com/ChinaLym/shoulder-framework.git
git@gitee.com:ChinaLym/shoulder-framework.git
ChinaLym
shoulder-framework
shoulder-framework

Search