栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

springboot项目中枚举类型的最佳实践

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

springboot项目中枚举类型的最佳实践

springboot项目中的RestController中的请求,
参数中的对象,如果有枚举属性,甚至枚举的List,Class嵌套的枚举属性等等
传code它认吗,传desc它认吗,甚至传枚举字符串它认吗?
为什么认,为什么不认,怎样解决,以及有什么最佳实践?


经过摸索和试探,最佳实践已经成功了。
不想把内容再在这里整理一遍了。
直接上项目地址:
https://gitee.com/codejam_org/springboot-enum-demo

已提交公开申请,审核中,审核通过会公开。


关键代码示例:

默认情况 (见demo的tag1) req
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class TestReq extends BaseReq {


    private WeekEnum week;

    private List weeks;

    private InnerClass innerClassReq;
}

入参:

{
    "week": "MONDAY",
    "weeks": [
        1,
        "MONDAY"
    ],
    "innerClassReq": {
        "innerWeek":"MONDAY",
        "integer": 2,
        "innerWeeks": [
            "1",
            "WEDNESDAY"
        ]
    }
}
res:
{
    "week": "MONDAY",
    "weeks": [
        1,
        "MONDAY"
    ],
    "innerClassReq": {
        "innerWeek":"MONDAY",
        "integer": 2,
        "innerWeeks": [
            "1",
            "WEDNESDAY"
        ]
    }
}
改进 (见demo的tag2) 思路

方法

  1. 让枚举随便继承一个什么类或接口,那么则可识别。
  2. 指定这个类或接口的序列化/反序列化如何如何识别
  3. 则可正常按照指定的方式解析、输出
具体实现

IEnum

package com.codejam.enums.demo.enums;

import com.codejam.enums.demo.jackson.EnumJsonSerializer;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;


//@JsonDeserialize(using = EnumJsonDeSerializer.class)
@JsonSerialize(using = EnumJsonSerializer.class)
public interface IEnum {

    int getCode();

    String getDesc();

    String getEnumValue();
}

package com.codejam.enums.demo.jackson;

import com.codejam.enums.demo.enums.IEnum;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import org.springframework.util.CollectionUtils;

public class EnumJsonSerializer extends JsonSerializer {

    @Override
    public void serialize(IEnum anEnum, JsonGenerator jgen, SerializerProvider provider)
        throws IOException {
        if (Objects.isNull(anEnum)) {
            jgen.writeNull();
            return;
        }

        Class aClass = anEnum.getClass();
        Field[] fields = aClass.getDeclaredFields();
        List fieldList = Arrays.stream(fields).filter(f -> !Modifier.isStatic(f.getModifiers())).collect(
            Collectors.toList());

        if (CollectionUtils.isEmpty(fieldList)) {
            jgen.writeObject(anEnum.getDesc());
        } else {
            jgen.writeStartObject();

            for (Field field : fieldList) {
                field.setAccessible(true);
                jgen.writeFieldName(field.getName());
                try {
                    jgen.writeObject(field.get(anEnum));
                } catch (IllegalAccessException e) {
                    throw new IOException(e);
                }
            }
            jgen.writeEndObject();
        }


    }

    @Override
    public Class handledType() {
        return IEnum.class;
    }
}
package com.codejam.enums.demo.enums;

import lombok.Getter;



public enum WeekEnum implements IEnum{

    MONDAY(1, "星期一"),
    TUESDAY(2, "星期2"),
    WEDNESDAY(3, "星期3"),

    ;


    @Getter
    private int code;

    @Getter
    private String desc;

    @Getter
    private String enumValue;

    WeekEnum(int code, String desc) {
        this.code = code;
        this.desc = desc;
        this.enumValue = this.toString();
    }
}

req 不变 res

如下图:

返回要啥有啥,感觉完美。

再改进 – (见demo的tag3)

再想想,还是能发现不足的。

xxxEnum里面自己多定义了一个enumValue字段,没什么意义。
可以在统一的地方处理一下即可。

输出参照:

主要变化:
package com.codejam.enums.demo.enums;

import com.codejam.enums.demo.jackson.EnumJsonDeSerializer;
import com.codejam.enums.demo.jackson.EnumJsonSerializer;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;


//@JsonDeserialize(using = EnumJsonDeSerializer.class)
@JsonSerialize(using = EnumJsonSerializer.class)
public interface IEnum {

    int getCode();

    String getDesc();

}

EnumJsonSerializer
见tag3的EnumJsonSerializer文件内容。


这回才真正完美了。

文中有demo地址,可直接下载。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/966592.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号