Spring Boot 之集成 MyBatis 操作数据库
一、MyBatis 概述
1.1 MyBatis 介绍
1.1.1 介绍
MyBatis是一款优秀的持久层框架,它支持定制化SQL、存储过程以及高级映射。
MyBatis避免了几乎所有的JDBC代码和手动设置参数以及获取结果集。MyBatis可以使用简单的XML或注解来配置和映射原生信息,将接口和Java的POJOs(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录。
1.1.2 优点
(1)可以手写SQL,比较灵活,对于很多互联网公司、业务迭代速度快的公司或者业务复杂的项目,MyBatis修改、维护等方面更加灵活。
(2)MyBatis上手更加容易,基本上没有更多学习成本,这是很多公司选用MyBatis的理由。
(3)从SQL优化方面来说,手写的SQL优化起来更加方便。
1.2 Spring Boot 整合 MyBatis
1.2.1 MyBatis 依赖
在pom.xml文件中导入MyBatis的依赖代码
<!-- MyBatis依赖-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
因为要操作数据库,所以还需要导入MySQL数据库的依赖
<!-- MySQL依赖 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
1.2.2 MyBatis 配置文件
在配置文件中需要配置数据库信息以及MyBatis配置,MyBatis常用的配置如下:
logging.level.com.test.dao.UsersMapper
:日志的打印级别,这里的logging.level.com.test.dao.UsersMapper
是本文案例中Mapper的位置,实际项目应该配置对应Mapper的位置。mybatis.mapper-locations
:Mapper文件的存放位置。mybatis.check-config-location
:MyBatis配置是否开启。mybatis.config-location
:MyBatis配置文件位置,与mybatis.check-config-location
配合使用。
具体配置如下
spring.resources.static-locations=classpath:/static,classpath:/templates/
##-----MySQL数据库配置-----##
# 数据库地址
spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=yes&characterEncoding=utf8
# 数据库用户名
spring.datasource.username=root
# 数据库密码
spring.datasource.password=123456
# 数据库驱动
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
##-----MyBatis配置-----##
# 检查mybatis配置是否存在,一般命名为mybatis-config.xml
mybatis.check-config-location=true
# 配置配置文件
mybatis.config-location=classpath:mybatis/mybatis-config.xml
# mapper.xml文件地址
mybatis.mapper-locations=classpath*:mapper/*Mapper.xml
# 日志级别
logging.level.com.test=debug
1.2.3 mybatis-config.xml
文件
在src/mian/resources/mybatis
下创建mybatis-config.xml
,这个文件是MyBatis的全局配置文件,包含以下几种类型的配置:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD SQL Map Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<typeAliases>
<typeAlias type="com.test.entity.Users" alias="users"></typeAlias>
</typeAliases>
</configuration>
mybatis-config.xml
文件常用属性
- properties(属性)
- settings(全局配置参数)
- typeAliases(类型别名)
- typeHandlers(类型处理器)
- objectFactory(对象工厂)
- plugins(插件)
- environments(环境集合属性对象)
- environment(环境子属性对象)
- transactionManager(事务管理)
- dataSource(数据源)
- mappers(映射器)
1.2.4 编写代码
创建实体类代码Users类
@Alias("users")
public class Users implements Serializable {
private int id;
private String name;
private int age;
private String sex;
/* 省略getter/setter */
@Override
public String toString() {
return "Users{" +
"id=" + id +
", name='" + name + '\'' +
", age=" + age +
", sex='" + sex + '\'' +
'}';
}
}
编写UsersMapper.xml文件,这个文件是mybatis编写sql的地方
<?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.test.Dao.UsersMapper">
<resultMap id="users" type="com.test.entity.Users"/>
<parameterMap id="users" type="com.test.entity.Users"/>
<select id="queryUsers" parameterMap="users" resultMap="users">
SELECT * FROM USERS WHERE NAME = #{name}
</select>
<update id="updateUsers" parameterMap="users">
UPDATE USERS SET AGE = #{age} WHERE NAME = #{name}
</update>
<insert id="insertUsers" parameterMap="users">
INSERT INTO USERS(NAME,AGE,SEX) VALUES(#{name},#{age},#{sex})
</insert>
<delete id="deleteUsers" parameterMap="users">
DELETE FROM USERS WHERE NAME = #{name}
</delete>
</mapper>
编写UsersMapper类文件,UsersMapper类中的方法对应UsersMapper.xml文件中的SQL,方法名对应其id
@Mapper
public interface UsersMapper {
public Users queryUsers(Users users);
public void updateUsers(Users users);
public void insertUsers(Users users);
public void deleteUsers(Users users);
}
再要添加@Mapper
注解,并且还要再Application启动类上添加@MapperScan("com.test.Dao")
注解,其中com.test.Dao
是UsersMapper类的地址。
编写UsersController类和UsersService类进行测试
UsersService类
@Service
public class UsersService {
@Autowired
private UsersMapper usersMapper;
public Users query(Users users){
return usersMapper.queryUsers(users);
}
public void update(Users users){
usersMapper.updateUsers(users);
}
public void insert(Users users){
usersMapper.insertUsers(users);
}
public void delete(Users users){
usersMapper.deleteUsers(users);
}
}
UsersController类
@RestController
public class UsersController {
@Autowired
private UsersService usersService;
@RequestMapping("/query")
public void query(){
Users users = new Users();
users.setName("张三");
Users query = usersService.query(users);
System.out.println("query = " + query);
}
@RequestMapping("/update")
public void update(){
Users users = new Users();
users.setName("张三");
users.setAge(18);
usersService.update(users);
}
@RequestMapping("/insert")
public void insert(){
Users users = new Users();
users.setName("李四");
users.setAge(33);
users.setSex("女");
usersService.insert(users);
}
@RequestMapping("/delete")
public void delete(){
Users users = new Users();
users.setName("张三");
usersService.delete(users);
}
}
启动代码,依次再浏览器访问如下网址即可执行对应操作。
http://localhost:8080/query
http://localhost:8080/update
http://localhost:8080/insert
http://localhost:8080/delete
1.3 MyBatis-Generator 插件自动生成代码
1.3.1 MyBatis-Generator 插件安装
在上述的示例中,我们需要自己编写实体类、UsersMapper类、UsersMapper.xml等文件,而这些操作是比较耗费时间的,所以MyBatis提供了一个插件MyBatis-Generator可以让我们自动生成代码。
以IDEA为例,打开设置,进入插件Plugins
搜索MyBatis插件
随便安装哪一个都可以,这里我是安装的第一个,安装后需要重启IDEA。
1.3.2 配置和使用插件
导入插件的依赖文件
<!--mybatis自动生成代码插件-->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<configuration>
<!--允许移动生成-->
<verbose>true</verbose>
<!--允许自动覆盖-->
<overwrite>true</overwrite>
<!--mybatis配置文件地址-->
<configurationFile>
src/main/resources/mybatis/mybatis-generator.xml
</configurationFile>
</configuration>
</plugin>
配置文件
spring.resources.static-locations=classpath:/static,classpath:/templates/
##-----MySQL数据库配置-----##
# 数据库地址
spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=yes&characterEncoding=utf8
# 数据库用户名
spring.datasource.username=root
# 数据库密码
spring.datasource.password=123456
# 数据库驱动
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
##-----MyBatis配置-----##
# 检查mybatis配置是否存在,一般命名为mybatis-config.xml
mybatis.check-config-location=true
# 配置配置文件地址
mybatis.config-location=classpath:mybatis/mybatis-generator.xml
# mapper.xml文件地址
mybatis.mapper-locations=classpath*:mapper/*Mapper.xml
# 日志级别
logging.level.com.test=debug
在src/main/resources/mybatis
路径下创建mybatis-generator.xml
文件,并编写如下代码,代码需要根据个人的不同进行配置
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<!-- 配置生成器 -->
<generatorConfiguration>
<!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 -->
<classPathEntry location="F://mysql-connector-java-5.1.24.jar"/>
<!-- 一个数据库一个context -->
<context id="DB2Tables" targetRuntime="Mybatis3">
<!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表;一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖 -->
<property name="autoDelimitKeywords" value="true"/>
<!-- 生成的Java文件的编码 -->
<property name="javaFileEncoding" value="utf-8"/>
<!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; -->
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
<!-- 格式化java代码 -->
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<!-- 格式化XML代码 -->
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
<plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
<plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
<!--配置生成注释信息,最多配置一个 -->
<commentGenerator>
<!-- 阻止生成注释包含时间戳 默认为false -->
<property name="suppressDate" value="true"/>
<property name="suppressAllComments" value="true"/>
<!-- 注释是否添加数据库表的备注信息 默认为false -->
<property name="addRemarkComments" value="true"/>
</commentGenerator>
<!-- jdbc连接-->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/test"
userId="root"
password="123456"/>
<!-- 类型转换 -->
<javaTypeResolver>
<!-- 是否使用bigDecimal, false可自动转化以下类型(Long, Integer, Short, etc.) -->
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!-- 生成实体类地址 -->
<javaModelGenerator targetPackage="com.test.entity" targetProject="src/main/java">
<!-- 是否让schema作为包的后缀 -->
<property name="enableSubPackages" value="true"/>
<!-- 从数据库返回的值去掉前后空格 -->
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- 生成map.xml文件存放地址 -->
<sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 生成接口dao type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 -->
<javaClientGenerator targetPackage="com.test.Dao" targetProject="src/main/java" type="XMLMAPPER">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!-- table可以有多个,每个数据库中的表都可以写一个table,tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 enableSelectByPrimaryKey相应的配置表示是否生成相应的接口 -->
<table tableName="users"
enableCountByExample="true"
enableUpdateByExample="true"
enableDeleteByExample="true"
enableSelectByExample="true"
selectByExampleQueryId="true">
</table>
</context>
</generatorConfiguration>
打开Maven Projects,找到如下的插件并启动,即可生成对应的实体类、mapper类和mapper.xml文件
1.3.3 完整的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.2.6.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.test</groupId>
<artifactId>springboot-mybatis-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot-mybatis-demo</name>
<description>Demo project for Spring Boot With MyBatis</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<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-devtools</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<!-- 没有该配置,devtools 不生效 -->
<fork>true</fork>
</configuration>
</plugin>
<!--mybatis自动生成代码插件-->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<configuration>
<!--允许移动生成-->
<verbose>true</verbose>
<!--允许自动覆盖-->
<overwrite>true</overwrite>
<!--mybatis配置文件地址-->
<configurationFile>
src/main/resources/mybatis/mybatis-generator.xml
</configurationFile>
</configuration>
</plugin>
</plugins>
</build>
</project>