# zuihou-admin-boot SaaS型微服务快速开发平台 [![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-2.5.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) ## 简介： 本项目是基于`SpringBoot(2.2.9.RELEASE)` 的 SaaS型前后端分离脚手架，具备用户管理、资源权限管理、Xss防跨站攻击、代码自动生成、多存储系统、分布式定时任务等多个模块，支持多业务系统并行开发，可以作为后端服务的开发脚手架。 代码简洁，架构清晰，非常适合学习和企业中使用。核心技术采用SpringBoot、Mybatis、JWT Token、Redis、RibbitMQ、FastDFS等主要框架和中间件。 希望能努力打造一套从 `SaaS基础框架` - `单体架构` - `持续集成` - `自动化部署` - `系统监测` 的解决方案。`本项目旨在实现基础能力，不涉及具体业务。` 部署方面, 可以采用以下4种方式，并会陆续公布jenkins集合以下3种部署方式的脚本和配置文件： - IDEA 启动 - jar部署 - docker部署 ## 如果您觉得有帮助，请点右上角 "Star" 支持一下，谢谢！ ## 详细文档: https://www.kancloud.cn/zuihou/zuihou-admin-cloud ps: gitee捐献 或者 二维码打赏（本页最下方）： 45元及以上 并 备注邮箱，可得开发文档一份（支持后续更新） 打赏或者捐献后直接加群：1039545140 并备注打赏时填写的邮箱，可以持续的获取最新的文档。 ## 交流群： 63202894（主群）、 1011148503（2号群） ![qq群.png](docs/image/qq群.png) zuihou-admin-cloud 交流 `加群前请先将下方项目点 star，支持下群主，谢谢😘` ## 项目代码地址 | 项目 | gitee | github | 备注 | |---|---|---|---| | zuihou-commons | https://gitee.com/zuihou111/zuihou-commons | https://github.com/zuihou/zuihou-commons | 核心工具类：boot和cloud 项目的公共抽象 | | zuihou-admin-cloud | https://gitee.com/zuihou111/zuihou-admin-cloud | https://github.com/zuihou/zuihou-admin-cloud | 微服务项目 | | zuihou-admin-boot | https://gitee.com/zuihou111/zuihou-admin-boot | https://github.com/zuihou/zuihou-admin-boot | 单体项目：功能跟cloud版一样 | | zuihou-ui | https://gitee.com/zuihou111/zuihou-ui | https://github.com/zuihou/zuihou-ui | 租户后台：租户使用 | | zuihou-admin-ui | https://gitee.com/zuihou111/zuihou-admin-ui | https://github.com/zuihou/zuihou-admin-ui | 开发&运营后台：内部使用 | | zuihou-generator | https://gitee.com/zuihou111/zuihou-generator | https://github.com/zuihou/zuihou-generator | 代码生成器：开发使用 | ## 全功能演示地址 | 项目 | 演示地址 | 管理员账号 | 普通账号 | |---|---|---|---| | 租户后台 | http://tangyh.top:10000/zuihou-ui/ | zuihou/zuihou | test/zuiou | | 开发&运营后台 | http://tangyh.top:180/zuihou-admin-ui/ | demoAdmin/zuihou | 无 | > 演示环境中内置租户没有写入权限，若要在演示环境测试增删改，请到`开发&运营后台`自行创建租户后测试 ``` 租户后台 和 开发&运营后台 2者之间的关系是什么？ A公司 使用这套SaaS脚手架二次开发了一个OA或者商城， B和C公司想使用A公司开发的这套系统，但土豪公司B有钱想要个性化功能，C公司是个穷逼，不愿意多花钱> 于是，A公司就在 zuihou-admin-ui（开发&运营后台） 上新建了 租户B 和租户C， 并各自新建了账号b1和账号c1， 分别给B公司和C公司 试用， B公司和C公司分别拿着账号， 在 zuihou-ui(租户后台) 上试用， 试用很满意，但土豪B公司先要定制功能， 就跟A公司签了一个500W的定制大单，并要求独立部署在他们自己的服务器 穷逼C公司没钱， 就花了20W使用A公司部署的云环境， 服务器和数据等都存在A公司的云服务器上。 ``` ## 功能点介绍: 1. **服务鉴权:** 通过JWT的方式来加强服务之间调度的权限验证，保证内部服务的安全性。 2. **数据权限** 利用基于Mybatis的DataScopeInterceptor拦截器实现了简单的数据权限 3. **SaaS（多租户）的无感解决方案** 使用Mybatis拦截器实现对所有SQL的拦截，COLUMN模式动态拼接租户编码，SCHEMA模式修改默认的Schema，DATASOURCE模式动态切换数据源，从而实现多租户数据隔离的目的。 并且支持可插拔。 4. **二级缓存** 采用J2Cache操作缓存，第一级缓存使用内存(Caffeine)，第二级缓存使用 Redis。 由于大量的缓存读取会导致 L2 的网络成为整个系统的瓶颈，因此 L1 的目标是降低对 L2 的读取次数。 该缓存框架主要用于集群环境中。单机也可使用，用于避免应用重启导致的缓存冷启动后对后端业务的冲击。 5. **优雅的Bean转换** 采用Dozer组件来对 DTO、DO、PO等对象的优化转换 6. **前后端统一表单验证** 严谨的表单验证通常需要 前端+后端同时验证， 但传统的项目，均只能前后端各做一次检验， 后期规则变更，又得前后端同时修改。 故在`hibernate-validator`的基础上封装了`zuihou-validator-starter`起步依赖，提供一个通用接口，可以获取需要校验表单的规则，然后前端使用后端返回的规则， 以后若规则改变，只需要后端修改即可。 7. **防跨站脚本攻击（XSS）** - 通过过滤器对所有请求中的 表单参数 进行过滤 - 通过Json反序列化器实现对所有 application/json 类型的参数 进行过滤 8. **当前登录用户信息注入器** - 通过注解实现用户身份注入 9. **在线API** 由于原生swagger-ui某些功能支持不够友好，故采用了国内开源的`swagger-bootstrap-ui`，并制作了stater，方便springboot用户使用。 10. **代码生成器** 基于Mybatis-plus-generator自定义了一套代码生成器， 通过配置数据库字段的注释，自动生成枚举类、数据字典注解、SaveDTO、UpdateDTO、表单验证规则注解、Swagger注解等。 11. **定时任务调度器**： 基于xxl-jobs进行了功能增强。（如：指定时间发送任务、执行器和调度器合并项目、多数据源） 12. **大文件/断点/分片续传** 前端采用webupload.js、后端采用NIO实现了大文件断点分片续传，启动Eureka、Zuul、File服务后，直接打开docs/chunkUploadDemo/demo.html即可进行测试。 经测试，本地限制堆栈最大内存128M启动File服务,5分钟内能成功上传4.6G+的大文件，正式服耗时则会受到用户带宽和服务器带宽的影响，时间比较长。 13. **跨表、跨库、跨服务的关联数据自动注入器** 用于解决跨表、跨库、跨服务分页数据的属性或单个对象的属性 回显关联数据之痛, 支持对静态数据属性(数据字典)、动态主键数据进行自动注入。 本项目是微服务脚手架 `zuihou-admin-cloud` 的单体架构版， 去除了SpringCloud 的部分，目的是为了简化部署、方便小型项目快速建站，但为了与`zuihou-admin-cloud`项目完美切换，所以保持一致的项目结构。 ## 技术栈/版本介绍： - 所涉及的相关的技术有： - JSON序列化:Jackson - 消息队列：RibbitMQ - 缓存：Redis - 缓存框架：J2Cache - 数据库： MySQL 5.7.9 或者 MySQL 8.0.19 - 定时器：采用xxl-jobs项目进行二次改造 - 前端：vue - 持久层框架： Mybatis-plus - 代码生成器：基于Mybatis-plus-generator自定义 - 项目构建：Maven 3.5 - 监控： spring-boot-admin 2.2.X - 文件服务器：FastDFS 5.0.5/阿里云OSS/本地存储 - Nginx - 部署方面： - 服务器：CentOS - Jenkins - Docker 18.09 - Kubernetes 1.12 本代码采用 Intellij IDEA 来编写，但源码与具体的 IDE 无关。 PS: Lombok版本过低会导致枚举类型的参数无法正确获取参数，经过调试发现因为版本多低后，导致EnumDeserializer的 Object obj = p.getCurrentValue();取的值为空。 ## 项目截图： | 预览 | 预览 | | ------------------------------------------------------ | ------------------------------------------------------ | | ![SBA监控.png](docs/image/项目相关/开发%26运营后台预览.png) | ![SBA监控.png](docs/image/项目相关/租户后台预览.png) | | ![swagger.png](docs/image/项目相关/swagger获取token.jpg) | ![admin-api.png](docs/image/项目相关/admin-api.png) | | ![SBA监控.png](docs/image/1000star.png) | ![定时任务.png](docs/image/项目相关/zuihou-jobs-server.png) | ## 友情链接 & 特别鸣谢 * SaaS型微服务快速开发平台：[https://github.com/zuihou/zuihou-admin-cloud](https://github.com/zuihou/zuihou-admin-cloud) * SaaS型单体快速开发平台：[https://github.com/zuihou/zuihou-admin-boot](https://github.com/zuihou/zuihou-admin-boot) * MyBatis-Plus：[https://mybatis.plus/](https://mybatis.plus/) * knife4j：[http://doc.xiaominfo.com/](http://doc.xiaominfo.com/) * hutool：[https://hutool.cn/](https://hutool.cn/) * xxl-job：[http://www.xuxueli.com/xxl-job/](http://www.xuxueli.com/xxl-job/) * kkfileview：[https://kkfileview.keking.cn](https://kkfileview.keking.cn) * j2cache：[https://gitee.com/ld/J2Cache](https://gitee.com/ld/J2Cache) * FEBS Cloud Web： [https://gitee.com/mrbirdd/FEBS-Cloud-Web](https://gitee.com/mrbirdd/FEBS-Cloud-Web) zuihou-ui 和 zuihou-admin-ui 基于本项目改造 * Cloud-Platform： [https://gitee.com/geek_qi/cloud-platform](https://gitee.com/geek_qi/cloud-platform) 作者学习时接触到的第一个微服务项目 ## 写在最后： 本项目正在开发阶段，由于作者白天要上班，只有晚上、周末能挤点时间来敲敲代码，所以进度可能比较慢，文档、注释也不齐全。 各位大侠就将就着看，但随着时间的推移。文档，注释，启动说明等码主我一定会补全的（对自己负责，也是对大家负责）。 ## 项目不错，支持一下吧 ![支持一下.png](docs/image/请作者买瓶防脱发药水吧.png) ps: gitee捐献 或者 二维码打赏（本页最下方）： 45元及以上 并 备注邮箱，可得开发文档一份（支持后续更新） 打赏或者捐献后直接加群：1039545140 并备注打赏时填写的邮箱，可以持续的获取最新的文档。