# springboot-api-demo

**Repository Path**: march21sunny/springboot-api-demo

## Basic Information

- **Project Name**: springboot-api-demo
- **Description**: SpringBoot 前后端分离脚手架
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-02-11
- **Last Updated**: 2024-01-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SpringBoot 前后端分离脚手架

### 技术栈

- SpringBoot
- Mybatis
- Mybayis-Plus
- Shiro
- JWT
- Swagger

```
Shiro + JWT 实现权限管理及统一网关链接
Swagger 自动api文档
springAop+druid实现多数据源注解
统一异常处理
```

### 目录结构
```
springboot-demo                                 # 项目名
│
├─logs                                          # 日志文件
├─src                                           # 项目源码
│  ├─main                                       
│  │  ├─java
│  │  │  └─com
│  │  │      └─dxjy
│  │  │          └─demo                         # 包名        
│  │  │              ├─config                   # 配置文件
│  │  │              ├─entity                   # 统一返回数据结构
│  │  │              ├─exception                # 统一异常处理
│  │  │              ├─filter                   # 过滤器 
│  │  │              ├─module                   # 业务模块
│  │  │              │  ├─demo                  # 自定义模块
│  │  │              │  └─sys                   # 系统模块   
│  │  │              │      ├─controller        # 前端控制器
│  │  │              │      ├─entity            # 实体类  
│  │  │              │      ├─mapper            # 数据访问层
│  │  │              │      ├─redis             # 缓存相关
│  │  │              │      └─service           # 数据服务层
│  │  │              │          └─impl
│  │  │              ├─task                     # 定时任务  
│  │  │              ├─**utils**                    # 工具类
│  │  │              └─SpringBootApplication    # 启动类
│  │  │ 
│  │  └─resources                               # 资源文件
│  │      ├─mapper                              # sql文件
│  │      ├─templates
│  │      ├─application.properties              # 公共配置文件
│  │      ├─application-dev.properties          # 本地环境配置文件    
│  │      ├─application-pro.properties          # 正式环境配置文件
│  │      ├─application-test.properties         # 测试环境配置文件
│  │      └─logback-spring.xml                  # 日志配置文件
│  │
│  └─test                                       # 测试类
│
├─pom.xml                                       # Maven包管理文件
└─README.md                                     # 项目说明文件

```

### 配置 config

- 跨域，全局配置：config/CORSConfiguration 或 接口单独配置：Controller 中添加 @CrossOrigin 注解
- Mysql多数据源 config/datasources
- 分页
- Redis缓存配置 config/RedisCacheConfig
- Shiro+JWT config/shiro
- Swagger


### 新项目
1. 修改项目名 `springboot-api-demo`
2. 修改包名 `com.dxjy.demo`
3. 修改pom.xml 中的 groupId、artifactId、name、description 
4. 修改Mybatis 配置文件 `MybatisPlusConfig` 中的 `MapperScan` 包路径 
5. 修改配置文件 `application-*.properties` 中的`mybatis-plus.type-aliases-package` 包路径 
6. 修改日志文件 `logback-spring.xml`中的sql输出日志包路径 
7. 若项目无需引入数据库相关，请在pom.xml中删除数据库相关依赖，以及 `application-*.properties` 中`datasources`相关配置，否则无法启动项目。


### 启动
- 运行 com.dxjy.demo.SpringBootDemoApplication 启动
- 访问 `http://localhost:8081/swagger-ui.html` 或 `http://localhost:8081/doc.html`


### 报错
```
Process finished with exit code 0
```
清理Maven的org 下 apache 文件夹,让Maven重新下载jar包

或者运行Maven命令,清理jar包
```
dependency:purge-local-repository
```


### MyBatis-Plus 集成

 [MyBatis-Plus 官网](https://baomidou.com/)