[![AUR](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://github.com/zuihou/zuihou-admin-cloud/blob/master/LICENSE) | [![](https://img.shields.io/badge/Author-zuihou-orange.svg)](https://github.com/zuihou/zuihou-admin-cloud) | [![](https://img.shields.io/badge/version-1.0-brightgreen.svg)](https://github.com/zuihou/zuihou-admin-cloud) | [![GitHub stars](https://img.shields.io/github/stars/zuihou/zuihou-admin-cloud.svg?style=social&label=Stars)](https://github.com/zuihou/zuihou-admin-cloud/stargazers) | [![star](https://gitee.com/zuihou111/zuihou-admin-cloud/badge/star.svg?theme=white)](https://gitee.com/zuihou111/zuihou-admin-cloud/stargazers) | [![GitHub forks](https://img.shields.io/github/forks/zuihou/zuihou-admin-cloud.svg?style=social&label=Fork)](https://github.com/zuihou/zuihou-admin-cloud/network/members) | [![fork](https://gitee.com/zuihou111/zuihou-admin-cloud/badge/fork.svg?theme=white)](https://gitee.com/zuihou111/zuihou-admin-cloud/members) ## 简介: 本项目是基于`SpringCloud(Hoxton.SR3)` + `SpringBoot(2.2.7.RELEASE)` 的 SaaS型微服务脚手架,具备用户管理、资源权限管理、网关统一鉴权、XSS防跨站攻击、自动代码生成、多存储系统、分布式事务、分布式定时任务等多个模块,支持多业务系统并行开发,支持多服务并行开发,可以作为后端服务的开发脚手架。代码简洁,架构清晰,非常适合学习和实际项目中使用。核心技术采用Nacos、Fegin、Ribbon、Zuul、Hystrix、JWT Token、Mybatis、SpringBoot、Seata、Sentinel、RabbitMQ、FastDFS等主要框架和中间件。 希望能努力打造一套 `SaaS基础框架` - `分布式微服务架构` - `持续集成` - `自动化部署` - `系统监测` 的解决方案。 另`本项目旨在实现基础能力,不涉及具体业务`,项目中很多配置都严格按照开发+生产级动态切换的设计思路,所以很多配置比较绕,需要对框架有一定的了解才能理解(这也是跟其他所谓的demo型的“开源项目”,所有配置都使用默认配置最大的区别),努力达到:`开发环境效率第一、生产环境的安全&性能第一!`。 ## 模式介绍 本项目可以通过修改配置文件的中一个参数,轻松切换项目的 **租户模式**。 ``` zuihou: database: multiTenantType: SCHEMA # 可选值: NONE COLUMN SCHEMA DATASOURCE ``` | 租户模式 | 描述 | 优点 | 缺点 | |---|---|---|---| | NONE(非租户模式) | 没有租户 | 简单、适合独立系统 | 缺少租户系统的优点 | | COLUMN(字段模式) | 租户共用一个数据库,在业务表中增加字段来区分 | 简单、不复杂、开发无感知 | 数据隔离性差、安全性差、数据备份和恢复困难、 | | SCHEMA(独立schema) | 每个租户独立一个 数据库(schema),执行sql时,动态在表名前增加schema | 简单、开发无感知、数据隔离性好 | 配置文件中必须配置数据库的root账号、不支持复杂sql和 sql嵌套自定义函数 | | DATASOURCE(独立数据源) | 每个租户独立一个 数据库(数据源),执行代码时,动态切换数据源 | 可独立部署数据库,数据隔离性好、扩展性高、故障影响小 | 相对复杂、开发需要注意切换数据源时的事务问题、需要较多的数据库 | | 模式\描述 | 表中有无租户字段 | 实体类中有无租户字段 | 分布式事务| 有几个数据库 | |---|---|---|---|---| | NONE | 无 | 无 | 支持 | zuihou_defaults | | COLUMN | 有 | 无 | 支持 | zuihou_column | | SCHEMA | 无 | 无 | 支持 | zuihou_defaults、zuihou_base_{tenant} | | DATASOURCE | 无 | 无 | 支持 | zuihou_defaults、zuihou_base_{tenant} | 部署方面, 可以采用以下4种方式,并会陆续公布jenkins集合以下3种部署方式的脚本和配置文件: - IDEA 启动 - jar部署 - docker部署 - k8s部署 ## 技术栈/版本介绍: - 所涉及的相关的技术有: - 前端:vue、element-ui - 消息队列:RabbitMQ - 缓存:Redis - 缓存框架:J2Cache 二级缓存 - 数据库: MySQL 5.7.x 或者 MySQL 8.0.19 - 持久层框架: Mybatis-plus - 文件存储:FastDFS 5.0.5 / 阿里云OSS / 七牛 / 本地存储 (可配置) - 前后端统一表单验证:hibernate-validater - 在线文档: knife4j - 定时器:采用xxl-jobs项目进行二次改造 - 代码生成器:基于Mybatis-plus-generator自定义 - 注册中心&配置中心:Nacos - API网关:Zuul & Gateway - 服务消费:OpenFeign - 负载均衡:Ribbon - 配置中心:Nacos - 服务熔断:Hystrix - 分布式事务: Seata - 分布式系统的流量防卫兵: Sentinel - 监控: spring-boot-admin 2.2 - 链路调用跟踪: zipkin 2.19 - 项目构建:Maven 3.5+ - Nginx - 部署方面: - 服务器:CentOS - Jenkins - Docker 18.09 - Kubernetes 1.12 ## 功能点介绍: 1. **服务注册&发现与调用:** 基于Nacos来实现的服务注册与发现,使用使用Feign来实现服务互调, 可以做到使用HTTP请求远程调用时能与调用本地方法一样的编码体验,开发者完全感知不到这是远程方法,更感知不到这是个HTTP请求。 2. **服务鉴权:** 通过JWT的方式来加强服务之间调度的权限验证,保证内部服务的安全性。 3. **负载均衡:** 将服务保留的rest进行代理和网关控制,除了平常经常使用的node.js、nginx外,Spring Cloud系列的zuul和ribbon,可以帮我们进行正常的网关管控和负载均衡。其中扩展和借鉴国外项目的扩展基于JWT的Zuul限流插件,方面进行限流。 4. **熔断机制:** 因为采取了服务的分布,为了避免服务之间的调用“雪崩”,采用了Hystrix的作为熔断器,避免了服务之间的“雪崩”。 5. **监控:** 利用Spring Boot Admin 来监控各个独立Service的运行状态;利用turbine来实时查看接口的运行状态和调用频率;通过Zipkin来查看各个服务之间的调用链等。 6. **链路调用监控:** 利用Zipkin实现微服务的全链路性能监控, 从整体维度到局部维度展示各项指标,将跨应用的所有调用链性能信息集中展现,可方便度量整体和局部性能,并且方便找到故障产生的源头,生产上可极大缩短故障排除时间。有了它,我们能做到: > 请求链路追踪,故障快速定位:可以通过调用链结合业务日志快速定位错误信息。 > 可视化:各个阶段耗时,进行性能分析。 >依赖优化:各个调用环节的可用性、梳理服务依赖关系以及优化。 >数据分析,优化链路:可以得到用户的行为路径,汇总分析应用在很多业务场景。 7. **数据权限** 利用基于Mybatis的DataScopeInterceptor拦截器实现了简单的数据权限 8. **SaaS(多租户)的无感解决方案** 使用Mybatis拦截器实现对所有SQL的拦截,修改默认的Schema,从而实现多租户数据隔离的目的。 并且支持可插拔。 9. **二级缓存** 采用J2Cache操作缓存,第一级缓存使用内存(Caffeine),第二级缓存使用 Redis。 由于大量的缓存读取会导致 L2 的网络成为整个系统的瓶颈,因此 L1 的目标是降低对 L2 的读取次数。 该缓存框架主要用于集群环境中。单机也可使用,用于避免应用重启导致的缓存冷启动后对后端业务的冲击。 10. **优雅的Bean转换** 采用Dozer组件来对 DTO、DO、PO等对象的优化转换 11. **前后端统一表单验证** 严谨的表单验证通常需要 前端+后端同时验证, 但传统的项目,均只能前后端各做一次检验, 后期规则变更,又得前后端同时修改。 故在`hibernate-validator`的基础上封装了`zuihou-validator-starter`起步依赖,提供一个通用接口,可以获取需要校验表单的规则,然后前端使用后端返回的规则, 以后若规则改变,只需要后端修改即可。 12. **防跨站脚本攻击(XSS)** - 通过过滤器对所有请求中的 表单参数 进行过滤 - 通过Json反序列化器实现对所有 application/json 类型的参数 进行过滤 13. **当前登录用户信息注入器** - 通过注解实现用户身份注入 14. **在线API** 由于原生swagger-ui某些功能支持不够友好,故采用了国内开源的`swagger-bootstrap-ui`,并制作了stater,方便springboot用户使用。 15. **代码生成器** 基于Mybatis-plus-generator自定义了一套代码生成器, 通过配置数据库字段的注释,自动生成枚举类、数据字典注解、SaveDTO、UpdateDTO、表单验证规则注解、Swagger注解等。 16. **定时任务调度器**: 基于xxl-jobs进行了功能增强。(如:指定时间发送任务、执行器和调度器合并项目、多数据源) 17. **大文件/断点/分片续传** 前端采用webupload.js、后端采用NIO实现了大文件断点分片续传,启动Eureka、Zuul、File服务后,直接打开docs/chunkUploadDemo/demo.html即可进行测试。 经测试,本地限制堆栈最大内存128M启动File服务,5分钟内能成功上传4.6G+的大文件,正式服耗时则会受到用户带宽和服务器带宽的影响,时间比较长。 18. **分布式事务** 集成了阿里的分布式事务中间件:seata,以 **高效** 并且对业务 **0侵入** 的方式,解决 微服务 场景下面临的分布式事务问题。 19. **跨表、跨库、跨服务的关联数据自动注入器** 用于解决跨表、跨库、跨服务分页数据的属性或单个对象的属性 回显关联数据之痛, 支持对静态数据属性(数据字典)、动态主键数据进行自动注入。 20. **灰度发布** 为了解决频繁的服务更新上线,版本回退,快速迭代,公司内部协同开发,本项目采用修改ribbon的负载均衡策略来实现来灰度发布。 ## 项目架构图: ![](https://img.kancloud.cn/2c/32/2c3290f28cd72504dc5b8cf3458dd506_1381x856.png) ## 项目结构: ~~~ ├─zuihou-admin-cloud │ │ │ ├─docs---------------------------------常用文档&脚本 │ │ │ ├─third-party---------------------------第三方组件 │ │ │ ├─zuihou-common-------------------------公共的业务代码 │ ├─zuihou-oauth--------------------------认证服务 │ ├─zuihou-authority----------------------权限服务 │ | ├─zuihou-authority-api---------------权限服务API模块 │ | ├─zuihou-authority-biz---------------权限服务权限模块业务层 │ | ├─zuihou-authority-controller--------权限服务权限模块接口层 │ | ├─zuihou-authority-entity------------权限服务权限模块实体层 │ | ├─zuihou-authority-server------------权限服务启动模块 │ | ├─zuihou-tenant-biz------------------权限服务租户模块业务层 │ | ├─zuihou-tenant-controller-----------权限服务租户模块接口层 │ | ├─zuihou-tenant-entity---------------权限服务租户模块实体层 │ ├─zuihou-demo---------------------------演示服务 │ ├─zuihou-file---------------------------文件模块服务 │ ├─zuihou-gateway------------------------统一网关负载中心 │ | |─zuihou-gateway-server--------------gateway网关服务 │ | |─zuihou-zuul-server-----------------zuul网关服务 │ ├─zuihou-jobs---------------------------定时任务调度执行器 │ ├─zuihou-msgs---------------------------消息模块服务 │ ├─zuihou-order--------------------------订单服务 │ │ │ ├─zuihou-support-------------------------监控支撑模块 │ | ├─zuihou-monitor----------------------spring-boot-admin监控中心 │ │ ├─zuihou-commons--------------------------公共模块 | ├─zuihou-boot--------------------------SpringBoot的封装 │ ├─zuihou-cache-starter-----------------缓存模块 【最新缓存参考 zuihou-j2cache-start】 │ ├─zuihou-cloud-starter-----------------SpringCloud常用配置起步依赖 │ ├─zuihou-core--------------------------项目核心模块 (核心模块存放无业务逻辑的公共代码) │ ├─zuihou-databases---------------------项目数据源配置模块 │ ├─zuihou-dozer-starter-----------------优雅的bean转换起步依赖 │ ├─zuihou-injection-starter-------------关联数据自动注入器 │ ├─zuihou-j2cache-starter---------------二级缓存配置 │ ├─zuihou-jwt-starter-------------------JWT起步依赖 │ ├─zuihou-log-starter-------------------操作日志起步依赖 │ ├─zuihou-mq-starter--------------------RabbitMQ起步依赖 │ ├─zuihou-scan-starter------------------扫描服务所有URI接口的组件 │ ├─zuihou-swagger2-starter--------------SwaggerUI文档配置 │ ├─zuihou-security-starter------------------用户信息自动注入起步依赖 │ ├─zuihou-validator-starter-------------增强表单前后端统一验证起步依赖 │ ├─zuihou-xss-starter-------------------防跨站攻击起步依赖 │ ├─zuihou-zipkin-client-starter---------zipkin 客户端统一配置 (只有依赖,没有代码) │ │ │ ├─zuihou-dependencies----------------------项目顶级pom (在zuihou-commons工程中) │ │ │ │-... ~~~ ## 优秀工具&友情链接 - [https://gitee.com/xiaoym/knife4j](https://gitee.com/xiaoym/knife4j):为Java MVC框架集成Swagger生成Api文档的工具 - [https://github.com/baomidou/mybatis-plus](https://github.com/baomidou/mybatis-plus): 是一个[MyBatis](http://www.mybatis.org/mybatis-3/)的增强工具 - [https://gitee.com/loolly/hutool](https://gitee.com/loolly/hutool) : 小而全的Java工具类库