正文

手把手教你入门MyBatis：从原理到实战，开源框架高效使用指南

/0 浏览量
0331

引言

MyBatis 是一个优秀的持久层框架，它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射，将接口和 Java 的 POJOs（Plain Old Java Objects，普通的 Java 对象）映射成数据库中的记录。本文将带你从 MyBatis 的原理开始，逐步深入到实战应用，让你高效地使用这个开源框架。

MyBatis 基础

1. MyBatis 简介

MyBatis 是一个半自动化的持久层框架，它允许你将 SQL 语句映射到 Java 接口和方法上。这样，你就可以通过简单的 Java 代码来操作数据库，而不需要编写复杂的 JDBC 代码。

2. MyBatis 核心组件

  • SqlSessionFactory：用于创建 SqlSession 的工厂类。
  • SqlSession：用于执行 SQL 语句的会话接口。
  • Executor：MyBatis 的执行器，负责执行 SQL 语句。
  • MappedStatement：表示一个映射语句，包含了 SQL 语句和参数映射等信息。
  • SqlSource：表示 SQL 语句的来源，可以是 XML 文件、注解或内联 SQL。

MyBatis 原理

1. MyBatis 加载配置

MyBatis 加载配置的过程如下：

  1. 加载 MyBatis 配置文件（如 mybatis-config.xml）。
  2. 解析配置文件，创建 SqlSessionFactory。
  3. 通过 SqlSessionFactory 创建 SqlSession。

2. MyBatis 执行 SQL 语句

MyBatis 执行 SQL 语句的过程如下：

  1. 通过 SqlSession 创建 Executor。
  2. Executor 根据MappedStatement 执行 SQL 语句。
  3. 将执行结果映射到 Java 对象。

MyBatis 实战

1. 创建 MyBatis 项目

首先，你需要创建一个 MyBatis 项目。以下是一个简单的项目结构：

mybatis-example
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── example
│   │   │           └── MyBatisExample.java
│   │   ├── resources
│   │   │   └── mybatis-config.xml
│   │   └── mapper
│   │       └── UserMapper.xml
│   └── test
│       ├── java
│       │   └── com
│       │       └── example
│       │           └── MyBatisExampleTest.java
│       └── resources
│           └── application.properties
└── pom.xml

2. 编写 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.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/mybatis_example"/>
        <property name="username" value="root"/>
        <property name="password" value=""/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="mapper/UserMapper.xml"/>
  </mappers>
</configuration>

3. 编写 Mapper 接口

在 src/main/java/com/example 目录下创建 UserMapper.java 接口，定义 SQL 语句对应的 Java 方法。

package com.example;

public interface UserMapper {
  User getUserById(int id);
}

4. 编写 Mapper XML 文件

在 src/main/resources/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.UserMapper">
  <select id="getUserById" resultType="com.example.User">
    SELECT * FROM user WHERE id = #{id}
  </select>
</mapper>

5. 编写测试类

在 src/test/java/com/example 目录下创建 MyBatisExampleTest.java 测试类，测试 MyBatis 的功能。

package com.example;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;

public class MyBatisExampleTest {
  @Test
  public void testGetUserById() {
    try (SqlSession session = getSqlSessionFactory().openSession()) {
      UserMapper mapper = session.getMapper(UserMapper.class);
      User user = mapper.getUserById(1);
      System.out.println(user);
    }
  }

  private SqlSessionFactory getSqlSessionFactory() {
    String resource = "mybatis-config.xml";
    try {
      return new SqlSessionFactoryBuilder().build(Resources.getResourceAsInputStream(resource));
    } catch (IOException e) {
      throw new RuntimeException("Error building sqlSessionFactory", e);
    }
  }
}

总结

通过本文的学习，你应该已经掌握了 MyBatis 的基本原理和实战应用。MyBatis 是一个功能强大、易于使用的持久层框架，可以帮助你高效地操作数据库。希望本文能帮助你更好地理解 MyBatis，并在实际项目中发挥其优势。

-- 展开阅读全文 --