MyBatis 是一个优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java 对象)映射成数据库中的记录。
MyBatis 简介
MyBatis 遵循约定优于配置( Convention Over Configuration)的原则,这意味着大部分情况下,你可以不用写太多的配置代码,框架会自动为你完成一些常见的数据库操作。然而,当你需要定制一些高级功能时,MyBatis 也提供了灵活的配置方式。
安装 MyBatis
首先,你需要将 MyBatis 添加到你的项目中。如果你使用 Maven,可以在 pom.xml 文件中添加以下依赖:
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version> <!-- 使用最新版本 -->
</dependency>
<!-- 添加数据库连接池依赖,如 HikariCP -->
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>4.0.3</version>
</dependency>
<!-- 添加数据库驱动依赖,如 MySQL -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.26</version>
</dependency>
</dependencies>
配置 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="your_username"/>
<property name="password" value="your_password"/>
</dataSource>
</environment>
</environments>
<!-- 映射文件配置 -->
<mappers>
<mapper resource="com/example/mapper/UserMapper.xml"/>
</mappers>
</configuration>
编写 Mapper 接口
Mapper 接口定义了数据库操作的接口,你只需要定义方法的名字和参数类型,MyBatis 会根据你的 XML 映射文件自动生成对应的 SQL 语句。
package com.example.mapper;
import com.example.model.User;
public interface UserMapper {
User getUserById(int id);
int insertUser(User user);
int updateUser(User user);
int deleteUser(int id);
}
创建 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.model.User">
SELECT * FROM users WHERE id = #{id}
</select>
<insert id="insertUser">
INSERT INTO users (name, email) VALUES (#{name}, #{email})
</insert>
<update id="updateUser">
UPDATE users SET name = #{name}, email = #{email} WHERE id = #{id}
</update>
<delete id="deleteUser">
DELETE FROM users WHERE id = #{id}
</delete>
</mapper>
使用 MyBatis
最后,你可以通过以下方式使用 MyBatis:
package com.example.service;
import com.example.mapper.UserMapper;
import com.example.model.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
public class UserService {
private final SqlSessionFactory sqlSessionFactory;
public UserService() {
sqlSessionFactory = new SqlSessionFactoryBuilder().build(
Resources.getResourceAsStream("mybatis-config.xml")
);
}
public User getUserById(int id) {
try (SqlSession session = sqlSessionFactory.openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
return mapper.getUserById(id);
}
}
}
以上就是一个简单的 MyBatis 入门示例。通过阅读本文,你应该对 MyBatis 有了一个基本的了解,并能够将其应用到你的项目中。随着你对其功能的深入了解,你将能够利用 MyBatis 提供的强大功能来提高你的数据访问效率。
