MyBatis 是一个流行的Java持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 通过简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects)映射成数据库中的记录。
MyBatis 快速上手指南
1. 环境搭建
1.1 确定开发环境
在开始之前,请确保你的开发环境已经安装了Java和Maven。Maven 是一个项目管理工具,它可以帮助我们管理项目依赖。
1.2 创建Maven项目
使用IDE(如IntelliJ IDEA或Eclipse)创建一个新的Maven项目。
1.3 添加依赖
在项目的pom.xml文件中添加以下依赖:
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.7</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.26</version>
</dependency>
</dependencies>
2. 配置MyBatis
2.1 创建SqlSessionFactory
在resources目录下创建一个名为mybatis-config.xml的文件,配置SqlSessionFactory。
<?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.2 创建SqlSession
在应用程序中,你可以使用SqlSessionFactoryBuilder来创建SqlSession。
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream("mybatis-config.xml"));
SqlSession sqlSession = sqlSessionFactory.openSession();
3. 创建映射文件
在com/example/mapper目录下创建一个名为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="selectById" resultType="com.example.entity.User">
SELECT * FROM user WHERE id = #{id}
</select>
</mapper>
4. 创建Mapper接口
在com/example/mapper目录下创建一个名为UserMapper.java的文件,定义Mapper接口。
package com.example.mapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.Select;
public interface UserMapper {
User selectById(Long id);
}
5. 使用MyBatis
public class Main {
public static void main(String[] args) {
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream("mybatis-config.xml"));
SqlSession sqlSession = sqlSessionFactory.openSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = userMapper.selectById(1L);
System.out.println(user);
sqlSession.close();
}
}
MyBatis 实用技巧
1. 使用注解代替XML映射
MyBatis 允许你使用注解来替代XML映射。下面是一个使用注解的例子:
@Mapper
public interface UserMapper {
@Select("SELECT * FROM user WHERE id = #{id}")
User selectById(Long id);
}
2. 使用缓存
MyBatis 支持两种类型的缓存:一级缓存和二级缓存。
- 一级缓存:SqlSession级别的缓存,默认开启。
- 二级缓存:Mapper级别的缓存,需要手动开启。
3. 使用动态SQL
MyBatis 支持动态SQL,可以让你在运行时构建SQL语句。
<select id="selectUsers" resultType="User">
SELECT * FROM users
<where>
<if test="name != null">
AND name = #{name}
</if>
<if test="age != null">
AND age = #{age}
</if>
</where>
</select>
4. 使用插件
MyBatis 支持插件,可以让你扩展其功能。例如,你可以使用插件来实现日志记录或性能分析。
@Intercepts({
@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})
})
public class MyPlugin implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
// 实现你的逻辑
return invocation.proceed();
}
}
5. 使用自定义类型处理器
MyBatis 支持自定义类型处理器,可以让你将Java类型转换为数据库类型。
@Alias("date")
public class LocalDateTypeHandler extends BaseTypeHandler<LocalDate> {
@Override
public void setNonNullParameter(PreparedStatement ps, int i, LocalDate parameter, JdbcType jdbcType) throws SQLException {
// 实现你的逻辑
}
@Override
public LocalDate getNullableResult(ResultSet rs, String columnName) throws SQLException {
// 实现你的逻辑
return null;
}
@Override
public LocalDate getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
// 实现你的逻辑
return null;
}
@Override
public LocalDate getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
// 实现你的逻辑
return null;
}
}
希望这个指南能帮助你快速上手MyBatis。祝你学习愉快!
