目的
该子框架主要基于技术栈及业务背景对常用的技术组件进行封装。
报文的封装规则
- 统一请求报文的解析。
- 统一返回报文的格式,包括业务异常。
异常的封装规则
- 将异常分为技术框架的异常和业务异常。
- 由于技术框架的异常不应该抛给系统功能的使用者,所以技术框架异常为可捕获的异常,业务开发者在调用API时,应用捕获该技术框架异常,转换为相关业务异常。
- 业务异常为运行时或不可捕获异常,直接将相关的业务异常提示信息抛出给框架。
- 为提高系统的运营及运维能力,为异常提供异常编码机制,可以基于编码机制辅助运维快速定位问题、分析问题,以及协助开发处理问题。
- 通过配置方式,启动异常归集功能,使对应的异常信息可以记录到类似于sentry的信息归集组件中。//TODO
数据库操作封装规则
- 封装实体接口,所有实体对象都应该继续实现接口,当实体保存时为实体生成主键值。
- 封装基本实体接口,所有基本实体对象在持久化时,为实体保存实体创建时间,在实体对象更新时,为实体对象更新最新更新时间。
- 封装有层级结构的实现,当保存更新层级实体时,需要设置交级实体。
- 提供一个通用持久层操作接口,提供实体最基本的CURD操作。
- 提供翻页对象,实现翻页查询功能。//TO CHECK
- 提供配置参数,控制所执行的SQL语句打印,方便功能开发时候的连调工作。
线程池封装规则
- 参数配置化线程池
- 对线程池进行重命名,方便日常系统监控。
分布式锁封装规则
- 封装分布式锁接口,为开发实现某些业务功能时提供分布式锁机制。
分布式缓存规则
- 封装分布式缓存接口,为高频读、低频写的数据提供分布式缓存的功能。
- 扩展Cache注解,使Cache注解基于分布式缓存实现。
日志封装规则
- 提供日志记录的统一日志格式配置。
- 提供审计功能,并可以配置审计信息持久化方式。
- 提供埋点功能,为开发埋点记录关键业务信息提供统一实现方式。
API元数据封装规则
- 基于注解配置API接口元数据信息。
- 提供配置文件,可以配置API接口元数据的一些参数。
消息组件的支持
//TODO
全文检索日志查询的支持
//TODO
网友评论