SpringBoot之多模块项目
SpringBoot之多模块项目
# SpringBoot之多模块项目
说明:我们通过
maven
的父子工程来搭建springboot
的多模块项目**
# 项目的整体结构
本项目涉及了到了五个模块
framework-web
模块主要是放置前端的页面等信息,framework-model
放置领域对象,framework-service
业务逻辑类放在这里,framework-mapper
操作数据库的对象放在这里,framework-common
基础公共的类放在这里
以上五个模块的依赖关系如下:
秉承的是至上而下的依赖关系。
具体的项目结构图如下
# 第一步:搭建父工程(framework-root)
父工程中只包含一个pom.xml
文件,文件内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.0.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.triumphxx</groupId>
<artifactId>framework-root</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>framework-root</name>
<description>Demo project for Spring Boot</description>
<packaging>pom</packaging>
<modules>
<module>framework-common</module>
<module>framework-web</module>
<module>framework-model</module>
<module>framework-service</module>
<module>framework-mapper</module>
</modules>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.triumphxx</groupId>
<artifactId>framework-model</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.triumphxx</groupId>
<artifactId>framework-mapper</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.triumphxx</groupId>
<artifactId>framework-service</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.triumphxx</groupId>
<artifactId>framework-common</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.triumphxx</groupId>
<artifactId>framework-web</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
说明:我们将所有的模块进行统一的版本信息管理,并将每一个模块引入到父
pom.xml
中。
# 第二步:搭建framework-web
模块
由于本模块是直接由前端进行调用的模块(前后端分离),
或者是直接将前端文件放在这个模块下,我们需要引入前端模版依赖,
和web
依赖。也需要依赖framework-service
,如下:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>com.triumphxx</groupId>
<artifactId>framework-service</artifactId>
</dependency>
2
3
4
5
6
7
8
9
10
11
12
模块结构如下:
framework-web
模块主要是和前端交互的接口controller
在这个模块我们创建一个控制器UserController
# 第三步:搭建framework-service
模块
由于本模块是需要依赖framework-mapper
模块。如下:
<dependency>
<groupId>com.triumphxx</groupId>
<artifactId>framework-mapper</artifactId>
</dependency>
2
3
4
模块结构如下:
framework-service
模块主要业务逻辑处理。我们创建了一个接口UserService
和实现UserServiceImpl
# 第四步:搭建framework-mapper
模块
由于本模块是需要依赖数据库相关依赖,和数据表实体。如下:
<dependency>
<groupId>com.triumphxx</groupId>
<artifactId>framework-model</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.2.0</version>
</dependency>
<!--数据库连接池-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.20</version>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
模块结构如下:
framework-mapper
模块主要操作数据库。我们创建了一个接口UserMapper
接口,并且实现查询user
表数据。如下:
/**
* @author:triumphxx
* @Date:2020/5/24
* @Time:5:38 下午
* @微信公众号:北漂码农有话说
* @desc:用户查询
**/
@Mapper
public interface UserMapper {
@Select("select * from user")
List<UserEntity> selectUser();
}
2
3
4
5
6
7
8
9
10
11
12
# 第五步:搭建framework-model
模块
我们只加入lombok
如下:
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
2
3
4
5
模块结构如下:
framework-model
模块主要管理我们的数据表对象。我们创建UserEntity
/**
* @author:triumphxx
* @Date:2020/5/24
* @Time:5:36 下午
* @微信公众号:北漂码农有话说
* @desc:用户实体类
**/
@Data
public class UserEntity {
private String username;
private int id;
private String password;
}
2
3
4
5
6
7
8
9
10
11
12
13
# 第六步:搭建framework-common
模块
这个模块主要是一些公共的组件,这边就不详细说了。
以上模块搭建好以后我们创建数据表
CREATE TABLE `user` (
`id` int(45) NOT NULL,
`username` varchar(255) COLLATE utf8_bin DEFAULT NULL,
`password` varchar(255) COLLATE utf8_bin DEFAULT NULL,
PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin;
2
3
4
5
6
插入一条测试数据
在framework-web
模块的配置文件配置数据库的信息
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC
username: root
password: root
type: com.alibaba.druid.pool.DruidDataSource
2
3
4
5
6
7
# 第七步:测试
启动项目并访问接口。
# 小结
好啦,数据查询到了,项目搭建完成,本次我们一起探究了,利用SpringBoot搭建一个多模块的项目, 这样做的目的是方便项目的管理