MyBatis 是一个优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的过程。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
MyBatis 简介
MyBatis 允许你将 SQL 映射存储在 XML 文件中,或者直接在注解中,这样你就可以将 SQL 与 Java 代码分离。它支持自定义 SQL、存储过程以及高级映射。MyBatis 遵循约定优于配置的原则,使得其配置和操作变得非常简单。
环境搭建
1. 添加依赖
首先,在你的 pom.xml 文件中添加 MyBatis 的依赖:
<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. 配置数据源
在 application.properties 或 application.yml 文件中配置数据源:
# application.properties
spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
快速上手
1. 创建实体类
首先,创建一个实体类来表示数据库中的表:
public class User {
private Integer id;
private String name;
private String email;
// Getters and Setters
}
2. 创建 Mapper 接口
创建一个 Mapper 接口,定义你需要执行的方法:
public interface UserMapper {
User getUserById(Integer id);
void addUser(User user);
}
3. 创建 Mapper XML
在 src/main/resources/mapper 目录下创建一个 XML 文件,用于配置 SQL 映射:
<?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>
<insert id="addUser" parameterType="com.example.entity.User">
INSERT INTO user (name, email) VALUES (#{name}, #{email})
</insert>
</mapper>
4. 创建 SqlSessionFactory
在 applicationContext.xml 或使用注解的方式创建 SqlSessionFactory:
public class MyBatisUtil {
public static SqlSessionFactory getSqlSessionFactory() throws IOException {
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
return sqlSessionFactory;
}
}
5. 使用 MyBatis
在业务逻辑层,使用 MyBatis 执行数据库操作:
public class UserService {
private final SqlSessionFactory sqlSessionFactory = MyBatisUtil.getSqlSessionFactory();
public User getUserById(Integer id) {
try (SqlSession session = sqlSessionFactory.openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
return mapper.getUserById(id);
}
}
public void addUser(User user) {
try (SqlSession session = sqlSessionFactory.openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
mapper.addUser(user);
session.commit();
}
}
}
总结
通过以上步骤,你已经成功入门了 MyBatis。MyBatis 提供了丰富的功能和配置选项,你可以根据自己的需求进行扩展。希望这篇指南能帮助你快速上手 MyBatis,并轻松实现数据库操作。
