带你走进Spring-Boot-项目实战：Maven-多模块项目搭建

最新推荐文章于 2024-11-22 06:13:28 发布

JAVA无声

最新推荐文章于 2024-11-22 06:13:28 发布

阅读量1.1k

点赞数 21

分类专栏：程序员文章标签： maven python java

本文链接：https://blog.csdn.net/a369966697/article/details/138024370

版权

程序员专栏收录该内容

778 篇文章 0 订阅

订阅专栏

④ 修改 Module name 增加横杠提升可读性，点击「 Finish 」

⑤ 同理添加「 demo-dao 」、「 demo-common 」、「 demo-web 」子模块，最终得到项目目录结构如下

4.3 整理父 pom 文件中的内容

① 删除 dependencies 标签及其中的 spring-boot-starter 和 spring-boot-starter-test 依赖，因为 Spring Boot 提供的父工程已包含，并且父 pom 原则上都是通过 dependencyManagement 标签管理依赖包。

注：dependencyManagement 及 dependencies 的区别自行查阅文档

② 删除 build 标签及其中的所有内容，spring-boot-maven-plugin 插件作用是打一个可运行的包，多模块项目仅仅需要在入口类所在的模块添加打包插件，这里父模块不需要打包运行。而且该插件已被包含在 Spring Boot 提供的父工程中，这里删掉即可。
③ 最后整理父 pom 文件中的其余内容，按其代表含义归类，整理结果如下：

4.0.0
pom
demo
Demo project for Spring Boot

com.example.demo
demo
0.0.1-SNAPSHOT

org.springframework.boot spring-boot-starter-parent 2.1.2.RELEASE demo-biz demo-common demo-dao demo-web

4.4 简易 HTTP 接口测试

准备工作都完成之后，通过一个简易的 HTTP 接口测试项目是否正常运行。

① 首先在 demo-web 层创建 com.example.demo.web 包并添加入口类 DemoWebApplication.java

注：com.example.demo.web 为多级目录结构并非单个目录名

package com.example.demo.web;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**

@author linjian
@date 2019/1/15
*/
@SpringBootApplication
public class DemoWebApplication {
public static void main(String[] args) {
SpringApplication.run(DemoWebApplication.class, args);
}
}

② 其次在 demo-web 层的 pom 文件中添加必要的依赖包

org.springframework.boot spring-boot-starter-web

② 然后在 com.example.demo.web 包中添加 controller 目录并新建一个 controller，添加 test 方法测试接口是否可以正常访问。

package com.example.demo.web.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**

@author linjian
@date 2019/1/15
*/
@RestController
@RequestMapping(“demo”)
public class DemoController {

@GetMapping(“test”)
public String test() {
return “Hello World!”;
}
}

③ 最后运行 DemoWebApplication 类中的 main 方法启动项目，默认端口为 8080，访问 http://localhost:8080/demo/test 即可测试接口

4.5 配置模块间的依赖关系

通常 JAVA Web 项目会按照功能划分不同模块，模块之间通过依赖关系进行协作，下面将完善模块之间的依赖关系。

① 首先在父 pom 文件中使用「 dependencyManagement 」标签声明所有子模块依赖

com.example.demo demo-biz ${demo.version} com.example.demo demo-common ${demo.version} com.example.demo demo-dao ${demo.version} com.example.demo demo-web ${demo.version}

注：${demo.version} 定义在 properties 标签中

② 其次在 demo-biz 层中的 pom 文件中添加 demo-dao 及 demo-common 依赖

com.example.demo demo-common com.example.demo demo-dao

③ 之后在 demo-web 层中的 pom 文件中添加 demo-biz 依赖

com.example.demo demo-biz

4.6 web 层调用 biz 层接口测试

模块依赖关系配置完成之后，通过 web 层测试下 biz 层的接口是否可以正常调用。

① 首先在 demo-biz 层创建 com.example.demo.biz 包，添加 service 目录并在其中创建 DemoService 接口类及 impl 目录（用于存放接口实现类）。

package com.example.demo.biz.service;

/**

@author linjian
@date 2019/1/15
*/
public interface DemoService {

String test();
}

package com.example.demo.biz.service.impl;

import com.example.demo.biz.service.DemoService;
import org.springframework.stereotype.Service;

/**

@author linjian
@date 2019/1/15
*/
@Service
public class DemoServiceImpl implements DemoService {

@Override
public String test() {
return “interface test”;
}
}

② DemoController 通过 @Autowired 注解注入 DemoService ，修改 DemoController 的 test 方法使之调用 DemoService 的 test 方法

@Autowired
private DemoService demoService;

@GetMapping(“test”)
public String test() {
return demoService.test();
}

③ 再次运行 DemoWebApplication 类中的 main 方法启动项目，发现如下报错

APPLICATION FAILED TO START

Description:

Field demoService in com.example.demo.web.controller.DemoController required a bean of type ‘com.example.demo.biz.service.DemoService’ that could not be found.

