开源项目芋道源码剖析 [开篇]

文章首发于我的博客：https://blog.liuzijian.com/post/source-code-about-ruoyi-vue-pro.html
1.弁言

芋道(又名yudao，ruoyi-vue-pro)是一个基于spring-boot框架的单体Java后端开源项目，拥有基于RBAC模子的组织架构管理、CRM、ERP、商城、代码天生、AI等多个功能模块。封装了多租户、数据权限、工作流、OAuth，邮件、短信、定时任务、日志、链路追踪等多种技术和业务组件。其在GitHub上的地址是：https://github.com/YunaiV/ruoyi-vue-pro
因工作中会用到这个框架，为了更好的定制和更新功能，所以决定把它的源码核心部门都读一遍，博客持续更新，边学习，边输出，做知识积累整理输出。对学过的做过的东西，有个痕迹与存档，可以随时做归纳总结。
本文基于2.4.0-jdk8-SNAPSHOT版本的源码。
2.项目总体结构

项目基于传统的maven构建，大致结构如下，整个项目是多模块结构，分为1个父模块和多个子模块。

1. ruoyi-vue-pro [yudao]
2.     │
3.     ├── yudao-dependencies
4.     │     └── pom.xml
5.     │
6.     ├── yudao-framework
7.     │     ├── yudao-common
8.     │     │       └── src
9.     │     │       └── pom.xml
10.     │     ├── yudao-spring-boot-starter-biz-xxxxxxx
11.     │     │       └── src
12.     │     │       └── pom.xml
13.     │     ├── yudao-spring-boot-starter-xxxxxxx
14.     │     │       └── src
15.     │     │       └── pom.xml
16.     │     └── pom.xml   
17.     │
18.     │── yudao-module-aaa   
19.     │     ├── yudao-module-aaa-api
20.     │     │       └── src
21.     │     │       └── pom.xml      
22.     │     ├── yudao-module-aaa-biz
23.     │     │       └── src
24.     │     │       └── pom.xml  
25.     │     └── pom.xml              
26.     │
27.     │── yudao-module-bbb   
28.     │     ├── yudao-module-bbb-api
29.     │     │       └── src
30.     │     │       └── pom.xml      
31.     │     ├── yudao-module-bbb-biz
32.     │     │       └── src
33.     │     │       └── pom.xml  
34.     │     └── pom.xml
35.     │        
36.     │── yudao-server
37.     │     └── src
38.     │     └── pom.xml
39.     │
40.     └── pom.xml

复制代码

3.模块的结构，功能和依赖关系

3.1 root

• 最外层的/pom.xml作为root模块的配置，通过包罗了yudao-framework，yudao-module-xxxxxx，yudao-server，yudao-dependencies等浩繁模块。
  

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.     ......
6.     <modules>
7.         <module>yudao-dependencies</module>
8.         <module>yudao-framework</module>
9.         
10.         <module>yudao-server</module>
11.         
12.         <module>yudao-module-system</module>
13.         <module>yudao-module-infra</module>
14.     </modules>
15.     ......
16. </project>

复制代码

• root模块通过引用负责统一依赖版本的模块yudao-dependencies来将依赖的版本号传递给所有子模块，从而统一整个项目的依赖版本
  

1. <dependencyManagement>
2.    <dependencies>
3.        <dependency>
4.            <groupId>cn.iocoder.boot</groupId>
5.            <artifactId>yudao-dependencies</artifactId>
6.            <version>${revision}</version>
7.            <type>pom</type>
8.            <scope>import</scope>
9.        </dependency>
10.    </dependencies>
11. </dependencyManagement>

复制代码

• root模块使用${revision}来设置自身的版本号，子模块的如果也设置为${revision}的话，就继承了root模块的版本号了，子模块的子模块也是一样的道理，这样整个工程所有子孙模块的版本号就都统一起来了，需要升级版本时，只需要在root模块的pom.xml文件中，把内里的版本号一改，整个工程所有子孙模块的版本号便全部跟着变了。
  例：
  /pom.xml
  

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
6.    <groupId>cn.iocoder.boot</groupId>
7.    <artifactId>yudao</artifactId>
8.    <version>${revision}</version>
9.    <packaging>pom</packaging>
11.    ... ...
13.    <properties>
14.        <revision>2.4.0-jdk8-SNAPSHOT</revision>
15.    </properties>
16. </project>

复制代码

yudao-module-system/pom.xml

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.    <parent>
6.        <groupId>cn.iocoder.boot</groupId>
7.        <artifactId>yudao</artifactId>
8.        <version>${revision}</version>
9.    </parent>
10.    <modelVersion>4.0.0</modelVersion>
11.    <modules>
12.        <module>yudao-module-system-api</module>
13.        <module>yudao-module-system-biz</module>
14.    </modules>
15.    <artifactId>yudao-module-system</artifactId>
16.    <packaging>pom</packaging>
18.    <name>${project.artifactId}</name>
19.    <description>
20.        system 模块下，我们放通用业务，支撑上层的核心业务。
21.        例如说：用户、部门、权限、数据字典等等
22.    </description>
24. </project>

