README.md · 积微致著/gourd-hu

### 简介
项目名称：葫芦胡，不知道起啥名字，就以自己的笔名代替了:joy:；  
这是自己开发实践的项目。工作中遇到的一些实用框架我都会整合到这个项目里面；  
项目主要以spring cloud alibaba组件整合一些常用框架来搭建一个简单易用、安全稳定的项目:sunglasses:。  
### 文档
线上swagger接口文档：[http://47.103.5.190:8088/swagger-ui.html#/](http://47.103.5.190:8088/swagger-ui.html#/)

### 组件模块
|  模块   |   描述  |   功能  |
| --- | --- | --- |
|  gourd-base   | 基础模块    |   项目所需的基础依赖、公共配置、及工具类等   |
|  gourd-gateway   | 网关模块    |   负责服务路由转发，可作为服务统一入口   |
|  gourd-cloud   | 分布式模块    | 服务注册发现、配置中心、分布式事务    |
|  gourd-security-rbac   | 用户鉴权模块    | （spring security+JWT）用户管理，角色/权限分配等    |
|  gourd-shiro-rbac   | 用户鉴权模块    | （shiro+JWT）用户管理，角色/权限分配等    |
|  gourd-log  | 日志模块    |  logback日志、接口访问日志记录等   |
|  gourd-cache   | 缓存模块    |  redis集群、redisson分布式锁、springcache注解式缓存  |
|  gourd-quartz   |  定时任务模块   |   quartz动态定时任务，并持久化到mysql数据库  |
|  gourd-activiti   | 工作流模块    |  activiti整合，及请假Demo   |
|  gourd-notice   | 通讯模块    |  邮件、短信、websocket等  |
|  gourd-file   | 文件模块    | 文件上传、下载、预览，Excel导入导出等     |
|  gourd-es   |  搜索引擎模块  |   elasticSearch 搜索引擎 |
|  gourd-rocketmq   |  消息模块   |  消息的发送和消费   |
|  gourd-activemq   |  消息模块   |  消息的发送和消费   |
|  gourd-generator   |  代码生成模块   |  mybatisPlus的代码生成工具，一键生成基础代码   |
|  gourd-boot-admin   |  监控模块   |  springboot admin监控台，邮件通知功能   |

### 项目模块  
|  模块   |  描述   |   功能  |
| --- | --- | --- |
| gourd-service-hu    |  主项目  |  整合了所有的组件模块,启动这个模块，就可以测试所有的功能啦  |
| gourd-service-sub   |  辅助项目|   简单的springboot项目，用于测试分布式服务调用和分布式事务等|
| gourd-service-sub-api   |  辅助API模块|   封装feign调用，方便复用|
### 如何开始
gourd-base模块为必须模块，包含启动项目的基础依赖。其他所有组件模块都是一个独立的模块；    
gourd-service-hu 主项目默认依赖了所有组件模块，可根据自己需要删除、增加模块依赖；     
如果不需要相应功能，在pom中去除相应模块依赖即可。
注：权限模块依赖缓存模块，因为需要将jwt-token存放于redis中。

### 集成功能  
**核心功能:**  
- 用户权限管理:   
>   框架：springSecurity/shiro +jwt，使用jwt-token作为用户身份Id；  
>   支持承租人模式；token续期等   
>   功能测试：AuthController-> /auth/login 账号密码：admin@gourd   123456     
- 动态数据源：  
>   动态多数据源（支持读写分离，如果只有一个数据库，可将master和slave配置成一样即可）;    
>   数据库连接密码加密;    
- 缓存：  
>   框架：[springCache](https://www.jianshu.com/p/6db623355e11)+redis+redisson ;   
>   封装redis、redisson工具类;                    
>   功能测试：TestController-> /test/cache ； TestController-> /test/lock;        
- 分布式事务：
>   框架：seata（AT模式）; 集成以nacos为配置中心
>   功能测试：CloudTestController -> /test/seata-tx     
- 定时任务： 
>   框架：quartz；  
>   quartz表结构自动生成;  
>   业务代码动态增加定时任务;   
>   数据持久化到Mysql数据库;  
>   功能测试：QuartzController  
- 分布式调用：  
>   注册发现中心：Nacos;   
>   feignClient远程调用;  
>   ribbon负载均衡、sentinel熔断降级 ;  
>   功能测试：CloudTestController       
- 配置中心：
>   框架：nacos; 支持配置及日志等级热更新；  
>   功能测试：CloudTestController -> /test/nacos         
- 限流熔断:  
>   框架：sentinel;接口限流、降级、系统保护、热点数据限流、权限设置等;  
>   规则持久化到Nacos;  
- 通讯：  
>   aliyun短信通知; 功能测试：NoticeTestController-> /notice/msg     
>   邮件通知(文本、html、附件、模板); 功能测试：NoticeTestController     
>   nio-websocket实时消息; 功能测试：http://47.103.5.190:8088/websocket.html
- 文件：
>   openoffice在线预览文件;功能测试：FileConvertController     
>   easyexcel实现Excel文件导入导出; 功能测试：EasyExcelController  
>   fastDfs文件上传、下载; 功能测试：FileController  
>   FlyingSaucer+thymeleaf实现动态模板文件转pdf打印; 功能测试：PdfController;    
- 工作流
>   框架：activiti  
>   请假流程Demo   
>   功能测试: ActivitiController       
- 消息：
>   框架：rocketMq
>   消息发送和消费
>   框架：activeMq
>   支持点对点和订阅发布模式，消息持久化
- async：  
>   支持@Async注解异步方法；  
>   异步线程池直接使用。
>   功能测试：TestController->/test/async-task 
- 搜索引擎 
>   框架：elasticSearch; 分布式、RESTful 风格的搜索和数据分析引擎；  
>   功能测试:UserEsController;   
- 工具类:    
>    1)地址ip获取工具(AddressUtil);  
>    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)统一异常处理，自定义业务异常；    
>  2)spring-retry接口重试,自定义接口重试次数、间隔、和重试的异常;     
>  3)AOP接口防重复提交，唯一条件：指定时间内，用户id+请求url+参数 控制唯一性;    
>  4)接口访问日志记录，记录请求地址、参数、返回、异常及接口耗时等并持久化到数据库;默认30天过期删除  ；  
>  5)实体类公共字段填充：is_deleted,version,created_by,created_time,updated_by,updated_time  ；  
>  6)实体类Id自动填充；
>  7)p6spy sql日志打印，打印sql耗时、替换参数后的sql;  
>  8)jasypt文本加解密，可用于数据库密码、redis密码、邮箱密码等加密；      
>    密文生成：[https://blog.csdn.net/HXNLYW/article/details/98635913](http://)  
>  9)图形验证码生成校验; 功能测试：http://47.103.5.190:8088/kaptcha.html
          
**辅助功能：**  
- swagger:   
>  接口文档、接口调试；  
>  本地地址：http://localhost:8088/swagger-ui.html#  
>  线上地址：http://47.103.5.190:8088/swagger-ui.html#/
- flyway：  
>  数据库脚本自动执行，只需要将sql脚本放在 /db目录下，项目启动就会自动执行脚本。  
- generator：  
>  mybatisPlus自动生成基础代码  
- druid监控：  
>  本地地址：http://localhost:8088/druid/login.html 账号密码：admin  
>  线上地址：http://47.103.5.190:8088/druid/login.html 账号密码：admin
- springboot admin监控：  
>  springboot应用监控，线程、内存、垃圾回收、配置等监控；  
>  访问地址：http://localhost:8769  
  
### 作者
名字：gourd.hu  
邮箱：13584278267@163.com  
博客：https://blog.csdn.net/HXNLYW  
微信号：13584278267 (欢迎咨询)

积微致著/gourd-hu

简介

发行版

贡献者

近期动态

积微致著/gourd-hu .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

积微致著/gourd-hu