aws-boot

本项目借鉴 Roses、Pig、RuoYi 等优秀开源项目，在此感谢各位开源大佬。

1. 项目介绍

简洁优雅的后台管理系统: aws-boot
SpringBoot + MybatisPlus + SaToken + Amis
非前后端分离项目，使用百度 amis 配置 json 生成页面
代码追求:「规范统一、简洁优雅、Less is More」 x 3 (重要的事情说三遍)
功能模块如下：

2. 项目架构

2.1 核心依赖

依赖	版本
spring-boot	2.6.11
mybatis-plus	3.5.2
sa-token	1.33.0
just-auth	1.4.0
druid	1.2.9
minio	8.2.2
knife4j	2.0.9
hutool	5.6.5

2.2 模块说明

b-xxx: 基础模块
c-xxx: 公共模块
d-xxx: 系统管理模块
e-xxx: 三方扩展模块
p-xxx: 业务应用模块
u-xxx: 页面模板模块
x-xxx: 测试示例模块

aws-boot
├── aws-b-base  [基础模块]
│   ├── base-api
│   └── base-spring-boot-starter
├── aws-c-auth  [公共权限模块]
│   ├── auth-api
│   └── auth-spring-boot-starter
├── aws-c-data  [公共数据模块]
│   ├── data-api
│   └── data-spring-boot-starter
├── aws-d-system  [系统管理模块]
│   ├── system-api
│   ├── system-biz
│   └── system-spring-boot-starter
├── aws-e-extend  [外部扩展模块]
│   ├── extend-open  [开放接口模块]
│   │   ├── open-api
│   │   ├── open-biz
│   │   └── open-spring-boot-starter
│   ├── extend-sms   [短信接口模块]
│   │   ├── sms-api
│   │   ├── sms-biz
│   │   ├── sms-sdk-alibaba
│   │   ├── sms-sdk-tencent
│   │   └── sms-spring-boot-starter
│   └── ...
├── aws-p-wechat  [微信应用模块]
│   ├── wechat-api
│   ├── wechat-biz
│   └── wechat-spring-boot-starter
├── aws-u-webapp  [页面模板模块]
│   ├── resources
│   │   └── templates
│   └── pom.xml
├── aws-x-demo  [测试示例模块]
│   ├── src
│   └── pom.xml
├── db  [数据库文件]
│   ├── Dockerfile
│   ├── db_create.sql
│   ├── db_d_system.sql
│   └── db_p_wechat.sql
├── docker-compose.yml  [容器部署文件] 
└── README.md

2.3 代码规范

xxx-api 层: constant、exception、pojo；
- constant: 常量类 + 枚举类；
- exception: 异常类 + 异常枚举；
- pojo: DTO + VO + PO；
  - request: XxxQuery(查询请求类)、XxxWrite(写入请求类)；
  - response: XxxModel(响应模型类)；
  - properties: XxxProperties(属性配置类)；
xxx-sdk 层: XxxServiceSdk (非必要层)；
xxx-biz 层: domain、mapper、service；
- domain: Xxx DO 对象类；
- mapper: XxxMapper 映射类；
- service: XxxService 业务类；
xxx-starter 层: config、controller；
- config: 配置类；
- controller: 接口类；

3. 快速启动

3.1 环境部署

基础环境：Redis(6.0) + Mysql(8.0) + Minio(RELEASE.2022-12-12)

方式一：容器部署（优先推荐）

## 1. 自行安装 docker + docker-compose
docker-compose -version

## 2. 构建并启动相关服务
docker-compose build
docker-compose up -d

## 3. 若数据没有导入成功，则手动导入一下
db/db_create.sql
db/db_d_system.sql
db/db_d_system_data.sql

方式二：本地启动（不建议）

## 1. mac 安装，其他请自行查找
brew install redis mysql minio/stable/minio

## 2. 启动相关服务
brew services start redis
brew services start mysql

export MINIO_ACCESS_KEY=admin
export MINIO_SECRET_KEY=Admin@123
nohup minio server /opt/oss --console-address :9001 --address :9000 > /dev/null 2>&1 &

## 3. 导入数据库文件
db/db_create.sql
db/db_d_system.sql
db/db_d_system_data.sql

查看环境是否启动成功:

Redis 客户端工具推荐：RedisDesktopClient
Mysql 客户端工具推荐：Jetbrains-DataGrip
Minio 自带客户端页面：Minio-Console

3.2 服务启动

## 1. 调整 aws-x-demo 的配置文件

### 可先调整主配置文件
vim aws-boot/aws-x-demo/src/main/resources/application.yml

### 注意 redis、mysql 配置，其他可暂时不调整
vim aws-boot/aws-x-demo/src/main/resources/application-dev.yml

## 2. 运行启动类
aws-x-demo/src/main/java/com/example/demo/DemoApplication.java