MyBatis 是一个优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
MyBatis 简介
MyBatis 遵循约定优于配置( Convention Over Configuration)的原则,这意味着大多数情况下,你不需要显式地配置 SQL 映射文件,MyBatis 会根据约定来生成相应的 SQL 语句。这使得 MyBatis 非常易于上手。
MyBatis 的核心组件
- SqlSessionFactory:MyBatis 的核心接口,用于创建 SqlSession 对象。
- SqlSession:用于执行 SQL 语句,是 MyBatis 的核心对象。
- Executor:MyBatis 的执行器,负责执行 SQL 语句。
- MappedStatement:MyBatis 的映射语句,包含了 SQL 语句和参数映射信息。
- SqlSource:MyBatis 的 SQL 源,用于生成 SQL 语句。
快速上手
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. 配置 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/example/mapper/UserMapper.xml"/>
</mappers>
</configuration>
3. 创建 Mapper 接口和 XML 映射文件
接下来,你需要创建一个 Mapper 接口和对应的 XML 映射文件。以下是一个简单的示例:
UserMapper.java
package com.example.mapper;
import com.example.entity.User;
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.entity.User">
SELECT * FROM user WHERE id = #{id}
</select>
</mapper>
4. 使用 MyBatis
最后,你可以使用 MyBatis 来执行 SQL 语句。以下是一个简单的示例:
public class Main {
public static void main(String[] args) {
SqlSessionFactory sqlSessionFactory = MyBatisUtil.getSqlSessionFactory();
try (SqlSession session = sqlSessionFactory.openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
User user = mapper.getUserById(1);
System.out.println(user);
}
}
}
实战技巧
1. 使用注解替代 XML
MyBatis 支持使用注解来替代 XML 映射文件。以下是一个使用注解的示例:
UserMapper.java
package com.example.mapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Result;
import org.apache.ibatis.annotations.Results;
public interface UserMapper {
@Select("SELECT * FROM user WHERE id = #{id}")
@Results({
@Result(property = "id", column = "id"),
@Result(property = "name", column = "name"),
@Result(property = "age", column = "age")
})
User getUserById(int id);
}
2. 使用动态 SQL
MyBatis 支持使用动态 SQL 来构建复杂的 SQL 语句。以下是一个使用动态 SQL 的示例:
UserMapper.java
package com.example.mapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.SelectProvider;
import org.apache.ibatis.jdbc.SQL;
public interface UserMapper {
@SelectProvider(type = SqlProvider.class, method = "getUserByCondition")
User getUserByCondition(@Param("name") String name, @Param("age") int age);
class SqlProvider {
public String getUserByCondition(@Param("name") String name, @Param("age") int age) {
return new SQL() {{
SELECT("*");
FROM("user");
if (name != null) {
WHERE("name = #{name}");
}
if (age != null) {
WHERE("age = #{age}");
}
}}.toString();
}
}
}
3. 使用缓存
MyBatis 支持使用一级缓存和二级缓存来提高性能。以下是一个使用一级缓存的示例:
UserMapper.java
package com.example.mapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.CacheNamespace;
import org.apache.ibatis.annotations.Select;
@CacheNamespace(eviction = CacheEviction.FIFO, flushInterval = 60000, size = 512, readWrite = true)
public interface UserMapper {
@Select("SELECT * FROM user WHERE id = #{id}")
User getUserById(int id);
}
总结
MyBatis 是一个功能强大的持久层框架,它可以帮助你轻松地完成数据库操作。通过本文的介绍,你应该已经掌握了 MyBatis 的基本用法和实战技巧。希望这些内容能够帮助你更好地使用 MyBatis。
