SpringBoot2系列教程(十三)|整合MyBatis(XML版)

前言

如题，今天介绍 SpringBoot 与 Mybatis 的整合以及 Mybatis 的使用，之前介绍过了 SpringBoot 整合MyBatis 注解版的使用，上一篇介绍过 MyBatis 的理论，今天这篇就不介绍 MyBatis 的理论了，有兴趣的跳转阅读：SpringBoot 实战 (十三) | 整合 MyBatis (注解版)

准备工作

• SpringBoot 2.1.3


• IDEA


• JDK 8

创建表

CREATE TABLE `student` (
`id` int(32) NOT NULL AUTO_INCREMENT,
`student_id` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT &＃39;学号&＃39;,
`name` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT &＃39;姓名&＃39;,
`age` int(11) NULL DEFAULT NULL COMMENT &＃39;年龄&＃39;,
`city` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT &＃39;所在城市&＃39;,
`dormitory` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT &＃39;宿舍&＃39;,
`major` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT &＃39;专业&＃39;,
PRIMARY KEY (`id`) USING BTREE
)ENGINE=INNODB AUTO_INCREMENT=1000 DEFAULT CHARSET=utf8;

引入依赖




org.springframework.boot
spring-boot-starter-jdbc



org.springframework.boot
spring-boot-starter-web



org.mybatis.spring.boot
mybatis-spring-boot-starter
2.0.0



com.alibaba
druid
1.1.14



mysql
mysql-connector-java
5.1.47
runtime



com.github.pagehelper
pagehelper-spring-boot-starter
1.2.5



org.springframework.boot
spring-boot-starter-test
test






org.springframework.boot
spring-boot-maven-plugin



org.mybatis.generator
mybatis-generator-maven-plugin
1.3.2

${basedir}/src/main/resources/generator/generatorConfig.xml
true
true





代码解释很详细了，但这里提一嘴，mybatis generator 插件用于自动生成代码，pagehelper 插件用于物理分页。

项目配置

