本篇笔记学习 b 站 up主 【遇见狂神说】的 MyBatis 随笔记录
文章目录
MyBatis 简介
mybatis3 中文文档官网：https://mybatis.org/mybatis-3/zh/index.html
GitHub 源码网址：https://github.com/mybatis/mybatis-3
最新版本是MyBatis 3.5.5 ，其发布时间是2020年6月4日。
Maven 仓库依赖：
<!-- 目前最新的 mybatis 版本 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
第一个MyBatis测试
1、 创建测试数据库
-- 创建测试数据库
CREATE DATABASE `mybatis`;
-- 使用此数据库
USE `mybatis`;
-- 创建 user 表
CREATE TABLE user(
`id` INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY,
`name` VARCHAR(30) NOT NULL,
`pwd` VARCHAR(30) NOT NULL
)ENGINE=INNODB CHARSET UTF8;
-- 添加3条测试数据
INSERT INTO user(`name`, `pwd`) VALUES
('张三', '864531'),
('李四', '1564513'),
('刘鹏飞', '9846513')
2、 搭建项目
使用 IDEA 创建一个空的 maven 项目
然后删除其中的 src 目录，将此工程作为一个父工程。
3、 添加 maven 依赖
<dependencies>
<!-- mysql 依赖 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!-- mybatis 依赖 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
<!-- junit 依赖 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<!-- lombok 依赖 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
</dependency>
</dependencies>
4、 添加第一个测试子 module 项目
5、创建 pojo 实体类
使用 @Data 注解可以省去写大量的 getter/setter 方法
package com.bai.pojo;
import lombok.Data;
import java.io.Serializable;
/**
* @author: 南独酌酒 <211425401@126.com>
* @date: 2020/10/15 21:54
*/
@Data
public class User implements Serializable {
private Integer id;
private String name;
private String pwd;
}
6、 配置 MyBatis 核心文件 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">
<!-- mybatis 核心配置 -->
<configuration>
<!-- 运行环境 -->
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=utf8"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
</configuration>
7、 创建一个工具类
此工具类用于获取 SqlSession 的类
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;
/**
* @author: 南独酌酒 <211425401@126.com>
* @date: 2020/10/15 22:04
*/
public class MyBatisUtil {
private static SqlSessionFactory sqlSessionFactory;
static {
try {
// 初始化构建 SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 通过 SqlSessionFactory 创建一个 SqlSession 对象
*
* @return SqlSession 对象
*/
public static SqlSession getSqlSession() {
return sqlSessionFactory.openSession();
}
}
8、 添加 UserMapper 接口
import com.bai.pojo.User;
import java.util.List;
/**
* @author: 南独酌酒 <211425401@126.com>
* @date: 2020/10/15 22:07
*/
public interface UserMapper {
/**
* 查询所有用户信息
*
* @return 用户信息
*/
public List<User> getUserList();
}
9、 添加 UserMapper.xml 配置文件编写 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.bai.dao.UserMapper">
<!-- 查询所有用户信息 -->
<select id="getUserList" resultType="com.bai.pojo.User">
select * from mybatis.user;
</select>
</mapper>
10、 添加测试类测试
import com.bai.dao.UserMapper;
import com.bai.pojo.User;
import com.bai.util.MyBatisUtil;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;
/**
* @author: 南独酌酒 <211425401@126.com>
* @date: 2020/10/15 22:11
*/
public class UserMapperTest {
@Test
public void test01() {
SqlSession sqlSession = null;
try {
// 1.获取到 SqlSession 对象那个
sqlSession = MyBatisUtil.getSqlSession();
// 2.通过 getMapper 方法加载对应的 UserMapper 接口
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
// 3.执行接口方法
List<User> userList = mapper.getUserList();
for (User user : userList) {
System.out.println(user);
}
} catch (Exception e) {
e.printStackTrace();
} finally {
// 4.关闭 sqlSession 对象
if (sqlSession != null) {
sqlSession.close();
}
}
}
}
然后通过运行我们发现一个被遗忘的问题， UserMapper文件并没有被注册到 MapperRegistry 中
Type interface com.bai.dao.UserMapper is not known to the MapperRegistry.
我们要解决这个问题，需要在 mybatis-config.xml 文件中注册此 Mapper 文件
然后我们还有遇到一个初始化异常错误
Error parsing SQL Mapper Configuration. Cause: java.io.IOException: Could not find resource com/bai/dao/UserMapper.xml
发生这个错误是因为在 java 源码中并不能加载 xml 类型的文件，要解决这个问题，需要修改一个 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.bai</groupId>
<artifactId>MyBatis-Study</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>mybatis-01</module>
</modules>
<dependencies>
<!-- mysql 依赖 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!-- mybatis 依赖 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
<!-- junit 依赖 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<!-- lombok 依赖 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
</dependency>
</dependencies>
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<!-- 支持 properties 在 resources 包中存在 -->
<include>**/*.properties</include>
<!-- 支持 xml 文件在 resources 包中存在 -->
<include>**/*.xml</include>
</includes>
<!-- 是否过滤 : 是 -->
<filtering>true</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<!-- 支持 properties 在 java 包中存在 -->
<include>**/*.properties</include>
<!-- 支持 xml 文件在 java 包中存在 -->
<include>**/*.xml</include>
</includes>
<!-- 是否过滤 : 是 -->
<filtering>true</filtering>
</resource>
</resources>
</build>
</project>
测试结果
CURD
namespaceMapper.xml 文件的命名空间，用来寻找要实现的接口id类似于方法名，唯一存在resultType返回值类型，基本上就是 Class 类型或者就是8大基本类型parameterType参数类型
select
-
编写接口
/** * 跟据 id 查询用户信息 * * @param id 查询条件 * @return 用户信息 */ public User getUserById(int id); -
编写 xml 中的 sql 语句
<!-- 跟据 id 查询用户信息 --> <select id="getUserById" resultType="com.bai.pojo.User" parameterType="int"> select * from mybatis.user where id = #{id}; </select> -
测试
@Test public void getUserById() { SqlSession sqlSession = MyBatisUtil.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); User user = mapper.getUserById(1); System.out.println(user); sqlSession.close(); }
insert
update
delete
@Test
public void addUser() {
SqlSession sqlSession = MyBatisUtil.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.addUser(new User(4, "哈哈", "135463"));
sqlSession.commit(); // 一定要记住提交事务
sqlSession.close();
}
@Test
public void updateUser() {
SqlSession sqlSession = MyBatisUtil.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.updateUser(new User(4, "呵呵", "66666"));
sqlSession.commit(); // 一定要记住提交事务
sqlSession.close();
}
@Test
public void deleteUser() {
SqlSession sqlSession = MyBatisUtil.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.deleteUser(4);
sqlSession.commit();
sqlSession.close();
}
通过 sqlSession.commit 方法来提交事务
注意：增删改一定要提交事务，这样才会将修改的数据更新回数据库中。
XML 配置
mybatis-config.xml 核心配置文件。
MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息
configuration 配置
properties
-
在外部 resource 文件下创建 db.properties 数据库连接文件
driver=com.mysql.jdbc.Driver url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=utf8 username=root password=123456 -
然后通过 properties 配置到 mybatis 核心配置文件中读取
-
测试代码是否能够正常运行
方式一：直接引入外部文件
<properties resource="db.properties"/>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
方式二：在 properties 标签内部通过 property 属性定义属性
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=utf8
<properties resource="db.properties">
<property name="user" value="root"/>
<property name="pwd" value="123456"/>
</properties>
<!-- 运行环境 -->
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${user}"/>
<property name="password" value="${pwd}"/>
</dataSource>
</environment>
</environments>
当二者同时配置了相同的信息，优先读取外部的 db.properties 文件
typeAliases 类型别名
- 类型别名可为 Java 类型设置一个缩写名字
- 意在降低冗余的全限定类名书写
方式一：通过 typeAlias 方式配置对应的类名
<typeAliases>
<typeAlias type="com.bai.pojo.User" alias="User"/>
</typeAliases>
通过配置别名，resultType 可以直接使用别名的方式来。
<!-- 查询所有用户信息 -->
<select id="getUserList" resultType="User">
select * from mybatis.user;
</select>
方式二：通过 package 包名的方式来配置
<typeAliases>
<package name="com.bai.pojo"/>
</typeAliases>
resultType 直接写 Class 类名即可，小写字母开头
<!-- 查询所有用户信息 -->
<select id="getUserList" resultType="user">
select * from mybatis.user;
</select>
如果使用了 package 的方式配置，又不想使用默认的小写字母类名，可以通过配置注解的方式来使用。
@Alias("hello")
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {
private Integer id;
private String name;
private String pwd;
}
resultType 直接使用 @Alias 注解中声明的名称即可
<!-- 查询所有用户信息 -->
<select id="getUserList" resultType="hello">
select * from mybatis.user;
</select>
映射器 mappers
方式一：通过 resource 方式配置
<mappers>
<mapper resource="com/bai/dao/UserMapper.xml"/>
</mappers>
方式二：通过 class 方式配置
<mappers>
<mapper class="com.bai.dao.UserMapper"/>
</mappers>
方式三：通过 package 方式配置
<mappers>
<package name="com.bai.dao"/>
</mappers>
注意点：接口和 xml 文件一定要同名，并且放在同一个包中。
不注意的话可能会出现各种各样的错误。
environments 环境配置
可以通过此配置指定多种环境的数据库连接配置
比如你现在创建了3套环境、开发、测试、生产
然后我们可以使用 default 属性来切换不同的环境
<environments default="test">
<!-- 开发环境 -->
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
<!-- 测试环境 -->
<environment id="test">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
<!-- 生产环境 -->
<environment id="product">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
-
事务管理器 transactionManager
他有两种类型，JDBC 、 MANAGED
-
数据源 dataSource
UNPOOLED、POOLED、JNDI
日志
stdout_logging
在 MyBatis 核心核心配置文件中添加配置
<!-- 基本设置 -->
<settings>
<!-- STDOUT_LOGGING 日志实现 -->
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
log4j
log4j 简介
- Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件
- 可以控制每一条日志的输出格式；通过定义每一条日志信息的级别
- 可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码
如何在项目中使用 log4j
-
引入 Maven 依赖
<dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> -
创建 log4j.properties 文件
# 将等级为DEBUG的日志信息输出到console和file这两个目的地,console和file的定义在下面的代码 log4j.rootLogger=DEBUG,console,file # 控制台输出的相关配置 log4j.appender.console=org.apache.log4j.ConsoleAppender log4j.appender.console.Target=System.out log4j.appender.console.Threshold=DEBUG log4j.appender.console.layout=org.apache.log4j.PatternLayout log4j.appender.console.layout.ConversionPattern=[%c]-%m%n # 文件输出的相关配置 log4j.appender.file=org.apache.log4j.RollingFileAppender log4j.appender.file.File=./log/bai.log log4j.appender.file.MaxFileSize=10MB log4j.appender.file.Threshold=DEBUG log4j.appender.file.layout=org.apache.log4j.PatternLayout log4j.appender.file.layout.ConversionPattern=[%p][%d{yyyy-MM-dd HH:mm:ss}][%c]-%m%n # 日志输出级别 log4j.logger.org.mybatis=DEBUG log4j.logger.java.sql=DEBUG log4j.logger.java.sql.Statement=DEBUG log4j.logger.java.sql.ResultSet=DEBUG log4j.logger.java.sql.PreparedStatement=DEBUG -
修改 MyBatis 核心配置文件，配置日志选项
<!-- 基本设置 --> <settings> <setting name="logImpl" value="LOG4J"/> </settings> -
测试
当前项目根目录下会生成一个 /log 文件夹，文件夹中的内容就是刚才输出的日志。
分页
Limit 分页
-
UserMapper
/** * limit 分页实现查询用户信息 * * @param map 条件 * @return 用户信息 */ public List<User> getUserLimit(Map<String, Integer> map); -
UserMapper.xml
<!-- limit 分页实现查询用户信息 --> <select id="getUserLimit" parameterType="map" resultType="user"> select * from mybatis.user limit #{pageNo},#{pageSize} </select> -
测试
@Test public void getUserLimit() { // limit 分页实现 SqlSession sqlSession = MyBatisUtil.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); Map<String, Integer> map = new HashMap<String, Integer>(2); map.put("pageNo", 1); map.put("pageSize", 2); List<User> list = mapper.getUserLimit(map); for (User user : list) { System.out.println(user); } sqlSession.close(); }
RowBounds 分页
-
UserMapper
/** * 使用 RowBounds 方式实现分页 * * @return 用户信息 */ public List<User> getUserRowBounds(); -
UserMapper.xml
<!-- 使用 RowBounds 方式实现分页 --> <select id="getUserRowBounds" resultType="user"> select * from mybatis.user </select> -
测试
@Test public void getUserRowBounds() { // 使用 RowBounds 方式实现分页 SqlSession sqlSession = MyBatisUtil.getSqlSession(); RowBounds rowBounds = new RowBounds(2, 2); List<User> list = sqlSession.selectList("com.bai.dao.UserMapper.getUserRowBounds", null, rowBounds); for (User user : list) { System.out.println(user); } sqlSession.close(); }
MyBatis PageHelper 分页插件
文档：https://pagehelper.github.io/docs/howtouse/
注解开发
@Select 注解
-
直接在 UserMapper 接口中使用 @Select 注解来编写 SQL 即可
/** * 查询全部用户 * * @return 用户信息 */ @Select("select * from user") List<User> getUserList(); -
测试
@Test public void getUserList() { // 测试 @Select 注解 SqlSession sqlSession = MyBatisUtil.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); List<User> list = mapper.getUsers(); for (User user : list) { System.out.println(user); } sqlSession.close(); }
注意：使用注解开发一定要在 mybatis 的核心配置文件中添加配置映射
<!-- 配置映射 -->
<mappers>
<mapper class="com.bai.dao.UserMapper"/>
</mappers>
@Param 注解
- 一般使用多个参数的话必须使用 @Param 注解传参
- 基本类型使用 @Param ，引用类型不需要使用此注解
- sql 语句获取其中的 @Param(“value”) Value 值来使用即可
自动设置事务提交
更改 MyBatisUtil 工具类
通过 sqlSessionFactory.openSession(true); 的重载方法可以开启自动提交事务。
/**
* 通过 SqlSessionFactory 创建一个 SqlSession 对象
*
* @return SqlSession 对象
*/
public static SqlSession getSqlSession() {
return sqlSessionFactory.openSession(true);
}
开启了自动提交事务后，增删改就不需要手动提交事务了。
@Insert 注解
/**
* 新增用户
*
* @param user 新增数据
*/
@Insert("insert into user(id, name, pwd) values(#{id}, #{name}, #{pwd})")
void addUser(User user);
// 测试
@Test
public void addUser() {
// 测试 @Select 注解
SqlSession sqlSession = MyBatisUtil.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.addUser(new User(5, "Hello", "333"));
sqlSession.close();
}
@Delete 注解
/**
* 更新用户信息
*
* @param user 更新数据
*/
@Update("update user set name = #{name},pwd = #{pwd} where id = #{id}")
void updateUser(User user);
// 测试
@Test
public void updateUser() {
// 测试 @Select 注解
SqlSession sqlSession = MyBatisUtil.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.updateUser(new User(5, "魔教教主", "777"));
sqlSession.close();
}
@Update 注解
/**
* 删除用户
*
* @param id 删除条件
*/
@Delete("delete from user where id = #{uid}")
void deleteById(@Param("uid") int id);
// 测试
@Test
public void deleteById() {
// 测试 @Select 注解
SqlSession sqlSession = MyBatisUtil.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.deleteById(5);
sqlSession.close();
}
#{} 和 ${} 的区别
#{} 是预编译执行 sql 的
${} 不是预编译
#{} 能够有效防止 sql 注入，推荐使用 #{}
Lombok 注解
项目中使用 lombok
-
IDEA 安装 Lombok 插件
-
项目中引入 Lombok 依赖即可使用
<!-- lombok 依赖 --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.12</version> </dependency>
lombok 常用注解
@Getter and @Setter // 给属性添加 getter 和 setter 方法
@ToString // 添加 toString() 方法
@EqualsAndHashCode // 在类中添加 equals() hashCode() 方法
@AllArgsConstructor // 在类中添加一个全参构造函数
@NoArgsConstructor // 在类中添加一个无参构造
@Slf4j // 日志
@Data // 类上面一般默认都是使用此注解
// 添加了 @Data 注解，会在类中生成 getter/setter/toString()/hashCode() 和 无参构造等方法
ResultMap 多对一实现
<select id="getStudents" resultMap="BaseStudentMap">
select s.id sid,s.name sname,t.name tname
from student s
left join teacher t on s.tid = t.id
</select>
<resultMap id="BaseStudentMap" type="com.bai.pojo.Student">
<id property="id" column="sid"/>
<result property="name" column="sname"/>
<association property="teacher" javaType="com.bai.pojo.Teacher">
<result property="name" column="tname"/>
</association>
</resultMap>
ResultMap 一对多实现
<select id="getById" resultMap="BaseResultMap">
select s.id sid,s.name sname,t.id tid,t.name tname from student s
left join teacher t on s.tid = t.id
</select>
<resultMap id="BaseResultMap" type="com.bai.pojo.Teacher">
<id property="id" column="tid"/>
<result property="name" column="tname"/>
<collection property="studentList" ofType="com.bai.pojo.Student">
<result property="name" column="sname"/>
</collection>
</resultMap>
- association 单个对象下使用
- collection 集合情况下使用
- 其中一定要注意 property 属性填写的是实体类中创建的属性、而 column 是 sql 语句查询的列名称，如果给 sql 语句查询的字段起了别名，一定在使用别名
动态 SQL
环境搭建
-
创建测试数据库
create table blog ( id varchar(30) not null comment '主键 id', title varchar(30) null comment '博客标题', author varchar(30) null comment '作者', create_time datetime null comment '创建时间', views int(10) null comment '博客浏览量', constraint blog_pk primary key (id) ) comment '博客表'; -
搭建工程
一个基本的工程搭建，复制之前 resources 目录下的配置文件，只需要修改其中 mappers 配置映射即可。
-
创建实体类 Blog
import lombok.Data; import java.util.Date; /** * @author: 南独酌酒 <211425401@126.com> * @date: 2020/10/24 10:20 */ @Data public class Blog { private String id; private String title; private String author; //todo 由于这里配置的属性和数据库明显不一致,可以通过配置驼峰命名转换来达到我们想要的结果 private Date createTime; private Integer views; } -
创建mybatis核心配置文件
由于我们的实体类 createTime 和数据库中定义的 create_time 不一样，可以通过此配置达到映射效果
<?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>
<!-- 读取配置文件 -->
<properties resource="db.properties"/>
<!-- 基本设置 -->
<settings>
<!-- STDOUT_LOGGING 日志实现 -->
<setting name="logImpl" value="STDOUT_LOGGING"/>
<!-- 是否开启驼峰命名自动映射 -->
<setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>
<!-- 数据库运行环境 -->
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<!-- 配置映射 -->
<mappers>
<mapper class="com.bai.dao.BlogMapper"/>
</mappers>
</configuration>
-
创建 BlogMapper 和 BlogMapper.xml 文件
-
创建 IdUtils 工具类，用来生成默认的 UUID 作为 blog 表的主键
import org.junit.Test; import java.util.UUID; /** * @author: 南独酌酒 <211425401@126.com> * @date: 2020/10/24 10:27 */ @SuppressWarnings("all") // 镇压警告 public class IdUtils { public static String getUUID() { return UUID.randomUUID().toString().replace("-", ""); } @Test public void test() { System.out.println(IdUtils.getUUID()); } } -
添加 blog 记录
/** * 添加博客记录 * * @param blog 博客 * @return 影响行数 */ public int saveBlog(Blog blog);<!-- 添加博客记录 --> <insert id="saveBlog" useGeneratedKeys="true" keyProperty="id"> insert into blog (id,title,author,create_time,views) values (#{id},#{title},#{author},#{createTime},#{views}) </insert> -
测试
@Test public void test01() { SqlSession sqlSession = MyBatisUtil.getSqlSession(); BlogMapper mapper = sqlSession.getMapper(BlogMapper.class); Blog blog = new Blog(); blog.setId(IdUtils.getUUID()); blog.setTitle("MyBatis确实好用"); blog.setAuthor("南独酌酒"); blog.setCreateTime(new Date()); blog.setViews(5600); mapper.saveBlog(blog); blog.setId(IdUtils.getUUID()); blog.setTitle("Spring确实好用"); mapper.saveBlog(blog); blog.setId(IdUtils.getUUID()); blog.setTitle("SpringBoot确实好用"); mapper.saveBlog(blog); blog.setId(IdUtils.getUUID()); blog.setTitle("SpringCloud确实好用"); mapper.saveBlog(blog); sqlSession.close(); }
动态 SQL 之 IF
在 xml 文件中通过 if 标签来达到动态拼接 sql 的目的
/**
* 跟据标题和作者姓名查询指定博客
*
* @param reqMap 查询条件
* @return 博客记录
*/
public List<Blog> getAll(@Param("reqMap") Map<String, Object> reqMap);
<!-- 跟据标题和作者姓名查询指定博客 -->
<select id="getAll" resultType="com.bai.pojo.Blog">
select * from blog where 1=1
<if test="reqMap.title != null">
and title = #{reqMap.title}
</if>
<if test="reqMap.author != null">
and author = #{reqMap.author}
</if>
</select>
测试
@Test
public void test02() {
SqlSession sqlSession = MyBatisUtil.getSqlSession();
BlogMapper mapper = sqlSession.getMapper(BlogMapper.class);
Map<String, Object> reqMap = new HashMap<String, Object>();
reqMap.put("title", "Mybatis确实好用");
List<Blog> blogs = mapper.getAll(reqMap);
for (Blog blog : blogs) {
System.out.println(blog);
}
sqlSession.close();
}
查询结果，控制台打印的 sql 语句真是拼接后的 sql
动态 SQL 之 choose、when、otherwise
这个类似于 java 中的 switch 语句
choose 相当于 switch
when 相当于 case
otherwise 相当于 default
/**
* choose、when、otherwise 测试
*
* @param map 条件
* @return 记录
*/
public List<Blog> queryChoose(Map<String, Object> map);
<!-- choose、when、otherwise 测试 -->
<select id="queryChoose" parameterType="map" resultType="com.bai.pojo.Blog">
select * from blog
<where>
<choose>
<when test="title != null">
title = #{title}
</when>
<when test="author != null">
author = #{author}
</when>
<otherwise>
views = #{views}
</otherwise>
</choose>
</where>
</select>
测试
@Test
public void test03() {
SqlSession sqlSession = MyBatisUtil.getSqlSession();
BlogMapper mapper = sqlSession.getMapper(BlogMapper.class);
Map<String, Object> map = new HashMap<String, Object>();
// map.put("title", "Mybatis确实好用");
// map.put("author", "南独酌酒");
map.put("views", "5600");
List<Blog> blogs = mapper.queryChoose(map);
for (Blog blog : blogs) {
System.out.println(blog);
}
sqlSession.close();
}
动态 SQL 之 trim、where、set
-
where
where 元素只会在子元素返回任何内容的情况下才插入 “WHERE” 子句。而且，若子句的开头为 “AND” 或 “OR”，where 元素也会将它们去除。
-
set
set 元素可以用于动态包含需要更新的列，忽略其它不更新的列
set 标签一般都用于在 update 语句上
set 元素会动态地在行首插入 SET 关键字，并会删掉额外的逗号
/** * 更新博客信息 * * @param blog 博客信息 * @return 影响行数 */ public int updateBlog(Blog blog);<!-- 更新博客信息 --> <update id="updateBlog" parameterType="com.bai.pojo.Blog"> update blog <set> <if test="title != null">title = #{title},</if> <if test="author != null">author = #{author},</if> </set> where id = #{id} </update>测试
@Test public void test04() { SqlSession sqlSession = MyBatisUtil.getSqlSession(); BlogMapper mapper = sqlSession.getMapper(BlogMapper.class); Blog blog = new Blog(); blog.setId("4c067d7a925e4bd3a972e802b59e5198"); blog.setTitle("SpringBoot确实好用"); mapper.updateBlog(blog); sqlSession.close(); }结果
-
trim
trim 类似于自定义一些花样来拼接 sql 语句
-
prefix 后缀
-
prefixOverrides 后缀重写
-
suffix 前缀
-
suffix 前缀重写
<trim prefix="" prefixOverrides="" suffix="" suffixOverrides=""> </trim>常见例子：前缀设置 where ，在有 and 或者 or 的情况下拼接 sql
<trim prefix="WHERE" prefixOverrides="AND |OR "> ... </trim>后缀设置 set，后缀重写以逗号结尾
<trim prefix="SET" suffixOverrides=","> ... </trim> -
动态 SQL 之 foreach
测试之前首先将 blog 表中的主键 改为 1234 等等，方便测试
/**
* 测试 foreach
*
* @param ids 条件
* @return 博客数据
*/
public List<Blog> queryForeach(@Param("ids") List<Integer> ids);
<!--
测试 foreach
select * from blog where id in (1,2,3)
-->
<select id="queryForeach" resultType="com.bai.pojo.Blog">
select * from blog
<where>
id in
<foreach collection="ids" item="id" open="(" close=")" separator=",">
#{id}
</foreach>
</where>
</select>
测试
@Test
public void test05() {
SqlSession sqlSession = MyBatisUtil.getSqlSession();
BlogMapper mapper = sqlSession.getMapper(BlogMapper.class);
List<Integer> list = new ArrayList<Integer>();
list.add(1);
list.add(2);
List<Blog> blogs = mapper.queryForeach(list);
for (Blog blog : blogs) {
System.out.println(blog);
}
sqlSession.close();
}
结果
SQL 片段
sql 片段是用来编写重复使用的代码
<sql id="if-title-author">
<if test="reqMap.title != null">
and title = #{reqMap.title}
</if>
<if test="reqMap.author != null">
and author = #{reqMap.author}
</if>
</sql>
<!-- 跟据标题和作者姓名查询指定博客 -->
<select id="getAll" resultType="com.bai.pojo.Blog">
select * from blog
<where>
<include refid="if-title-author"/>
</where>
</select>
通过定义 sql 标签在其中写入经常服用的代码即可
通过 include 标签来引用 sql 片段即可
MyBatis 缓存
- mybatis 默认开启一级缓存，一级缓存作用域只限定于 sqlSession 的一次会话
- mybatis 二级缓存需要自定义开启，作用域是基于 namespace
一级缓存测试
/**
* 跟据id查询用户
*
* @param id 查询条件
* @return 用户信息
*/
public User getById(@Param("id") int id);
<!-- 跟据id查询用户 -->
<select id="getById" resultType="com.bai.pojo.User">
select * from user where id = #{id};
</select>
开始测试
@Test
public void test01() {
// 测试一级缓存
SqlSession sqlSession = MyBatisUtil.getSqlSession();
// 一级缓存的作用域只限定于 sqlSession 一次会话中有效
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
System.err.println("================第一次查询 user==================");
User user = mapper.getById(1);
System.err.println(user);
System.err.println("================第二次查询 user==================");
User user2 = mapper.getById(1);
System.err.println(user2);
sqlSession.close();
}
测试结果
一级缓存失效的问题：
-
查询的不是同一次数据，就不会有缓存一说
-
增删改都会刷新缓存，缓存就会被清除
-
手动设置缓存失效，通过
sqlSession.clearCache();实现清除缓存
二级缓存测试
-
mybatis 核心配置文件配置开启全局二级缓存
<!-- 显示的开启二级缓存 --> <setting name="cacheEnabled" value="true"/> -
在想要使用二级缓存的 Mapper.xml 文件中创建 cache 标签即可开启二级缓存
<!-- 开启二级缓存 --> <cache/>也可以自定义设置一些常用参数
<!-- 开启二级缓存 --> <cache eviction="FIFO" flushInterval="60000" size="512" readOnly="true"/>eviction 缓存清除策略
LRU– 最近最少使用：移除最长时间不被使用的对象。FIFO– 先进先出：按对象进入缓存的顺序来移除它们。SOFT– 软引用：基于垃圾回收器状态和软引用规则移除对象。WEAK– 弱引用：更积极地基于垃圾收集器状态和弱引用规则移除对象
flushInterval 刷新间隔
size 引用数目
readOnly 只读属性
二级缓存是事务性的。这意味着，当 SqlSession 完成并提交时，或是完成并回滚，但没有执行 flushCache=true 的 insert/delete/update 语句时，缓存会获得更新
-
测试
@Test public void test02() { // 测试二级缓存 SqlSession sqlSession = MyBatisUtil.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); User user = mapper.getById(1); System.out.println(user); sqlSession.close(); SqlSession sqlSession2 = MyBatisUtil.getSqlSession(); UserMapper mapper2 = sqlSession2.getMapper(UserMapper.class); User user2 = mapper2.getById(1); System.out.println(user2); sqlSession2.close(); } -
测试结果
2665
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
