轻松搞定SpringBoot + MybatisPlus使用枚举类型enum报错：No enum constant xxx

2023-10-31 18:20:46

在SpringBoot + MybatisPlus中使用枚举类型

在SpringBoot + MybatisPlus项目中，枚举类型是一种非常有用的工具，它允许我们用一组相关常量来表示有限值集合。本文将深入探讨如何使用枚举类型，解决常见问题，并提供通用枚举功能的详细信息。

枚举类型简介

枚举类型是一种特殊的类，它包含一组常量，这些常量代表一组相关的值。在Java中，枚举类型使用enum来定义。例如：

public enum Gender {
    MALE,
    FEMALE
}

这个枚举类型定义了两个常量：MALE和FEMALE，它们分别代表男性和女性。

在MybatisPlus中使用枚举类型

在MybatisPlus中，我们可以通过在实体类中使用@TableEnum注解来使用枚举类型。例如：

@Table(name = "user")
public class User {

    @TableId(type = IdType.AUTO)
    private Long id;

    @Column(name = "gender")
    @TableEnum(value = "gender", typeHandler = MybatisEnumTypeHandler.class)
    private Gender gender;

    // 省略其他代码
}

在这个例子中，我们在User类中定义了一个名为gender的字段，它的类型是Gender枚举类型。我们在该字段上使用了@TableEnum注解，其中value属性指定了该字段在数据库中的列名，typeHandler属性指定了类型处理器，它负责将枚举值与数据库中的值进行转换。

解决“No enum constant xxx”报错

在使用枚举类型时，可能会遇到“No enum constant xxx”的报错，这个报错通常是因为枚举类没有被正确加载到类路径中。解决这个问题的方法有两种：

1. 将枚举类放在类路径下

我们可以将枚举类放在项目的类路径下，这样就可以让MybatisPlus正确加载枚举类。类路径通常位于项目的根目录下，我们可以将枚举类放在src/main/java目录下。

2. 使用枚举扫描器

MybatisPlus提供了一个枚举扫描器，它可以自动扫描项目中的枚举类并将其加载到类路径中。我们可以通过在配置文件中配置枚举扫描器来使用它。

在application.yml文件中添加如下配置：

mybatis-plus:
  type-enums-package: com.example.demo.enums

在这个例子中，我们将扫描com.example.demo.enums包下的所有枚举类。

通用枚举

从MybatisPlus 3.5.2版本开始，引入了通用枚举功能。通用枚举功能不需要配置枚举扫描器，也不需要在实体类中使用@TableEnum注解，即可使用枚举类型。

要使用通用枚举功能，需要在实体类中使用@EnumValue注解来指定枚举值的列名。例如：

@Table(name = "user")
public class User {

    @TableId(type = IdType.AUTO)
    private Long id;

    @Column(name = "gender")
    @EnumValue(name = "gender")
    private Gender gender;

    // 省略其他代码
}

在这个例子中，我们在User类中定义了一个名为gender的字段，它的类型是Gender枚举类型。我们在该字段上使用了@EnumValue注解，其中name属性指定了该字段在数据库中的列名。

结论

在SpringBoot + MybatisPlus项目中使用枚举类型非常简单。我们可以使用@TableEnum注解或通用枚举功能来实现此目的。通过遵循本文中的步骤，我们可以轻松地在项目中使用枚举类型，并避免常见问题。

常见问题解答

1. 如何解决“No enum constant xxx”报错？

将枚举类放在类路径下或使用枚举扫描器来加载枚举类可以解决此问题。

2. 什么是通用枚举功能？

从MybatisPlus 3.5.2版本开始，引入的通用枚举功能不需要配置枚举扫描器，也不需要在实体类中使用@TableEnum注解，即可使用枚举类型。

3. 如何使用通用枚举功能？

在实体类中使用@EnumValue注解来指定枚举值的列名即可使用通用枚举功能。

4. 如何指定枚举类型在数据库中的列名？

使用@TableEnum注解的value属性或@EnumValue注解的name属性来指定枚举类型在数据库中的列名。