server:
port: 8080
spring:
datasource:
name: test
url: jdbc:mysql://127.0.0.1:3306/test
username: root
password: 123456
#druid相关配置
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.jdbc.Driver
filters: stat
maxActive: 20
initialSize: 1
maxWait: 60000
minIdle: 1
timeBetweenEvictionRunsMillis: 60000
minEvictableIdleTimeMillis: 300000
validationQuery: select &＃39;x&＃39;
testWhileIdle: true
testOnBorrow: false
testOnReturn: false
poolPreparedStatements: true
maxOpenPreparedStatements: 20
## 该配置节点为独立的节点，有很多同学容易将这个配置放在spring的节点下，导致配置无法被识别
mybatis:
mapper-locations: classpath:mapping/*.xml #注意：一定要对应mapper映射xml文件的所在路径
type-aliases-package: com.nasus.mybatisxml.model # 注意：对应实体类的路径
#pagehelper分页插件
pagehelper:
helperDialect: mysql
reasonable: true
supportMethodsArguments: true
params: count=countSql

mybatis generator 配置文件

这里要注意，配置 pom.xml 中 generator 插件所对应的配置文件时，在 Pom.xml 加入这一句，说明 generator 插件所对应的配置文件所对应的配置文件路径。这里已经在 Pom 中配置了，请见上面的 Pom 配置。

${basedir}/src/main/resources/generator/generatorConfig.xml

generatorConfig.xml ：


PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">































代码注释很详细，不多说。

生成代码过程

第一步：选择编辑配置

第二步：选择添加 Maven 配置

第三步：添加命令 mybatis-generator:generate -e 点击确定

第四步：运行该配置，生成代码

特别注意！！！同一张表一定不要运行多次，因为 mapper 的映射文件中会生成多次的代码，导致报错，切记。如要运行多次，请把上次生成的 mapper 映射文件代码删除再运行。

第五步：检查生成结果

遇到的问题

请参照别人写好的遇到问题的解决方法，其中我就遇到数据库时区不对以及只生成 Insert 方法这两个问题。都是看以下这篇文章解决的：

Mybatis Generator自动生成代码以及可能出现的问题

生成的代码

1、实体类：Student.java

package com.nasus.mybatisxml.model;
public class Student {
private Long id;
private Integer age;
private String city;
private String dormitory;
private String major;
private String name;
private Long studentId;
// 省略 get 和 set 方法
}

2、mapper 接口：StudentMapper.java

package com.nasus.mybatisxml.mapper;
import com.nasus.mybatisxml.model.Student;
import java.util.List;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface StudentMapper {
int deleteByPrimaryKey(Long id);
int insert(Student record);
int insertSelective(Student record);
Student selectByPrimaryKey(Long id);
// 我添加的方法，相应的要在映射文件中添加此方法
List selectStudents();
int updateByPrimaryKeySelective(Student record);
int updateByPrimaryKey(Student record);
}

3、映射文件：StudentMapper.xml














id, age, city, dormitory, major, name, student_id


select

from student
where id = #{id,jdbcType=BIGINT}


delete from student
where id = #{id,jdbcType=BIGINT}


insert into student (id, age, city,
dormitory, major, name,
student_id)
values (#{id,jdbcType=BIGINT}, #{age,jdbcType=INTEGER}, #{city,jdbcType=VARCHAR},
#{dormitory,jdbcType=VARCHAR}, #{major,jdbcType=VARCHAR}, #{name,jdbcType=VARCHAR},
#{studentId,jdbcType=BIGINT})


insert into student


id,


age,


city,


dormitory,


major,


name,


student_id,




#{id,jdbcType=BIGINT},


#{age,jdbcType=INTEGER},


#{city,jdbcType=VARCHAR},


#{dormitory,jdbcType=VARCHAR},


#{major,jdbcType=VARCHAR},


#{name,jdbcType=VARCHAR},


#{studentId,jdbcType=BIGINT},




update student


age = #{age,jdbcType=INTEGER},


city = #{city,jdbcType=VARCHAR},


dormitory = #{dormitory,jdbcType=VARCHAR},


major = #{major,jdbcType=VARCHAR},


name = #{name,jdbcType=VARCHAR},


student_id = #{studentId,jdbcType=BIGINT},


where id = #{id,jdbcType=BIGINT}


update student
set age = #{age,jdbcType=INTEGER},
city = #{city,jdbcType=VARCHAR},
dormitory = #{dormitory,jdbcType=VARCHAR},
major = #{major,jdbcType=VARCHAR},
name = #{name,jdbcType=VARCHAR},
student_id = #{studentId,jdbcType=BIGINT}
where id = #{id,jdbcType=BIGINT}



SELECT

from student



serviec 层

1、接口：

public interface StudentService {
int addStudent(Student student);
Student findStudentById(Long id);
PageInfo findAllStudent(int pageNum, int pageSize);
}

2、实现类

@Service
public class StudentServiceImpl implements StudentService{
//会报错，不影响
@Resource
private StudentMapper studentMapper;
/**
* 添加学生信息
* @param student
* @return
*/
@Override
public int addStudent(Student student) {
return studentMapper.insert(student);
}
/**
* 根据 id 查询学生信息
* @param id
* @return
*/
@Override
public Student findStudentById(Long id) {
return studentMapper.selectByPrimaryKey(id);
}
/**
* 查询所有学生信息并分页
* @param pageNum
* @param pageSize
* @return
*/
@Override
public PageInfo findAllStudent(int pageNum, int pageSize) {
//将参数传给这个方法就可以实现物理分页了，非常简单。
PageHelper.startPage(pageNum, pageSize);
List studentList = studentMapper.selectStudents();
PageInfo result = new PageInfo(studentList);
return result;
}
}

controller 层

@RestController
@RequestMapping("/student")
public class StudentController {
@Autowired
private StudentService studentService;
@GetMapping("/{id}")
public Student findStidentById(@PathVariable("id") Long id){
return studentService.findStudentById(id);
}
@PostMapping("/add")
public int insertStudent(@RequestBody Student student){
return studentService.addStudent(student);
}
@GetMapping("/list")
public PageInfo findStudentList(@RequestParam(name = "pageNum", required = false, defaultValue = "1") int pageNum,
@RequestParam(name = "pageSize", required = false, defaultValue = "10") int pageSize){
return studentService.findAllStudent(pageNum,pageSize);
}
}

启动类

@SpringBootApplication
@MapperScan("com.nasus.mybatisxml.mapper") // 扫描 mapper 接口，必须加上
public class MybatisxmlApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisxmlApplication.class, args);
}
}

提一嘴，@MapperScan("com.nasus.mybatisxml.mappe") 这个注解非常的关键，这个对应了项目中 mapper(dao) 所对应的包路径，必须加上，否则会导致异常。

Postman 测试

1、插入方法：

2、根据 id 查询方法：

3、分页查询方法：

源码下载

https://github.com/turoDog/Demo/tree/master/springboot_mybatisxml_demo

帮忙点个 star 可好？

最后

如果看到这里，说明你喜欢这篇文章，请转发、点赞。微信搜索「一个优秀的废人」，关注后回复「1024」送你一套完整的 java 教程。