Chaos Server
基于 Spring Boot 的 Java Web Server 框架, 简化开发, 封装了常见的企业级项目开发框架, 如 Mybaits
, Spring Security
, Shiro
, JPA
等。
<dependency>
<groupId>net.cofcool.chaos</groupId>
<artifactId>chaos-server-${MODULE_NAME}</artifactId>
<version>${VERSION}</version>
</dependency>
查看更新日志
使用可查看 示例项目
模块说明
- common 该模块定义了基本接口和类等。
- core 核心实现,包括拦截器, 国际化,Json 解析等
- data-jpa
JPA
相关的基础Service
和工具类等 - data-mybatis
Mybatis
相关的基础Service
和工具类等 - data-redis 提供
Redis
所需依赖。 - security-shiro 封装了
Shiro
,简化开发流程。 - security-spring 封装了
Spring Security
,简化开发流程。 - actuator 提供监控所需依赖。
- component-processor 编译时扫描
BaseComponent
注解,该注解可标识基础组件, 避免组件调用混乱。 - boot-starter 根据
Spring Boot
规范进行自动化配置。
配置
# 是否调试模式
chaos.development.debug=false
# 项目版本
chaos.development.version=100
# 是否开启验证码
chaos.auth.using-captcha=false
# 定义扫描 Scanned 注解的路径
chaos.development.annotation-path=net.cofcool.chaos.server.demo
# "Spring Security" 项目, 该配置为匿名访问路径; "Shiro" 为授权路径配置, 即"filterChainDefinitions"
chaos.auth.urls=/auth/**\=anon,/error\=anon,/**\=authc
# 登陆路径
chaos.auth.login-url=/auth/login
# 注入数据key配置, 多个时以","分隔
chaos.auth.checked-keys=id
使用
业务相关Service可继承DataAccess
接口, 实现类可继承SimpleService
抽象类。
使用Page
类封装分页的相关数据, ORM模块的Paging
继承并扩展。
- Mybatis: 通过
PageHelper
分页。 - Jpa: 通过
Pageable
分页。
异常处理时, 自定义业务相关异常需继承ServiceException
。如需设定异常级别, 实现ExceptionLevel
接口即可, 该级别影响异常的打印。ServiceException
已实现该接口, 默认为最高级别。
授权处理
封装了Apache Shiro
和Spring Security
, 应用可依赖security-shiro
模块或security-spring
模块来实现授权管理。
AuthService
类定义了登录等操作, 应用不需要实现该类, 只需引用该组件即可, Shiro
模块需要通过调用该类的login
来实现登录,Spring Security
的登录由"filter"完成,因此不需要调用该方法。
UserAuthorizationService
定义应用操作, 应用需实现该类。
PasswordProcessor
定义密码处理操作, 应用需实现该类。
User
存储用户信息。
Service 层
DataAccess
定义"Service"常用的方法。
Result
封装运行结果,提供两个子接口,QueryResult
封装查询结果,其它情况由ExecuteResult
处理。
抽象类SimpleService
实现DataAccess
类,实现query
方法,简化分页操作,定义queryWithPage
方法,用于分页查询。通过ExceptionCodeManager
描述执行状态错误码等。JPA 应用的"Service"可继承SimpleJpaService
。
Controller 层
默认提供三种"Controller(使用Scanned
注解)"代理类:
- 注入用户数据到请求参数中, 即数据隔离,实现类为
ApiProcessingInterceptor
- 请求日志打印,实现类为
LoggingInterceptor
- 参数校验,实现类为
ValidateInterceptor
1. Json解析
ResponseBodyMessageConverter
支持把Result
, Number
, String
, Result.ResultState
等对象转为Message
对象,即可保证接口返回的数据统一为Message
规定的格式(), 应用可调用Message.of()
方法创建实例。
异常处理
默认处理异常类型
GlobalHandlerExceptionResolver
处理在请求中发生的异常,包括如下异常:
- ServiceException
- NullPointerException, IndexOutOfBoundsException, NoSuchElementException
- HttpMessageNotReadableException
- UnsupportedOperationException
- MethodArgumentNotValidException
- DataAccessException
除以上异常外,其它异常由 Spring 的DefaultHandlerExceptionResolver
处理。
把异常信息包装为Message
对象,保证发生异常时的响应格式符合接口规范。
注意:当运行在Debug
模式时,会优先调用DefaultHandlerExceptionResolver
处理异常。
描述信息
应用中的描述信息统一由 ExceptionCodeManager
处理。ExceptionCodeDescriptor
封装了描述信息,默认提供了两种类型:
- SimpleExceptionCodeDescriptor
- ResourceExceptionCodeDescriptor
SimpleExceptionCodeDescriptor
为默认配置,包含了常见的描述代码和描述信息,例如操作成功,操作失败等。
ResourceExceptionCodeDescriptor
从"messages"文件中读取配置的描述信息。
后续计划
-
data-mybatis
模块集成通用 Mapper - 完善单元测试