AUR | | | GitHub stars | star | GitHub forks | fork

简介:

本项目是基于SpringCloud(Greenwich.RELEASE) + SpringBoot(2.1.2.RELEASE) 的微服务 脚手架,
具备用户管理、资源权限管理、网关统一鉴权、Xss防跨站攻击、自动代码生成、多存储系统、分布式事务、分布式定时任务等多个模块,支持多业务系统并行开发,支持多服务并行开发,可以作为后端服务的开发脚手架。代码简洁,架构清晰,非常适合学习使用。

核心技术采用Eureka、Fegin、Ribbon、Zuul、Hystrix、JWT Token、Mybatis、SpringBoot、Seata、Nacos、Sentinel、RabbitMQ、FastDFS等主要框架和中间件。

希望能努力打造一套从 基础框架 - 分布式微服务架构 - 持续集成 - 自动化部署 - 系统监测 的解决方案。

该项目为本人在学习过程中通过一些其他的开源项目资料文章进行整合的一个提供基础功能的项目。本项目旨在实现基础能力,不设计具体业务。
目前国内的一些资料讲解和使用的SpringCloud版本都比较低,而一些开源项目,则大多不适用于生产,
自己在基于现有的开源项目和资料学习的同时,将一些想法和最佳实践落地为本项目。

部署方面, 可以采用以下4种方式,并会陆续公布jenkins集合以下3种部署方式的脚本和配置文件:

  • IDEA 启动
  • jar部署
  • docker部署
  • k8s部署

