MyBatis 是一款优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
MyBatis 简介
MyBatis 遵循约定优于配置的原则,使得开发者可以更加专注于业务逻辑的实现,而不是数据库操作。它通过XML或注解的方式配置SQL映射,将接口方法与SQL语句进行绑定,从而实现数据库的增删改查操作。
环境搭建
1. 添加依赖
在项目的 pom.xml 文件中添加以下依赖:
<dependencies>
<!-- MyBatis 依赖 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.7</version>
</dependency>
<!-- MySQL 驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.26</version>
</dependency>
<!-- 数据库连接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.6</version>
</dependency>
</dependencies>
2. 配置数据库
在 application.properties 文件中配置数据库连接信息:
# 数据库连接信息
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_example?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
3. 创建实体类
创建一个实体类 User,对应数据库中的 user 表:
public class User {
private Integer id;
private String name;
private String email;
// 省略 getter 和 setter 方法
}
MyBatis 配置
1. 创建 MyBatis 配置文件
在 src/main/resources 目录下创建 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/mybatis_example?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/example/mapper/UserMapper.xml"/>
</mappers>
</configuration>
2. 创建 Mapper 接口
在 com.example.mapper 包下创建 UserMapper 接口,定义数据库操作方法:
package com.example.mapper;
import com.example.entity.User;
public interface UserMapper {
User getUserById(Integer id);
List<User> getAllUsers();
int addUser(User user);
int updateUser(User user);
int deleteUser(Integer id);
}
3. 创建 Mapper 映射文件
在 src/main/resources/com/example/mapper 目录下创建 UserMapper.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>
<select id="getAllUsers" resultType="com.example.entity.User">
SELECT * FROM user
</select>
<insert id="addUser" parameterType="com.example.entity.User">
INSERT INTO user (name, email) VALUES (#{name}, #{email})
</insert>
<update id="updateUser" parameterType="com.example.entity.User">
UPDATE user SET name = #{name}, email = #{email} WHERE id = #{id}
</update>
<delete id="deleteUser" parameterType="int">
DELETE FROM user WHERE id = #{id}
</delete>
</mapper>
使用 MyBatis
1. 创建 MyBatis 会话工厂
在 com.example.mapper 包下创建 MyBatisUtil 类,用于创建 MyBatis 会话工厂:
package com.example.mapper;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
public class MyBatisUtil {
public static SqlSessionFactory getSqlSessionFactory() {
String resource = "mybatis-config.xml";
try {
return new SqlSessionFactoryBuilder().build(resource);
} catch (Exception e) {
throw new RuntimeException("Error building SqlSessionFactory", e);
}
}
}
2. 使用 MyBatis 操作数据库
在业务逻辑层,使用 MyBatis 会话工厂创建会话,并执行数据库操作:
package com.example.service;
import com.example.entity.User;
import com.example.mapper.UserMapper;
import org.apache.ibatis.session.SqlSession;
public class UserService {
public User getUserById(Integer id) {
try (SqlSession session = MyBatisUtil.getSqlSessionFactory().openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
return mapper.getUserById(id);
}
}
public List<User> getAllUsers() {
try (SqlSession session = MyBatisUtil.getSqlSessionFactory().openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
return mapper.getAllUsers();
}
}
public int addUser(User user) {
try (SqlSession session = MyBatisUtil.getSqlSessionFactory().openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
int result = mapper.addUser(user);
session.commit();
return result;
}
}
public int updateUser(User user) {
try (SqlSession session = MyBatisUtil.getSqlSessionFactory().openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
int result = mapper.updateUser(user);
session.commit();
return result;
}
}
public int deleteUser(Integer id) {
try (SqlSession session = MyBatisUtil.getSqlSessionFactory().openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
int result = mapper.deleteUser(id);
session.commit();
return result;
}
}
}
通过以上步骤,您已经成功入门 MyBatis,并掌握了 SQL 映射与数据库交互技巧。在实际项目中,您可以根据需求进行扩展和优化。祝您学习愉快!
