如何仅为单个端点按特定格式序列化EnumSet？

现有如下枚举类：

public enum Foo {
  CONST1("Const1 description"),
  CONST2("Const2 description");

  private final String label;

  private Foo(String label) {
    this.label = label;
  }

  public String getLabel() {
    return label;
  }
  
}

对应接口需要返回该枚举的所有值，供前端做下拉选择：

@GetMapping
public ResponseEntity<EnumSet<Foo>> allOfFoo() {
  return ResponseEntity.ok(EnumSet.allOf(Foo.class));
}

需求是仅针对这个接口定制枚举的返回格式，输出如下JSON结构，其他场景保持枚举原有序列化规则：

[
  {
    "name": "CONST1",
    "description": "Const1 description"
  },
  {
    "name": "CONST2",
    "description": "Const2 description"
  }
]

尝试过Jackson的@JsonProperty、@JsonValue但会修改枚举类影响全局；@JsonSerialize在枚举被包裹时用过，但不确定如何在控制器方法中生效；mix-ins会全局修改枚举序列化，均不符合需求，求可行方案，或是否API设计存在问题？

方案1：返回定制DTO（最直观无侵入） #

专门为该接口创建DTO类，将枚举信息映射到DTO中，完全隔离全局序列化规则。

1. 定义DTO类：

public class FooOptionDTO {
    private String name;
    private String description;

    public FooOptionDTO(Foo foo) {
        this.name = foo.name();
        this.description = foo.getLabel();
    }

    // 生成getter方法，Jackson需通过这些方法序列化字段
    public String getName() { return name; }
    public String getDescription() { return description; }
}

2. 修改控制器方法，将EnumSet转换为DTO集合返回：

@GetMapping
public ResponseEntity<List<FooOptionDTO>> allOfFoo() {
    List<FooOptionDTO> options = Arrays.stream(Foo.values())
            .map(FooOptionDTO::new)
            .collect(Collectors.toList());
    return ResponseEntity.ok(options);
}

这个方案简单直接，完全不影响原有枚举和全局序列化配置，后续需求变更也易调整，推荐优先使用。

方案2：局部使用自定义序列化器（不修改枚举） #

通过MappingJacksonValue在单个接口方法中指定临时序列化器，不会影响全局规则。

1. 自定义Foo的序列化器：

public class FooOptionSerializer extends StdSerializer<Foo> {
    public FooOptionSerializer() {
        super(Foo.class);
    }

    @Override
    public void serialize(Foo foo, JsonGenerator gen, SerializerProvider provider) throws IOException {
        gen.writeStartObject();
        gen.writeStringField("name", foo.name());
        gen.writeStringField("description", foo.getLabel());
        gen.writeEndObject();
    }
}

2. 修改控制器方法，用MappingJacksonValue包装并设置序列化器：

@GetMapping
public ResponseEntity<MappingJacksonValue> allOfFoo() {
    EnumSet<Foo> foos = EnumSet.allOf(Foo.class);
    MappingJacksonValue wrapper = new MappingJacksonValue(foos);
    
    SimpleModule module = new SimpleModule();
    module.addSerializer(Foo.class, new FooOptionSerializer());
    wrapper.setModules(List.of(module));
    
    return ResponseEntity.ok(wrapper);
}

此方案无需创建DTO，直接在序列化层面定制，适合不想新增类的场景，且仅对当前接口生效。

方案3：用@JsonSerialize结合方法级别配置（Spring 3.2+支持） #

在控制器方法的返回值上直接标注@JsonSerialize，指定集合元素的序列化器。

1. 先定义好上述FooOptionSerializer，再修改控制器：

@GetMapping
public ResponseEntity<@JsonSerialize(contentUsing = FooOptionSerializer.class) EnumSet<Foo>> allOfFoo() {
    return ResponseEntity.ok(EnumSet.allOf(Foo.class));
}

这种方式更简洁，直接在方法返回值的泛型上标注序列化器，Spring会识别并仅对当前接口的枚举元素应用该序列化规则。

你的API设计没问题，这种“局部接口需要特殊数据格式，全局保持原有规则”的场景非常常见，属于合理的业务需求，不需要调整整体设计，上述方案均可满足需求。

内容的提问来源于stack exchange，提问作者Viktor Ozerov