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

news2024/11/27 0:32:57

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

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

在这里插入图片描述

什么是 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文件示例如下：

<!-- UserMapper.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。

<!-- UserMapper.xml -->
<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文件的路径。

<!-- mybatis-config.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.";
        }
    }
}