技术栈/版本介绍:

  • 所涉及的相关的技术有:
    • JSON序列化:Jackson
    • 消息队列:RabbitMQ
    • 数据库: MySQL 5.7.9 (驱动6.0.6)
    • 定时器:采用xxl-jobs项目进行二次改造
    • 前端:vue
    • 持久层框架: Mybatis-plus
    • 代码生成器:基于Mybatis-plus-generator自定义 [https://github.com/zuihou/zuihou-generator.git]
    • API网关:Zuul
    • 服务注册与发现:Eureka -> Nacos
    • 服务消费:OpenFeign
    • 负载均衡:Ribbon
    • 配置中心:Nacos
    • 服务熔断:Hystrix
    • 项目构建:Maven 3.3
    • 分布式事务: Seata
    • 分布式系统的流量防卫兵: Sentinel
    • 文件服务器:FastDFS 5.0.5/阿里云OSS/七牛/本地存储
    • Nginx
  • 部署方面:
    • 服务器:CentOS
    • Jenkins
    • Docker 18.09
    • Kubernetes 1.12

本代码采用 Intellij IDEA(2019.02) 来编写,虽然源码与具体的 IDE 无关,但目前已经发现好几个用户反馈使用Eclipse时,存在某些问题了。

功能点介绍:

  • 服务注册与调用:

基于Eureka来实现的服务注册与调用,在Spring Cloud中使用Feign, 我们可以做到使用HTTP请求远程服务时能与调用本地方法一样的编码体验,开发者完全感知不到这是远程方法,更感知不到这是个HTTP请求。

  • 服务鉴权:

通过JWT的方式来加强服务之间调度的权限验证,保证内部服务的安全性。

  • 负载均衡:

将服务保留的rest进行代理和网关控制,除了平常经常使用的node.js、nginx外,Spring Cloud系列的zuul和rebbion,可以帮我们进行正常的网关管控和负载均衡。其中扩展和借鉴国外项目的扩展基于JWT的Zuul限流插件,方面进行限流。

  • 熔断机制:

因为采取了服务的分布,为了避免服务之间的调用“雪崩”,采用了Hystrix的作为熔断器,避免了服务之间的“雪崩”。

  • 监控:

利用Spring Boot Admin 来监控各个独立Service的运行状态;利用turbine来实时查看接口的运行状态和调用频率;通过Zipkin来查看各个服务之间的调用链等。

  • 数据权限

利用基于Mybatis的DataScopeInterceptor拦截器实现了简单的数据权限

  • 优雅的Bean转换

采用Dozer组件来对 DTO、DO、PO等对象的优化转换

  • 前后端统一表单验证

严谨的表单验证通常需要 前端+后端同时验证, 但传统的项目,均只能前后端各做一次检验, 后期规则变更,又得前后端同时修改。
故在hibernate-validator的基础上封装了zuihou-validator-starter起步依赖,提供一个通用接口,可以获取需要校验表单的规则,然后前端使用后端返回的规则,
以后若规则改变,只需要后端修改即可。

  • 防跨站脚本攻击(XSS)
    详情见: zuihou-xss-starter模块
  • 当前用户信息注入器
    详情见: zuihou-user-starter模块
  • 在线API
    由于原生swagger-ui某些功能支持不够友好,故采用了国内开源的swagger-bootstrap-ui,并制作了stater,方便springboot用户使用。
  • 代码生成器

基于Mybatis-plus-generator自定义了一套代码生成器, 通过配置数据库字段的注释,自动生成枚举类、数据字典注解、SaveDTO、UpdateDTO、表单验证规则注解、Swagger注解等。

  • 定时任务调度器

基于xxl-jobs进行了功能增强。(如:指定时间发送任务、执行器和调度器合并项目、多数据源)

  • 汉化 Eureka 注册中心页面

  • 大文件/断点/分片续传

前端采用webupload.js、后端采用NIO实现了大文件断点分片续传,启动Eureka、Zuul、File服务后,直接打开docs/chunkUploadDemo/demo.html即可进行测试。
经测试,本地限制堆栈最大内存128M启动File服务,5分钟内能成功上传4.6G+的大文件,正式服耗时则会受到用户带宽和服务器带宽的影响,时间比较长。

  • 分布式事务
    集成了阿里的分布式事务中间件:seata,以 高效 并且对业务 0侵入 的方式,解决 微服务 场景下面临的分布式事务问题。

项目架构图:

项目结构:


├─zuihou-admin-cloud
│  │  
│  ├─docs-------------------------------------文档
│  │  
│  ├─third-party-----------------------------第三方组件
│  │  
│  ├─zuihou-backend---------------------------后端服务
│  |  ├─zuihou-api----------------------------常用API
│  |  ├─zuihou-authority----------------------权限服务[正在开发]
│  |  |  ├─zuihou-authority-biz---------------权限服务业务模块
│  |  |  ├─zuihou-authority-controller--------权限服务接口模块
│  |  |  ├─zuihou-authority-entity------------权限服务实体模块
│  |  |  ├─zuihou-authority-server------------权限服务启动模块
│  |  ├─zuihou-demo---------------------------演示服务
│  |  ├─zuihou-file---------------------------文件模块服务[完成]
│  |  ├─zuihou-gateway------------------------统一网关负载中心
│  |  |  |─zuihou-gateway-server--------------gateway网关启动模块
│  |  |  |─zuihou-zuul-authentication---------zuul网关权限控制模块
│  |  |  |─zuihou-zuul-base-------------------zuul网关公共模块
│  |  |  |─zuihou-zuul-ratelimit--------------zuul网关限流模块
│  |  |  |─zuihou-zuul-server-----------------zuul网关启动模块
│  |  ├─zuihou-jobs---------------------------定时任务调度执行器[完成]
│  |  ├─zuihou-msgs---------------------------消息模块服务[完成]
│  |  ├─zuihou-order--------------------------订单服务
│  │ 
│  ├─zuihou-commons--------------------------公共模块   
│  |  ├─zuihou-cache-starter-----------------缓存模块 【最新缓存参考 zuihou-j2cache-start】
│  |  ├─zuihou-common------------------------项目业务模块 (业务模块主要用于存放可能跟业务相关的公共代码)
│  |  ├─zuihou-config-------------------------配置中心
│  |  ├─zuihou-core--------------------------项目核心模块 (核心模块存放无业务逻辑的公共代码)
│  |  ├─zuihou-databases---------------------项目数据源配置模块
│  |  ├─zuihou-dozer-starter-----------------优雅的bean转换起步依赖
│  |  ├─zuihou-j2cache-starter---------------二级缓存配置
│  |  ├─zuihou-jwt-starter-------------------JWT起步依赖
│  |  ├─zuihou-log-starter-------------------操作日志起步依赖
│  |  ├─zuihou-openfeign-starter-------------OpenFeign常用配置起步依赖
│  |  ├─zuihou-shiro-starter-----------------shiro起步依赖[已放弃]
│  |  ├─zuihou-swagger2-starter--------------SwaggerUI文档配置
│  |  ├─zuihou-user-starter------------------用户信息自动注入起步依赖
│  |  ├─zuihou-validator-starter-------------增强表单前后端统一验证起步依赖
│  |  ├─zuihou-xss-starter-------------------防XSS起步依赖
│  |  ├─zuihou-zipkin-client-starter---------zipkin 客户端统一配置
│  │ 
│  ├─zuihou-dependencies----------------------项目顶级pom
│  │ 
│  ├─zuihou-support---------------------------服务模块
│  |  ├─zuihou-monitor------------------------spring-boot-admin监控中心
│  |  ├─zuihou-zipkin-------------------------zipkin分布式链路跟踪
│  │
│  │-...

期待您的加入:

1,前端  (急需!!只要你懂点vue、热爱开源,请加入我们的队伍吧)
2,后端
3,土豪哥哥(求赞助服务器)
4,有想要合作或者赞助服务器的朋友加群(63202894)联系群主

如何贡献代码

1,Fork
2,修改代码后提交pr
3,等待合并
4,合并超过5次的朋友,直接拉为项目开发者