目錄
上一篇文章我們知道了SpringBoot整合H2數據庫，至於爲什麼要使用數據庫？沒有別的原因，只是因爲公司電腦安裝的MySql竟然跑不起來，所以這裏使用H2，其作爲一個Java開發的嵌入式數據庫，可直接嵌入項目中。下面我們就開始一步一步進行整合。
一、框架介紹
MyBatis-Plus
- 增強版的MyBatis；通過簡單的配置，即可快速進行CRUD操作；自帶代碼生成、分頁插件。
Mybatis-plus-generator
- MyBatis-Plus 的代碼生成器，可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各個模塊的代碼，極大的提升了開發效率。
Druid
- alibaba開源的數據庫連接池，號稱Java語言中最好的數據庫連接池。
二、項目構建
1 創建SpringBoot工程
這裏還是使用IDEA快速創建SpringBoot項目，具體步驟見上一篇文章：SpringBoot整合H2數據庫
2 添加項目依賴
在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.ssymon.study</groupId>
<artifactId>spring-boot-study</artifactId>
<version>1.0</version>
<name>spring-boot-study</name>
<description>Study Spring Boot Demo</description>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<mybatis-plus.version>3.3.2</mybatis-plus.version>
<h2database.version>1.4.200</h2database.version>
<lombok.version>1.18.12</lombok.version>
<hutool.version>5.3.5</hutool.version>
<swagger2.version>2.9.2</swagger2.version>
<druid.version>1.1.22</druid.version>
<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
<maven-resources-plugin.version>3.1.0</maven-resources-plugin.version>
<maven-surefire-plugin.version>2.18.1</maven-surefire-plugin.version>
</properties>
<dependencies>
<!-- spring-boot start -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>
<!-- h2 數據庫 -->
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>${h2database.version}</version>
</dependency>
<!-- lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
<optional>true</optional>
</dependency>
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger2.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger2.version}</version>
</dependency>
<!-- mybatis-plus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
<!-- alibaba druid 連接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>${druid.version}</version>
</dependency>
<!-- hutool 工具類庫 -->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>${hutool.version}</version>
</dependency>
</dependencies>
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>${maven-resources-plugin.version}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>${maven-compiler-plugin.version}</version>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>${maven-surefire-plugin.version}</version>
<configuration>
<skipTests>true</skipTests><!--默認關掉單元測試 -->
<testFailureIgnore>true</testFailureIgnore>
</configuration>
</plugin>
</plugins>
</build>
<repositories>
<repository>
<id>aliyun</id>
<name>aliyun-maven</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
</repository>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://maven.aliyun.com/repository/spring</url>
</repository>
<repository>
<id>central</id>
<name>maven-central</name>
<url>http://central.maven.org/maven2/</url>
</repository>
</repositories>
</project>
3 修改SpringBoot配置文件
在application.properties配置文件中添加Druid，MyBatis-Plus相關配置
# 應用配置 根據自己需要配置
spring.application.name=spring-boot-study
server.servlet.context-path=/sb-study
server.port=8080
# DataSource Config
spring.datasource.driver-class-name=org.h2.Driver
# DATABASE_TO_LOWER=TRUE;-要求數據庫名稱小寫 CASE_INSENSITIVE_IDENTIFIERS=TRUE;-要求對字段的大小寫不敏感
spring.datasource.url=jdbc:h2:D:/symon/project/db/sbstudy;CASE_INSENSITIVE_IDENTIFIERS=TRUE;
spring.datasource.username=symon
spring.datasource.password=123456
# 指定Schema (DDL)腳本
spring.datasource.schema=classpath:db/schema.sql
# 指定Data (DML)腳本
spring.datasource.data=classpath:db/data.sql
# 指定schema要使用的Platform
spring.datasource.platform=h2
# 是否啓用h2控制檯
spring.h2.console.enabled=true
# 配置h2控制檯訪問地址，http://localhost:8080/h2
spring.h2.console.path=/h2
# Druid連接池配置
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
# 初始化大小，最小，最大
spring.datasource.initialSize=5
spring.datasource.minIdle=10
spring.datasource.maxActive=20
# 配置獲取連接等待超時的時間
spring.datasource.maxWait=60000
# 配置間隔多久才進行一次檢測，檢測需要關閉的空閒連接，單位是毫秒
spring.datasource.timeBetweenEvictionRunsMillis=60000
# 配置一個連接在池中最小生存的時間，單位是毫秒
spring.datasource.minEvictableIdleTimeMillis=300000
spring.datasource.validationQuery=select 1
spring.datasource.testWhileIdle=true
spring.datasource.testOnBorrow=false
spring.datasource.testOnReturn=false
# 打開PSCache，並且指定每個連接上PSCache的大小
spring.datasource.poolPreparedStatements=true
spring.datasource.maxPoolPreparedStatementPerConnectionSize=20
# 配置監控統計攔截的filters，去掉後監控界面sql無法統計，'wall'用於防火牆
spring.datasource.filters=stat,wall,slf4j
# 通過connectProperties屬性來打開mergeSql功能；慢SQL記錄
spring.datasource.connectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
# MyBatis-Plus配置
mybatis-plus.mapper-locations=classpath:mapper/*.xml
4 項目結構
提前創建好相關代碼文件的包，下圖是我創建的項目簡單結構
5 新建CodeGenerator.java代碼生成類
代碼生成類用來快速生成xml、mapper、entity、service、controller等類
具體配置詳見：https://mp.baomidou.com/guide/generator.html
public class CodeGenerator {
public static void main(String[] args) {
// 代碼生成器
AutoGenerator mpg = new AutoGenerator();
String tableNames = "student";
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = "D:/symon/project/spring-boot-study";//項目目錄
gc.setOutputDir(projectPath + "/src/main/java");//生成文件的輸出目錄
gc.setAuthor("symon");//開發人員
gc.setOpen(false);
gc.setBaseColumnList(true);
gc.setBaseResultMap(true);
gc.setServiceName("%sService");//生成service名稱
gc.setFileOverride(true);
mpg.setGlobalConfig(gc);
// 數據源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:h2:D:/symon/project/db/sbstudy;CASE_INSENSITIVE_IDENTIFIERS=TRUE;");
dsc.setDriverName("org.h2.Driver");
dsc.setUsername("symon");
dsc.setPassword("123456");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setParent("com.ssymon.study.springbootstudy");
pc.setController("controller");
pc.setMapper("dao");
pc.setService("service");
pc.setServiceImpl("service.impl");
pc.setEntity("entity");
mpg.setPackageInfo(pc);
// 自定義配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 freemarker
//String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 velocity
String templatePath = "/templates/mapper.xml.vm";
// 自定義輸出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定義配置會被優先輸出
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定義輸出文件名 ， 如果你 Entity 設置了前後綴、此處注意 xml 的名稱會跟着發生變化！！
return projectPath + "/src/main/resources/mapper/" + tableInfo.getXmlName() + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定義輸出模板
//指定自定義模板路徑，注意不要帶上.ftl/.vm, 會根據使用的模板引擎自動識別
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setEntityTableFieldAnnotationEnable(true);
strategy.setChainModel(true);//實體類是否爲鏈式模型 @Accessors(chain = true)
strategy.setRestControllerStyle(true);
strategy.setInclude(tableNames.split(","));
strategy.setControllerMappingHyphenStyle(true);
strategy.setCapitalMode(true);
mpg.setStrategy(strategy);
mpg.execute();
}
}
執行main函數之前先啓動一下項目確保表已創建，執行main函數之後所生成的文件如下圖，可以說是非常方便了。
6 創建DruidConfig.java連接池配置類
配置數據源，配置後臺訪問，配置filter
@Configuration
public class DruidConfig {
@Bean
@ConfigurationProperties(prefix = "spring.datasource")
public DataSource getDataSource(){
return new DruidDataSource();
}
//配置Druid的監控
//1、配置一個管理後臺的Servlet
@Bean
public ServletRegistrationBean statViewServlet(){
ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");
Map<String,String> initParams = new HashMap<>();
initParams.put("loginUsername","symon");
initParams.put("loginPassword","123456");
initParams.put("allow","");// IP白名單 (沒有配置或者爲空，則允許所有訪問)
initParams.put("deny","");// IP黑名單 (存在共同時，deny優先於allow)
initParams.put("resetEnable","false");
bean.setInitParameters(initParams);
return bean;
}
//2、配置一個web監控的filter
@Bean
public FilterRegistrationBean webStatFilter(){
FilterRegistrationBean bean = new FilterRegistrationBean();
bean.setFilter(new WebStatFilter());
Map<String,String> initParams = new HashMap<>();
initParams.put("exclusions","*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*");// 忽略資源
bean.setInitParameters(initParams);
bean.setUrlPatterns(Arrays.asList("/*"));
return bean;
}
}
7 測試
寫一個簡單的查詢接口來測試整合是否成功
① 在代碼生成器生成的controller中添加簡單的查詢邏輯
@RestController
@RequestMapping("/student")
public class StudentController {
@Autowired
private StudentService studentService;
@GetMapping("/listAll")
public List<Student> list() {
return studentService.list();
}
}
② 啓動類中添加mapper接口掃描路徑
@SpringBootApplication
//mapper接口掃描路徑
@MapperScan("com.ssymon.study.springbootstudy.dao")
public class SpringBootStudyApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootStudyApplication.class, args);
}
}
③ 在IDEA中啓動項目，啓動成功之後：
訪問h2後臺：http://localhost:8080/sb-study/h2，登錄成功即可查看數據庫相關信息
訪問druid後臺：http://localhost:8080/sb-study/druid，登陸之後即可查看連接池相關信息
通過瀏覽器或postman訪問剛剛寫的測試接口：http://localhost:8080/sb-study/student/listAll，結果如下
8 小結
自此SpringBoot整合MyBatis-Plus+Druid就結束了，我們可以發現，通過代碼生成器生成的service和mapper已經繼承了簡單的CRUD方法，正如MyBatis-Plus官網所說：爲簡化開發而生。
MyBatis-plus官網：https://mp.baomidou.com/