一.前言
笔者在配置spring boot + mybatis的集成运行MySQL数据库的时候,参阅了很多博文,发现大部分都是长篇大论的堆砌代码,内容也是千篇一律,让读者晦涩难懂,不利于环境的快速搭建。于是,笔者在参考了这些博文之后,自己总结了一种相对简单的配置方式。与其说是简单的配置方式,不如说是简单的描述方式,方便有需要的人快速配置spring boot + mybatis集成。
二.步骤
Mybatis的集成可以简单地概括成两步:
①application.properties增加spring配置数据库链接地址
②pom.xml引入mybatis-spring-boot-starter和mysql-connector-java
当然啦,以上两个步骤是建立在有spring boot项目的前提之下,下面开始详细说明。
三.开始
①进入SPRING INITIALIZR(如图1),输入项目名称,选择要引入的依赖(Web,MySQL,Mybatis),最后生成项目下载到本地(如图2)。
到此,我们相当于完成了章节二步骤的第②步,即引入了mybatis-spring-boot-starter和mysql-connector-java。
②进入IDEA,解压上一步下载好的项目然后打开,如图3,4所示。
③项目目录结构
在这里只是象征性地模仿着某些blog贴出项目目录结构,不作解释。如图5,值得注意的是,橙色圈出来的部分是笔者自己创建的目录。红色圈出的就是要配置的部分,对应于章节二的第①步,其中mybatis-config.xml是需要手动创建的。
④mybatis-config.xml配置文件
在resources目录下手动创建mybatis-config.xml,复制粘贴以下代码。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<settings>
<!-- Globally enables or disables any caches configured in any mapper under this configuration -->
<setting name="cacheEnabled" value="true"/>
<!-- Sets the number of seconds the driver will wait for a response from the database -->
<setting name="defaultStatementTimeout" value="3000"/>
<!-- Enables automatic mapping from classic database column names A_COLUMN to camel case classic Java property names aColumn -->
<setting name="mapUnderscoreToCamelCase" value="true"/>
<!-- Allows JDBC support for generated keys. A compatible driver is required.
This setting forces generated keys to be used if set to true,
as some drivers deny compatibility but still work -->
<setting name="useGeneratedKeys" value="true"/>
</settings>
<!-- Continue going here -->
</configuration>
⑤application.properties配置
将以下配置拷贝至application.properties中。
#数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
mybatis.config-location=classpath:mybatis-config.xml
至此,已经完成了spring boot + mybatis的集成配置,最终的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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.st</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>demo</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.4.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot</artifactId>
<version>2.0.2.RELEASE</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
四.定义映射器
虽然说spring boot简化了很多Mybatis复杂的xml配置,但是作为Mybatis的四大组件之一的映射器是不可或缺的。可以这样理解,一个映射器 = 一个接口 + 一个xml文件。
①准备工作
例如,笔者创建了一个名为“test”的数据库,其中有一个“roommate”表,存放的是室友信息(可能我“爱”上了我的室友们吧,哈哈)。于是,我们需要创建一个roommate的POJO,Mybatis会自动完成数据库表字段向POJO中属性的映射。图6是数据库的“roommate”表结构,下面是与之对应的“Roommate.java”。
在项目目录model中创建Roommate.java,如下。
package com.st.demo.model;
/**
* Created by songtao on 2018/8/21.
*/
public class Roommate {
private String name;
private int sex;
private String phone;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getSex() {
return sex;
}
public void setSex(int sex) {
this.sex = sex;
}
public String getPhone() {
return phone;
}
public void setPhone(String phone) {
this.phone = phone;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
@Override
public String toString() {
return "Roommate{" +
"name='" + name + '\'' +
", sex=" + (sex == 1 ? "男" : "女") +
", phone='" + phone + '\'' +
", age=" + age +
'}';
}
}
②定义RoommateDAO接口
在dao目录中创建RoommateDAO接口,为了简单演示,这里只是做了一个按id查询的操作。注意不要忘了@Mapper,因为要在IoC容器初始化。
tips:其实这里可以直接在getRoommateById()方法上方使用@Select({"select name,sex,phone,age from roommate where id = #{id}"}),但是笔者在阅读《Java EE互联网轻量级框架整合开发 SSM框架》一书中,作者提到,要采用xml配置的方式为主,注解的方式为辅。试想一下,当sql语句很复杂的时候,用注解的方式会很容易出错,还会导致代码的可读性降低。于是,笔者采用了xml配置的方式。
至此,一个接口定义完了,接下来定义一个xml。
package com.st.demo.dao;
import org.apache.ibatis.annotations.Mapper;
import com.st.demo.model.Roommate;
/**
* Created by songtao on 2018/8/21.
*/
@Mapper
public interface RoommateDAO {
Roommate getRoommateById(int id);
}
③定义RoommateDAO.xml
xml配置的原则:在相同的包目录下定义同名xml。
这里有两点需要注意:a.相同的包 b.同名xml。
这里我们再看一下目录结构,如图7。
红色线条部分体现了相同的包。这里还要注意:在resources下创建目录的时候不可以一次性把目录创建成com.st.demo.dao,要先创建com目录,然后在com目录中创建st目录,再往st目录创建demo目录,最后在demo目录中创建dao目录。
橙色标记部分体现了同名,即RoommateDAO和RoommateDAO.xml同名。
以下是RoommateDAO.xml的内容。注意:namespace的值要和上一步定义的接口RoommateDAO一致(全名),<select>标签中的id的值要与RoommateDAO中的方法getRoommateById()一致,resultType要和getRoommateById()方法的返回值Roommate一致,并且要用类全名。
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.st.demo.dao.RoommateDAO">
<sql id="table">roommate</sql>
<sql id="selectFields">name,sex,phone,age</sql>
<select id="getRoommateById" resultType="com.st.demo.model.Roommate">
SELECT
<include refid="selectFields"/>
FROM
<include refid="table"/>
WHERE
id = #{id}
</select>
</mapper>
到此,映射器已经定义完毕了,接下来就是激动人心的时刻了,能不能取得数据呢,下节见分晓。
五.测试
在/src/test/java/com/st/demo路径中新建一个测试类DBTest.java,先用@Autowired将按RoommateDAO类型注入roommateDAO,然后调用getRoommateById()方法查询id为'1'的数据,运行结果如图8。
package com.st.demo;
import com.st.demo.dao.RoommateDAO;
import com.st.demo.model.Roommate;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
/**
* Created by songtao on 2018/8/21.
*/
@RunWith(SpringRunner.class)
@SpringBootTest
public class DBTest {
@Autowired
RoommateDAO roommateDAO;
@Test
public void testDB(){
Roommate roommate = roommateDAO.getRoommateById(1);
System.out.println(roommate.toString());
}
}
六.小结
数据库在开发过程中充当着重要的角色,框架的出现抹去了以往JDBC操作数据库的纷繁。传统的JDBC的数据库操作步骤为:①加载驱动 ②创建数据库连接 ③创建statement对象 ④执行SQL获取数据 ⑤数据转换 ⑥资源释放。而Mybatis关注第④步。(以上来自叶神的总结)。于是在如此流行的后台框架Spring boot集成Mybatis也是大势所趋了,本文旨在以最简单的方式描述配置过程,迈出开发的这一小步。以上都是来自笔者个人的经验总结,如有疏漏,欢迎批评指正。
七.参考链接
1.https://start.spring.io/
2.http://spring.io/projects/spring-boot
3.http://www.mybatis.org/mybatis-3/zh/index.html