Как сериализовать список перечислений из остальных API

Question

Я хочу вернуть список перечислений из вызова API api, чтобы он отображал значение перечисления, а не только имена перечислений, в формате JSON.В настоящее время мой вызов rest возвращает json в виде:

{
  "responses": [
    "ACTION_TAKEN",
    "IGNORED",
    "UNDETECTED"
  ]
}

Но я хочу, чтобы это было больше похоже (или что-то в этом роде):

{
  "responses": [
    {
      "name":"ACTION_TAKEN",
      "value":"Action Taken"
    },
    {
      "name":"IGNORED",
      "value":"Ignored"
    },
    {
      "name":"UNDETECTED",
      "value":"Undetected"
    }
   ]
}

Мое перечисление выглядит так:

public enum Response {

  ACTION_TAKEN ("Action Taken"),
  IGNORED ("Ignored"),
  UNDETECTED("Undetected");

  private String value;

  Response(String value) {
    this.value = value;
  }

  public String getValue() {
    return this.value;
  }

  @Override
  public String toString() {
    return value;
  }
}

Мой модельный объект выглядит следующим образом.Ради этого примера он просто имеет список значений перечисления.

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class StaticData {

  private List<Response> responses;

  public List<Response> getResponses() {
    return responses;
  }

  public void setResponses(List<Response> responses) {
    this.responses = responses;
  }
}

Метод веб-службы выглядит следующим образом:

@Component
@Path("staticData")
@Produces("application/json")
@Consumes("application/json")
public class StaticDataResource {

  @GET
  public Response getCurrentContent() {
    StaticData staticData = new StaticData();
    staticData.setResponses(Arrays.asList(Response.values()));
    return Response.ok(staticData).build();
  }
}

Вот зависимости от моего эффективного pom (извините за неправильное форматирование)

<dependencies>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aspects</artifactId>
    <version>4.2.5.RELEASE</version>
    <scope>compile</scope>
  </dependency>
  <dependency>
    <groupId>com.sun.jersey.contribs</groupId>
    <artifactId>jersey-spring</artifactId>
    <version>1.19.1</version>
    <scope>compile</scope>
    <exclusions>
      <exclusion>
        <artifactId>*</artifactId>
        <groupId>org.springframework</groupId>
      </exclusion>
    </exclusions>
  </dependency>
  <dependency>
    <groupId>com.thetransactioncompany</groupId>
    <artifactId>cors-filter</artifactId>
    <version>2.4</version>
    <scope>compile</scope>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aop</artifactId>
    <version>4.2.5.RELEASE</version>
    <scope>compile</scope>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>4.2.5.RELEASE</version>
    <scope>compile</scope>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-expression</artifactId>
    <version>4.2.5.RELEASE</version>
    <scope>compile</scope>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-oxm</artifactId>
    <version>4.2.5.RELEASE</version>
    <scope>compile</scope>
  </dependency>
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-orm</artifactId>
  <version>4.2.5.RELEASE</version>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>1.7.19</version>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
  <version>1.7.19</version>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>commons-logging</groupId>
  <artifactId>commons-logging</artifactId>
  <version>1.2</version>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>commons-io</groupId>
  <artifactId>commons-io</artifactId>
  <version>2.4</version>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>com.google.guava</groupId>
  <artifactId>guava</artifactId>
  <version>19.0</version>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>org.reflections</groupId>
  <artifactId>reflections</artifactId>
  <version>0.9.10</version>
  <scope>compile</scope>
  <exclusions>
    <exclusion>
      <artifactId>guava</artifactId>
      <groupId>com.google.guava</groupId>
    </exclusion>
  </exclusions>
</dependency>
<dependency>
  <groupId>javax.servlet</groupId>
  <artifactId>javax.servlet-api</artifactId>
  <version>3.0.1</version>
  <scope>provided</scope>
</dependency>
<dependency>
  <groupId>javax.ws.rs</groupId>
  <artifactId>javax.ws.rs-api</artifactId>
  <version>2.0.1</version>
  <scope>provided</scope>
</dependency>
<dependency>
  <groupId>org.eclipse.persistence</groupId>
  <artifactId>javax.persistence</artifactId>
  <version>2.1.0</version>
  <scope>provided</scope>
</dependency>
<dependency>
  <groupId>javax.ejb</groupId>
  <artifactId>javax.ejb-api</artifactId>
  <version>3.2</version>
  <scope>provided</scope>
</dependency>
  <dependency>
      <groupId>javax.transaction</groupId>
      <artifactId>jta</artifactId>
      <version>1.1</version>
      <scope>provided</scope>
    </dependency>
</dependencies>

Я пытался добавить @JsonFormat(shape = JsonFormat.Shape.Object) в начало моего класса enum.Это не сработало.Я попытался добавить @JsonValue выше моего метода getValue () в классе enum, но это тоже не сработало.Я попытался добавить собственный сериализатор, расширяющий StdSerializer или JsonSerializer, и сослаться на этот класс выше моего перечисления, используя @JsonSerialize(using = ReasonSerializer).Я поставил точку останова в методе сериализации и не ударил его, так что это не сработало.Я немного посмотрел на выполнение implements ContextResolver<ObjectMapper>, но не мог понять, или это был даже правильный путь, чтобы пойти вниз или нет.

Любая помощь очень ценится!Спасибо!

Answer 1

Окончательное решение

Это работает с JAX-RS, и я проверил его с вашим кодом.

Используйте @JsonFormat с public String getName().

@JsonFormat(shape=JsonFormat.Shape.OBJECT)
public enum Response {
    ACTION_TAKEN ("Action Taken"),
    IGNORED ("Ignored"),
    UNDETECTED("Undetected");

    private String value;

    Response(String value) {
        this.value = value;
    }
    // Getters, Setters

    public String getName() {
        return name();
    }
}

Выход JSON

{
    "responses": [{
            "value": "Action Taken",
            "name": "ACTION_TAKEN"
        }, {
            "value": "Ignored",
            "name": "IGNORED"
        }, {
            "value": "Undetected",
            "name": "UNDETECTED"
        }
    ]
}

Проверено с использованием следующей зависимости.

import com.fasterxml.jackson.annotation.JsonFormat;

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>2.9.6</version>
</dependency>

Альтернативное решение

Документы Джексона гласят, что поведение может меняться в зависимости от используемого сериализатора.Так что, если первое решение не работает, оно может.

@JsonFormat(shape=JsonFormat.Shape.OBJECT)
public enum Response {
    ACTION_TAKEN ("Action Taken"),
    IGNORED ("Ignored"),
    UNDETECTED("Undetected");

    private String name;
    private String value;

    Response(String value) {
        name = name();
        this.value = value;
    }

    public String getName() {
        return name;
    }

    public String getValue() {
        return value;
    }
}

Answer 2

Согласно этой странице: https://www.javaworld.com/article/2072870/java-enums-are-inherently-serializable.html Каждый Enum естественно сериализуем, поэтому ваш тоже должен работать.

Но вы должны учитывать то, что было сказано здесь: Является ли пользовательский enum Serializable тоже?

Резюме: «Константы перечисления сериализуются иначе, чем обычные сериализуемые или экстернализуемые объекты. Сериализованная форма константы перечисления состоит исключительно из ее имени; значения поля константы не присутствуют в форме»

Чтобы решить вашу проблему, я бы подумал об использовании простого класса Pojo для представления вашего сериализуемого класса.Если вы все еще хотите использовать Enum, вы можете использовать переводчик Pojo <-> Enum (я не рекомендую делать этот последний вариант из-за избыточности, но последнее слово должно быть вашим, в зависимости от того, что вы хотите с ним делать:)).