Jackson优雅序列化Java枚举类过程解析

 更新时间:2020年09月04日 09:18:15   作者:码农小胖哥  
这篇文章主要介绍了Jackson优雅序列化Java枚举类过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

1. 前言

在Java开发中我们为了避免过多的魔法值,使用枚举类来封装一些静态的状态代码。但是在将这些枚举的意思正确而全面的返回给前端却并不是那么顺利,我们通常会使用Jackson类库序列化对象为JSON,今天就来讲一个关于使用Jackson序列化枚举的通用性技巧。

2. 通用枚举范式

为了便于统一处理和规范统一的风格,建议指定一个统一的抽象接口,例如:

/**
 * The interface Enumerator.
 */
public interface Enumerator {
  /**
   * Code integer.
   *
   * @return the integer
   */
  Integer code();

  /**
   * Description string.
   *
   * @return the string
   */
  String description();
}

我们来写一个实现来标识性别:

public enum GenderEnum implements Enumerator {

  UNKNOWN(0, "未知"),

  MALE(1, "男"),

  FEMALE(2, "女");

  private final Integer code;
  private final String description;

  GenderEnum(Integer code, String description) {
    this.code = code;
    this.description = description;
  }

  @Override
  public Integer code() {
    return code;
  }

  @Override
  public String description() {
    return description;
  }
}

3. 序列化枚举

如果我们直接使用Jackson对枚举进行序列化,将只能简单的输出枚举的String名称:

  @Resource
  private ObjectMapper objectMapper;

  @Test
  void enumTest() {
    try {
      String s = objectMapper.writeValueAsString(GenderEnum.MALE);
      // 输出字符串 MALE
      System.out.println(s);
    } catch (JsonProcessingException e) {
      e.printStackTrace();
    }
  }

我们期望将GenderEnum.MALE 序列化为 {"code":1,"description":"男"} 。我们可以向ObjectMapper定制化一个Module来实现这种个性化需求:

     // 声明一个简单Module 对象
     SimpleModule module = new SimpleModule();
      // 给Module 添加一个序列化器
      module.addSerializer(Enumerator.class, new JsonSerializer<Enumerator>() {
        @Override
        public void serialize(Enumerator value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
          // 开始写入对象
          gen.writeStartObject();
          // 分别指定 k v  code  description
          gen.writeNumberField("code",value.code());
          gen.writeStringField("description",value.description());
          // 显式结束操作
          gen.writeEndObject();
        }
      });

    // 注册 Module
    objectMapper.registerModule(module);

然后再次执行就会获取我们期望的结果。然而这并不算合理。

4. Spring Boot 中自动全局配置

在Spring Boot应用中我们希望能全局配置。Spring Boot的自动配置为我们提供了一个个性化定制ObjectMapper的可能性,你只需要声明一个Jackson2ObjectMapperBuilderCustomizer并注入Spring IoC:

@Bean
public Jackson2ObjectMapperBuilderCustomizer enumCustomizer(){
  return jacksonObjectMapperBuilder -> jacksonObjectMapperBuilder.serializerByType(Enumerator.class, new JsonSerializer<Enumerator>() {
    @Override
    public void serialize(Enumerator value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
          gen.writeStartObject();
          gen.writeNumberField("code",value.code());
          gen.writeStringField("description",value.description());
          gen.writeEndObject();

    }
  });
}

这样就实现了全局配置。

5. 总结

这里我们介绍了如何定制Jackson库以达到对枚举进行更加友好的序列化的目的。其实不单单枚举,你也可以实现其它序列化,反序列化,时间输出格式的定制。这些特性留给你自己挖掘。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • java设计模式之装饰器模式(Decorator)

    java设计模式之装饰器模式(Decorator)

    这篇文章主要为大家详细介绍了java设计模式之装饰器模式Decorator,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-01-01
  • 举例讲解Java的JSON类库GSON的基本用法

    举例讲解Java的JSON类库GSON的基本用法

    GSON是谷歌在GitHub上开源的Java的JSON格式转换类库,能够实现Java对象向JSON的序列和反序列,这里我们就来举例讲解Java的JSON类库GSON的基本用法:
    2016-06-06
  • Spring Boot 部署过程解析(jar or war)

    Spring Boot 部署过程解析(jar or war)

    这篇文章主要介绍了Spring Boot 部署过程解析(jar or war),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-09-09
  • java开发https请求ssl不受信任问题解决方法

    java开发https请求ssl不受信任问题解决方法

    这篇文章主要介绍了java开发https请求ssl不受信任问题解决方法,具有一定借鉴价值,需要的朋友可以参考下
    2018-01-01
  • 解读controller层,service层,mapper层,entity层的作用与联系

    解读controller层,service层,mapper层,entity层的作用与联系

    这篇文章主要介绍了关于controller层,service层,mapper层,entity层的作用与联系,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • Spring成员对象注入的三种方式详解

    Spring成员对象注入的三种方式详解

    这篇文章主要为大家详细介绍了Spring成员对象注入的三种方式,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-02-02
  • Java服务器主机信息监控工具类的示例代码

    Java服务器主机信息监控工具类的示例代码

    这篇文章主要介绍了Java服务器主机信息监控工具类的示例代码,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • 使用Java开发实现OAuth安全认证的应用

    使用Java开发实现OAuth安全认证的应用

    这篇文章主要介绍了使用Java开发实现OAuth安全认证的应用的方法,OAuth安全认证经常出现于社交网络API应用的相关开发中,需要的朋友可以参考下
    2015-11-11
  • Spring Boot2集成AOPLog来记录接口访问日志

    Spring Boot2集成AOPLog来记录接口访问日志

    这篇文章主要介绍了Spring Boot2集成AOPLog来记录接口访问日志,日志是一个Web项目中必不可少的部分,借助它我们可以做许多事情,比如问题排查、访问统计、监控告警等,需要的朋友可以参考下
    2019-06-06
  • Mybatis批量操作sql写法示例(批量新增、更新)

    Mybatis批量操作sql写法示例(批量新增、更新)

    Mybatis技术,现在是工作中使用频率越来越高,我们在对数据库进行操作的时候,经常会遇到批量操作的需求,这篇文章主要给大家介绍了关于Mybatis批量操作sql写法的相关资料,需要的朋友可以参考下
    2021-05-05

最新评论