复制代码

yudao-module-system/yudao-module-system-api/pom.xml

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.    
6.    <parent>
7.        <groupId>cn.iocoder.boot</groupId>
8.        <artifactId>yudao-module-system</artifactId>
9.        <version>${revision}</version>
10.    </parent>
11.    <modelVersion>4.0.0</modelVersion>
12.    <artifactId>yudao-module-system-api</artifactId>
13.    <packaging>jar</packaging>
15.    <name>${project.artifactId}</name>
16.    <description>
17.        system 模块 API，暴露给其它模块调用
18.    </description>
20.    ......
22. </project>

复制代码

• 通过插件org.codehaus.mojo:flatten-maven-plugin来防止不必要的依赖传递
  

1. <build>
2.    <pluginManagement>
3.        <plugins>
4.            <plugin>
5.                <groupId>org.apache.maven.plugins</groupId>
6.                <artifactId>maven-surefire-plugin</artifactId>
7.                <version>${maven-surefire-plugin.version}</version>
8.            </plugin>
10.            <plugin>
11.                <groupId>org.apache.maven.plugins</groupId>
12.                <artifactId>maven-compiler-plugin</artifactId>
13.                <version>${maven-compiler-plugin.version}</version>
14.                <configuration>
15.                    <annotationProcessorPaths>
16.                        <path>
17.                            <groupId>org.springframework.boot</groupId>
18.                            <artifactId>spring-boot-configuration-processor</artifactId>
19.                            <version>${spring.boot.version}</version>
20.                        </path>
21.                        <path>
22.                            <groupId>org.projectlombok</groupId>
23.                            <artifactId>lombok</artifactId>
24.                            <version>${lombok.version}</version>
25.                        </path>
26.                        <path>
27.                            <groupId>org.mapstruct</groupId>
28.                            <artifactId>mapstruct-processor</artifactId>
29.                            <version>${mapstruct.version}</version>
30.                        </path>
31.                    </annotationProcessorPaths>
32.                </configuration>
33.            </plugin>
34.            <plugin>
35.                <groupId>org.codehaus.mojo</groupId>
36.                <artifactId>flatten-maven-plugin</artifactId>
37.            </plugin>
38.        </plugins>
39.    </pluginManagement>
41.    <plugins>
42.        <plugin>
43.            <groupId>org.codehaus.mojo</groupId>
44.            <artifactId>flatten-maven-plugin</artifactId>
45.            <version>${flatten-maven-plugin.version}</version>
46.            <configuration>
47.                <flattenMode>oss</flattenMode>
48.                <updatePomFile>true</updatePomFile>
49.            </configuration>
50.            <executions>
51.                <execution>
52.                    <goals>
53.                        <goal>flatten</goal>
54.                    </goals>
55.                    <id>flatten</id>
56.                    <phase>process-resources</phase>
57.                </execution>
58.                <execution>
59.                    <goals>
60.                        <goal>clean</goal>
61.                    </goals>
62.                    <id>flatten.clean</id>
63.                    <phase>clean</phase>
64.                </execution>
65.            </executions>
66.        </plugin>
67.    </plugins>
69. </build>

复制代码

3.2 yudao-dependencies

这个模块内仅有一个pom.xml文件，该模块的作用仅仅是统一整个项目的依赖版本，因为yudao-dependencies模块没有指定，因此不能从父(即root)模块继承${revision}，需要在自己的内里维护自己的${revision}版本供自己引用，版本号的值一样平常要与root模块中的版本号要保持一致。
{% note warning %}
yudao-dependencies模块并不是root模块的子模块，因为如果root模块成了yudao-dependencies的父模块的同时还引用了子模块yudao-dependencies的话，就会导致循环引用，因此yudao-dependencies没有指定，只是由root模块通过包罗进去举行代管，root模块构建时，yudao-dependencies会一并构建。

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.     <groupId>cn.iocoder.boot</groupId>
6.     <artifactId>yudao-dependencies</artifactId>
7.     <version>${revision}</version>
8.     <packaging>pom</packaging>
10.     ... ...
12.     <properties>
13.         <revision>2.4.0-jdk8-SNAPSHOT</revision>
14.     </properties>
15.     ... ...
16. </project>

复制代码

yudao-dependencies内里只有一个pom.xml文件，其使用声明了整个项目所需要的依赖，并被root模块引入，从而统一整个工程的依赖版本。
yudao-dependencies不但通过引用springframework，spring-boot-dependencies等type为pom的依赖项来继承第三方框架的版本，还规定了项目自身封装的一些框架(yudao-framework)的版本号。

