新闻中心

mybatis 教程

发布时间：2024-11-03 08:41:21 点击量：24

MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射关系，极大地简化了数据库交互操作。对于 Java 开发者而言，MyBatis 提供了一种灵活易用的方式来管理应用程序的数据库连接。以下是 MyBatis 的详细教程，以帮助您全面了解和使用这款工具。

1. MyBatis 简介

MyBatis 最早是作为 Apache 的 iBatis 项目发展而来，2010 年起步发展为 MyBatis。其主要目的是帮助开发者更好地进行 SQL 查询的管理和数据库持久化。与 Hibernate 等 ORM 工具不同，MyBatis 允许开发者编写自己需要的 SQL 查询代码，使得操作更加精确和高效。它的核心功能包括：

SQL 映射：MyBatis 通过 XML 文件或注解定义动态 SQL 查询语句。
ORM 功能：支持 POJO 映射，提供一定程度的对象-关系映射功能。
自动映射：允许结果集自动映射到对象属性，无需开发者手动设置。

2. MyBatis 环境搭建

要使用 MyBatis，首先需要将其集成到项目中。通常情况下，MyBatis 作为一个第三方库，需要添加到项目的构建路径中。

2.1 添加依赖

如果您使用 Maven 构建工具，可以在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.9</version>
</dependency>

另外，如果您使用其他工具，如 Gradle，请使用相应的语法进行依赖管理。

2.2 配置文件

MyBatis 使用 XML 文件进行全局配置。通常，我们创建一个名为 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.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mydb"/>
                <property name="username" value="root"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mappers/UserMapper.xml"/>
    </mappers>
</configuration>

3. 基础使用

3.1 创建数据库模型

假设我们有一个简单的用户表，结构如下：

CREATE TABLE users (
    id INT PRIMARY KEY AUTO_INCREMENT,
    username VARCHAR(50),
    email VARCHAR(50)
);

对应的 Java POJO 类可以这样定义：

public class User {
    private Integer id;
    private String username;
    private String email;

    // Getters and Setters
    // ...
}

3.2 编写 Mapper 接口和 XML

Mapper 接口与 SQL 映射文件是 MyBatis 的核心组成部分。首先，我们定义一个 UserMapper 接口：

public interface UserMapper {
    User selectUser(int id);
    List<User> selectAllUsers();
    void insertUser(User user);
    void updateUser(User user);
    void deleteUser(int id);
}

接下来，我们创建对应的 XML 文件 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.mappers.UserMapper">
    <select id="selectUser" parameterType="int" resultType="com.example.models.User">
        SELECT * FROM users WHERE id = #{id}
    </select>

    <select id="selectAllUsers" resultType="com.example.models.User">
        SELECT * FROM users
    </select>

    <insert id="insertUser" parameterType="com.example.models.User">
        INSERT INTO users (username, email) VALUES (#{username}, #{email})
    </insert>

    <update id="updateUser" parameterType="com.example.models.User">
        UPDATE users SET username = #{username}, email = #{email} WHERE id = #{id}
    </update>

    <delete id="deleteUser" parameterType="int">
        DELETE FROM users WHERE id = #{id}
    </delete>
</mapper>

4. 使用 SqlSession 访问数据库

MyBatis 提供 SqlSession 对象来执行映射器中的 SQL 操作。典型的使用步骤包括获取会话、执行 SQL 操作以及关闭会话：

public class MyBatisExample {
    public static void main(String[] args) {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);

            // Insert a new user
            User newUser = new User();
            newUser.setUsername("john");
            newUser.setEmail("john@example.com");
            mapper.insertUser(newUser);

            // Select user by ID
            User user = mapper.selectUser(1);
            System.out.println(user.getUsername());

            // Update the user
            user.setEmail("john_updated@example.com");
            mapper.updateUser(user);

            // Delete the user
            mapper.deleteUser(1);

            session.commit();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

5. 高级特性

MyBatis 还提供了一些高级特性，如动态 SQL、一级和二级缓存、懒加载和插件机制等。这些特性使得 MyBatis 不仅灵活，而且功能强大。

动态 SQL

MyBatis 的动态 SQL 是其最强大的特性之一，允许在 XML 中使用一些标签来生成动态的 SQL 语句，例如 <if>, <choose>, <trim>, <foreach> 等。

<select id="findActiveBlogLike" resultType="Blog">
  SELECT * FROM blog WHERE state = ‘ACTIVE’
  <if test="title != null">
    AND title like #{title}
  </if>
  <if test="author != null and author.name != null">
    AND author_name like #{author.name}
  </if>
</select>