MyBatis快速入门

2023-06-18

字数统计: 1.9k字 | 阅读时长: 9分

前言

攒一个MyBatis快速入门，MP用的多，但对于MyBatis还不够了解，学习之。

写了两个Demo，分别是不用框架和用Spring。

介绍

MyBatis 是一款持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO为数据库中的记录。

下面以两个示例演示如何构建基于MyBatis的应用。

数据准备

假设有一个学生表（students），包含以下字段：

id (主键，自增)
name (学生姓名)
age (学生年龄)
grade (学生年级)

// author: SilenceZheng66

CREATE TABLE students (
  id INT PRIMARY KEY AUTO_INCREMENT,
  name VARCHAR(100),
  age INT,
  grade VARCHAR(50)
);

INSERT INTO students (name, age, grade) VALUES
  ('Alice', 18, 'Grade 10'),
  ('Bob', 17, 'Grade 11'),
  ('Charlie', 16, 'Grade 9');

1、不用框架构建基于MyBatis的应用

1. 安装MyBatis

下载MyBatis的jar包并放置于类路径中。此外还需要mysql-connector-java。

2. 编写MyBatis配置文件 mybatis-config.xml

当使用MyBatis框架时，如果将配置文件命名为mybatis-config.xml，那么MyBatis会默认去加载这个文件作为配置文件。否则需要在代码中显式指定配置文件的名称，通过SqlSessionFactoryBuilder的build方法。

<?xml version="1.0" encoding="UTF-8"?>
<!-- XML 文件的声明部分，指定了 XML 的版本和编码方式。 -->

<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd"> 
<!-- DTD（文档类型定义）声明，指定了 MyBatis 配置文件的格式和规范。 -->

<configuration>
<!-- 根元素，表示 MyBatis 的配置文件的起始点。 -->
  <environments default="development">
  <!-- 定义了环境配置，其中 default 属性指定了默认的环境。 -->
    <environment id="development">
    <!-- 定义了一个环境，其中 id 属性指定了环境的唯一标识。 -->
      <transactionManager type="JDBC" />
      <!-- 指定事务管理器的类型为 JDBC，表示使用 JDBC 进行事务管理。 -->
      <dataSource type="POOLED">
      <!-- 指定数据源的类型为 POOLED，表示使用连接池管理数据库连接。MyBatis框架内部包含一个简单的连接池实现。 -->
        <property name="driver" value="com.mysql.cj.jdbc.Driver" />
        <!-- 设置数据库驱动的类名。 -->
        <property name="url" value="jdbc:mysql://localhost:3306/mydatabase" />
        <!-- 设置数据库的 URL。 -->
        <property name="username" value="myuser" />
        <property name="password" value="mypassword" />
      </dataSource>
    </environment>
  </environments>
  <mappers>
  <!-- 定义一个或多个映射器（Mapper）配置。 -->
    <mapper resource="StudentMapper.xml" />
    <!-- 指定了映射器配置文件的路径，其中 resource 属性值为相对于配置文件的路径。 -->
  </mappers>
</configuration>

3. 编写映射文件 StudentMapper.xml

简单的查找。注意配置文件通常放在resources目录下，例如src/main/resources。

<?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="mybatis.simple.StudentMapper">
    <select id="getAllStudents" resultType="mybatis.simple.Student">
        SELECT * FROM students
    </select>
</mapper>

4. 编写实体类 Student.java

用了一下Lombok，也加进类路径就可以了。

// author: SilenceZheng66
package mybatis.simple;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
    private int id;
    private String name;
    private int age;
    private String grade;

    @Override
    public String toString() {
        return "Student [id=" + id + ", name=" + name + ", age=" + age + ", grade=" + grade + "]";
    }
}

5. 编写数据访问接口 StudentMapper

// author: SilenceZheng66
package mybatis.simple;

import java.util.List;

public interface StudentMapper {
    List<Student> getAllStudents();
}

6. 编写数据访问接口实现类

// author: SilenceZheng66
package mybatis.simple;

import java.util.List;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

public class StudentMapperImpl implements StudentMapper {
    private final SqlSessionFactory sqlSessionFactory;