1. <dependencyManagement>
2.     <dependencies>
3.         <dependency>
4.             <groupId>org.springframework</groupId>
5.             <artifactId>spring-framework-bom</artifactId>
6.             <version>${spring.framework.version}</version>
7.             <type>pom</type>
8.             <scope>import</scope>
9.         </dependency>
10.         <dependency>
11.             <groupId>org.springframework.security</groupId>
12.             <artifactId>spring-security-bom</artifactId>
13.             <version>${spring.security.version}</version>
14.             <type>pom</type>
15.             <scope>import</scope>
16.         </dependency>
17.         <dependency>
18.             <groupId>org.springframework.boot</groupId>
19.             <artifactId>spring-boot-dependencies</artifactId>
20.             <version>${spring.boot.version}</version>
21.             <type>pom</type>
22.             <scope>import</scope>
23.         </dependency>
25.         <dependency>
26.             <groupId>cn.iocoder.boot</groupId>
27.             <artifactId>yudao-spring-boot-starter-biz-tenant</artifactId>
28.             <version>${revision}</version>
29.         </dependency>
30.         <dependency>
31.             <groupId>cn.iocoder.boot</groupId>
32.             <artifactId>yudao-spring-boot-starter-biz-data-permission</artifactId>
33.             <version>${revision}</version>
34.         </dependency>
35.         <dependency>
36.             <groupId>cn.iocoder.boot</groupId>
37.             <artifactId>yudao-spring-boot-starter-biz-ip</artifactId>
38.             <version>${revision}</version>
39.         </dependency>
41.         <dependency>
42.             <groupId>cn.iocoder.boot</groupId>
43.             <artifactId>yudao-common</artifactId>
44.             <version>${revision}</version>
45.         </dependency>
47.         ... ...
49.     </dependencies>
50. </dependencyManagement>

复制代码

通过插件org.codehaus.mojo:flatten-maven-plugin来防止不必要的依赖传递

1. <build>
2.     <plugins>
3.         
4.         <plugin>
5.             <groupId>org.codehaus.mojo</groupId>
6.             <artifactId>flatten-maven-plugin</artifactId>
7.             <version>${flatten-maven-plugin.version}</version>
8.             <configuration>
9.                 <flattenMode>bom</flattenMode>
10.                 <updatePomFile>true</updatePomFile>
11.             </configuration>
12.             <executions>
13.                 <execution>
14.                     <goals>
15.                         <goal>flatten</goal>
16.                     </goals>
17.                     <id>flatten</id>
18.                     <phase>process-resources</phase>
19.                 </execution>
20.                 <execution>
21.                     <goals>
22.                         <goal>clean</goal>
23.                     </goals>
24.                     <id>flatten.clean</id>
25.                     <phase>clean</phase>
26.                 </execution>
27.             </executions>
28.         </plugin>
29.     </plugins>
30. </build>

复制代码

3.3 yudao-framework

该模块内主要是需要用到的公共依赖和一些对常用框架和功能组件的封装，大致结构如下

1. yudao-framework
2.       │
3.       │── yudao-common
4.       │     ├─ src
5.       │     │   └─ main
6.       │     │       └─ java
7.       │     │            └─ cn.iocoder.yudao.framework.common
8.       │     │                  └─ core
9.       │     │                  └─ enums
10.       │     │                  └─ exception
11.       │     │                  └─ pojo
12.       │     │                  └─ util
13.       │     │                  └─ validation
14.       │     │
15.       │     └─ pom.xml
16.       │
17.       │── yudao-spring-boot-starter-xxxxxx
18.       │     ├─ src
19.       │     │   └─ main
20.       │     │       ├─ java
21.       │     │       |    ├─ cn.iocoder.yudao.framework.xxxxxx
22.       │     │       |    │     └─ config
23.       │     │       |    │     └─ core
24.       │     │       |    │     └─ aaa
25.       │     │       |    │         
26.       │     │       |    └─ bbb.ccc.ddd                     
27.       │     │       │
28.       │     │       └─ resources
29.       │     │            └─ META-INF.spring
30.       │     │                  └─ org.springframework.boot.autoconfigure.AutoConfiguration.imports
31.       │     │                              
32.       │     └── pom.xml
33.       │
34.       └── pom.xml

复制代码

