MyBatis-Plus3 Enum使用

注重版权，若要转载烦请附上作者和链接

作者：Joshua_yi

链接：https://blog.csdn.net/weixin_44984664/article/details/122282769

---

一、说明

官方文档
通用枚举

里面有一句话
自3.1.0开始，如果你无需使用原生枚举，可配置默认枚举来省略扫描通用枚举配置 默认枚举配置

这里面如果直接扫描枚举配置会直接报错!!!

# 这两个是一样的
#  typeEnumsPackage: com.fuwu.test.enumerate
  type-enums-package: com.fuwu.test.enumerate

正确配置如下

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 查看日志
    map-underscore-to-camel-case: true
    # 自mybatis3.1.0开始，如果你无需使用原生枚举，可配置默认枚举来省略扫描通用枚举配置 默认枚举配置
    default-enum-type-handler: org.apache.ibatis.type.EnumOrdinalTypeHandler

二、代码

（一）Enum类

package com.fuwu.test.enumerate;

import com.baomidou.mybatisplus.annotation.EnumValue;
import com.fasterxml.jackson.annotation.JsonValue;
import lombok.Getter;

import java.util.HashMap;
import java.util.Map;


public enum LiveStatusEnum {
    /**
     * 还未开始
     */
    NOT_START(0, "live not start", "未开始"),
    IN_LIVING(1, "in living", "正在直播");
    /**
     * 对应的值
     */
    @EnumValue
    @Getter
    private final int value;

    /**
     * 具体的描述
     */
    private final String des;
    /**
     * 用户提示
     */
    private final String userHint;

    LiveStatusEnum(int value, String description, String userHint) {
        this.value = value;
        this.des = description;
        this.userHint = userHint;
    }
    
    public static LiveStatusEnum valueOf(int value) throws Exception {
        switch (value) {
            case 0: {
                return LiveStatusEnum.NOT_START;
            }
            case 1: {
                return LiveStatusEnum.IN_LIVING;
            }
            default: {
                throw new Exception("illegal value");
            }
        }
    }


    /**
     * 获取实体的信息Map格式
     * 用于前端展示
     * @return 实体信息
     */
    @JsonValue
    public Map<String, Object> getInfoMap() {
        Map<String, Object> res = new HashMap<>(3);
        res.put("value", this.value);
        res.put("des", this.des);
        res.put("userHint", this.userHint);
        return res;
    }
}

（二）实体类

package com.fuwu.test.entity;

import com.alibaba.fastjson.annotation.JSONField;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.fasterxml.jackson.annotation.JsonValue;
import com.fuwu.test.enumerate.LiveStatusEnum;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;
import lombok.experimental.Tolerate;
import org.apache.ibatis.type.JdbcType;

import java.io.Serializable;
import java.math.BigDecimal;
import java.sql.JDBCType;
import java.sql.Timestamp;

/**
 * 直播列表
 *
 * @TableName live
 */
@Builder
@Data
@EqualsAndHashCode(callSuper = false)
@ApiModel(description = "直播实体类")
@Accessors(chain = true)
public class Live implements Serializable {
    private static final long serialVersionUID = -25015338142691271L;

    @Tolerate
    public Live() {
    }

    /**
     * 直播记录ID
     */
    @TableId(value = "id_live", type = IdType.ASSIGN_ID)
    private Long idLive;

    /**
     * 直播标题
     */
    private String liveTitle;
    /**
     * 直播状态，0为未开始，1为直播中
     */
    @ApiModelProperty("直播状态，0为未开始，1为直播中")
    @TableField(value = "live_status")
    private LiveStatusEnum liveStatus;
    /**
     * 是否开始录播，0不开启录播，1开启录播
     */
}

（三）controller

package com.fuwu.test.controller;

import com.fasterxml.jackson.databind.SerializationFeature;
import com.fuwu.core.format.response.ResultBody;
import com.fuwu.test.entity.Live;
import com.fuwu.test.enumerate.LiveStatusEnum;
import com.fuwu.test.mapper.LiveMapper;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;


@Validated
@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
    @GetMapping("hello")
    public String hello() {
        return "Hello World";
   }

    @Resource
    private LiveMapper liveMapper;

    @GetMapping("test1")
    public ResultBody test1(Long id) {
        Live live = liveMapper.selectById(id);
        System.out.println(live);
        return ResultBody.success(live);
    }

    @GetMapping("test2")
    public ResultBody test2() {
        Live live = new Live().setLiveTitle("hhhhhhhhhh").setLiveStatus(LiveStatusEnum.IN_LIVING);
        liveMapper.insert(live);
        return ResultBody.success(live);
    }
}

（四）结果

插入

查询