一、功能特征

二、模块说明

smart-cloud├──smart-api-core -- 接口权限、加解密、签名等注解 && 用户上下文│  ├──smart-api-annotation -- 接口权限、加解密、签名等注解│  └──smart-user-context -- 用户上下文├──smart-code-generate -- 代码生成├──smart-common-pojo -- 公共对象（VO、DTO、BO、DO等）├──smart-common-web -- web模块公共处理├──smart-constants -- 常量模块├──smart-exception -- 异常模块├──smart-mask -- 敏感数据混淆├──smart-test -- test封装│  ├──smart-cloud-starter-test -- test封装│  ├──smart-cloud-starter-test-mock-rabbitmq -- test rabbitmq模块封装│  ├──smart-cloud-starter-test-mock-redis -- test redis模块封装│  └──smart-cloud-test-core -- test 单元测试、集成测试封装├──smart-utility -- 工具类└──smart-could-starter -- 框架封装   ├──smart-cloud-starter-api-version -- 接口多版本控制   ├──smart-cloud-starter-configure -- 框架配置属性封装   ├──smart-cloud-starter-core -- 框架核心（自定义注解、异常封装、请求响应公共参数、业务相关工具类）   ├──smart-cloud-starter-elasticsearch-dynamic-datasource -- elasticsearch动态数据源   ├──smart-cloud-starter-feign -- feign封装（可拆可合、切面处理）   ├──smart-cloud-starter-global-id -- 分布式id生成器   ├──smart-cloud-starter-job -- 定时任务封装   ├──smart-cloud-starter-locale -- 国际化封装   ├──smart-cloud-starter-log4j2 -- 日志封装（log4j2日志打印，支持日志敏感数据脱敏）   ├──smart-cloud-starter-logback -- 日志封装（logback日志打印，支持日志敏感数据脱敏）   ├──smart-cloud-starter-method-log -- 方法切面日志封装   ├──smart-cloud-starter-mock -- mock封装（mock工具类、常用mock策略、请求接口mock拦截器）   ├──smart-cloud-starter-mp-shardingjdbc -- mybatis plus、dynamic-datasource、shardingjdbc封装（支持多数据源、分库分表；mapper工具类）   ├──smart-cloud-starter-mybatis-plus -- mybatis plus、dynamic-datasource封装（支持多数据源；mapper工具类、表隐私字段加解密等）   ├──smart-cloud-starter-rabbitmq -- rabbitmq封装（消费失败，自动放入延迟队列重新消费）   ├──smart-cloud-starter-rate-limit -- 接口限流   ├──smart-cloud-starter-redis -- redis封装、自定义分布式锁注解   ├──smart-cloud-starter-static-discovery -- 支持feign client的服务地址从配置中心动态获取（不通过注册中心）   ├──smart-cloud-starter-web -- web封装（日志切面、异常处理、参数校验）   └──smart-cloud-starter-monitor -- 服务监控，接口监控      ├──smart-cloud-monitor-common -- 监控公共代码      ├──smart-cloud-starter-monitor-api -- 接口异常监控      └──smart-cloud-starter-monitor-admin -- spring boot admin监控（服务状态、gc、线程数、内存、cpu、tomcat等），企业微信发通知

三、技术栈

四、服务合并原理

五、相关说明

（一）服务合并遇到的问题

1、bean名称冲突

不同服务合并打一起后，会存在bean名称冲突的问题。通过自定义bean名称生成规则解决。

2、rpc与rpc实现类冲突

自定义条件注解封装FeignClient。使其在单体服务时，rpc走feign；在合体服务时，rpc走内部进程通信。

3、yaml文件的自动加载

自定义注解YamlScan，用来加载配置的yaml文件（支持正则匹配）。通过SPI机制，在spring.factories文件中添加EnvironmentPostProcessor的实现类，通过其方法参数SpringApplication获取启动类的信息，从而获取YamlScan注解配置的yaml文件信息。然后将yaml文件加到ConfigurableEnvironment中。

4、启动类注解冲突

自定义条件注解SmartSpringCloudApplicationCondition，只会让启动类标记的启动注解生效。

5、maven打包异常

合体服务打包时，单体服务依赖的包也打进单体服务jar。通过maven profiles解决

（二）日志数据脱敏

1.从日志侧切入，自定义标签，打印日志时进行脱敏处理；2.自定义jackson的序列化器；打印日志时，采用自定义的序列化器；3.通过反射获取log传入参数的MaskRule注解信息，最终根据注解规则进行字符串的截取与替换。

（三）服务监控

1、服务离线通知

2、服务健康检测没通过

3、服务上线

（四）接口mock数据

（五）测试

1、单元测试

2、集成测试

3、系统测试

（六）接口文档

1、接口文档由以下步骤自动生成：

2、接口文档效果图

概要

详情

七、错误码说明