255 lines
8.6 KiB
Markdown
255 lines
8.6 KiB
Markdown
# Spring Boot 整合 Mybatis
|
||
|
||
|
||
<nav>
|
||
<a href="#一项目说明">一、项目说明</a><br/>
|
||
<a href="#11-项目结构">1.1 项目结构</a><br/>
|
||
<a href="#12-主要依赖">1.2 主要依赖</a><br/>
|
||
<a href="#二整合-Mybatis">二、整合 Mybatis</a><br/>
|
||
<a href="#21-配置数据源">2.1 配置数据源</a><br/>
|
||
<a href="#22--XML-方式">2.2 XML 方式</a><br/>
|
||
<a href="#23-注解方式">2.3 注解方式</a><br/>
|
||
</nav>
|
||
|
||
## 一、项目说明
|
||
|
||
### 1.1 项目结构
|
||
|
||
- 项目涉及表的建表语句放置在 resources 的 sql 文件夹下；
|
||
|
||
- 关于 Mybatis SQL 的写法提供两种方式：
|
||
|
||
**xml 写法**：对应的类为 ProgrammerMapper.java 和 programmerMapper.xml，用 MybatisXmlTest 进行测试；
|
||
|
||
**注解写法**：对应的类为 Programmer.java ，用 MybatisAnnotationTest 进行测试。
|
||
|
||
<div align="center"> <img src="https://github.com/heibaiying/spring-samples-for-all/blob/master/pictures/spring-boot-mybatis.png"/> </div>
|
||
|
||
### 1.2 主要依赖
|
||
|
||
按照 Spring 官方对于自定义的 starter 命名规范的要求：
|
||
|
||
- 官方的 starter 命名：spring-boot-starter-XXXX
|
||
- 其他第三方 starter 命名：XXXX-spring-boot-starte
|
||
|
||
所以 Mybatis 的 starter 命名为 mybatis-spring-boot-starter，如果有自定义 starter 需求，也需要按照此命名规则进行命名。
|
||
|
||
```xml
|
||
<!--spring 1.5 x 以上版本对应 mybatis 1.3.x (1.3.1)
|
||
关于更多 spring-boot 与 mybatis 的版本对应可以参见 <a href="http://www.mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/">-->
|
||
<dependency>
|
||
<groupId>org.mybatis.spring.boot</groupId>
|
||
<artifactId>mybatis-spring-boot-starter</artifactId>
|
||
<version>1.3.2</version>
|
||
</dependency>
|
||
<!--引入mysql驱动-->
|
||
<dependency>
|
||
<groupId>mysql</groupId>
|
||
<artifactId>mysql-connector-java</artifactId>
|
||
<version>8.0.13</version>
|
||
</dependency>
|
||
<dependency>
|
||
<groupId>org.projectlombok</groupId>
|
||
<artifactId>lombok</artifactId>
|
||
<optional>true</optional>
|
||
</dependency>
|
||
<dependency>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-starter-test</artifactId>
|
||
<scope>test</scope>
|
||
</dependency>
|
||
```
|
||
|
||
spring boot 与 mybatis 版本的对应关系：
|
||
|
||
| MyBatis-Spring-Boot-Starter | [MyBatis-Spring](http://www.mybatis.org/spring/index.html#Requirements) | Spring Boot |
|
||
| --------------------------- | ------------------------------------------------------------ | ------------- |
|
||
| **1.3.x (1.3.1)** | 1.3 or higher | 1.5 or higher |
|
||
| **1.2.x (1.2.1)** | 1.3 or higher | 1.4 or higher |
|
||
| **1.1.x (1.1.1)** | 1.3 or higher | 1.3 or higher |
|
||
| **1.0.x (1.0.2)** | 1.2 or higher | 1.3 or higher |
|
||
|
||
## 二、整合 Mybatis
|
||
|
||
### 2.1 配置数据源
|
||
|
||
Spring Boot 2.x 版本默认采用 Hikari 作为数据库连接池，Hikari 是目前 Java 平台性能最好的连接池，性能好于 druid：
|
||
|
||
```yaml
|
||
spring:
|
||
datasource:
|
||
url: jdbc:mysql://127.0.0.1:3306/mysql?characterEncoding=UTF-8&serverTimezone=UTC&useSSL=false
|
||
username: root
|
||
password: root
|
||
driver-class-name: com.mysql.cj.jdbc.Driver
|
||
|
||
# 如果不想配置对数据库连接池做特殊配置的话,以下关于连接池的配置就不是必须的
|
||
# spring-boot 2 默认采用高性能的 Hikari 作为连接池 更多配置可以参考 https://github.com/brettwooldridge/HikariCP#configuration-knobs-baby
|
||
type: com.zaxxer.hikari.HikariDataSource
|
||
hikari:
|
||
# 池中维护的最小空闲连接数
|
||
minimum-idle: 10
|
||
# 池中最大连接数，包括闲置和使用中的连接
|
||
maximum-pool-size: 20
|
||
# 此属性控制从池返回的连接的默认自动提交行为。默认为 true
|
||
auto-commit: true
|
||
# 允许最长空闲时间
|
||
idle-timeout: 30000
|
||
# 此属性表示连接池的用户定义名称，主要显示在日志记录和 JMX 管理控制台中，以标识池和池配置。 默认值：自动生成
|
||
pool-name: custom-hikari
|
||
#此属性控制池中连接的最长生命周期，值 0 表示无限生命周期，默认 1800000 即 30 分钟
|
||
max-lifetime: 1800000
|
||
# 数据库连接超时时间,默认 30 秒，即 30000
|
||
connection-timeout: 30000
|
||
# 连接测试 sql 这个地方需要根据数据库方言差异而配置 例如 oracle 就应该写成 select 1 from dual
|
||
connection-test-query: SELECT 1
|
||
|
||
# mybatis 相关配置
|
||
mybatis:
|
||
# 指定 sql xml 文件的位置
|
||
mapper-locations: classpath*:mappers/*.xml
|
||
configuration:
|
||
# 当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。
|
||
# oracle 数据库建议配置为 JdbcType.NULL, 默认是 Other
|
||
jdbc-type-for-null: 'null'
|
||
# 是否打印 sql 语句 调试的时候可以开启
|
||
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
|
||
```
|
||
|
||
### 2.2 XML 方式
|
||
|
||
新建 ProgrammerMapper.java 和 programmerMapper.xml，及其测试类：
|
||
|
||
```java
|
||
@Mapper
|
||
public interface ProgrammerMapper {
|
||
|
||
void save(Programmer programmer);
|
||
|
||
Programmer selectById(int id);
|
||
|
||
int modify(Programmer programmer);
|
||
|
||
void delete(int id);
|
||
}
|
||
```
|
||
|
||
```xml
|
||
<?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.heibaiying.springboot.dao.ProgrammerMapper">
|
||
|
||
<insert id="save">
|
||
insert into programmer (name, age, salary, birthday) VALUES (#{name}, #{age}, #{salary}, #{birthday})
|
||
</insert>
|
||
|
||
<select id="selectById" resultType="com.heibaiying.springboot.bean.Programmer">
|
||
select * from programmer where name = #{id}
|
||
</select>
|
||
|
||
<update id="modify">
|
||
update programmer set name=#{name},age=#{age},salary=#{salary},birthday=#{birthday} where id=#{id}
|
||
</update>
|
||
|
||
<delete id="delete">
|
||
delete from programmer where id = #{id}
|
||
</delete>
|
||
|
||
</mapper>
|
||
```
|
||
|
||
测试类：
|
||
|
||
```java
|
||
@RunWith(SpringRunner.class)
|
||
@SpringBootTest
|
||
public class MybatisXmlTest {
|
||
|
||
@Autowired
|
||
private ProgrammerMapper mapper;
|
||
|
||
@Test
|
||
public void save() {
|
||
mapper.save(new Programmer("xiaominng", 12, 3467.34f, new Date()));
|
||
mapper.save(new Programmer("xiaominng", 12, 3467.34f, new Date()));
|
||
}
|
||
|
||
@Test
|
||
public void modify() {
|
||
mapper.modify(new Programmer(1, "xiaohong", 112, 347.34f, new Date()));
|
||
}
|
||
|
||
@Test
|
||
public void selectByCondition() {
|
||
Programmer programmers = mapper.selectById(1);
|
||
System.out.println(programmers);
|
||
}
|
||
|
||
@Test
|
||
public void delete() {
|
||
mapper.delete(2);
|
||
Programmer programmers = mapper.selectById(2);
|
||
Assert.assertNull(programmers);
|
||
}
|
||
}
|
||
```
|
||
|
||
### 2.3 注解方式
|
||
|
||
```java
|
||
@Mapper
|
||
public interface ProgrammerDao {
|
||
|
||
@Insert("insert into programmer (name, age, salary, birthday) VALUES (#{name}, #{age}, #{salary}, #{birthday})")
|
||
void save(Programmer programmer);
|
||
|
||
@Select("select * from programmer where name = #{id}")
|
||
Programmer selectById(int id);
|
||
|
||
@Update("update programmer set name=#{name},age=#{age},salary=#{salary},birthday=#{birthday} where id=#{id}")
|
||
int modify(Programmer programmer);
|
||
|
||
@Delete(" delete from programmer where id = #{id}")
|
||
void delete(int id);
|
||
}
|
||
```
|
||
|
||
测试类：
|
||
|
||
```java
|
||
@RunWith(SpringRunner.class)
|
||
@SpringBootTest
|
||
public class MybatisAnnotationTest {
|
||
|
||
@Autowired
|
||
private ProgrammerDao programmerDao;
|
||
|
||
@Test
|
||
public void save() {
|
||
programmerDao.save(new Programmer("xiaominng", 12, 3467.34f, new Date()));
|
||
programmerDao.save(new Programmer("xiaominng", 12, 3467.34f, new Date()));
|
||
}
|
||
|
||
@Test
|
||
public void modify() {
|
||
programmerDao.modify(new Programmer(1, "xiaolan", 21, 347.34f, new Date()));
|
||
}
|
||
|
||
@Test
|
||
public void selectByCondition() {
|
||
Programmer programmers = programmerDao.selectById(1);
|
||
System.out.println(programmers);
|
||
}
|
||
|
||
@Test
|
||
public void delete() {
|
||
programmerDao.delete(3);
|
||
Programmer programmers = programmerDao.selectById(3);
|
||
Assert.assertNull(programmers);
|
||
}
|
||
}
|
||
|
||
```
|
||
|