MyBatis 是一款优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
下面,我们将从零开始,逐步深入探讨 MyBatis 的使用,包括其配置、映射文件的编写、动态 SQL 以及如何将其应用到实际项目中。
一、MyBatis 简介
1.1 MyBatis 的优势
- 简化数据库操作:通过减少对 JDBC 的直接操作,提高了开发效率。
- 灵活的映射规则:可以灵活地映射 Java 对象到数据库表,以及表字段到 Java 对象属性。
- 支持自定义 SQL:可以自定义复杂的 SQL 语句,如存储过程、触发器等。
- 插件扩展:MyBatis 提供了插件机制,可以扩展其功能。
1.2 MyBatis 的使用场景
- 中小型项目:由于 MyBatis 的轻量级特性,非常适合中小型项目。
- 对性能要求不高的项目:MyBatis 在性能上可能不如一些成熟的框架,但对于大多数中小型项目来说,性能已经足够。
- 需要自定义 SQL 的项目:MyBatis 支持自定义 SQL,适合需要复杂查询的场景。
二、MyBatis 的基本配置
2.1 环境搭建
首先,需要在项目中引入 MyBatis 的依赖。以下是一个简单的 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 配置文件
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">
<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/mydb"/>
<property name="username" value="root"/>
<property name="password" value=""/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/myproject/mapper/UserMapper.xml"/>
</mappers>
</configuration>
2.3 映射文件
映射文件定义了 SQL 语句与 Java 对象之间的映射关系。以下是一个简单的示例:
<?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.myproject.mapper.UserMapper">
<select id="selectById" resultType="com.myproject.entity.User">
SELECT * FROM user WHERE id = #{id}
</select>
</mapper>
三、MyBatis 动态 SQL
MyBatis 提供了丰富的动态 SQL 功能,可以灵活地构建 SQL 语句。
3.1 if 标签
<select id="selectUsers" resultType="User">
SELECT * FROM users
<where>
<if test="name != null">
AND name = #{name}
</if>
<if test="email != null">
AND email = #{email}
</if>
</where>
</select>
3.2 choose 标签
<select id="selectUsers" resultType="User">
SELECT * FROM users
<where>
<choose>
<when test="name != null">
name = #{name}
</when>
<when test="email != null">
email = #{email}
</when>
<otherwise>
1=1
</otherwise>
</choose>
</where>
</select>
3.3 foreach 标签
<select id="selectUsers" resultType="User">
SELECT * FROM users
<where>
<if test="ids != null">
id IN
<foreach item="id" collection="ids" open="(" separator="," close=")">
#{id}
</foreach>
</if>
</where>
</select>
四、MyBatis 实战项目解析
4.1 项目结构
以下是一个简单的 MyBatis 项目结构示例:
src/
|-- main/
| |-- java/
| | |-- com/
| | | |-- myproject/
| | | | |-- entity/
| | | | | |-- User.java
| | | | |-- mapper/
| | | | | |-- UserMapper.java
| | | | |-- service/
| | | | | |-- UserService.java
| |-- resources/
| | |-- mybatis-config.xml
| | |-- mapper/
| | | |-- UserMapper.xml
| |-- webapp/
| |-- WEB-INF/
| |-- web.xml
|-- test/
| |-- java/
| |-- resources/
|-- pom.xml
4.2 用户实体类
package com.myproject.entity;
public class User {
private Integer id;
private String name;
private String email;
// 省略getter和setter方法
}
4.3 用户 Mapper 接口
package com.myproject.mapper;
public interface UserMapper {
User selectById(Integer id);
}
4.4 用户 Mapper 映射文件
<?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.myproject.mapper.UserMapper">
<select id="selectById" resultType="com.myproject.entity.User">
SELECT * FROM user WHERE id = #{id}
</select>
</mapper>
4.5 用户服务类
package com.myproject.service;
public class UserService {
private final UserMapper userMapper;
public UserService(UserMapper userMapper) {
this.userMapper = userMapper;
}
public User getUserById(Integer id) {
return userMapper.selectById(id);
}
}
五、MyBatis 技巧分享
5.1 使用注解替代 XML 映射
MyBatis 支持使用注解替代 XML 映射,这样可以提高开发效率。
package com.myproject.mapper;
import com.myproject.entity.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
@Mapper
public interface UserMapper {
@Select("SELECT * FROM user WHERE id = #{id}")
User selectById(Integer id);
}
5.2 使用 MyBatis Generator 自动生成代码
MyBatis Generator 是一个代码生成器,可以自动生成实体类、Mapper 接口和 XML 映射文件。
5.3 使用 MyBatis 插件
MyBatis 提供了插件机制,可以扩展其功能。例如,可以创建一个插件来打印 SQL 语句。
六、总结
本文从零开始,详细介绍了 MyBatis 的基本概念、配置、动态 SQL 以及如何将其应用到实际项目中。通过本文的学习,相信你已经对 MyBatis 有了一个全面的认识。希望你在实际项目中能够灵活运用 MyBatis,提高开发效率。
