Mybatis全局配置及映射关系的实现
337
2022-08-05
IDEA搭建SpringBoot多模块聚合工程过程详解(多模块聚合工程)
IDEA搭建SpringBoot多模块聚合工程过程详解(多模块聚合工程)
目录一、搭建环境（1）IDEA创建maven工程（2）修改pom依赖（4）创建app-pojo子工程（5）创建app-mapper子工程（6）创建app-service子工程 （7）创建app-web子工程 （8）统一依赖管理（9）添加web依赖（10）关联子工程依赖（11）测试子工程依赖是否成功二、集成MyBatis（1）父工程中添加MyBatis依赖管理（2）app-mapper子工程引入MyBatis（4）配置mybatis和mysql数据源（5）service调用mapper接口方法（6）启动类添加mapper扫描（7）添加测试方法（8）启动工程测试三、集成Druid数据源（1）引入druid依赖（2）添加druid配置（3）启动工程测试四、集成Log4j2日志（1）添加Log4j2依赖（2）编写Log4j2配置文件（3）配置Log4j2日志（4）测试日志输出功能
这篇文章主要是介绍一下，如何在IDEA开发工具下，搭建一个基于SpringBoot的多模块聚合工程项目。
多模块聚合工程：按照MVC的思想，将应用分成三层web、service、mapper/dao这三个主要模块。
本篇文章，将项目模块细分为如下几个子工程模块：
app-common：通用工具类模块，专门用于项目中使用的一些工具类。
app-pojo：实体类模块，专门存放实体类对象，例如：DTO、BO、AO、VO等等对象。
app-mapper：dao接口模块，专门存放操作数据库的dao接口。
app-service：业务逻辑模块，专门进行业务逻辑的处理。
app-web：控制器模块，用于页面请求控制模块。
下面正式开始搭建聚合工程。
一、搭建环境
（1）IDEA创建maven工程
通过IDEA创建一个maven的quickstart类型项目，然后删除里面的src目录，保留pom.xml文件即可，如下图所示：
（2）修改pom依赖
修改父工程项目中的pom.xml文件，添加【springboot】依赖。
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
（3）创建app-common子模块
在弹出界面中，选择【quickstart】类型的项目，然后下一步，填入子工程信息即可。
在子工程中，删除多余的【test】目录和【App】启动类，修改pom文件，删除多余内容，添加父工程依赖。
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
（4）创建app-pojo子工程
（5）创建app-mapper子工程
（6）创建app-service子工程
（7）创建app-web子工程
（8）统一依赖管理
通过前面的七个步骤，我们已经将父工程和子工程都搭建完成了，并且引入了【springboot】父工程依赖。这里，我们为了方便管理每个子工程的依赖，以及其他第三方依赖，我们可以选择在父工程中的【pom】文件中，统一的定义依赖版本。
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
（9）添加web依赖
在子工程【app-web】的pom文件中，添加【web】依赖，并且创建【Application】启动类。
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
创建【Application】启动类。
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
创建【TestController】测试类。
@RestController
public class TestController {
@GetMapping("/")
public String demo() {
return "
}
}
创建【src/main/resources】目录，新增【application.yml】配置文件。
server:
port: 6250 # 项目启动端口
启动项目，打开浏览器，访问测试路径。
到这里，SpringBoot聚合项目已经创建好了，并且能够启动访问了。
（10）关联子工程依赖
上面几个子工程虽然创建好了，但是每个子工程之间并没有依赖关系，现在我们就将这几个子工程进行依赖关联。
我个人将上面几个子工程的依赖关系进行如下关联：
app-web----->app-service（---->表示依赖）
app-service----->app-mapper，app-common
app-mapper----->app-pojo
依次给每个子工程添加上面的依赖即可。
app-mapper子工程引入app-pojo依赖
app-service子工程引入app-mapper依赖
app-web子工程引入app-service依赖
（11）测试子工程依赖是否成功
在app-service中添加测试类，然后在app-web中调用app-service中的方法。
注意：这里为了能够在app-service子工程中，能够使用web的注解，我们将原先app-web中的【web】依赖移到【app-service】中去，【app-service】模块中pom文件，如下所示：
【TestService】测试接口
public interface TestService {
String findAll();
}
【TestServiceImpl】实现类
@Service
public class TestServiceImpl implements TestService {
@Override
public String findAll() {
return "调用app-service子工程中的findAll()方法";
}
}
【TestController】测试类中，调用【app-service】模块的方法。
@RestController
public class TestController {
@Autowired
private TestService testService;
@GetMapping("/findAll")
public String findAll() {
return testService.findAll();
}
}
重新启动工程，打开浏览器，访问findAll路径。
如果能够，出现上面的结果，则说明，app-web能够调用到app-service中的方法了。
二、集成MyBatis
（1）父工程中添加MyBatis依赖管理
在【app-spboot】父工程对应的pom文件中，添加【MyBatis】的依赖管理，如下所示：
（2）app-mapper子工程引入MyBatis
在【app-mapper】子工程中，引入【MyBatis】依赖、【mysql】驱动依赖，因为【MyBatis】是专门用于操作数据库的，所以需要引入mysql数据库驱动。
（3）创建测试mapper接口 在【app-pojo】子工程中，创建一个【TestUser】实体类。
public class TestUser implements Serializable {
private Integer id;
private String name;
private Integer age;
// setter and getter
}
在【app-mapper】子工程中，创建一个【TestUserMapper】接口。
public interface TestUserMapper {
List
}
在【app-mapper】子工程中，创建【src/main/resources/mapper】目录，并且在目录下，新增【TestUserMapper.xml】映射文件。
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
select * from mybatis_test
到这里，mapper接口就创建完成了，继续下一步操作。
（4）配置mybatis和mysql数据源
在【app-web】子工程中的【application.yml】配置文件里面，添加mybatis的相关配置信息、mysql数据源信息。
server:
port: 6250 # 项目启动端口
# 配置 mysql 数据源
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mybatis_test?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8
username: root
password: root
# mybatis 配置
mybatis:
mapper-locations: classpath:mapper/**/*.xml # 指定mapper映射文件位置
（5）service调用mapper接口方法
在【app-service】子工程中，注入【TestUserMapper】对象，然后调用【findAll】方法，查询数据库中的数据。
@Service
public class TestServiceImpl implements TestService {
@Autowired
private TestUserMapper testUserMapper;
@Override
public List
return testUserMapper.findAll();
}
}
（6）启动类添加mapper扫描
@MapperScan(value = "com.gitee.app.mapper.*") // 扫描mapper接口
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
（7）添加测试方法
在原先的【TestController】类中，添加一个【query】方法，用于查询数据库数据。
@RestController
public class TestController {
@Autowired
private TestService testService;
@GetMapping("/")
public String demo() {
return "
}
@GetMapping("/findAll")
public String findAll() {
return testService.findAll();
}
@GetMapping("/query")
public List
List
System.out.println(list);
return list;
}
}
（8）启动工程测试
启动项目，然后访问query路径，查看是否能够查询到数据库数据。
到这里，SpringBoot聚合工程，集成MyBatis就完成啦。
三、集成Druid数据源
Druid是阿里巴巴开源的一款数据库连接池。Druid提供了和SpringBoot集成的starter，叫做：【druid-spring-boot-starter】。
（1）引入druid依赖
在【app-spboot】父工程的pom依赖中，添加druid统一依赖管理。
在【app-mapper】子工程中，引入【druid-spring-boot-starter】依赖
（2）添加druid配置
在【app-web】子工程【application.yml】配置文件中，添加druid相关配置
server:
port: 6250 # 项目启动端口
# 配置 mysql 数据源
spring:
datasource:
# druid 相关配置
type: com.alibaba.druid.pool.DruidDataSource
druid:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/zblog_test?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&useSSL=false
username: root
password: root
initial-size: 5 # 初始化连接数量
min-idle: 5 # 最小数量
max-active: 20 # 最多数量
max-wait: 60000 # 获取连接最大超时等待时间，单位毫秒ms
time-between-eviction-runs-millis: 60000 # 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒ms
min-evictable-idle-time-millis: 300000 # 配置一个连接在池中最小生存的时间，单位是毫秒ms
# 如果validationQuery为null，testOnBorrow、testOnReturn、testWhileIdle都不会起作用
validation-query: SELECT 1 FROM DUAL # 用来检测连接是否有效的sql，要求是一个查询语句
# 建议配置为true，不影响性能，并且保证安全性。
# 获取连接的时候检测，若空闲时间大于timeBetweenEvictionRunsMillis，执行validationQuery检测连接是否有效。
test-while-idle: true
# 申请连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能
test-on-borrow: true
# 归还连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能
test-on-return: true
# 打开PSCache，并且指定每个连接上PSCache的大小
pool-prepared-statements: true
max-pool-prepared-statement-per-connection-size: 20
# configuration of druid plugin
# 配置监控统计拦截的filters，去掉后监控界面sql无法统计，'wall'用于防火墙
filters: stat,wall
use-global-data-source-stat: true
# 通过connectProperties属性来打开mergeSql功能；慢SQL记录
connection-properties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
# configuration of druid control server
stat-view-servlet:
enabled: true # 开启druid监控页面,false则访问出现404
login-username: root # druid监控登录用户
login-password: root # druid监控登录密码
reset-enable: false
url-pattern: /druid/* # druid监控界面访问路径
web-stat-filter:
url-pattern: /* # 添加过滤规则
# 对以下类型，忽略过滤格式
exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*'
# mybatis 配置
mybatis:
mapper-locations: classpath:mapper/**/*.xml # 指定mapper映射文件位置
（3）启动工程测试
启动工程，访问【http://localhost:6250/druid】，此时如果配置成功，则会跳转到Druid监控的登录界面。
到这里，SpringBoot集成Druid数据源就完成啦。。。。
四、集成Log4j2日志
（1）添加Log4j2依赖
SpringBoot的依赖中，默认有日志相关依赖，我们如果要使用Log4j2日志依赖，需要将SpringBoot自带的依赖剔除。在【app-service】子工程中，将【spring-boot-starter-web】依赖中剔除【spring-boot-starter-logging】依赖，并且引入【spring-boot-starter-log4j2】依赖。
（2）编写Log4j2配置文件
Log4j2有两种配置文件，第一种是【properties】，第二种是【xml】，一般都采用【xml】的格式来定义Log4j2日志信息。在【src/main/resources】目录下，创建【log4j2.xml】配置文件。
qjXekV
（3）配置Log4j2日志
在【application.yml】配置文件中，指定【log4j2.xml】配置文件的路径。通过步骤(2)，我们已经编写好了log4j2.xml配置文件，但是SpringBoot还不知道log4j2.xml配置文件在哪里，需要我们手动进行配置，告诉SpringBoot去哪里加载log4j2.xml配置文件。
# 日志配置
logging:
http:// config: classpath:log4j2.xml # 指定log4j2配置文件
（4）测试日志输出功能
在【TestController】类中，添加如下测试代码
@RestController
public class TestController {
// 日志输出对象
private static final Logger LOG = LoggerFactory.getLogger(TestController.class);
@Autowired
private TestService testService;
@GetMapping("/query")
public List
LOG.info("======>>>: 开始查询数据库");
List
LOG.info("======>>>: 数据库查询完成");
System.out.println(list);
return list;
}
}
注意：上面日志引入的包是slf4j里面的。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
启动项目，访问查询方法，查看控制台和日志文件是否有日志输出即可，有日志输出，则表示Log4j2配置成功啦。
以上，就是SpringBoot搭建多模块聚合工程，并且集成了MyBatis框架、Druid数据源、Log4j2日志依赖。
版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。
相关文章
发表评论
暂时没有评论，来抢沙发吧~