# springboot_back_mould

**Repository Path**: ju-xiang/springboot_back_mould

## Basic Information

- **Project Name**: springboot_back_mould
- **Description**: 一个springboot的restful脚手架，集成了一些常用工具
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2022-01-30
- **Last Updated**: 2022-04-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: JWT, SpringBoot, JPA, Redis

## README

# SpringBoot_back_mould

**中文文档** | [英文文档](README.en.md)

#### 介绍

一个SpringBoot的restful脚手架，集成了一些常用工具

#### 软件架构

> 这是一个SpringBoot的restful脚手架，集成了JPA+Redis+Mybatis+Jwt+Hutools和一些其他的工具类，力求做到开箱即用，提供给开发者使用。

**主要集成到的工具类有**

1. 邮件工具类
2. token工具类(自动续期)
3. 对象转换工具类
4. 验证表单
5. 企业微信机器人
6. 自动任务类
7. Md5校验类
8. Redis工具类
9. 日志类
10. 分页类
11. 基础实体类
12. 常用枚举类等

#### 使用说明

1. 克隆本项目
2. 使用加密工具encryptor加密数据库信息等敏感信息（正式环境一定要这样做）
3. 使用maven打包项目为jar包，在这之前不要动yml配置文件，否则会出现错误（打包命令：`mvn clean package -Dmaven.test.skip=true -U`）
4. 默认的jar包位置为：`/你的项目路径/output/springboot_back_mould.jar`
5. 上面路径中有application.yml配置文件，修改其中的数据库和redis配置信息
6. 使用命令`java -jar output/springboot_back_mould.jar --spring.profiles.active=prod`启动项目
7. 必要时也可以加上SpringBoot Admin进行管理

docker部署(除非对文件结构非常清晰，否则不建议使用)：

```shell
docker build -t springboot_back_mould .
docker run --net=host --restart=always -d -p 8881:8881 springboot_back_mould
```

#### 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

#### 贡献者名单

> * **琚翔** [个人博客](https://blog.ybmxsxfjs.cn)

#### TODO

1. ~~unique异常未解决~~
2. ~~全局异常处理还需要改善，另外最好能将异常实时反馈到企业微信~~
3. ~~企业微信机器人长段文字无法发送的问题需要改进~~
4. ~~redis集成(主要用于验证码和单点登录)~~
5. ~~权限验证还未写~~
6. ~~随机生成验证码的工具类~~
7. 分页工具类的验证和使用示例
8. fix bugs
9. ~~token自动续期~~
10. ~~避免重复提交注解~~
11. 文件上传类：本地上传，cos上传
12. 后台管理界面（最难最重要）