MyBatis 是一款优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
MyBatis 快速入门
1. 环境搭建
首先,你需要准备以下环境:
- Java 开发工具包(JDK)
- Maven 或 Gradle(用于依赖管理)
- 数据库(如 MySQL)
- MyBatis 框架
在 Maven 项目中,你可以在 pom.xml 文件中添加以下依赖:
<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.23</version>
</dependency>
</dependencies>
2. 配置文件
MyBatis 使用配置文件来管理数据库连接、事务和映射文件。在 src/main/resources 目录下创建 mybatis-config.xml 文件,配置数据库连接信息:
<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/your_database"/>
<property name="username" value="root"/>
<property name="password" value="your_password"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/example/mapper/UserMapper.xml"/>
</mappers>
</configuration>
3. 映射文件
在 src/main/resources 目录下创建 UserMapper.xml 文件,定义 SQL 语句和结果映射:
<mapper namespace="com.example.mapper.UserMapper">
<select id="selectById" resultType="com.example.entity.User">
SELECT * FROM user WHERE id = #{id}
</select>
</mapper>
4. 接口定义
在 com.example.mapper 包下创建 UserMapper.java 接口:
package com.example.mapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.Select;
public interface UserMapper {
User selectById(int id);
}
5. 使用 MyBatis
在 Java 代码中,你可以通过 SqlSessionFactoryBuilder 创建 SqlSessionFactory,然后通过 SqlSessionFactory 获取 SqlSession,最后使用 SqlSession 执行 SQL 语句:
public class Main {
public static void main(String[] args) {
try (SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(new FileInputStream("src/main/resources/mybatis-config.xml"))) {
try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = userMapper.selectById(1);
System.out.println(user);
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
MyBatis 实战技巧
1. 使用注解替代 XML
MyBatis 支持使用注解来替代 XML 映射文件。在 UserMapper.java 接口中,你可以使用 @Select 注解来替代 UserMapper.xml 文件:
package com.example.mapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.Select;
public interface UserMapper {
@Select("SELECT * FROM user WHERE id = #{id}")
User selectById(int id);
}
2. 使用动态 SQL
MyBatis 支持使用动态 SQL 来构建复杂的 SQL 语句。在 UserMapper.xml 文件中,你可以使用 <if>、<choose>、<when> 和 <otherwise> 等标签来动态构建 SQL 语句:
<mapper namespace="com.example.mapper.UserMapper">
<select id="selectByCondition" resultType="com.example.entity.User">
SELECT * FROM user
<where>
<if test="id != null">
AND id = #{id}
</if>
<if test="name != null">
AND name = #{name}
</if>
</where>
</select>
</mapper>
3. 使用缓存
MyBatis 支持一级缓存和二级缓存。一级缓存默认开启,用于同一个 SqlSession 中查询结果的重用。二级缓存用于跨 SqlSession 的数据共享。
在 mybatis-config.xml 文件中,你可以配置二级缓存:
<settings>
<setting name="cacheEnabled" value="true"/>
</settings>
在 UserMapper.xml 文件中,你可以为 selectById 方法添加缓存:
<mapper namespace="com.example.mapper.UserMapper">
<select id="selectById" resultType="com.example.entity.User" useCache="true">
SELECT * FROM user WHERE id = #{id}
</select>
</mapper>
4. 使用插件
MyBatis 支持使用插件来自定义行为。例如,你可以使用插件来实现日志记录、分页等功能。
在 mybatis-config.xml 文件中,你可以添加插件:
<plugins>
<plugin interceptor="com.example.plugin.MyInterceptor"/>
</plugins>
在 MyInterceptor.java 文件中,你可以实现 Interceptor 接口:
package com.example.plugin;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;
import java.sql.Connection;
import java.util.Properties;
@Intercepts({
@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})
})
public class MyInterceptor implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
// 实现自定义行为
return invocation.proceed();
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
// 设置插件属性
}
}
总结
MyBatis 是一款功能强大的持久层框架,可以帮助你简化数据库操作。通过本文的介绍,你应该已经掌握了 MyBatis 的基本使用方法,包括环境搭建、配置文件、映射文件、接口定义和使用技巧。在实际项目中,你可以根据需求灵活运用 MyBatis 的各种功能,提高开发效率。
