服务介绍

说明：编写本文档时，acuity-cloud-pro-datasource-column 4.6.0

技术栈

技术架构.drawio

架构图

acuity-cloud-pro架构图

认证服务： acuity-oauth

主要包括：

登录相关接口
获取用户信息、权限、菜单等接口
常用数据接口(如前端获取的字典、枚举接口）

系统服务： acuity-system

主要包括：

开发运营系统的接口基本都在系统服务
应用管理：应用维护、给租户授权应用、给应用配置全局资源
平台级系统管理：维护字典、参数、客户端等
租户管理、给租户创建独立数据源（数据源模式）、租户管理员维护、租户表结构初始化、租户表数据初始化等功能。

基础服务： acuity-base

主要包括:

基础平台的接口基本都在base服务
基础功能组织机构管理、岗位管理、租户下的员工管理、租户级系统设置、角色权限分配等功能。
站内信（通知、公告、待办、预警）、短信功能、邮件功能(尚未实现) 等。支持多种第三方短信、多种第三方邮件。
文件存储、文件下载、文件回显等功能，支持多种第三方OSS存储。

代码生成服务： acuity-generator

【开发运营系统】-【开发工具】下代码生成相关接口
支持MySQL、Oracle、SQL Server
能生成acuity-cloud的服务和acuity-boot的模块
能生成acuity-cloud和acuity-boot的java代码
能生成acuity-web-pro的前端代码

网关服务： acuity-gateway

主要包括 token解析、接口(uri)权限拦截、黑白名单、限流等功能。

监控： acuity-monitor

SpringBootAdmin 监控功能

acuity-cloud-pro-datasource-column 目录结构

├── 01-docs                   # 文档
│   ├── image                 # 文档图片
│   ├── sql                   # 数据库脚本，初始化项目时，需要执行此文件夹中的脚本
├── acuity-base                 # 基础服务
│   ├── acuity-base-api         # 基础服务API层
│   ├── acuity-base-biz         # 基础服务业务层 
│   ├── acuity-base-controller  # 基础服务控制层  
│   ├── acuity-base-entity      # 基础服务实体、VO、枚举层
│   └── acuity-base-server      # 基础服务启动配置层
├── acuity-system               # 系统服务
│   ├── acuity-system-api
│   ├── acuity-system-biz
│   ├── acuity-system-controller
│   ├── acuity-system-entity
│   └── acuity-system-server
├── acuity-gateway              # 网关服务
│   └── acuity-gateway-server
├── acuity-oauth                # 认证服务
│   ├── acuity-oauth-api
│   ├── acuity-oauth-biz
│   ├── acuity-oauth-entity
│   ├── acuity-oauth-controller
│   └── acuity-oauth-server
├── acuity-generator            # 代码生成服务
│   ├── acuity-generator-entity
│   ├── acuity-generator-biz
│   ├── acuity-generator-controller
│   └── acuity-generator-server
├── acuity-public                        # 公共模块
│   ├── acuity-common                    # 业务相关的公共类
│   ├── acuity-common-api                # 公共的API层    
│   ├── acuity-data-scope-sdk            # 数据权限插件
│   ├── acuity-database-mode             # 租户模式配置层
│   ├── acuity-file-sdk                  # 业务文件（附件）接口插件
│   ├── acuity-model                     # 公共的实体和vo类
│   ├── acuity-tenant-datasource-init    # (数据源模式特有) 启动时加载数据源插件
│   └── acuity-userinfo-sdk              # 用户信息注入插件
├── acuity-support                       # 业务无关的其他服务
│   └── acuity-monitor                   # spring boot admin 监控
└── src
    └── main
       └── filters                        # yml文件中的 @xxx@ 参数就在此配置
           └── config-dev.properties      # 开发环境全局配置  
           └── config-prod.properties     # 生产环境全局配置

├── 01-docs                   # 文档
│   ├── image                 # 文档图片
│   ├── sql                   # 数据库脚本，初始化项目时，需要执行此文件夹中的脚本
├── acuity-base                 # 基础服务
│   ├── acuity-base-api         # 基础服务API层
│   ├── acuity-base-biz         # 基础服务业务层 
│   ├── acuity-base-controller  # 基础服务控制层  
│   ├── acuity-base-entity      # 基础服务实体、VO、枚举层
│   └── acuity-base-server      # 基础服务启动配置层
├── acuity-system               # 系统服务
│   ├── acuity-system-api
│   ├── acuity-system-biz
│   ├── acuity-system-controller
│   ├── acuity-system-entity
│   └── acuity-system-server
├── acuity-gateway              # 网关服务
│   └── acuity-gateway-server
├── acuity-oauth                # 认证服务
│   ├── acuity-oauth-api
│   ├── acuity-oauth-biz
│   ├── acuity-oauth-entity
│   ├── acuity-oauth-controller
│   └── acuity-oauth-server
├── acuity-generator            # 代码生成服务
│   ├── acuity-generator-entity
│   ├── acuity-generator-biz
│   ├── acuity-generator-controller
│   └── acuity-generator-server
├── acuity-public                        # 公共模块
│   ├── acuity-common                    # 业务相关的公共类
│   ├── acuity-common-api                # 公共的API层    
│   ├── acuity-data-scope-sdk            # 数据权限插件
│   ├── acuity-database-mode             # 租户模式配置层
│   ├── acuity-file-sdk                  # 业务文件（附件）接口插件
│   ├── acuity-model                     # 公共的实体和vo类
│   ├── acuity-tenant-datasource-init    # (数据源模式特有) 启动时加载数据源插件
│   └── acuity-userinfo-sdk              # 用户信息注入插件
├── acuity-support                       # 业务无关的其他服务
│   └── acuity-monitor                   # spring boot admin 监控
└── src
    └── main
       └── filters                        # yml文件中的 @xxx@ 参数就在此配置
           └── config-dev.properties      # 开发环境全局配置  
           └── config-prod.properties     # 生产环境全局配置

acuity-boot-pro-datasource-column 目录结构

├── 01-docs                   # 文档
│   ├── image                 # 文档图片
│   ├── sql                   # 数据库脚本，初始化项目时，需要执行此文件夹中的脚本
├── acuity-base                 # 基础服务
│   ├── acuity-base-biz         # 基础服务业务层 
│   ├── acuity-base-controller  # 基础服务控制层  
│   ├── acuity-base-entity      # 基础服务实体、VO、枚举层
├── acuity-boot-server          # acuity-boot启动配置层
├── acuity-system               # 系统服务
│   ├── acuity-system-biz
│   ├── acuity-system-controller
│   ├── acuity-system-entity
├── acuity-gateway              # 网关服务
│   └── acuity-gateway-server
├── acuity-oauth                # 认证服务
│   ├── acuity-oauth-biz
│   ├── acuity-oauth-entity
│   ├── acuity-oauth-controller
│   ├── acuity-oauth-userinfo                     # 用户信息注入插件
├── acuity-generator            # 代码生成服务
│   ├── acuity-generator-entity
│   ├── acuity-generator-biz
│   ├── acuity-generator-controller
├── acuity-public                        # 公共模块
│   ├── acuity-common                    # 业务相关的公共类
│   ├── acuity-common-api                # 公共的API层    
│   ├── acuity-data-scope-sdk            # 数据权限插件
│   ├── acuity-database-mode             # 租户模式配置层
│   ├── acuity-file-sdk                  # 业务文件（附件）接口插件
│   ├── acuity-model                     # 公共的实体和vo类
│   ├── acuity-tenant-datasource-init    # (数据源模式特有) 启动时加载数据源插件

├── 01-docs                   # 文档
│   ├── image                 # 文档图片
│   ├── sql                   # 数据库脚本，初始化项目时，需要执行此文件夹中的脚本
├── acuity-base                 # 基础服务
│   ├── acuity-base-biz         # 基础服务业务层 
│   ├── acuity-base-controller  # 基础服务控制层  
│   ├── acuity-base-entity      # 基础服务实体、VO、枚举层
├── acuity-boot-server          # acuity-boot启动配置层
├── acuity-system               # 系统服务
│   ├── acuity-system-biz
│   ├── acuity-system-controller
│   ├── acuity-system-entity
├── acuity-gateway              # 网关服务
│   └── acuity-gateway-server
├── acuity-oauth                # 认证服务
│   ├── acuity-oauth-biz
│   ├── acuity-oauth-entity
│   ├── acuity-oauth-controller
│   ├── acuity-oauth-userinfo                     # 用户信息注入插件
├── acuity-generator            # 代码生成服务
│   ├── acuity-generator-entity
│   ├── acuity-generator-biz
│   ├── acuity-generator-controller
├── acuity-public                        # 公共模块
│   ├── acuity-common                    # 业务相关的公共类
│   ├── acuity-common-api                # 公共的API层    
│   ├── acuity-data-scope-sdk            # 数据权限插件
│   ├── acuity-database-mode             # 租户模式配置层
│   ├── acuity-file-sdk                  # 业务文件（附件）接口插件
│   ├── acuity-model                     # 公共的实体和vo类
│   ├── acuity-tenant-datasource-init    # (数据源模式特有) 启动时加载数据源插件

项目结构介绍

概念声明

层：

API层：包含acuity-base-api、acuity-oauth-api、acuity-system-api 等模块
业务层：包含acuity-base-biz、acuity-system-biz、acuity-oauth-biz等模块
控制层：包含acuity-base-controller、acuity-system-controller、acuity-oauth-controller等模块
实体层：包含acuity-base-entity、acuity-system-entity、acuity-oauth-entity等模块
启动层：包含acuity-base-server、acuity-system-server、acuity-oauth-server等模块

模块： (模块和层可以混着说, 只要团队的人懂即可)

acuity-box-utils-pro 项目下的每个包. 如 acuity-core、 acuity-cloud-starter
acuity-cloud 项目下的每个包. 如acuity-base、acuity-common等
acuity-boot 项目下的每个包. 如acuity-base、acuity-common等

服务:

认证服务：acuity-oauth下的所有模块组成权限服务
系统服务：acuity-system下的所有模块组成租户服务
基础服务：acuity-base下的所有模块组成权限服务
网关服务：acuity-gateway下的所有模块组成网关服务
代码生成服务：acuity-generator下的所有模块组成代码生成服务
监控服务：acuity-monitor

acuity-public 目录下存放业务服务公共模块和收费的插件：

acuity-common 模块用于存放跟大多数服务有关的常量类和工具类等
acuity-common-api 模块公共api层
acuity-data-scope-sdk：数据权限插件
acuity-database-mode：租户模式实现插件。如DATASOURCE模式、COLUMN模式、NONE模式的实现类
acuity-file-sdk：附件sdk，用于业务服务保存和查询业务附件信息
acuity-model：公共的model对象
acuity-userinfo-sdk：用户信息注入器
acuity-tenant-datasource-init (datasource模式专属) ： DATASOURCE模式的初始化数据源模块，用于业务服务启动时，初始化租户数据源

总结：一个服务可以包含多个模块，一个模块可以包含多个层。

疑问🤔️

都已经是微服务项目了, 为什么还要将项目按模块拆封得如此细?

受到原来项目的“影响“, 已经习惯了将一个大项目按照功能拆封成多个模块的习惯
按照大功能将代码物理拆分成多个模块后, 强制按照server -> controller -> biz -> entity 层的依赖关系来开发功能
- 可以让项目结构更加清晰, 是典型的低耦合、高内聚体现;
- 可以避免开发水平参差不齐的团队,胡乱添加依赖, 胡乱注入Bean. (只允许: Controller 调用 Service, Service调用Mapper)
当某个项目不需要某个功能时(如没有站内信、没有短信发送、没有操作日志等), 按模块拆分的短信和站内信可以很轻松的在消息服务排除或者删除这2个功能。
方便后期调整为单体项目或微服务项目！（这一点很重要，使得单体改微服务，微服务改单体及其方便）

服务拆分模块建议

原则上推荐一个服务最好包含5个模块(api模块、entity模块、biz模块、controller层、server层), 但任何事情都不是绝对的,具体怎么分模块可以根据业务自身情况来定. 如: 消息服务希望将站内消息、短信、邮件等相关等逻辑集成到消息服务, 这几个功能既有独立性, 做得更细一些,甚至可以将站内消息、短信、邮件等功能独立成单独的服务, 但这务必会增加系统部署开销, 所以综合考虑, 将站内消息、短信、邮件等功能按模块开发,然后组合成一个服务, 即降低了部署等成本,也将每个功能独立出来,方便日后独立成单独的服务和禁用某些功能.

API层说明：

服务于服务之间互相访问时，通过api模块来调用。api 模块实际上就是通过声明式FeignClient实现的接口，B服务调用A服务的UserApi接口时，FeignClient将该次调用封装成Http请求，最后访问的是A服务的 Contoller层接口。

业务层说明：

主要存放Service接口及实现，Redis操作类、Mapper接口以及Xml（resources目录下）。约定如下：

AService 能注入BService，但禁止直接或间接循环注入。如AService -> BService ，BService->AService 在Service 层封装业务逻辑, 操作缓存接口、Mapper接口的操作

实体层说明：

存放实体po、文件传输对象DTO(本项目忽略VO)、枚举类型等，不涉及逻辑的一些类。

控制层说明：

主要存放一些服务的 Contrller 接口，用于对外访问。约定如下：

Controller 不能互相注入调用 Controller 只能调用Service，禁止调用Mapper(Dao) Controller 主要负责参数验证、转换等操作，尽量别写业务代码

启动层说明：

主要存放一些服务所需的启动类、配置类、配置文件、消息队列消费方监听入口等

每个层的依赖关系：

每个服务一般情况下都包含5个层： server、controller、biz、entity、api （特殊情况可以删减一些），他们的依赖依赖关系为： server -> controller -> biz -> entity ，api层独立，用于其他服务依赖。

服务介绍 ​

技术栈 ​

架构图 ​

认证服务： acuity-oauth ​

系统服务： acuity-system ​

基础服务： acuity-base ​

网关服务： acuity-gateway ​

监控： acuity-monitor ​

acuity-cloud-pro-datasource-column 目录结构 ​

acuity-boot-pro-datasource-column 目录结构 ​

项目结构介绍 ​

概念声明 ​

疑问🤔️ ​

服务拆分模块建议 ​

API层 说明： ​

业务层 说明： ​

实体层 说明： ​

控制层说明： ​

启动层说明： ​

每个层的依赖关系： ​

调用流程（acuity-cloud) ​