yudao-framework下没有其他依赖，只是简单的将所有封装的组件聚合起来
yudao-framework/pom.xml

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.     <modelVersion>4.0.0</modelVersion>
6.     <parent>
7.         <artifactId>yudao</artifactId>
8.         <groupId>cn.iocoder.boot</groupId>
9.         <version>${revision}</version>
10.     </parent>
11.     <packaging>pom</packaging>
12.     <modules>
13.         <module>yudao-common</module>
14.         <module>yudao-spring-boot-starter-mybatis</module>
15.         <module>yudao-spring-boot-starter-redis</module>
16.         <module>yudao-spring-boot-starter-web</module>
17.         <module>yudao-spring-boot-starter-security</module>
18.         <module>yudao-spring-boot-starter-websocket</module>
20.         <module>yudao-spring-boot-starter-monitor</module>
21.         <module>yudao-spring-boot-starter-protection</module>
22.         <module>yudao-spring-boot-starter-job</module>
23.         <module>yudao-spring-boot-starter-mq</module>
25.         <module>yudao-spring-boot-starter-excel</module>
26.         <module>yudao-spring-boot-starter-test</module>
28.         <module>yudao-spring-boot-starter-biz-tenant</module>
29.         <module>yudao-spring-boot-starter-biz-data-permission</module>
30.         <module>yudao-spring-boot-starter-biz-ip</module>
31.     </modules>
33.     <artifactId>yudao-framework</artifactId>
34.     <description>
35.         该包是技术组件，每个子包，代表一个组件。每个组件包括两部分：
36.             1. core 包：是该组件的核心封装
37.             2. config 包：是该组件基于 Spring 的配置
39.         技术组件，也分成两类：
40.             1. 框架组件：和我们熟悉的 MyBatis、Redis 等等的拓展
41.             2. 业务组件：和业务相关的组件的封装，例如说数据字典、操作日志等等。
42.         如果是业务组件，Maven 名字会包含 biz
43.     </description>
44.     <url>https://github.com/YunaiV/ruoyi-vue-pro</url>
46. </project>

复制代码

yudao-common模块封装了一些项目公共的枚举类，非常类，公共的实体类，和一些工具类，在这个项目中通常会被其他组件模块(yudao-spring-boot-starter-xxxx)和业务模块的api模块(yudao-module-xxxxx-api)所引用。
除了yudao-common外其余的都是封装的框架功能模块，模块名格式为yudao-spring-boot-starter-xxxx，分为业务组件和技术组件。技术组件模块名中没有biz，业务组件是有的。业务组件通常会引用业务模块的api模块(yudao-module-xxxxx-api)
例如数据权限yudao-spring-boot-starter-biz-data-permission组件依赖了体系管理业务模块的api：yudao-module-system-api

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.     <parent>
6.         <artifactId>yudao-framework</artifactId>
7.         <groupId>cn.iocoder.boot</groupId>
8.         <version>${revision}</version>
9.     </parent>
10.     <modelVersion>4.0.0</modelVersion>
11.     <artifactId>yudao-spring-boot-starter-biz-data-permission</artifactId>
12.     <packaging>jar</packaging>
14.     ......
16.     <dependencies>
17.         <dependency>
18.             <groupId>cn.iocoder.boot</groupId>
19.             <artifactId>yudao-common</artifactId>
20.         </dependency>
22.         .........
24.         
25.         <dependency>
26.             <groupId>cn.iocoder.boot</groupId>
27.             <artifactId>yudao-module-system-api</artifactId>
28.             <version>${revision}</version>
29.         </dependency>
31.         .........
33. </project>

复制代码

该模块下的包名都以cn.iocoder.yudao.framework开头，背面是组件名称，然后再往下大多又分成config和core两个包，config包下是spring-boot的配置类，与组件本身的配置有关，core包下是组件详细功能的实当代码，需要注意的是config包下的配置类会配合resources/META-INF.spring下的org.springframework.boot.autoconfigure.AutoConfiguration.imports文件使用，配置类的类路径只有配在这个文件中，才会被spring扫描到，然后将组件注入spring容器中，供其他业务模块使用。
framework模块之间也可以相互引用，例如yudao-spring-boot-starter-biz-data-permission就依赖了yudao-spring-boot-starter-security，yudao-spring-boot-starter-mybatis和yudao-spring-boot-starter-test

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.     <parent>
6.         <artifactId>yudao-framework</artifactId>
7.         <groupId>cn.iocoder.boot</groupId>
8.         <version>${revision}</version>
9.     </parent>
10.     <modelVersion>4.0.0</modelVersion>
11.     <artifactId>yudao-spring-boot-starter-biz-data-permission</artifactId>
12.     <packaging>jar</packaging>
14.     <name>${project.artifactId}</name>
15.     <description>数据权限</description>
16.     <url>https://github.com/YunaiV/ruoyi-vue-pro</url>
18.     <dependencies>
19.         <dependency>
20.             <groupId>cn.iocoder.boot</groupId>
21.             <artifactId>yudao-common</artifactId>
22.         </dependency>
24.         
25.         <dependency>
26.             <groupId>cn.iocoder.boot</groupId>
27.             <artifactId>yudao-spring-boot-starter-security</artifactId>
28.             <optional>true</optional>
29.         </dependency>
31.         
32.         <dependency>
33.             <groupId>cn.iocoder.boot</groupId>
34.             <artifactId>yudao-spring-boot-starter-mybatis</artifactId>
35.         </dependency>
37.         
38.         <dependency>
39.             <groupId>cn.iocoder.boot</groupId>
40.             <artifactId>yudao-module-system-api</artifactId>
41.             <version>${revision}</version>
42.         </dependency>
44.         
45.         <dependency>
46.             <groupId>cn.iocoder.boot</groupId>
47.             <artifactId>yudao-spring-boot-starter-test</artifactId>
48.             <scope>test</scope>
49.         </dependency>
50.     </dependencies>
52. </project>

