MyBatis入门到精通——第二篇

第二篇：MyBatis基础配置与环境搭建

在第一篇文章中，我们了解了MyBatis的基本概念和优势。接下来，进入MyBatis的实际操作部分，这篇文章将详细讲解如何配置MyBatis，并演示如何与Spring Boot进行整合，为项目搭建一个基础的环境。

1. 引言：MyBatis的配置基础

• 回顾上篇内容：在第一篇文章中，我们已经看到了MyBatis是如何简化数据库操作的。本篇将从项目搭建的角度，带领你一步步完成MyBatis的配置。
• 为什么环境配置重要：配置文件是MyBatis的核心，合理的配置不仅能提高开发效率，还能避免潜在的性能问题。

2. 项目结构

• 创建一个基于Maven的Spring Boot项目，MyBatis可以通过其官方的Spring Boot Starter轻松与Spring Boot整合。
• 项目结构示例：

  ├── src
  │   ├── main
  │   │   ├── java
  │   │   │   └── com.example
  │   │   │       └── MyBatisApp.java
  │   │   ├── resources
  │   │   │   ├── application.yml
  │   │   │   └── mapper
  │   │   │       └── UserMapper.xml
  └── pom.xml
  

3. Maven依赖管理

• 首先，我们需要在pom.xml文件中添加相关的依赖，以便Spring Boot项目支持MyBatis。
• 依赖配置：

  <dependencies>
    <!-- Spring Boot基础依赖 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
    </dependency>
  
    <!-- MyBatis与Spring Boot集成 -->
    <dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>2.1.4</version>
    </dependency>
  
    <!-- MySQL数据库驱动 -->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <scope>runtime</scope>
    </dependency>
  
    <!-- 测试依赖 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>
  

4. 配置数据库连接信息

• MyBatis通过配置文件来管理与数据库的连接。我们可以使用Spring Boot的application.yml文件进行配置。

• application.yml配置：

  spring:
    datasource:
      url: jdbc:mysql://localhost:3306/mydb
      username: root
      password: password
      driver-class-name: com.mysql.cj.jdbc.Driver
  
  mybatis:
    mapper-locations: classpath:mapper/*.xml
    type-aliases-package: com.example.entity
  

• 配置解释：

  • spring.datasource: 配置数据库连接的URL、用户名和密码。
  • mybatis.mapper-locations: 指定Mapper XML文件的存放路径。
  • mybatis.type-aliases-package: 设置MyBatis实体类的包路径，方便后续自动映射。

5. 编写MyBatis配置文件

• MyBatis的核心配置文件是mybatis-config.xml，但当你使用Spring Boot与MyBatis整合时，很多全局配置可以通过Spring Boot的配置文件直接管理，简化了传统的mybatis-config.xml文件。因此，在此整合过程中，我们可以省去这个文件，只需要通过application.yml文件进行配置。

6. 创建实体类与Mapper接口

• 实体类：在项目中创建一个User实体类，用来表示数据库中的users表。

  package com.example.entity;
  
  public class User {
      private int id;
      private String name;
      private int age;
  
      // Getters and Setters
  }
  

• Mapper接口：在com.example.mapper包下创建一个接口UserMapper，定义数据库操作方法。

  package com.example.mapper;
  
  import com.example.entity.User;
  import org.apache.ibatis.annotations.Mapper;
  import org.apache.ibatis.annotations.Select;
  
  @Mapper
  public interface UserMapper {
      @Select("SELECT * FROM users WHERE id = #{id}")
      User getUserById(int id);
  }
  

• Mapper解释：

  • 使用@Mapper注解标记这个接口为MyBatis的Mapper接口。
  • 使用@Select注解编写SQL语句，可以选择在Mapper XML文件中管理SQL，也可以在接口上通过注解直接定义SQL。

7. 编写Mapper XML文件

虽然可以通过注解编写SQL，但对于复杂查询，我们推荐使用XML文件进行管理。接下来展示如何编写一个XML文件与Mapper接口配合使用。

• 创建UserMapper.xml：在resources/mapper目录下创建UserMapper.xml，并定义SQL查询。

  <mapper namespace="com.example.mapper.UserMapper">
    <select id="getUserById" resultType="com.example.entity.User">
      SELECT id, name, age FROM users WHERE id = #{id}
    </select>
  </mapper>
  

• 解释：

  • namespace：对应UserMapper接口。
  • resultType：定义SQL查询的返回类型，指定为User实体类。
  • #{id}：通过占位符将参数传递给SQL语句，MyBatis自动处理参数绑定。

8. Spring Boot启动类

• 在com.example包下创建启动类MyBatisApp.java，这是Spring Boot项目的入口，带有@SpringBootApplication注解。

  package com.example;
  
  import org.springframework.boot.SpringApplication;
  import org.springframework.boot.autoconfigure.SpringBootApplication;
  
  @SpringBootApplication
  public class MyBatisApp {
      public static void main(String[] args) {
          SpringApplication.run(MyBatisApp.class, args);
      }
  }
  

9. 测试你的配置

• 测试用例：为了验证我们的配置是否正确，编写一个简单的测试类，通过Spring Boot的测试框架来验证MyBatis与数据库的连接。

  package com.example;
  
  import com.example.entity.User;
  import com.example.mapper.UserMapper;
  import org.junit.jupiter.api.Test;
  import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.boot.test.context.SpringBootTest;
  
  @SpringBootTest
  public class MyBatisAppTests {
      @Autowired
      private UserMapper userMapper;
  
      @Test
      public void testGetUserById() {
          User user = userMapper.getUserById(1);
          System.out.println(user.getName());
      }
  }
  

• 通过执行这个测试用例，我们可以验证UserMapper是否能够正确执行SQL语句并返回结果。如果配置正确，程序会输出数据库中ID为1的用户的名称。

10. 总结与展望

• 总结：通过本篇文章，我们完成了一个基本的Spring Boot与MyBatis集成项目，配置了数据库连接，并实现了一个简单的数据库查询操作。在实际项目中，MyBatis的配置文件可以更加复杂，比如配置缓存、分页插件等功能，在后续文章中，我们将逐步深入探讨这些高级功能。

• 预告下一篇文章：下一篇文章将会介绍MyBatis的CRUD操作以及动态SQL的使用，帮助你更加灵活地操作数据库。