The injection point has the following annotations: - @org.springframework.beans.factory.annotation.Autowired(required=true)

Action:

Consider defining a bean of type ‘com.example.demo.biz.service.DemoService’ in your configuration.

原因是找不到 DemoService 类

④ 在 DemoWebApplication 入口类中增加包扫描，设置 @SpringBootApplication 注解中的 scanBasePackages 值为 com.example.demo

@SpringBootApplication(scanBasePackages = “com.example.demo”)

⑤ 设置完后重新运行 main 方法，项目正常启动，访问 http://localhost:8080/demo/test 测试接口

4.7 集成 MyBatis

以上接口均是静态的，不涉及数据库操作，下面将集成 MyBatis 访问数据库中的数据。

① 首先父 pom 文件中声明 mybatis-spring-boot-starter 及 lombok 依赖

org.mybatis.spring.boot mybatis-spring-boot-starter 1.3.2 org.projectlombok lombok 1.16.22

② 其次在 demo-dao 层中的 pom 文件中添加上述依赖

mysql mysql-connector-java org.mybatis.spring.boot mybatis-spring-boot-starter org.projectlombok lombok

③ 之后在 demo-dao 层创建 com.example.demo.dao 包，通过 mybatis-genertaor 工具生成 dao 层相关文件（ DO 、 Mapper 、 xml ），目录结构如下

④ 然后在 demo-web 层中的 resources 目录创建 applicatio.properties 文件并在其中添加 datasource 及 MyBatis 相关配置项

spring.datasource.driverClassName = com.mysql.jdbc.Driver
spring.datasource.url = jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8
spring.datasource.username = test
spring.datasource.password = 123456

mybatis.mapper-locations = classpath:mybatis/*.xml
mybatis.type-aliases-package = com.example.demo.dao.entity

注：如果生成的 xml 在 dao 层 resources 目录的子目录中则 mybatis.mapper-locations 需设置为 classpath:mybatis//.xml

⑤ DemoService 通过 @Autowired 注解注入 UserMapper ，修改 DemoService 的 test 方法使之调用 UserMapper 的 selectById 方法

@Autowired
private UserMapper userMapper;

@Override
public String test() {
UserDO user = userMapper.selectById(1);
return user.toString();
}

⑥ 再次运行 DemoWebApplication 类中的 main 方法启动项目，出现如下报错

APPLICATION FAILED TO START

Description:

Field userMapper in com.example.demo.biz.service.impl.DemoServiceImpl required a bean of type ‘com.example.demo.dao.mapper.business.UserMapper’ that could not be found.

The injection point has the following annotations: - @org.springframework.beans.factory.annotation.Autowired(required=true)

Action:

Consider defining a bean of type ‘com.example.demo.dao.mapper.business.UserMapper’ in your configuration.

原因是找不到 UserMapper 类
⑦ 在 DemoWebApplication入口类中增加 dao 层包扫描，添加 @MapperScan 注解并设置其值为 com.example.demo.dao.mapper

@MapperScan(“com.example.demo.dao.mapper”)

⑧ 设置完后重新运行 main 方法，项目正常启动，访问 http://localhost:8080/demo/test 测试接口

五、外部 Tomcat 部署 war 包

外部 Tomcat 部署的话，就不能依赖于入口类的 main 函数了，而是要以类似于 web.xml 文件配置的方式来启动 Spring应用上下文。
① 在入口类中继承 SpringBootServletInitializer 并实现 configure 方法

public class DemoWebApplication extends SpringBootServletInitializer {

@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
return builder.sources(DemoWebApplication.class);
}

public static void main(String[] args) {
SpringApplication.run(DemoWebApplication.class, args);
}
}

② 之前在 demo-web 引入了 spring-boot-starter-web 的依赖，该依赖包包含内嵌的 Tomcat 容器，所以直接部署在外部 Tomcat 会冲突报错。这里在 demo-web 层中的 pom 文件中重定义 spring-boot-starter-tomcat 依赖包的「 scope 」即可解决该问题。

org.springframework.boot spring-boot-starter-tomcat provided

③ 声明 demo-web 层的打包方式及最终的包名

war
…省略其余部分…

demo

④ 此时在 demo-web 层目录执行「 mvn clean install 」即可打出一个名为 demo.war 的包。

六、Maven Profile 多环境打包

在日常开发中，通常不止一套环境，如开发环境、测试环境、预发环境、生成环境，而每个环境的配置项可能都不一样，这就需要用到多环境打包来解决这个问题。

① 在 demo-web 层的 resources 目录中新建 conf 目录，再在其中按照环境创建相应目录，这里创建开发环境「 dev 」及测试环境「 test 」，再将原本的 application.properties 文件分别拷贝一份到两个目录中，根据环境修改其中的配置项，最后删除原本的配置文件。得到目录结构如下：

② 往 demo-web 层的 pom 文件添加 profile 标签

dev