复制代码

3.4 yudao-module-xxxxx

yudao-module-xxxxx模块是实现详细业务的模块，详细结构如下:
(xxxxx为业务名，aaa，bbb为业务下的详细功能名)

1. yudao-module-xxxxx
2.     │
3.     │── yudao-module-xxxxx-api
4.     │     ├─ src
5.     │     │   └─ main
6.     │     │       └─ java
7.     │     │            └─ cn.iocoder.yudao.module.xxxxx
8.     │     │                ├─ api
9.     │     │                │   ├─ aaa
10.     │     │                │   │    ├─ dto
11.     │     │                │   │    │   └─ AaaRespDTO.java
12.     │     │                │   │    └─ AaaApi.java                    
13.     │     │                │   └─ bbb
14.     │     │                │        ├─ dto
15.     │     │                │        │   └─ BbbRespDTO.java
16.     │     │                │        └─ BbbApi.java
17.     │     │                └─ enums
18.     │     │                    ├─ aaa
19.     │     │                    │    └─ AaaCccEnum.java   
20.     │     │                    │    └─ AaaDdddEnum.java                 
21.     │     │                    ├─ bbb
22.     │     │                    │    └─ BbbCccEnum.java   
23.     │     │                    │    └─ BbbDdddEnum.java
24.     │     │                    │         
25.     │     │                    ├─ AaaTypeConstants.java   
26.     │     │                    └─ BbbTypeConstants.java               
27.     │     │
28.     │     └─ pom.xml
29.     │
30.     │── yudao-module-xxxxx-biz
31.     │     ├─ src
32.     │     │   └─ main
33.     │     │       ├─ java
34.     │     │       |    └─ cn.iocoder.yudao.module.xxxxx
35.     │     │       |        ├─ api
36.     │     │       |        │   ├─ aaa   
37.     │     │       |        │   │   └─ AaaApiImpl.java  
38.     │     │       |        │   └─ bbb   
39.     │     │       |        │       └─ BbbApiImpl.java  
40.     │     │       |        │                                 
41.     │     │       |        ├─ controller
42.     │     │       |        │   ├─ admin   
43.     │     │       |        │   │   ├─ aaa
44.     │     │       |        │   │   │   ├─ vo
45.     │     │       |        │   │   │   │   └─ AaaReqVO.java                    
46.     │     │       |        │   │   │   └─ AaaController.java
47.     │     │       |        │   │   └─ bbb
48.     │     │       |        │   │       ├─ vo
49.     │     │       |        │   │       │   └─ BbbReqVO.java                    
50.     │     │       |        │   │       └─ BbbController.java   
51.     │     │       |        │   │               
52.     │     │       |        │   └─ app   
53.     │     │       |        │       └─ aaa
54.     │     │       |        │           ├─ vo
55.     │     │       |        │           │   └─ AaaAppReqVO.java         
56.     │     │       |        │           └─ AaaAppController.java
57.     │     │       |        │              
58.     │     │       |        ├─ convert  
59.     │     │       |        │   ├─ aaa
60.     │     │       |        │   │   └─ AaaConvert.java         
61.     │     │       |        │   └─ bbb
62.     │     │       |        │       └─ BbbConvert.java
63.     │     │       |        │        
64.     │     │       |        ├─ framework
65.     │     │       |        ├─ job
66.     │     │       |        ├─ mq
67.     │     │       |        ├─ service
68.     │     │       |        │   ├─ aaa
69.     │     │       |        │   │   └─ AaaService.java
70.     │     │       |        │   │   └─ AaaServiceImpl.java                    
71.     │     │       |        │   └─ bbb
72.     │     │       |        │       └─ BbbService.java
73.     │     │       |        │       └─ BbbServiceImpl.java
74.     │     │       |        │
75.     │     │       |        │
76.     │     │       |        └─ dal
77.     │     │       |            ├─ dataobject
78.     │     │       |            │   ├─ aaa
79.     │     │       |            │   │   └─ AaaDO.java         
80.     │     │       |            │   └─ bbb
81.     │     │       |            │       └─ BbbDO.java                    
82.     │     │       |            └─ mysql  
83.     │     │       |                ├─ aaa
84.     │     │       |                │   └─ AaaMapper.java         
85.     │     │       |                └─ bbb
86.     │     │       |                    └─ BbbMapper.java                           
87.     │     │       │  
88.     │     │       └─ resource
89.     │     │              └─ mapper
90.     │     │                  ├─ aaa
91.     │     │                  │   └─ AaaMapper.xml         
92.     │     │                  └─ bbb
93.     │     │                      └─ BbbMapper.xml                             
94.     │     └── pom.xml
95.     │
96.     └── pom.xml  