    public StudentMapperImpl(SqlSessionFactory sqlSessionFactory) {
        this.sqlSessionFactory = sqlSessionFactory;
    }

    @Override
    public List<Student> getAllStudents() {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            StudentMapper mapper = session.getMapper(StudentMapper.class);
            return mapper.getAllStudents();
        }
    }
}

7. 编写主程序

package mybatis.simple;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class Main {
  public static void main(String[] args) throws IOException {
    // 加载 MyBatis 配置文件
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

    // 创建 StudentMapper 对象
    StudentMapper studentMapper = new StudentMapperImpl(sqlSessionFactory);

    // 调用方法获取所有学生信息
    List<Student> students = studentMapper.getAllStudents();

    // 打印学生信息
    for (Student student : students) {
      System.out.println(student);
    }
  }
}


输出：
Student [id=1, name=Alice, age=18, grade=Grade 10]
Student [id=2, name=Bob, age=17, grade=Grade 11]
Student [id=3, name=Charlie, age=16, grade=Grade 9]

2、用Spring Boot构建基于MyBatis的应用

从一个空Maven项目开始。

1. 引入依赖

<dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>8.0.28</version>
    </dependency>

    <dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>2.2.2</version>
    </dependency>

    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.24</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

2. 在 application.properties 配置数据库

spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
spring.datasource.username=myuser
spring.datasource.password=mypassword

mybatis.mapper-locations=classpath*:/mapper/*.xml

3. 创建实体类

// author: SilenceZheng66
package slz.mybatis.spring.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
    private int id;
    private String name;
    private int age;
    private String grade;

    @Override
    public String toString() {
        return "Student [id=" + id + ", name=" + name + ", age=" + age + ", grade=" + grade + "]";
    }
}

4. 创建 Mapper 接口和对应的 XML 映射文件。

// author: SilenceZheng66
package slz.mybatis.spring.mapper;

import slz.mybatis.spring.entity.Student;
import java.util.List;

public interface StudentMapper {
    List<Student> getAllStudents();
}

XML映射文件放置在resources下的mapper目录中。

<?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="slz.mybatis.spring.mapper.StudentMapper">
    <select id="getAllStudents" resultType="slz.mybatis.spring.entity.Student">
        SELECT * FROM students
    </select>
</mapper>

5. 编写服务类

// author: SilenceZheng66
package slz.mybatis.spring.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import slz.mybatis.spring.entity.Student;
import slz.mybatis.spring.mapper.StudentMapper;
import java.util.List;

@Service
public class StudentService {
    private final StudentMapper studentMapper;

    @Autowired
    public StudentService(StudentMapper studentMapper) {
        this.studentMapper = studentMapper;
    }

    public List<Student> getAllStudents() {
        return studentMapper.getAllStudents();
    }
}

@Autowired表示需要通过自动装配的方式将 StudentMapper 对象注入到 StudentService 类中。

6. 编写控制器

// author: SilenceZheng66
package slz.mybatis.spring.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import slz.mybatis.spring.entity.Student;
import slz.mybatis.spring.service.StudentService;
import java.util.List;

@RestController
public class StudentController {
    private final StudentService studentService;

    @Autowired
    public StudentController(StudentService studentService) {
        this.studentService = studentService;
    }

    @GetMapping("/students")
    public List<Student> getAllStudents() {
        return studentService.getAllStudents();
    }
}

7. 编写入口类

// author: SilenceZheng66
package slz.mybatis.spring;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.autoconfigure.SpringBootApplication;


@SpringBootApplication
@MapperScan(basePackages = {"slz.mybatis.spring.mapper.**"})
public class SpringApplication {
    public static void main(String[] args) {
        org.springframework.boot.SpringApplication.run(SpringApplication.class, args);
    }
}

启动后访问：http://localhost:8080/students即可查看学生信息。

参考

[1] https://mybatis.org/mybatis-3/zh/getting-started.html
[2] https://www.liaoxuefeng.com/wiki/1252599548343744/1260466914339296

后记

通过mybatis-spring-boot-starter配置MyBatis比原版有了一些便利，例如通过注解指定Mapper类扫描路径自动注册、自动配置SqlSessionFactory、自动注入Mapper实例等。

首发于 silencezheng.top，转载请注明出处。

前言

介绍