目录结构

quan
├── .github   (可选，GitHub 相关文件)
├── .gradle   (可选，Gradle 自动生成的相关文件)
├── .idea   (可选，IDEA开发工具 自动生成的相关文件)
├── buildSrc   (必须，Gradle 配置相关文件)
├── gradle   (必须，Gradle 配置相关文件)
├── quan-app   (必须，应用服务目录)
│   ├── quan-app-aggregations   （可选，聚合应用服务，将其它应用模块打包成一个服务运行）
│   ├── quan-app-common (必须，应用通用模块，配置应用基础的工具、组件等，主要提供给应用依赖)
│   ├── quan-app-core (必须，领域核心模块，对接底层应用（如：MySQL、MongoDB），对外提供操作底层应用的接口)
│   ├── quan-app-service (必须，业务模块，对接领域核心模块，封装业务相关操作，对外提供业务操作接口)
│   ├── quan-app-mobile-bff (可选，客户端BFF层，对接业务层，封装客户端的接口，提供客户端所需的数据结构，配置客户端的权限等)
│   └── quan-app-pm-bff (可选，管理后台BFF层，对接业务层，封装后台管理系统的接口，提供后台管理系统所需的数据结构，配置后台管理系统的权限等)
├── quan-cloud (必须，Spring Cloud相关组件)
│   ├── quan-cloud-eureka （必须，注册中心组件）
│   └── quan-cloud-gateway (必须，网关组件，封装或扩展自定义权限)
├── quan-code (可选，基于`人人代码生成器`开发的代码生成工具)
├── quan-common-utils (必须，项目通用模块)
│   ├── quan-base-common （必须，配置项目通用的工具）
│   └── quan-config-common (必须，配置项目通用的配置组件)
├── quan-dependencies (必须，统一配置依赖版本)
├── quan-deploy (可选，项目初始化的一些sql脚本、配置等)
├── quan-security  (必须，独立的鉴权服务模块)
│   ├── quan-security-common （必须，配置项目通用的工具）
│   │   ├── quan-security-base-common （必须，配置鉴权模块基础的枚举、dto等信息，对外提供轻量级的依赖）
│   │   └── quan-security-conf-common (必须，配置鉴权模块通用的配置等，主要提供给鉴权服务模块)
│   └── quan-security-server（必须，安全中心服务模块，对外提供鉴权相关的功能，当前主要提供token校验，后续会将网关鉴权相关业务移植到该模块）
├── quan-tools (必须，封装的工具模块)
│   ├── quan-captcha （必须，验证码相关工具，图片验证码、邮箱验证码等）
│   ├── quan-crypto （必须，登录密码相关工具，基于shiro的密码生成工具）
│   ├── quan-dingtalk （必须，基于钉钉登录API封装的工具）
│   ├── quan-feign （可选，扩展feign组件请求的工具，实验功能，谨慎使用）
│   ├── quan-file （必须，基于Minio文件服务API封装的文件操作工具）
│   ├── quan-id （必须，基于雪花算法封装的ID生产工具）
│   ├── quan-jasypt （可选，基于ulisesbocchio的配置加密工具）
│   ├── quan-jms （可选，基于ActiveMQ封装的JMS工具类）
│   ├── quan-limiter （可选，限制器组件，可用于限流、分布式锁等场景）
│   ├── quan-mail （可选，封装的邮件发送工具类）
│   ├── quan-redis （可选，基于Redis Template 封装的工具类）
│   ├── quan-sitemap （可选，用于生成sitemap.xml工具类）
│   └── 更多工具。待扩展... 
├── .gitignore (可选，忽略git版本控制配置文件)
├── build.gradle (必须，gradle配置)
├── gradle.properties (必须，gradle配置)
├── gradlew (必须，gradle配置)
├── gradlew.bat (必须，gradle配置)
├── lombok.config (必须，lombok配置)
└── settings.gradle (必须，gradle配置)

• quan-app/<结构化目录> 请查看《配置和约定》。

• quan-tools 引用工具不需要全局扫描，需要用的工具直接依赖即可自动注册。有些工具需要再配置文件中开启才会生效，请查看：请查看《配置和约定》

• quan-tools/<结构化目录> 请查看《配置和约定》。

• quan-deploy 用于存放初始化的sql脚本、文档说明等。安装好环境后，获取sql脚本并执行，用于初始化数据库。

---

提示

为了方便您更快的学习和使用本框架，我在代码当中添加了比较多的注释说明。