复制代码

整个项目的Controller， Service， Mapper都封装在业务模块里，业务模块是根据详细的业务来建立的。
每个业务模块都由yudao-module-xxxxx-api和yudao-module-xxxxx-biz两个子模块组成。yudao-module-xxxxx-api模块中是开放给其他业务模块或业务组件调用的接口代码和一些公共的枚举和常量，yudao-module-xxxxx-biz模块中是详细业务的实当代码，因为api定义的接口是biz实现的，因此biz模块起首要依赖它自己要实现的api模块。
模块内包名都是固定前缀cn.iocoder.yudao加module再加业务模块名的情势，例如：cn.iocoder.yudao.module.xxxxx，在此基础上根据所属层级建立下一级包名，例如cn.iocoder.yudao.module.xxxxx.controller.admin，cn.iocoder.yudao.module.xxxxx.service，然后根据详细业务功能再建立更深层级的包名和包下的类，例如：cn.iocoder.yudao.module.xxxxx.controller.admin.aaa.vo。
包名解释：

• yudao-module-xxxxx-api
  
  
  
  • cn.iocoder.yudao.module.xxxxx.api 包存放业务模块需要对外暴漏的接口，以及用于传输数据的DTO对象。
    
  • cn.iocoder.yudao.module.xxxxx.enums 包存放该业务模块的枚举类和常量类，既供自己使用，也供调用方使用。
    
  
  
• yudao-module-xxxxx-biz
  
  
  
  • cn.iocoder.yudao.module.xxxxx.api 包存放对api模块定义的接口类的实现(***ApiImpl)，实现类为Spring容器管理，被Spring注入到调用者引用的Api接口上，ApiImpl和Controller一样，接收到调用后再调用业务层Service代码。
    
  • cn.iocoder.yudao.module.xxxxx.controller 分为admin和app两个子包，分别放置管理员接口和会员接口，包中存放Controller类及接收和天生JSON的实体类VO，接收http请求并返回数据。
    
  • cn.iocoder.yudao.module.xxxxx.service 包下是详细的Service业务接口和实现类。
    
  • cn.iocoder.yudao.module.xxxxx.dal 包是负责数据库访问的DAO层，分为dataobject和mysql两个包，dataobject包内存放的是DO对象，mysql包内存放的是Mybatis/Mybatis-Plus的Mapper类，Java代码无法实现的复杂SQL，可在resources文件夹内定义"*Mapper.xml"文件实现。
    
  • cn.iocoder.yudao.module.xxxxx.convert 包功能比较简单，用于存放mapstruct转换器类，用于各种不同类型的实体类对象之间的深拷贝互相转换。
    
  • cn.iocoder.yudao.module.xxxxx.mq 消息发送接收。
    
  • cn.iocoder.yudao.module.xxxxx.job 定时任务。
    
  • cn.iocoder.yudao.module.xxxxx.framework 配合yudao-framework模块封装的框架和功能来实现一些更高级的功能，例如文档天生，数据权限等等。
    
  • ......
    
  
  

业务模块biz之间是相互独立的，如biz模块间要相互调用，只要互相引用对方的api模块坐标到自己biz的pom.xml即可，这样的模块依赖方式完美遵循依赖倒置原则，如果是biz直接引用biz不但违背依赖倒置原则，而且可能还会导致maven构建时报出循环引用的错误。本项目中后续还会出现业务组件框架模块(yudao-spring-boot-starter-biz-xxxxxxxx)依赖详细业务模块的情况，同样也是需要引用业务模块的api。
例:

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.    
6.     <parent>
7.         <groupId>cn.iocoder.boot</groupId>
8.         <artifactId>yudao-module-system</artifactId>
9.         <version>${revision}</version>
10.     </parent>
12.     <modelVersion>4.0.0</modelVersion>
13.    
14.     <artifactId>yudao-module-system-biz</artifactId>
15.     <packaging>jar</packaging>
17.     ... ...
19.     <dependencies>
20.         <dependency>
21.             <groupId>cn.iocoder.boot</groupId>
22.             
23.             <artifactId>yudao-module-system-api</artifactId>
24.             <version>${revision}</version>
25.         </dependency>
26.         <dependency>
27.             <groupId>cn.iocoder.boot</groupId>
28.             
29.             <artifactId>yudao-module-infra-api</artifactId>
30.             <version>${revision}</version>
31.     </dependency>
33.     ... ...
35. </project>

