spring-cloud-plus

系统介绍

spring-cloud-plus 是以spring-cloud-alibaba为基础并整合一些常用框架的分布式基础开发平台。

项目以组件模块的方式构建&＃xff0c;实现项目模块可插拔组装。工作中遇到的一些常用框架&＃xff0c;我都会整合到此项目&＃xff0c;并持续更新。

目标

- 成为一个简单易用、快速高效、功能丰富、安全稳定的分布式项目脚手架。

- 让每个人都可以独立、快速、高效地开发一套分布式项目&＃xff01;

技术栈

- 基础&＃xff1a;springboot &＃43; springcloud

- 持久化&＃xff1a;MybatisPlus

- 连接池&＃xff1a;Druid

- 数据库&＃xff1a;Mysql

- 项目构建&＃xff1a;Maven

- API网关&＃xff1a; Gateway

- 日志&＃xff1a;Logback

- 注册、配置中心&＃xff1a; Nacos

- 服务调用&＃xff1a; Feign &＃43; Ribbon

- 熔断、降级&＃xff1a;Sentinel

- 分布式事务&＃xff1a;Seata

- 分布式锁&＃xff1a;Redisson

- 鉴权&＃xff1a; Shiro &＃43; jwt-token

- 缓存&＃xff1a; Redis、springCache

- 工作流&＃xff1a;Activiti

- 定时任务&＃xff1a; Quartz

- 消息中间件&＃xff1a;ActiveMq

- 文件操作&＃xff1a;FastDFS、EasyExcel

- 搜索存储引擎&＃xff1a;Elasticsearch

- 接口文档&＃xff1a;Swagger、knife4j

- 应用监控&＃xff1a;spring-boot-admin

- 前置负载&＃xff1a;Nginx

- 链路追踪&＃xff1a;Skywalking

- 项目部署&＃xff1a;docker-compose

技术架构图

组件模块

| 模块 | 描述 | 功能 |

| cmpt-base | 基础模块 | 项目所必须的依赖包和配置和基础类 |

| cmpt-core | 核心模块 | 项目公共的工具类等 |

| cmpt-cloud | 分布式模块 | 注册、配置中心、分布式事务等 |

| cmpt-rbac | 鉴权模块 | RBAC鉴权模型&＃xff0c;用户、角色、权限分配等 |

| cmpt-cache | 缓存模块 | redis集群、redisson分布式锁、springcache注解式缓存 |

| cmpt-quartz | 定时调度模块 | quartz动态定时任务&＃xff0c;并持久化到mysql数据库 |

| cmpt-activiti | 工作流模块 | activiti整合&＃xff0c;及请假Demo |

| cmpt-notice | 通讯模块 | 邮件、短信、websocket等 |

| cmpt-file | 文件模块 | 文件上传、下载、预览&＃xff0c;Excel导入导出等 |

| cmpt-es | 搜索引擎模块 | elasticSearch 搜索引擎整合 |

| cmpt-activemq | 消息模块 | 消息的发送和消费 |

| cmpt-log | 日志模块 | logback日志、操作日志记录等 |

| cmpt-flyway | 脚本执行模块 | 数据库脚本自动执行 |

| generator-boot | 代码生成模块 | mybatisPlus的代码生成工具&＃xff0c;一键生成基础代码 |

项目模块

| 模块 | 描述 | 功能 |

| boot-admin-web | 应用监控模块 | 监控应用线程、内存、垃圾回收、配置等监控 |

| gateway-web | 网关模块 | 负责服务路由转发&＃xff0c;可作为服务统一入口 |

| openapi-web | 开放平台模块 | 外部接口调用入口、签名鉴权等 |

| admin-web | 主项目 | 整合了所有的组件模块,启动这个模块&＃xff0c;就可以测试所有的功能啦 |

| sub-webb | 辅助项目| 简单的cloud项目&＃xff0c;用于测试分布式服务调用和分布式事务等 |

| sub-api | 辅助API模块| 封装feign调用&＃xff0c;方便复用 |

文档

线上接口文档

如何开始

项目启动需要设置 local环境配置&＃xff1a;

所有项目模块都可以直接启动&＃xff0c;配置信息都放在Nacos中了。如果需要修改配置地址信息等&＃xff0c;可自己添加application.yaml然后修改&＃xff0c;项目中提供了一份demo文件可参考&＃xff1a;

有时会报Sentinel的配置类型转换异常&＃xff0c;需要调整JDK版本&＃xff0c;我使用的版本是&＃xff1a;1.8.0_231 是可以正常启动的。具体参看&＃xff1a;

部署

