MyBatisPlus--通用枚举

本文介绍如何使用MyBatisPlus简化MyBatis枚举属性配置,通过配置枚举扫描包,自动将枚举映射为字段值,反之亦然。演示了枚举类的实现方式及在实体类中的应用,包括插入数据和查询数据的过程。

通用枚举

MyBatisPlus解决了繁琐的配置,让MyBatis更优雅的适用枚举属性。

配置枚举类扫描包

# 配置枚举扫描包
mybatis-plus.type-enums-package=psers.zhang.demo.enums

枚举类(实现IEnum<T>)

public enum SexEnum implements IEnum<Integer> {

    MALE(1, "男"),
    FEMALE(0, "女");

    private int value;
    private String desc;

    SexEnum(int value, String desc) {
        this.value = value;
        this.desc = desc;
    }

    @Override
    public Integer getValue() {
        return this.value;
    }

    @Override
    public String toString() {
        return this.desc;
    }
}

表结构

在这里插入图片描述

实体类

@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("tb_user")
public class User extends Model<User> {

    //指定主键为自增
    @TableId(type = IdType.AUTO)
    private Long id;

    //指定数据表中字段名
    @TableField(value = "user_name")
    private String userName;

    @TableField(fill = FieldFill.INSERT)
    private String password;
    private String name;
    private Integer age;
    private String email;

    //逻辑删除字段: 0,未删除; 1,已删除
    @TableLogic //标记为逻辑删除字段
    private Integer deleted;


    //性别,枚举类型:1,男; 0,女
    private SexEnum sex;


    //指定该字段在表中是不存在的
    @TableField(exist = false)
    private String address;
}

测试

插入数据:自动将枚举映射为字段值

	@Test
    public void testInsert(){
        User user = new User();
        user.setEmail("123456@qq.com");
        user.setAge(18);
        user.setName("diaochan");
        user.setUserName("貂蝉");
        user.setPassword("123456");
        user.setSex(SexEnum.FEMALE);
        user.setDeleted(0);
        //返回受影响的行数
        int rows = userMapper.insert(user);
        System.out.println(rows);

        //获取自增长后的id值,MP会自动回填自增后的id
        System.out.println(user.getId());
    }

在这里插入图片描述

查询:自动将字段值映射为枚举值

@Test
    public void testSelectList(){
        List<User> users = userMapper.selectList(null);
        for (User u : users)
            System.out.println(u);
    }

控制台打印:

Execute SQL:
    SELECT
        id,
        user_name,
        password,
        name,
        age,
        email,
        deleted,
        sex 
    FROM
        tb_user 
    WHERE
        deleted=0

User(id=4, userName=zhaoliu, password=123456, name=赵六, age=48, email=test4@qq.com, deleted=0, sex=, address=null)
User(id=5, userName=小强, password=88888, name=xiaoqiang, age=30, email=123456@qq.com, deleted=0, sex=, address=null)
User(id=6, userName=貂蝉, password=123456, name=diaochan, age=18, email=123456@qq.com, deleted=0, sex=, address=null)

### MyBatis Plus 中使用通用枚举 #### 配置枚举包路径 为了使 MyBatis Plus 能够识别并处理项目中的自定义枚举类型,在 `application.yml` 文件中指定枚举类型的包位置。这允许框架自动扫描这些枚举类,并将其作为支持的数据类型来操作。 ```yaml mybatis-plus: type-enums-package: com.example.enums ``` 此处假设所有的枚举都位于 `com.example.enums` 包下[^4]。 #### 定义枚举类 创建一个简单的 Java 枚举类,该类代表性别选项: ```java public enum Gender { MALE, FEMALE; } ``` 此代码片段展示了如何声明一个基本的枚举类型[^3]。 #### 映射实体属性至数据库列 当设计数据模型时,可以在实体类中直接引用上述定义好的枚举类型。例如,对于学生表而言,可以这样设置其性别字段: ```java @Data @TableName("students") public class Student { private Long id; @TableField(value = "gender", fill = FieldFill.INSERT_UPDATE) private Gender gender; // other fields... } ``` 这里通过 `private Gender gender;` 将学生的性别信息关联到了之前定义过的 `Gender` 枚举上。 #### 自动转换机制 MyBatis Plus 提供了内置的功能来自动生成 SQL 查询语句以及完成对象关系映射(ORM)。这意味着一旦配置好之后,无需额外编写任何 XML 或者注解就能实现从数据库读取/写入枚举值的操作[^1]。 #### 处理 JSON 序列化问题 如果遇到将枚举传递给前端接口时报错的情况,则可能是因为默认情况下 Jackson 不知道该如何解析这些特殊的常量名称。可以通过调整 Spring Boot 的全局配置解决这个问题: ```java @Configuration public class WebConfig implements WebMvcConfigurer { @Bean public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() { return builder -> builder.featuresToEnable( SerializationFeature.WRITE_ENUMS_USING_TO_STRING); } } ``` 这段配置使得应用程序能够按照字符串形式输出枚举实例而不是原始的名字空间加点的形式[^5]。
评论 5
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值