复制代码

3.5 yudao-server

yudao-server是启动项目的模块，内里有spring-boot主启动类cn.iocoder.yudao.server.YudaoServerApplication，缺省的请求处置惩罚类cn.iocoder.yudao.server.controller.DefaultController，不同环境的配置文件application-*.yml，还有一个logback的日志配置文件logback-spring.xml。

1. yudao-server
2.     |
3.     ├─ src
4.     |   └─ main
5.     |        ├─ java
6.     |        |    └─ cn.iocoder.yudao.server
7.     |        |        └─ controller
8.     |        |            └─ DefaultController.java        
9.     |        |        └─ YudaoServerApplication.java  
10.     |        |
11.     |        └─ resources
12.     |             └─ application.yaml
13.     |             └─ application-dev.yaml
14.     |             └─ application-local.yaml
15.     |             └─ logback-spring.xml
16.     |     
17.     └─ pox.xml

复制代码

yudao-server模块汇聚了所有的业务模块，打包上线的可执行jar包就是这个模块编译而成的，该模块聚合了所有的业务模块的biz模块(yudao-module-***-biz)以及一些需要直接引用的starter，需要启用哪个业务模块就可以按需引入哪个业务模块。
/yudao-server/pom.xml中，引入了项目最核心的两个业务模块：体系管理yudao-module-system-biz和服务保障yudao-module-infra-biz，默认不引入其他业务模块从而加快编译速率，还引入了一些其他的starter，最后通过spring-boot-maven-plugin插件将此模块代码打包为可执行的jar包，从而启动整个项目。

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.    
6.     <parent>
7.         <groupId>cn.iocoder.boot</groupId>
8.         <artifactId>yudao</artifactId>
9.         <version>${revision}</version>
10.     </parent>
11.     <modelVersion>4.0.0</modelVersion>
13.     <artifactId>yudao-server</artifactId>
14.     <packaging>jar</packaging>
16.     <name>${project.artifactId}</name>
17.     <description>
18.         后端 Server 的主项目，通过引入需要 yudao-module-xxx 的依赖，
19.         从而实现提供 RESTful API 给 yudao-ui-admin、yudao-ui-user 等前端项目。
20.         本质上来说，它就是个空壳（容器）！
21.     </description>
22.     <url>https://github.com/YunaiV/ruoyi-vue-pro</url>
24.     <dependencies>
25.         <dependency>
26.             <groupId>cn.iocoder.boot</groupId>
27.             <artifactId>yudao-module-system-biz</artifactId>
28.             <version>${revision}</version>
29.         </dependency>
30.         <dependency>
31.             <groupId>cn.iocoder.boot</groupId>
32.             <artifactId>yudao-module-infra-biz</artifactId>
33.             <version>${revision}</version>
34.         </dependency>
36.         
37.         <dependency>
38.             <groupId>org.springframework.boot</groupId>
39.             <artifactId>spring-boot-configuration-processor</artifactId>
40.             <optional>true</optional>
41.         </dependency>
43.         
44.         <dependency>
45.             <groupId>cn.iocoder.boot</groupId>
46.             <artifactId>yudao-spring-boot-starter-protection</artifactId>
47.         </dependency>
49.     </dependencies>
51.     <build>
52.         
53.         <finalName>${project.artifactId}</finalName>
54.         <plugins>
55.             
56.             <plugin>
57.                 <groupId>org.springframework.boot</groupId>
58.                 <artifactId>spring-boot-maven-plugin</artifactId>
59.                 <version>${spring.boot.version}</version>
60.                 <executions>
61.                     <execution>
62.                         <goals>
63.                             <goal>repackage</goal>
64.                         </goals>
65.                     </execution>
66.                 </executions>
67.             </plugin>
68.         </plugins>
69.     </build>
71. </project>

复制代码

cn.iocoder.yudao.server.YudaoServerApplication是整个项目的主启动类，通过注解@SpringBootApplication(scanBasePackages = {"${yudao.info.base-package}.server", "${yudao.info.base-package}.module"})将cn.iocoder.yudao.module下的包列入Spring扫描范围，用于实例化module模块中的类，并纳入Spring容器管理，这也是业务模块(yudao-module-xxx-xxx)下的子包和类必须放在cn.iocoder.yudao.module包下的原因。

