MyBatisPlus快速入门（四）MyBatisPlus的常用注解

比眉伴天荒 2024-02-17 11:16 72阅读 0赞

> **作者主页**：[Designer 小郑][Designer]  
> **作者简介**：Java全栈软件工程师一枚，来自浙江宁波，负责开发管理公司OA项目，专注软件前后端开发、系统定制、远程技术指导。CSDN学院、蓝桥云课认证讲师，全栈领域优质创作者。

![在这里插入图片描述][5e3f690c22ae4a978272677ebcdcd6f3.png_pic_center]

#### 目录 ####

*  一、MyBatisPlus 常用注解
 *  二、@TableName 用法
 *  三、@TableId 用法
 *  四、@TableField 用法
 *  五、@Version 用法
 *  六、@EnumValue 用法
 *  七、@TableLogic 用法
 *  八、@Insert、@Update、@Delete、@Select 用法

## 一、MyBatisPlus 常用注解 ##

**MyBatis-Plus 是一个基于MyBatis的增强工具库**，提供了许多便捷的功能和注解来简化开发过程，比如下面是 MyBatis-Plus 常用的注解。

1.  **@TableName**：用于指定实体类对应的数据库表名，可以在实体类的类级别上使用。
2.  **@TableId**：用于标识实体类的主键属性，可以在实体类的主键字段上使用。可以指定主键策略、自增等属性。
3.  **@TableField**：用于标识实体类的非主键字段，可以在实体类的属性上使用。可以指定字段名、是否为数据库表字段、字段策略等属性。
4.  **@Version**：用于标识乐观锁字段，可以在实体类的属性上使用。用于在并发更新时保证数据的一致性。
5.  **@EnumValue**：用于标识枚举类的值字段，可以在枚举类的属性上使用。用于将枚举值映射到数据库存储的值。
6.  **@TableLogic**：用于标识逻辑删除字段，可以在实体类的属性上使用。用于标记数据是否已被逻辑删除。
7.  **@Insert、@Update、@Delete、@Select**：用于标识Mapper接口中的SQL语句，可以在Mapper接口的方法上使用。用于执行相应的SQL操作。

在下面的章节中，将逐个详细介绍。

![在这里插入图片描述][01e27027f8484c71a59d2fa2de99e84b.png_pic_center]

## 二、@TableName 用法 ##

@TableName 注解在 MyBatis-Plus 中用于指定实体类对应的数据库表名。它可以在实体类的类级别上使用。

import com.baomidou.mybatisplus.annotation.TableName;
    
    @TableName("user") // 指定数据库表名为"user"
    public class User {
        
        private Long id;
        private String username;
        private String password;
        
        // 省略getter和setter方法
    }

使用 `@TableName` 注解指定了User实体类对应的数据库表名为 `user`。

这样在使用 MyBatis-Plus 的增删改查操作时，就会默认使用 `user` 作为表名。

如果实体类的类名与数据库表名一致，可以省略 @TableName 注解，MyBatis-Plus 会默认将实体类名转换为小写作为表名。

public class User {
        
        private Long id;
        private String username;
        private String password;
        
        // 省略getter和setter方法
    }

User实体类没有使用@TableName注解，MyBatis-Plus会默认将类名"User"转换为小写，作为数据库表名，即默认表名为"user"。

需要注意的是，@TableName 注解只是用于指定数据库表名，并不会自动创建表结构。表结构的创建还是需要根据数据库的规则进行相应的操作。

通过使用 @TableName 注解，我们可以灵活地指定实体类对应的数据库表名，方便与数据库进行交互。

## 三、@TableId 用法 ##

@TableId注解用于标识实体类中的主键字段，使用@TableId注解，需要在实体类中标记主键字段，例如：

public class User {
        
        @TableId(type = IdType.AUTO) // 标识为自增主键
        private Long id;
        
        // 其他字段...
        
        // getter和setter方法...
    }

在 Mapper 接口中，使用 @TableId 注解指定对应的数据库字段名，例如：

public interface UserMapper extends BaseMapper<User> {
        
        @Select("SELECT * FROM user WHERE id = #{id}")
        User selectUserById(@Param("id") Long id);
    }

@TableId 注解的 type 属性指定了主键生成策略，`IdType.AUTO` 表示使用数据库自增主键。

@TableId 注解和 BaseMapper 接口配合使用，可以实现 MyBatis Plus 的各种数据库操作功能。

## 四、@TableField 用法 ##

@TableField注解是MyBatisPlus中的一个注解，用于标识实体类中的字段与数据库表中的字段的映射关系。

在实体类中标记字段，例如：

public class User {
        
        @TableField("user_name")
        private String username;
        // 其他字段...
        // getter和setter方法...
    }

在上述代码中，@TableField 注解的 `value`属性指定了对应的数据库字段名，这里使用了"user\_name"作为数据库表中字段的名称。

在Mapper接口中，可以根据 @TableField 注解的属性进行查询、更新等操作，例如：

public interface UserMapper extends BaseMapper<User> {
        
        @Select("SELECT * FROM user WHERE user_name = #{username}")
        User selectUserByUsername(@Param("username") String username);
    }

@TableField 注解的 `value` 属性指定了对应的数据库字段名，这里使用了 `user_name` 作为数据库表中字段的名称。

使用 @TableField 注解可以简化实体类字段与数据库表字段的映射关系，提高开发效率。

![在这里插入图片描述][1bd46ff5fbee4a149102c8a1ed9b68fd.png_pic_center]

