MybatisPlus中@EnumValue注解使用及应用场景

 更新时间:2025年10月23日 09:53:17   作者:小猿、  
@EnumValue注解标记在枚举类型的字段上,表示该字段是枚举值在数据库中存储的实际值,这对于枚举的持久化是关键,确保枚举在数据库中的表示与Java枚举类的一致性,下面就来详细的介绍一下@EnumValue注解如何使用,感兴趣的可以了解一下

@EnumValue注解详细介绍

功能概述

  • @EnumValue注解标记在枚举类型的字段上,表示该字段是枚举值在数据库中存储的实际值。这对于枚举的持久化是关键,确保枚举在数据库中的表示与Java枚举类的一致性。

主要用途

  • 字段指定:指定枚举类中哪个字段将用于数据库存储。例如,如果一个枚举包含多个字段(如代码和描述),你可以使用@EnumValue指定哪个字段代表实际的存储值。
  • 数据转换:帮助MybatisPlus自动处理枚举与数据库存储值之间的转换,简化持久化逻辑。

应用场景

  • 当数据库中的某个字段需要存储枚举类型的值(如状态码、类型标识符)时,使用@EnumValue来明确该字段。
  • 使枚举值与数据库中的实际存储值相对应,有助于代码的清晰和一致性。

示例代码及其解读

import com.baomidou.mybatisplus.annotation.EnumValue;

public enum Status {
    @EnumValue
    ACTIVE(1, "Active"),
    INACTIVE(0, "Inactive");

    private final int code;
    private final String description;

    Status(int code, String description) {
        this.code = code;
        this.description = description;
    }

    public int getCode() {
        return code;
    }

    public String getDescription() {
        return description;
    }

    public static Status fromCode(int code) {
        for (Status status : values()) {
            if (status.code == code) {
                return status;
            }
        }
        throw new IllegalArgumentException("Unknown code: " + code);
    }
}

详细解释

  • 字段声明code字段上使用了@EnumValue注解,指示该字段是用于数据库存储的实际值。
  • 构造函数:枚举的构造函数接收codedescription,分别用于数据库存储值和描述。
  • fromCode方法:根据存储的code值查找对应的枚举实例,简化从数据库值到枚举对象的转换。

MybatisPlus配置

  • MybatisPlus会在映射时自动识别@EnumValue注解,并将枚举的存储字段用于数据库操作,而不是枚举名称。

配置实体类

假设我们有一个名为 User 的实体类,其中一个字段使用了 Status 枚举类型。

实体类示例

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import lombok.Data;

@Data
@TableName("user") // 指定数据库表名
public class User extends Model<User> {

    @TableId // 指定主键字段
    private Long id;

    @TableField("username")
    private String username;

    @TableField("status")
    private Status status; // 使用枚举类型字段

    // 其他字段和方法...
}

配置说明:

  1. @TableName

    • 用于指定数据库中的表名。这个注解是可选的,如果实体类名与表名相同,可以省略。
  2. @TableId

    • 标记主键字段。可以指定主键策略(如自增、UUID等),但这在使用 @EnumValue 时并不直接相关。
  3. @TableField

    • 用于指定数据库表中的字段名。默认情况下,字段名与数据库列名相同,但你可以通过这个注解来显式指定。
  4. Status status

    • 这是枚举类型字段。MyBatis-Plus 会根据 @EnumValue 注解来处理这个字段的数据库存储。

使用@EnumValue注解能有效管理枚举在数据库中的持久化,使得枚举类型的存储和读取更加一致和清晰。

到此这篇关于MybatisPlus中@EnumValue注解使用及应用场景的文章就介绍到这了,更多相关MybatisPlus @EnumValue注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:

相关文章

  • Java Web实现登录页面验证码验证功能

    Java Web实现登录页面验证码验证功能

    这篇文章主要介绍了Java Web登录页面验证码验证功能,本文通过实例代码给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-12-12
  • Java利用Easyexcel导出excel表格的示例代码

    Java利用Easyexcel导出excel表格的示例代码

    这篇文章主要为大家详细介绍了Java利用Easyexcel导出excel表格的示例代码,文中的代码讲解详细,感兴趣的小伙伴可以跟随小编一起了解一下
    2022-07-07
  • Java那点事——StringBuffer与StringBuilder原理与区别

    Java那点事——StringBuffer与StringBuilder原理与区别

    本文给大家分享StringBuffer与StringBuilder的区别,它们的应用场景是什么?非常不错,面试考官经常考的一个问题,有需要的朋友跟着脚本之家小编一起学习吧
    2016-06-06
  • Java kafka如何实现自定义分区类和拦截器

    Java kafka如何实现自定义分区类和拦截器

    这篇文章主要介绍了Java kafka如何实现自定义分区类和拦截器,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • 在Spring中如何注入动态代理Bean

    在Spring中如何注入动态代理Bean

    这篇文章主要介绍了在Spring中如何注入动态代理Bean问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-03-03
  • 解决poi导出excel无法打开文件的问题

    解决poi导出excel无法打开文件的问题

    这篇文章主要介绍了解决poi导出excel无法打开文件的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • SpringBoot事务使用及回滚实现代码详解

    SpringBoot事务使用及回滚实现代码详解

    这篇文章主要介绍了SpringBoot事务使用及回滚实现代码详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08
  • 详解Java中两种分页遍历的使用姿势

    详解Java中两种分页遍历的使用姿势

    这篇文章主要介绍了详解Java中两种分页遍历的使用姿势,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • Spring Boot 整合 Fisco Bcos部署、调用区块链合约的案例

    Spring Boot 整合 Fisco Bcos部署、调用区块链合约的案例

    本篇文章介绍 Spring Boot 整合 Fisco Bcos 的相关技术,最最重要的技术点,部署、调用区块链合约的工程案例,本文通过流程分析给大家介绍的非常详细,需要的朋友参考下吧
    2022-01-01
  • SpringBoot利用Redis实现防止订单重复提交的解决方案

    SpringBoot利用Redis实现防止订单重复提交的解决方案

    在涉及订单操作的业务中,防止订单重复提交是一个常见需求,用户可能会因误操作或网络延迟而多次点击提交订单按钮,导致订单重复提交,所以本文给大家介绍了SpringBoot利用Redis实现防止订单重复提交的解决方案,需要的朋友可以参考下
    2024-10-10

最新评论