1. package cn.iocoder.yudao.server;
3. import org.springframework.boot.SpringApplication;
4. import org.springframework.boot.autoconfigure.SpringBootApplication;
6. /**
7. * 项目的启动类
8. * @author 芋道源码
9. */
10. @SuppressWarnings("SpringComponentScan") // 忽略 IDEA 无法识别 ${yudao.info.base-package}
11. @SpringBootApplication(scanBasePackages = {"${yudao.info.base-package}.server", "${yudao.info.base-package}.module"})
12. public class YudaoServerApplication {
14.     public static void main(String[] args) {
15.         SpringApplication.run(YudaoServerApplication.class, args);
16.     }
18. }

复制代码

controller包下定义了一个缺省的cn.iocoder.yudao.server.controller.DefaultController类，如果被调用的接口所在的模块没有被yudao-server引入，就会被这个类中带着路径通配符的接口方法“兜底”，给出对应的错误提示，这个也是芋道源码中比较精巧的筹划之一。

1. package cn.iocoder.yudao.server.controller;
3. import cn.iocoder.yudao.framework.common.pojo.CommonResult;
4. import org.springframework.web.bind.annotation.RequestMapping;
5. import org.springframework.web.bind.annotation.RestController;
7. import static cn.iocoder.yudao.framework.common.exception.enums.GlobalErrorCodeConstants.NOT_IMPLEMENTED;
9. /**
10. * 默认 Controller，解决部分 module 未开启时的 404 提示。
11. * 例如说，/bpm/** 路径，工作流
12. *
13. * @author 芋道源码
14. */
15. @RestController
16. public class DefaultController {
18.     @RequestMapping("/admin-api/bpm/**")
19.     public CommonResult<Boolean> bpm404() {
20.         return CommonResult.error(NOT_IMPLEMENTED.getCode(),
21.                 "[工作流模块 yudao-module-bpm - 已禁用][参考 https://doc.iocoder.cn/bpm/ 开启]");
22.     }
24.     @RequestMapping("/admin-api/mp/**")
25.     public CommonResult<Boolean> mp404() {
26.         return CommonResult.error(NOT_IMPLEMENTED.getCode(),
27.                 "[微信公众号 yudao-module-mp - 已禁用][参考 https://doc.iocoder.cn/mp/build/ 开启]");
28.     }
30.     @RequestMapping(value = {"/admin-api/product/**", // 商品中心
31.             "/admin-api/trade/**", // 交易中心
32.             "/admin-api/promotion/**"})  // 营销中心
33.     public CommonResult<Boolean> mall404() {
34.         return CommonResult.error(NOT_IMPLEMENTED.getCode(),
35.                 "[商城系统 yudao-module-mall - 已禁用][参考 https://doc.iocoder.cn/mall/build/ 开启]");
36.     }
38.     @RequestMapping("/admin-api/erp/**")
39.     public CommonResult<Boolean> erp404() {
40.         return CommonResult.error(NOT_IMPLEMENTED.getCode(),
41.                 "[ERP 模块 yudao-module-erp - 已禁用][参考 https://doc.iocoder.cn/erp/build/ 开启]");
42.     }
44.     @RequestMapping("/admin-api/crm/**")
45.     public CommonResult<Boolean> crm404() {
46.         return CommonResult.error(NOT_IMPLEMENTED.getCode(),
47.                 "[CRM 模块 yudao-module-crm - 已禁用][参考 https://doc.iocoder.cn/crm/build/ 开启]");
48.     }
50.     @RequestMapping(value = {"/admin-api/report/**"})
51.     public CommonResult<Boolean> report404() {
52.         return CommonResult.error(NOT_IMPLEMENTED.getCode(),
53.                 "[报表模块 yudao-module-report - 已禁用][参考 https://doc.iocoder.cn/report/ 开启]");
54.     }
56.     @RequestMapping(value = {"/admin-api/pay/**"})
57.     public CommonResult<Boolean> pay404() {
58.         return CommonResult.error(NOT_IMPLEMENTED.getCode(),
59.                 "[支付模块 yudao-module-pay - 已禁用][参考 https://doc.iocoder.cn/pay/build/ 开启]");
60.     }
62.     @RequestMapping(value = {"/admin-api/ai/**"})
63.     public CommonResult<Boolean> ai404() {
64.         return CommonResult.error(NOT_IMPLEMENTED.getCode(),
65.                 "[AI 大模型 yudao-module-ai - 已禁用][参考 https://doc.iocoder.cn/ai/build/ 开启]");
66.     }
68.     @RequestMapping(value = {"/admin-api/iot/**"})
69.     public CommonResult<Boolean> iot404() {
70.         return CommonResult.error(NOT_IMPLEMENTED.getCode(),
71.                 "[IOT 物联网 yudao-module-iot - 已禁用][参考 https://doc.iocoder.cn/iot/build/ 开启]");
72.     }
74. }

复制代码

3.6 关系图

1.引用关系，箭头由被引用模块指向引用模块

2.继承关系，箭头由父级指向子级

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。