## 五、@Version 用法 ##

@Version 注解用于实现乐观锁功能，用于标识一个字段作为乐观锁版本号字段。

在实体类中标记乐观锁版本号字段，例如：

public class User {
        
        @Version
        private Integer version;
        // 其他字段...
        // getter和setter方法...
    }

在上述代码中，@Version 注解标记了 `version` 字段为乐观锁版本号字段。

在Mapper接口中进行更新操作时，MyBatis-Plus 会自动处理乐观锁。

public interface UserMapper extends BaseMapper<User> {
        
        @Update("UPDATE user SET name = #{name} WHERE id = #{id} AND version = #{version}")
        int updateWithVersion(@Param("name") String name, @Param("id") Long id, @Param("version") Integer version);
    }

在上述代码中，@Update 注解中的 `version = #{version}` 条件会自动根据 `version` 字段的值进行乐观锁判断，只有版本号匹配才会执行更新操作。

使用 @Version 注解可以实现乐观锁功能，**用于解决并发更新数据时的数据一致性问题**。

## 六、@EnumValue 用法 ##

@EnumValue 注解用于实体类中枚举字段的映射。使用 @EnumValue 注解，需要在实体类中定义枚举字段。

public class User {
        
        @EnumValue
        private Gender gender;
        //其他字段...
        //getter和setter方法...
    }
    
    public enum Gender {
        
        MALE(1, "男"),
        FEMALE(2, "女");
    
        private int code;
        private String description;
    
        Gender(int code, String description) {
        
            this.code = code;
            this.description = description;
        }
        //getter方法...
    }

在上述代码中，@EnumValue 注解标记了 gender 字段，用于将数据库中的字段值映射为枚举类型。

然后，在 Mapper 接口中进行查询操作时，MyBatis-Plus 会自动处理枚举字段的映射，例如：

public interface UserMapper extends BaseMapper<User> {
        
        @Select("SELECT * FROM user WHERE gender = #{gender}")
        List<User> selectByGender(@Param("gender") Gender gender);
    }

在上述代码中，通过 `#{gender}` 参数来查询gender字段，MyBatis-Plus 会自动将枚举类型的参数转换为对应的数据库字段值。

使用 @EnumValue 注解可以方便地进行枚举字段的映射，提高开发效率。

## 七、@TableLogic 用法 ##

@TableLogic 注解用于逻辑删除的字段映射，使用@TableLogic注解，请同学们首先在实体类中定义逻辑删除字段，代码如下。

public class User {
        
        @TableLogic
        private Integer deleted;
        // 其他字段...
        // getter和setter方法...
    }

在上述代码中，@TableLogic 注解标记了 `deleted` 字段，用于表示逻辑删除的状态。

在Mapper接口中进行查询操作时，MyBatis-Plus 会自动处理逻辑删除的字段，代码如下。

public interface UserMapper extends BaseMapper<User> {
        
        @Select("SELECT * FROM user WHERE deleted = 0")
        List<User> selectActiveUsers();
    }

在上述代码中，通过查询deleted字段的值来筛选出未被逻辑删除的数据。

使用 @TableLogic 注解可以方便地实现逻辑删除功能，提高开发效率。

## 八、@Insert、@Update、@Delete、@Select 用法 ##

MyBatisPlus提供了@Insert、@Update、@Delete和@Select这几个注解，用于在Mapper接口中定义对应的SQL操作。

**@Insert 注解用于定义插入操作的SQL语句**，代码如下。

@Mapper
    public interface UserMapper extends BaseMapper<User> {
        
    
        @Insert("INSERT INTO user (id, name, age) VALUES (#{id}, #{name}, #{age})")
        int insertUser(User user);
    }

**@Update注解用于定义更新操作的SQL语句**，代码如下。

@Mapper
    public interface UserMapper extends BaseMapper<User> {
        
    
        @Update("UPDATE user SET name = #{name}, age = #{age} WHERE id = #{id}")
        int updateUser(User user);
    }

**@Delete注解用于定义删除操作的SQL语句**，代码如下。

@Mapper
    public interface UserMapper extends BaseMapper<User> {
        
    
        @Delete("DELETE FROM user WHERE id = #{id}")
        int deleteUserById(Long id);
    }

**@Select 注解用于定义查询操作的 SQL 语句**，代码如下。

@Mapper
    public interface UserMapper extends BaseMapper<User> {
        
    
        @Select("SELECT * FROM user WHERE id = #{id}")
        User selectUserById(Long id);
    }

我们可以直接在Mapper接口的方法上使用对应的注解来定义 SQL 语句，使用 `#{}` 进行参数的占位，MyBatis-Plus 会根据注解中定义的 SQL 语句自动生成对应的 SQL 执行操作。

![在这里插入图片描述][3a01dc60e62c415b812015851343f1c0.png_pic_center]

[Designer]: https://blog.csdn.net/qq_41464123
[5e3f690c22ae4a978272677ebcdcd6f3.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/6ac39a9b0142418a9a8b4a7a6e679820.png
[01e27027f8484c71a59d2fa2de99e84b.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/05cd011ab4d64d709e7ec4956d4cc440.png
[1bd46ff5fbee4a149102c8a1ed9b68fd.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/d83ab9adb2404c8fb3471d8de4b7cc88.png
[3a01dc60e62c415b812015851343f1c0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/f1d9a48ac21b43e5865d5f65c9e261a1.png