MyBatis 映射文件（Mapper XML）：配置与使用

逃离我推掉我的手 2023-10-16 16:41 176阅读 0赞

## MyBatis 映射文件（Mapper XML）：配置与使用 ##

MyBatis是一个强大的Java持久化框架，它允许您将SQL查询、插入、更新和删除等操作与Java方法进行映射。这种映射是通过MyBatis的映射文件，通常称为Mapper XML文件来实现的。本文将深入探讨什么是MyBatis的映射文件以及如何配置和使用它们。

![在这里插入图片描述][098cebee2b424685af6fe6dac8e35d10.png]

### 什么是 MyBatis 映射文件？ ###

MyBatis的映射文件（Mapper XML文件）是用于定义SQL语句和Java方法之间映射关系的XML配置文件。这些文件提供了以下功能：

*  **定义 SQL 查询和操作：** 在Mapper XML文件中，您可以定义SQL查询、插入、更新、删除等操作。这些SQL语句可以包含参数和结果映射。
 *  **参数映射：** 您可以在Mapper XML文件中指定如何映射方法的参数到SQL语句中的参数。这通常使用`#{}`占位符完成。
 *  **结果映射：** 您可以定义如何将SQL查询的结果映射到Java对象中。这通常使用`<result>`元素来完成。
 *  **命名空间：** 每个Mapper XML文件都有一个唯一的命名空间，用于标识这个Mapper的作用域。Mapper接口通常与Mapper XML文件的命名空间相对应。
 *  **动态 SQL：** Mapper XML文件还支持动态SQL，使您能够根据条件生成不同的SQL查询。

一个简单的Mapper XML文件示例如下：

<mapper namespace="com.example.mapper.UserMapper">
        <select id="getUserById" resultType="com.example.model.User">
            SELECT * FROM users WHERE id = #{id}
        </select>
    </mapper>

在上述示例中，我们定义了一个名为`getUserById`的查询操作，它将根据`id`参数查询用户，并将结果映射到`com.example.model.User`类型的对象中。

### 配置 MyBatis 映射文件 ###

要使用MyBatis的映射文件，您需要执行以下步骤：

#### 步骤 1：创建 Mapper XML 文件 ####

首先，创建一个Mapper XML文件，通常存放在项目的classpath下的一个目录中，例如`src/main/resources/mapper`。

<mapper namespace="com.example.mapper.UserMapper">
        
        <select id="getUserById" resultType="com.example.model.User">
            SELECT * FROM users WHERE id = #{id}
        </select>
    
        
        <insert id="insertUser" parameterType="com.example.model.User">
            INSERT INTO users (username, email) VALUES (#{username}, #{email})
        </insert>
    </mapper>

在上述示例中，我们定义了两个操作：`getUserById`和`insertUser`，分别用于查询用户和插入用户信息。

#### 步骤 2：配置 MyBatis ####

要使用Mapper XML文件，需要在MyBatis的配置文件中引入它们。MyBatis的配置文件通常是`mybatis-config.xml`，您需要在其中配置Mapper XML文件的路径。

<configuration>
        <mappers>
            <mapper resource="mapper/UserMapper.xml"/>
        </mappers>
    </configuration>

在上述配置中，我们使用`<mappers>`元素引入了Mapper XML文件，使用`<mapper>`元素的`resource`属性指定了XML文件的路径。

#### 步骤 3：创建 Mapper 接口 ####

通常情况下，会创建一个Java接口来定义SQL操作的方法，并使用注解来绑定Mapper XML文件中的SQL操作。

package com.example.mapper;
    
    import com.example.model.User;
    import org.apache.ibatis.annotations.Insert;
    import org.apache.ibatis.annotations.Select;
    
    public interface UserMapper {
        
    
        @Select("SELECT * FROM users WHERE id = #{id}")
        User getUserById(int id);
    
        @Insert("INSERT INTO users (username, email) VALUES (#{username}, #{email})")
        int insertUser(User user);
    }

在上述示例中，我们使用`@Select`和`@Insert`注解来绑定Mapper XML文件中的SQL操作。这使得您可以通过Java接口来调用这些操作。

#### 步骤 4：配置 MyBatis 数据源 ####

最后，您需要配置MyBatis的数据源和其他相关属性。这通常在Spring Boot的配置文件中完成。

# application.yml
    spring:
      datasource:
        url: jdbc:mysql://localhost:3306/mydb
        username: root
        password: your_password
        driver-class-name: com.mysql.cj.jdbc.Driver
      mybatis:
        config-location: classpath:mybatis-config.xml

在上述配置中，我们指定了数据库的连接信息，并通过`mybatis.config-location`属性指定了MyBatis的配置文件位置。

### 使用 MyBatis 映射文件 ###

现在，您可以使用MyBatis映射文件来执行数据库操作了。以下是一个简单的示例：

@RestController
    @RequestMapping("/users")
    public class UserController {
        
    
        private final UserMapper userMapper;
    
        @Autowired
        public UserController(UserMapper userMapper) {
        
            this.userMapper = userMapper;
        }
    
        @GetMapping("/{id}")
        public User getUser(@PathVariable int id) {
        
            return userMapper.getUserById(id);
        }
    
        @PostMapping("/")
        public String createUser(@RequestBody User user) {
        
            int rows = userMapper.insertUser(user);
            if (rows > 0) {
        
                return "User created successfully!";
            } else {
        
                return "User creation failed.";
            }
        }
    }

在上述代码中，我们创建了一个`UserController`，它注入了`UserMapper`。通过`getUser`方法可以根据用户ID查询用户信息，通过`createUser`方法可以插入新用户信息。

### 运行 MyBatis 映射文件示例 ###

现在，您可以运行应用程序并测试MyBatis映射文件的配置和使用。确保数据库连接信息正确，并通过REST API测试`/users/{id}`和`/users/`端点。

### 总结 ###

MyBatis的映射文件（

Mapper XML文件）是配置和管理SQL映射的关键部分。它们允许您将Java对象与数据库表之间的操作进行映射，从而实现了数据的持久化。通过创建Mapper XML文件、配置MyBatis、创建Mapper接口和使用注解，您可以轻松地进行数据库操作。

本文介绍了如何创建和配置MyBatis映射文件，以及如何使用它们执行数据库操作。希望这篇文章对您有所帮助，让您更好地理解MyBatis映射文件的概念和用法。 Happy coding！

[098cebee2b424685af6fe6dac8e35d10.png]: https://img-blog.csdnimg.cn/098cebee2b424685af6fe6dac8e35d10.png