Skip to content

Latest commit

 

History

History
218 lines (193 loc) · 7.71 KB

README.md

File metadata and controls

218 lines (193 loc) · 7.71 KB
Raw

EasyEnum

Coverage Status GitHub code size in bytes GitHub GitHub last commit

重铸枚举荣光！！

功能

  • 简化枚举类定义（省略属性定义&get方法，提供大量实用的枚举转换工具）
  • Json序列化、反序列支持（Redis/MQ等需要json序列化的场景）
  • Spring开发支持（支持Post请求DTO/VO中使用枚举属性、支持Get请求方法出入参使用枚举、Feign调用支持枚举传输）
  • MyBatis开发支持（Entity中可直接用枚举属性在sql中自动转换成数值、MyBatisPlus中Wrapper支持直接使用枚举条件）
  • Dubbo传参支持（json协议完美支持，Hessian协议不推荐使用枚举传输）

快速上手

1. 创建枚举类

回想一下，以前我们每次创建枚举类都要定义属性、写get方法和一堆工具方法，代码非常重复。

而使用EasyEnum后，将枚举实现Dict接口，代码将简化成如下。

/**
 * 性别枚举示例
 */
public enum SexEnum implements Dict<Integer> {
    MALE(1, "男"),
    FEMALE(2, "女"),
    UNKNOWN(3, "未知");

    SexEnum(Integer code, String text) {
        // 一个init方法搞定，该方法来自Dict接口
        init(code, text);
    }
}

你没看错，原先的属性定义、get方法、工具方法全部省略，仅仅只需要在构造方法中调用init()方法即可。接着就能通过getCode()和getText()方法获取枚举的编码值和文本。

Integer code = SexEnum.MALE.getCode(); // 1
String text = SexEnum.MALE.getText(); // "男"

Dict的含义即为字典，拥有编码和文本两个固定属性，而在业务开发中定义的枚举大都是就是字典，所以抽象成接口，省略枚举类中重复代码。

2.使用枚举方法

Dict接口除了优化枚举申明，还提供了大量实用的api：

// 1、通过code获取text
String text = Dict.getTextByCode(SexEnum.class, 1); // "男"
// 2、通过text获取code
Integer code = Dict.getCodeByText(SexEnum.class, "男"); // 1
// 3、通过code获取枚举
SexEnum sex = Dict.getByCode(SexEnum.class, 1); // SexEnum.MALE

转换成字典项集合，常用于给前端下拉框展示使用

// 4、获取枚举的所有元素
List<DictBean> all = Dict.getAll(SexEnum.class); // [{code:1,text:"男"},{code:2,text:"女"},{code:3,text:"未知"}]
// 5、获取枚举的指定元素
List<DictBean> items = Dict.getItems(SexEnum.MALE, SexEnum.FEMALE); // [{code:1,text:"男"},{code:2,text:"女"}]
// 6、排除指定元素，获取其他元素
List<DictBean> items = Dict.getItemsExclude(SexEnum.UNKNOWN); // [{code:1,text:"男"},{code:2,text:"女"}]

上例中的DictBean是Dict的一个实现类，用于存储真正的枚举数据，DictBean定义如下：

public class DictBean implements Dict<Object> {
    /**
     * 字典code
     */
    private final Object code;
    /**
     * 字典text
     */
    private final String text;
    /**
     * 是否废弃
     */
    private final transient boolean isDeprecated;
    
}

其中isDeprecated属性的作用是如果我们在枚举项上使用@Deprecated注解时，这个属性的值就会为true。

示例：

public enum SexEnum implements Dict<Integer> {
    MALE(1, "男"),
    FEMALE(2, "女"),
    @Deprecated
    UNKNOWN(3, "未知");
    ...
}

// 使用getAll()的重载方法，第二个入参表示是否排除废弃枚举项
List<DictBean> all = Dict.getAll(SexEnum.class, true); // [{code:1,text:"男"},{code:2,text:"女"}]

3.Spring开发支持

