为什么 Jersey 忽略我的 Jackson 注释？

Question

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

一些正在序列化的对象具有自定义枚举字段。默认情况下，这些枚举会根据枚举值转换为字符串——我希望枚举为 have slightly more complex serializations.

我在枚举中使用 Jackson 注释，但端点似乎忽略了它们。我一直在想方设法找出问题出在哪里，现在我求助于您。

枚举代码

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.

然后添加 Jackson 提供商
```
<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 版本。看看 Updating Jersey 2 in GlassFish 4

Answer 2

Glassfish 本身有 jackson jar，它可能与您在 pom.xml 中声明的显式 jackson jar 有冲突。

在 maven 网站上，对于每个版本的 jar，您选择的 jar 中几乎没有其他编译时依赖 jar。

所以这些也可能与您在 pom.xml

中声明的 jar 冲突

我也删除了

<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</artifactId>
    <version>2.24</version>
</dependency>

来自 pom.xml

Answer 3

对于使用应用程序 class 而不是使用 web.xml 的 Jersey 2.2x 用户，这对我有用

1.在ResourceConfig中，

@ApplicationPath("rest")
public class JerseyApplication  extends ResourceConfig {
    public JerseyApplication() {
        packages("com.example.rest");
        register(JacksonFeature.class);                       
    }
}

或者，如果您使用的是应用程序 class，

public class MyApplication extends Application {

    public Set<Class<?>> getClasses() {
        final Set<Class<?>> classes = new HashSet<Class<?>>();
        .
        .
        classes.add(JacksonFeature.class);
        return classes;
    }
}

2.在pom.xml中添加这个依赖，

<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</artifactId>
    <version>2.26</version>
</dependency>

3. 确保在 getter 和 setter 上也有注释。在我的例子中，@JsonIgnore 注释仅在我在该 class 变量的 getter 和 setter 上使用它时才起作用。

为什么 Jersey 忽略我的 Jackson 注释？

Why is Jersey ignoring my Jackson annotations?

java

glassfish

jersey

jackson

jersey-2.0