引言
MyBatis 是一个优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的过程。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
本文旨在为读者提供一个全面而实用的指南,从入门到进阶,再到常见问题的解决,帮助读者高效地使用 MyBatis。
入门篇
1. MyBatis 简介
MyBatis 遵循约定优于配置的原则,通过 XML 或注解的方式定义 SQL 映射和操作数据库。它支持自定义 SQL、存储过程以及高级映射。
2. 环境搭建
2.1 添加依赖
在 Maven 项目中,添加以下依赖:
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.26</version>
</dependency>
</dependencies>
2.2 配置文件
创建 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">
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/test"/>
<property name="username" value="root"/>
<property name="password" value=""/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/example/mapper/UserMapper.xml"/>
</mappers>
</configuration>
2.3 编写 Mapper 接口和 XML 映射文件
创建 UserMapper.java 接口:
package com.example.mapper;
public interface UserMapper {
User getUserById(int id);
}
创建 UserMapper.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.example.mapper.UserMapper">
<select id="getUserById" resultType="com.example.User">
SELECT * FROM user WHERE id = #{id}
</select>
</mapper>
3. 使用 MyBatis
在 Java 代码中,使用 SqlSessionFactoryBuilder 创建 SqlSessionFactory,然后通过 SqlSessionFactory 创建 SqlSession:
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsReader("mybatis-config.xml"));
try (SqlSession session = sqlSessionFactory.openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
User user = mapper.getUserById(1);
System.out.println(user);
}
进阶篇
1. 动态 SQL
MyBatis 支持动态 SQL,可以方便地实现条件查询、分页等功能。
1.1 <if> 标签
<select id="getUserByCondition" resultType="com.example.User">
SELECT * FROM user
<where>
<if test="id != null">
AND id = #{id}
</if>
<if test="name != null">
AND name = #{name}
</if>
</where>
</select>
1.2 <choose>、<when>、<otherwise> 标签
<select id="getUserByCondition" resultType="com.example.User">
SELECT * FROM user
<where>
<choose>
<when test="id != null">
id = #{id}
</when>
<when test="name != null">
name = #{name}
</when>
<otherwise>
1=1
</otherwise>
</choose>
</where>
</select>
2. 关联映射
MyBatis 支持一对一、一对多、多对多等关联映射。
2.1 一对一
<mapper namespace="com.example.mapper.UserMapper">
<resultMap id="userResultMap" type="com.example.User">
<id property="id" column="id"/>
<result property="name" column="name"/>
<association property="address" column="address_id" javaType="com.example.Address">
<id property="id" column="address_id"/>
<result property="street" column="street"/>
<result property="city" column="city"/>
</association>
</resultMap>
<select id="getUserById" resultMap="userResultMap">
SELECT u.id, u.name, a.id as address_id, a.street, a.city
FROM user u
LEFT JOIN address a ON u.address_id = a.id
WHERE u.id = #{id}
</select>
</mapper>
2.2 一对多
<mapper namespace="com.example.mapper.UserMapper">
<resultMap id="userResultMap" type="com.example.User">
<id property="id" column="id"/>
<result property="name" column="name"/>
<collection property="orders" column="id" ofType="com.example.Order">
<id property="id" column="order_id"/>
<result property="name" column="order_name"/>
</collection>
</resultMap>
<select id="getUserById" resultMap="userResultMap">
SELECT u.id, u.name, o.id as order_id, o.name as order_name
FROM user u
LEFT JOIN order o ON u.id = o.user_id
WHERE u.id = #{id}
</select>
</mapper>
3. 缓存
MyBatis 提供了两种类型的缓存:一级缓存和二级缓存。
3.1 一级缓存
一级缓存是本地缓存,每个 SqlSession 有自己的缓存。当执行查询时,MyBatis 会先从一级缓存中查找数据,如果没有找到,则从数据库中查询,并将查询结果存入一级缓存。
3.2 二级缓存
二级缓存是跨 SqlSession 的缓存,可以被多个 SqlSession 共享。MyBatis 支持自定义二级缓存,通过实现 org.apache.ibatis.cache.Cache 接口来实现。
常见问题解决指南
1. 映射文件中找不到对应的 SQL 映射
检查 Mapper 接口和 XML 映射文件是否正确,确保接口方法和 XML 映射文件中的 SQL 映射对应。
2. SQL 映射执行失败
检查 SQL 语句是否正确,确保数据库连接正常,检查数据源配置。
3. 映射文件中找不到对应的实体类
检查实体类路径是否正确,确保实体类与 XML 映射文件中的 resultType 或 resultMap 对应。
4. 映射文件中找不到对应的属性
检查实体类中是否存在对应的属性,确保属性名与 XML 映射文件中的 result 或 association 标签的 property 属性对应。
5. 映射文件中找不到对应的列
检查实体类中是否存在对应的属性,确保属性名与 XML 映射文件中的 result 或 association 标签的 column 属性对应。
总结
MyBatis 是一个功能强大、灵活的持久层框架,通过本文的介绍,相信读者已经对 MyBatis 有了一定的了解。在实际开发中,不断实践和总结,才能更好地掌握 MyBatis,提高开发效率。