3.1 Post请求DTO/VO中使用枚举属性

在以往的接口开发中，当DTO中有枚举含义的字段时，常常是用Integer类型来定义，然后代码中写逻辑时需要这样：

// 实际上这段代码还会告警，提示应使用equals
if(student.getSex() == SexEnum.MALE.getCode()){
    ...
}

又比如当遇到switch-case时，代码也稍显麻烦：

// 写法1，直接用魔法值
switch(studentDTO.getSex()){
    case 1: System.out.print("男");break;
    case 2: System.out.print("女");break;
}
// 写法2，先转换成枚举类
SexEnum sex = SexEnum.getByCode(studentDTO.getSex());
switch(sex){
    case MALE: System.out.print("男");break;
    case FEMAL: System.out.print("女");break;
}

那为什么不直接在Bean中使用枚举类型的属性呢？

public class StudentDTO {
    private Integer id;
    private String name;
    private SexEnum sex; // 使用枚举类型
    
}

// 写switch-case很顺畅
switch(studentDTO.getSex()){
    case MALE:  System.out.print("男");break;
    case FEMAL: System.out.print("女");break;
}

这里DTO、VO都支持直接用枚举类型的属性，因为组件对Dict枚举的json序列化和反序列化做了支持

源码参考：DictJacksonConfiguration

3.2 支持Get请求方法出入参使用枚举

接口参数除了Json序列化方式，也有可能是Get请求参数方式，组件同样也做了支持

@GetMapping("/listStudentBySex")
public List<Student> listStudent(SexEnum sex){
    ...   
}

这里无论是入参还是出参都可以使用枚举，因为对枚举对Spring的converter做了支持

源码参考：DictSpringConvertConfintion

3.3 Feign调用支持枚举参数传输

Feign调用时，方法参数会先在调用方序列化成url请求参数进行传输，到达被调用方后再反序列化成方法入参，这里也对枚举做了支持

// 被调用方接口申明
@FeignClient(url = "", path = "/student")
public interface StudentFeignClient {

    @GetMapping("/listStudentBySex")
    List<Student> listStudent(SexEnum sex); //直接使用枚举入参
}

// 调用方：
@Resource
private StudentFeignClient studentFeignClient;
...
List<Student> studentList = studentFeignClient.listStudent(SexEnum.MALE);

源码参考：DictSpringConvertConfiguration

4.Mybatis开发支持

可以在实体中直接使用枚举来充当属性，sql查询后会自动进行类型转换：

public class Student{
    @TableId
    private Integer id;
    private String name;
    private SexEnum sex; // 使用枚举类型
    
}

另外，如果你使用了MybatisPlus，那么也可以简化MybatisPlus的枚举条件查询代码：

Wrapper<Student> wrapper = new LambdaQueryWrapper<>(); // QueryWrapper同理
// 之前
wrapper.eq(Student::sex, SexEnum.MALE.getCode());
// 之后
wrapper.eq(Student::sex, SexEnum.MALE);
// 注意：这里的代码简化不要求Student类中的sex属性类型必须是枚举，Integer类型同样有效

源码参考：DictMybatisConfiguration

使用方式

导入依赖即自动生效

 <!-- Spring开发支持，含核心功能、Json、SpringConverter（项目须依赖springWeb）和Mybatis（项目须依赖mybatis）） -->
 <dependency>
     <groupId>io.github.luo-zhan</groupId>
     <artifactId>easy-enum-for-spring</artifactId>
     <version>1.3.1-RELEASE</version>
 </dependency>

如果你不需要Spring和Mybatis的支持，只需要Dict枚举的工具方法，可以只引入以下依赖

<!-- 核心模块 -->
<dependency>
   <groupId>io.github.luo-zhan</groupId>
   <artifactId>easy-enum</artifactId>
   <version>1.3.1-RELEASE</version>
</dependency>

交流

有任何问题或建议，欢迎提issues或者来讨论组内畅所欲言

💬进入讨论组