MyBatis-注解方式

最新推荐文章于 2025-06-24 10:26:02 发布

Flying_Fish_Xuan

最新推荐文章于 2025-06-24 10:26:02 发布

阅读量1.2k

点赞数 9

CC 4.0 BY-SA版权

文章标签： mybatis spring java

本文链接：https://blog.csdn.net/Flying_Fish_roe/article/details/142448856

MyBatis 注解方式详解

MyBatis 是一个流行的 Java 数据持久化框架，它提供了简洁的方式将 SQL 语句与 Java 对象进行映射。除了常规的 XML 配置方式外，MyBatis 还支持注解方式来简化 SQL 配置。这种方式允许开发者直接在接口或类上使用注解，避免冗长的 XML 配置。

1. MyBatis 注解方式简介

MyBatis 注解方式是指通过 Java 注解的形式在接口上编写 SQL 语句，替代传统的 XML 映射文件。注解方式具有简洁、高效的特点，适合于简单的 SQL 查询和更新操作。

常用的注解包括：

@Select：执行查询操作。
@Insert：执行插入操作。
@Update：执行更新操作。
@Delete：执行删除操作。
@Results：用于指定复杂的字段映射。
@ResultMap：用于重用映射配置。

2. 环境配置

在项目中使用 MyBatis 注解方式需要以下步骤：

2.1 添加 Maven 依赖

首先，在 Spring Boot 项目中引入 MyBatis 依赖：

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

2.2 配置数据库连接

在 application.yml 文件中配置数据库连接信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver
  mybatis:
    type-aliases-package: com.example.demo.model

type-aliases-package 用于简化结果映射时的类名，指定模型类所在的包。

3. 基本注解使用

下面是一个简单的示例，演示如何使用 MyBatis 注解方式进行数据库操作。

3.1 创建实体类

假设有一个 User 实体类，表示数据库中的 user 表：

public class User {
    private Integer id;
    private String username;
    private String email;

    // Getters and setters
}

3.2 创建 Mapper 接口

UserMapper 接口用于定义与 user 表交互的操作。在这里使用注解的方式定义 SQL 查询。

import org.apache.ibatis.annotations.*;

import java.util.List;

@Mapper
public interface UserMapper {

    @Select("SELECT * FROM user WHERE id = #{id}")
    User getUserById(@Param("id") Integer id);

    @Select("SELECT * FROM user")
    List<User> getAllUsers();

    @Insert("INSERT INTO user (username, email) VALUES (#{username}, #{email})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    void insertUser(User user);

    @Update("UPDATE user SET username = #{username}, email = #{email} WHERE id = #{id}")
    void updateUser(User user);

    @Delete("DELETE FROM user WHERE id = #{id}")
    void deleteUser(@Param("id") Integer id);
}

@Select：用于执行查询操作。
@Param：用于将方法参数映射到 SQL 语句中的占位符。
@Insert：用于执行插入操作，@Options 注解的 useGeneratedKeys 属性用于获取自增主键。
@Update 和 @Delete：分别用于更新和删除操作。

3.3 测试 Mapper

通过 Spring 的依赖注入来调用 UserMapper 接口，执行数据库操作。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/users")
public class UserController {

    @Autowired
    private UserMapper userMapper;

    @GetMapping("/{id}")
    public User getUserById(@PathVariable Integer id) {
        return userMapper.getUserById(id);
    }

    @GetMapping
    public List<User> getAllUsers() {
        return userMapper.getAllUsers();
    }

    @PostMapping
    public void createUser(@RequestBody User user) {
        userMapper.insertUser(user);
    }

    @PutMapping("/{id}")
    public void updateUser(@PathVariable Integer id, @RequestBody User user) {
        user.setId(id);
        userMapper.updateUser(user);
    }

    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable Integer id) {
        userMapper.deleteUser(id);
    }
}

4. 复杂映射与注解

对于较为复杂的查询操作，MyBatis 注解方式也能很好地处理结果映射。可以使用 @Results 和 @Result 注解来自定义字段映射，解决字段名和实体类属性名不一致的问题。

4.1 自定义字段映射

假设 user 表的字段与 User 类的属性不完全一致，例如表中的 user_name 字段对应 User 类的 username 属性。

@Mapper
public interface UserMapper {

    @Select("SELECT id, user_name, email FROM user WHERE id = #{id}")
    @Results({
        @Result(property = "id", column = "id"),
        @Result(property = "username", column = "user_name"),
        @Result(property = "email", column = "email")
    })
    User getUserById(@Param("id") Integer id);
}

@Results：用于定义结果集的映射。
@Result：定义字段到属性的映射关系，property 表示实体类的属性，column 表示数据库表的列。

4.2 嵌套结果映射

当查询涉及多表关联时，可以使用嵌套结果映射将子查询的结果映射到关联对象。

例如，User 类中包含 Address 对象，user 表和 address 表通过 address_id 关联。

public class Address {
    private Integer id;
    private String street;
    private String city;

    // Getters and setters
}

public class User {
    private Integer id;
    private String username;
    private String email;
    private Address address;

    // Getters and setters
}

Mapper 接口中使用嵌套结果映射：

@Mapper
public interface UserMapper {

    @Select("SELECT u.id, u.username, u.email, a.id AS address_id, a.street, a.city " +
            "FROM user u LEFT JOIN address a ON u.address_id = a.id WHERE u.id = #{id}")
    @Results({
        @Result(property = "id", column = "id"),
        @Result(property = "username", column = "username"),
        @Result(property = "email", column = "email"),
        @Result(property = "address.id", column = "address_id"),
        @Result(property = "address.street", column = "street"),
        @Result(property = "address.city", column = "city")
    })
    User getUserWithAddress(@Param("id") Integer id);
}

在此例中，address 对象的属性通过嵌套映射被填充，结果集中的 address_id、street 和 city 列分别映射到 Address 类的 id、street 和 city 属性。

5. MyBatis 注解的优缺点

5.1 优点

简洁：注解方式省去了 XML 映射文件的冗余配置，对于简单的 SQL 语句，注解更直接。
高效：注解可以直接与 Java 代码集成，避免了 XML 和 Java 之间的切换，简化了开发流程。
可维护性好：由于注解与接口绑定，改动接口的同时可以很直观地看到对应的 SQL 改动，代码更加自描述。

5.2 缺点

复杂 SQL 不适合注解：对于复杂的查询、多表关联操作，注解的可读性和可维护性较差。此时还是推荐使用 XML 来定义 SQL 语句。
灵活性不足：与 XML 配置相比，注解方式难以支持动态 SQL 语句的灵活性，例如条件查询等较复杂的业务需求。

6. 总结

MyBatis 注解方式为开发者提供了一种简洁、高效的替代方案来定义 SQL 语句。通过使用 @Select、@Insert、@Update 和 @Delete 等注解，开发者可以直接在接口上定义 SQL 操作，避免 XML 配置的冗余。对于简单的 CRUD 操作，注解方式具有很大的优势，能够极大地提高开发效率。然而，对于复杂的 SQL 查询

或多表关联，注解方式的可读性和灵活性可能不足，此时更推荐使用 XML 配置来处理复杂场景。