项目中设计的一些技术服务端都是使用docker部署的&＃xff0c;包括&＃xff1a;mysql、redis、nacos、seata等。

项目也是用docker-compose部署的&＃xff0c;由于平台原因&＃xff0c;不能直接放链接&＃xff0c;需要部署文章可以私信我。

集成功能

**核心功能:**

• 用户权限管理:

框架&＃xff1a;shiro &＃43;jwt&＃xff0c;使用jwt-token作为用户身份Id&＃xff1b;

支持承租人模式&＃xff1b;token续期等

• 网关:

负责服务路由转发&＃xff0c;可作为服务统一入口

• 开放平台:

通过签名验证方式&＃xff0c;鉴权外部接口调用

• 动态数据源&＃xff1a;

动态多数据源(支持读写分离&＃xff0c;如果只有一个数据库&＃xff0c;可将master和slave配置成一样即可);

数据库连接密码加密;

• 缓存&＃xff1a;

框架&＃xff1a;springCache、redis、redisson ;

封装redis、redisson工具类;

• 分布式事务

框架&＃xff1a;seata(AT模式); 集成以nacos为配置中心

• 定时任务

框架&＃xff1a;quartz&＃xff1b;

quartz表结构自动生成;

业务代码动态增加定时任务;

数据持久化到Mysql数据库;

• 分布式

注册发现中心&＃xff1a;Nacos;

feignClient远程调用;

ribbon负载均衡、sentinel熔断降级 ;

• 配置中心

框架&＃xff1a;nacos; 支持配置及日志等级热更新&＃xff1b;

• 限流熔断

框架&＃xff1a;sentinel;接口限流、降级、系统保护、热点数据限流、权限设置等;

规则持久化到Nacos;

• 通讯

aliyun短信通知;

邮件通知(文本、html、附件、模板);

• 文件

openoffice在线预览文件;

easyexcel实现Excel文件导入导出;

fastDfs文件上传、下载;

FlyingSaucer&＃43;thymeleaf实现动态模板文件转pdf打印;

• 工作流

框架&＃xff1a;activiti

请假流程Demo

• 消息

框架&＃xff1a;activeMq

支持点对点和订阅发布模式&＃xff0c;消息持久化

• 日志

logback日志记录&＃xff0c;以小时为单位生成日志文件&＃xff1b;

操作日志记录&＃xff0c;根据配置策略规定异步生成日志&＃xff1b;

记录请求地址、参数、返回、异常及接口耗时等并持久化到数据库默认保留30天的日志。

• 搜索引擎

框架&＃xff1a;elasticSearch; 分布式、RESTful 风格的搜索和数据分析引擎&＃xff1b;

• 工具类

1)地址ip获取工具(IpAddressUtil);

2)日期处理工具(DateUtil);

3)分布式全局唯一订单号生成、分布式全局唯一主键id生成工具(OrderNumberUtil、IdGeneratorUtil);

4)md5加密工具、AES加解密工具(Md5Util、AesHopeUtil);

5)汉字拼音生成工具(Pinyin4jUtil);

6)铭感词脱敏工具(SensitiveInfoUtil);

7)集合转换复制工具(CollectionUtil);

8)redis操作工具类、redisson锁工具类(RedisUtil、RedisLockUtil);

9)RestTemplate远程调用工具了(RestTemplateUtil);

• 其他功能

1)统一异常处理&＃xff0c;自定义业务异常&＃xff1b;

2)spring-retry接口重试,自定义接口重试次数、间隔、和重试的异常;

3)AOP接口防重复提交&＃xff0c;唯一条件&＃xff1a;指定时间内&＃xff0c;用户id&＃43;请求url&＃43;参数 控制唯一性;

4)实体类公共字段填充&＃xff1a;is_deleted,version,created_by,created_time,updated_by,updated_time

5)p6spy sql日志打印&＃xff0c;打印sql耗时、替换参数后的sql;

6)jasypt文本加解密&＃xff0c;可用于数据库密码、redis密码、邮箱密码等加密&＃xff1b;

7)图形验证码生成校验

**辅助功能&＃xff1a;**

• knife4j

接口文档、接口调试&＃xff1b;

• flyway

数据库脚本自动执行&＃xff0c;只需要将sql脚本放在 /db目录下&＃xff0c;项目启动就会自动执行脚本。

• generator

mybatisPlus自动生成基础代码

• druid监控

数据监控&＃xff0c;慢sql记录等

• springbootadmin监控

springboot应用监控&＃xff0c;线程、内存、垃圾回收、配置等监控&＃xff1b;

作者

名字&＃xff1a;葫芦胡

需要项目地址的可以私信我。