引自官方:MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
实战环境
《MyBatis初级实战》系列的环境信息如下:
-
JDK:1.8.0_181
-
mybatis-spring-boot-starter:2.1.3(对应的MyBatis:3.5.5)
-
Spring Boot:2.3.2.RELEASE
-
MySQL:5.7.29
-
实战环境:win10
-
开发工具:IntelliJ IDEA 2019.2.1 (Ultimate Edition)
Spring Boot集成MyBatis常规步骤概览
Spring Boot集成MyBatis的常规步骤如下:
-
maven中添加mybatis-spring-boot-starter的依赖;
-
Spring Boot的配置中指定MyBatis配置文件的位置;
-
Spring Boot的配置中指定MyBatis映射文件的位置;
-
添加MyBatis配置文件,后续MyBatis的常规配置集中在此;
-
映射文件xxxMapper.xml及其对应的接口文件;
-
业务代码中,Autowired注解修饰接口文件并使用;
- 接下来开始实战,咱们先把数据准备好;
准备数据
-
请您自行准备好MySQL服务,我这边MySQL是部署在docker上的,可以参考《群晖DS218+部署mysql》;
-
创建名为mybatis的数据库;
-
在mybatis数据库下执行以下SQL,即可创建本次实战所需数据:
USE mybatis;
DROP TABLE IF EXISTS user
;
CREATE TABLE user
(
id
int(32) NOT NULL AUTO_INCREMENT,
name
varchar(32) NOT NULL,
age
int(32) NOT NULL,
PRIMARY KEY (id
)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;
DROP TABLE IF EXISTS log
;
CREATE TABLE log
(
id
int(32) NOT NULL AUTO_INCREMENT,
user_id
int(32),
action
varchar(255) NOT NULL,
create_time
datetime not null,
PRIMARY KEY (id
)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;
INSERT INTO mybatis.user (id, name, age) VALUES (3, ‘tom’, 11);
INSERT INTO mybatis.log (id, user_id, action, create_time) VALUES (3, 3, ‘read book’, ‘2020-08-07 08:18:16’);
源码下载
- 如果您不想编码,可以在GitHub下载所有源码,地址和链接信息如下表所示(https://github.com/zq2599/blog_demos):
| 名称 | 链接 | 备注 |
| :-- | :-- | :-- |
| 项目主页 | https://github.com/zq2599/blog_demos | 该项目在GitHub上的主页 |
| git仓库地址(https) | https://github.com/zq2599/blog_demos.git | 该项目源码的仓库地址,https协议 |
| git仓库地址(ssh) | git@github.com:zq2599/blog_demos.git | 该项目源码的仓库地址,ssh协议 |
- 这个git项目中有多个文件夹,本章的应用在mybatis文件夹下,如下图红框所示:
关于父子工程
为了整个系列的代码好管理,我这边用maven创建的是父子工程,如果您只要子工程,不需要父子结构,要对子工程的pom.xml做以下调整:
- parent节点原本如下:
com.bolingcavalry
mybatis
1.0-SNAPSHOT
…/pom.xml
请替换成以下内容(也就是直接用>spring-boot-starter-parent作为父工程):
org.springframework.boot
spring-boot-starter-parent
2.3.2.RELEASE
- 子工程种的dependency节点中没有version子节点,这些都放在父工程的dependencyManagement中统一管理了,请您将version添加到子工程的各个dependency节点:
- 接下来开始编码
创建父工程
创建名为mybatis的maven工程,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”>
4.0.0
org.springframework.boot
spring-boot-starter-parent
2.3.2.RELEASE
com.bolingcavalry
mybatis
1.0-SNAPSHOT
pom
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
simple
org.mybatis.spring.boot
mybatis-spring-boot-starter
2.1.3
- 至此,准备工作算是全部完成了,接下来咱们开始创建一个典型的Spring Boot集成MyBatis的项目吧;
Spring Boot集成MyBatis
- 在父工程mybatis之下新建名为simple的Spring Boot子工程,其pom.xml内容如下:
<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”>
4.0.0
com.bolingcavalry
mybatis
1.0-SNAPSHOT
…/pom.xml
com.bolingcavalry
simple
0.0.1-SNAPSHOT
simple
Demo project for Spring Boot
<java.version>1.8</java.version>
org.springframework.boot
spring-boot-starter-web
org.mybatis.spring.boot
mybatis-spring-boot-starter
2.1.3
mysql
mysql-connector-java
runtime
org.springframework.boot
spring-boot-starter-test
test
org.junit.vintage
junit-vintage-engine
org.springframework.boot
spring-boot-maven-plugin
- Spring Boot配置文件是simple/src/main/resources/application.yml,内容如下:
server:
port: 8080
spring:
数据源
datasource:
username: root
password: 123456
url: jdbc:mysql://192.168.50.43:3306/mybatis?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
driver-class-name: com.mysql.cj.jdbc.Driver
mybatis配置
mybatis:
配置文件所在位置
config-location: classpath:mybatis-config.xml
映射文件所在位置
mapper-locations: classpath:mappers/*Mapper.xml
日志配置
logging:
level:
root: INFO
com:
bolingcavalry:
simple:
mapper: debug
- 新建user表对应的实体类User.java:
package com.bolingcavalry.simple.entity;
/**
-
@Description: 实体类
-
@author: willzhao E-mail: zq2599@gmail.com
-
@date: 2020/8/4 8:24
*/
public class User {
private Integer id;
private String name;
private Integer age;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
@Override
public String toString() {
return “User{” +
“id=” + id +
“, name='” + name + ‘’’ +
“, age=” + age +
‘}’;
}
}
- 新建log表对应的实体类Log.java:
package com.bolingcavalry.simple.entity;
import java.sql.Date;
/**
-
@Description: 实体类
-
@author: willzhao E-mail: zq2599@gmail.com
-
@date: 2020/8/4 8:24
*/
public class Log {
private Integer id;
private Integer userId;
private String action;
private Date createTime;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public Integer getUserId() {
return userId;
}
public void setUserId(Integer userId) {
this.userId = userId;
}
public String getAction() {
return action;
}
public void setAction(String action) {
this.action = action;
}
public Date getCreateTime() {
return createTime;
}
public void setCreateTime(Date createTime) {
this.createTime = createTime;
}
@Override
public String toString() {
return “Log{” +
“id=” + id +
“, userId=” + userId +
“, action='” + action + ‘’’ +
“, createTime=” + createTime +
‘}’;
}
}
- 接下来会新建三个配置文件,先来看下它们的位置,以免后面放错地方引起不必要的麻烦:
- application.yml所在目录下,新增名为mybatis-config.xml的文件,这是mybatis的配置文件,本例很简单只有一个配置,内容如下:
- resources/mappers目录下,新增名为UserMapper.xml的文件,和user表相关的查询都在此,本文只有一个查询user表的操作,注意下文中的resultType等于User,这里没有写User类的完整路径,是因为前面mybatis-config.xml文件中配置了typeAliases的package节点的缘故:
select * from user where id = #{id}
- 再新增LogMapper.xml,如下所示,log表中的user_id字段在Log.java中没有同名的字段,因此要新增resultMap来建立数据库和实体类的字段映射关系,再在select节点用上这个关系,注意要用resultMap属性(UserMapper.xml中用的是resultType):
select * from log where id = #{id}
- 接下来是业务要用到的接口文件,第一个是UserMapper.java:
package com.bolingcavalry.simple.mapper;
import com.bolingcavalry.simple.entity.User;
import org.springframework.stereotype.Repository;
@Repository
public interface UserMapper {
User sel(int id);
}
- 第二个是LogMapper.java:
package com.bolingcavalry.simple.mapper;
import com.bolingcavalry.simple.entity.Log;
import org.springframework.stereotype.Repository;
@Repository
public interface LogMapper {
Log sel(int id);
}
- 上述两个类都使用了Repository注解,作用是避免在编码过程中,IDEA给出红线提示,如下图:
- 映射配置完毕,接下来就可以在应用中使用了,先为user做一个service类UserService.java,里面通过Autowired注解注入UserMapper的实现:
package com.bolingcavalry.simple.service;
import com.bolingcavalry.simple.entity.User;
import com.bolingcavalry.simple.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class UserService {
@Autowired
UserMapper userMapper;
public User sel(int id){
return userMapper.sel(id);
}
}