为什么泽西岛无视我的杰克逊注释？

Question

我正在使用Jersey和Jackson创建一个简单的JSON API.

一些被序列化的对象具有自定义枚举字段.默认情况下,这些枚举将转换为基于枚举值的字符串 - 我希望枚举具有稍微复杂的序列化.

我在枚举中使用杰克逊注释,但端点似乎忽略了它们.我一直在试着找出问题所在,我现在转向你.

枚举代​​码

package org.example.code;

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonProperty;

@JsonFormat(shape= JsonFormat.Shape.OBJECT)
public enum ExampleEnum {
    YES (1, "Yes indeed"),
    NO (2, "No way buddy")

    private final Integer code;
    private final String description;

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

    @JsonProperty("code")
    public Integer getCode() {
        return code;
    }
    @JsonProperty("description")
    public String getDescription() {
        return description;
    }
}

API代码

package org.example.webservice.impl;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import org.example.code.ExampleEnum;


@Path("/example")
public class ExampleService {   
    @GET
    @Path("/test")
    @Produces({MediaType.APPLICATION_JSON})
    public ExampleEnum getExampleEnum() {
        return ExampleEnum.YES;
    }
}

当我调用端点时example/test,输出是YES 我想要的输出是什么{ code: 1, description: "Yes indeed" }

配置文件如下......

的pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>api</artifactId>
    <version>0.0.1</version>
    <packaging>war</packaging>

    <name>example API</name>
    <url>http://example.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>

        <dependency>
            <groupId>javax.ws.rs</groupId>
            <artifactId>javax.ws.rs-api</artifactId>
            <version>2.0.1</version>
        </dependency>

        <dependency>
            <groupId>javax.annotation</groupId>
            <artifactId>javax.annotation-api</artifactId>
            <version>1.2</version>
        </dependency>

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.6.0</version>
        </dependency>

        <dependency>
            <groupId>org.glassfish.jersey.containers</groupId>
            <artifactId>jersey-container-servlet-core</artifactId>
            <version>2.18</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.3</version>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId>
                <version>2.2</version>
                <configuration>
                    <url>http://localhost:8080/manager/text</url>
                    <server>TomcatServer</server>
                    <path>/example</path>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

web.xml中

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0" 
    xmlns="http://java.sun.com/xml/ns/javaee" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
  <display-name></display-name> 
  <servlet>
    <display-name>Example Servlet</display-name>
    <servlet-name>Example Servlet</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
    <init-param>
        <param-name>jersey.config.server.provider.packages</param-name>
        <param-value>org.example.webservice.impl</param-value>
    </init-param>
    <init-param>
        <param-name>com.sun.jersey.api.json.POJOMappingFeature</param-name>
        <param-value>true</param-value>
    </init-param>
    <init-param>
      <param-name>jersey.config.server.provider.classnames</param-name>
      <param-value>org.glassfish.jersey.filter.LoggingFilter;org.glassfish.jersey.media.multipart.MultiPartFeature</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>Example Servlet</servlet-name>
    <url-pattern>/services/*</url-pattern>
  </servlet-mapping>
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
</web-app>

Answer 1

所以几件事情:

• com.sun.jersey.api.json.POJOMappingFeature 适用于Jersey 1.x,所以你可以摆脱它.

• MOXy是Glassfish中的默认提供程序,因此如果您想使用Jackson,则需要禁用MOXy.你可以通过添加它来实现<init-param>

  <init-param>
      <param-name>jersey.config.server.disableMoxyJson</param-name>
      <param-value>true</param-value>
  </init-param>
  

  如果您使用的ResourceConfig是配置,则可以使用该属性

  public class JerseyConfig extends ResourceConfig {
      public JerseyConfig() {
          property(ServerProperties.MOXY_JSON_FEATURE_DISABLE, true);
      }
  }
  

  实际上是常数值jersey.config.server.disableMoxyJson.

• 然后添加杰克逊提供商

  <dependency>
      <groupId>org.glassfish.jersey.media</groupId>
      <artifactId>jersey-media-json-jackson</artifactId>
      <version>${jersey2.version}</version>
      <scope>provided</scope>
  </dependency>
  

  Jersey版本应该与您用于项目的任何版本匹配.需要注意的一件非常重要的事情是,如果您使用的是Glassfish,您应该将所有Jersey依赖项放在一个中,<scope>provided</scope>因为服务器已经在其库中安装了jar.您不希望项目依赖项与服务器中已有的jar冲突.

• 接下来,您需要在应用程序中注册Jackson提供商.如果您使用的是web.xml,则可以JacksonFeature将该...classnames属性添加到列表中

  <init-param>
      <param-name>jersey.config.server.provider.classnames</param-name>
      <param-value>
          org.glassfish.jersey.filter.LoggingFilter,
          org.glassfish.jersey.media.multipart.MultiPartFeature,
          org.glassfish.jersey.jackson.JacksonFeature
      </param-value>
  </init-param>
  

  如果您使用的ResourceConfig是配置,那么您只需注册即可JacksonFeature

  public class JerseyConfig extends ResourceConfig {
      public JerseyConfig() {
          register(JacksonFeature.class);
      }
  }
  

我可能会指出的另一个与这个问题无关的事情是,Glassfish 4已经有了Jersey实现,这是一个非常古老的2.x版本,可能是2.0.添加运行时Jersey依赖项时,它们可能会发生冲突.我会做两件事之一,或者将所有Jersey依赖项放在一个provided <scope>或者如果你有更高版本功能的要求,你可能想要研究在Glassfish中更新Jersey版本.在GlassFish 4中查看更新Jersey 2