对Jersey使用自定义的ObjectWriter

Question

我正在开发一个REST网络服务。泽西岛作为 jax-rs 提供程序，杰克逊作为序列化/反序列化。我还基于Retrofit2开发客户端。

我的类层次结构是由第三方库提供的，所有类都是从根基类BaseObject派生出来的。其中一些类有不受欢迎的getter，例如我想在序列化时忽略它们（请注意，重要的是它们根本没有被序列化，在反序列化上使用FAIL_ON_UNKNOWN_PROPERTIES在我的例子中是不够的）。

我已经在使用Mixins的< code>BaseClass上使用了Jackson @JsonFilter。据我所知，要应用过滤器，必须使用以下方法:

new ObjectMapper().writer(filterProvider).writeValueAsString...

到目前为止，一切都很好：从生成的json中成功过滤了不需要的属性。

现在我必须配置Jersey和Retrofit2来使用我定制的json序列化器/反序列化器。

对于Jersey，可以使用实现上下文解析器的提供程序类配置序列化/反序列化

类似地，在改装2中，通过使用改装.Builder（）.addConverterFactory（JacksonConverterFactory.create（objectMapper）），可以自定义序列化/反序列化。

问题是new ObjectMapper（）. Writ（filterProvider）是ObjectWriter类型的，而不是ObjectMapper类型的。如何告诉泽西和Retrofit2使用使用我的过滤器的自定义ObjectWriter？




Answer 1

从Jackson的2.6版本开始，它为ObjectMapper提供了“setFilterProvider”方法。我没有尝试过，但文档对此有描述:https://faster XML . github . io/Jackson-databind/javadoc/2.6/com/faster XML/Jackson/databind/object mapper . html # setFilterProvider-com . faster XML . Jackson . databind . ser . filter provider-。我想你可以试试，因为这个描述符合你的情况。

我用Jersey 2.7和Jackson 2.9.5构建了一个测试服务。它运行良好，但你必须知道一些技巧来运行它。

在pom.xml添加泽西和杰克逊：

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.glassfish.jersey</groupId>
            <artifactId>jersey-bom</artifactId>
            <version>${jersey.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<dependencies>
    <dependency>
        <groupId>org.glassfish.jersey.containers</groupId>
        <artifactId>jersey-container-servlet-core</artifactId>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.media</groupId>
        <artifactId>jersey-media-json-jackson</artifactId>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-core</artifactId>
        <version>${jackson.version}</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>${jackson.version}</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-annotations</artifactId>
        <version>${jackson.version}</version>
    </dependency>
</dependencies>
<properties>
    <jersey.version>2.7</jersey.version>
    <jackson.version>2.9.5</jackson.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

您必须定义此依赖关系：

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

这是强制性的。

web.xml您必须参考服务的配置：

<web-app version="2.5"
     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_2_5.xsd">
<servlet>
    <servlet-name>Jersey Web Application</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
    <init-param>
        <param-name>org.glassfish.jersey.server.ResourceConfig</param-name>
        <param-value>com.home.MyApplication</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

MyApplication.java：

package com.home;

import org.glassfish.jersey.jackson.JacksonFeature;
import org.glassfish.jersey.server.ResourceConfig;

import javax.ws.rs.ApplicationPath;

@ApplicationPath("/webapi")
public class MyApplication extends ResourceConfig {

    public MyApplication() {

        register(ObjectMapperProvider.class);
        register(JacksonFeature.class);
        register(MyResource.class);

    }
}

使用自定义ObjectMapperProvider，您必须注册JacksonFeature.class，因为没有它，泽西不会使用自定义ObjectMapperProvider。

ObjectMapperProvider.java：

package com.home;

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;
import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;

@Provider
public class ObjectMapperProvider implements ContextResolver<ObjectMapper>{

    final ObjectMapper defaultObjectMapper;

    public ObjectMapperProvider() {
        defaultObjectMapper = createDefaultMapper();
    }

    @Override
    public ObjectMapper getContext(Class<?> type) {return defaultObjectMapper;}

    public static ObjectMapper createDefaultMapper() {

        final ObjectMapper mapper = new ObjectMapper();
        mapper.enable(SerializationFeature.INDENT_OUTPUT);
        mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
        mapper.setFilters(new SimpleFilterProvider().addFilter("dataFilter", SimpleBeanPropertyFilter.serializeAllExcept("region", "city")));
        return mapper;

    }
}

要定义过滤器，请使用“setFilters”方法。此方法已弃用，但泽西岛名为“jersey-hk2”的库不知道新方法“setFilterProvider”并引发异常。使用旧方法，一切都很好。

带有@JsonFilter的业务对象：

@JsonFilter("dataFilter")
public class SimpleData {

    @JsonProperty("name")
    String firstName;

    @JsonProperty("secondName")
    String lastName;

    @JsonProperty("country")
    String country;

    @JsonProperty("region")
    String region;

    @JsonProperty("city")
    String city;

    @JsonProperty("genre")
    String genre;

    public SimpleData() {

        this.firstName = "Bryan";
        this.lastName = "Adams";

        this.country = "Canada";
        this.region = "Ontario";
        this.city = "Kingston";
        this.genre = "Rock";

    }

    public String getFirstName() {    return firstName;       }
    public void setFirstName(String firstName) {  this.firstName = firstName;  }
    public String getLastName() {   return lastName;    }
    public void setLastName(String lastName) {  this.lastName = lastName;       }
    public String getCountry() {    return country;    }
    public void setCountry(String country) {  this.country = country;      }
    public String getRegion() {   return region;     }
    public void setRegion(String region) {   this.region = region;       }
    public String getCity() {  return city;     }
    public void setCity(String city) {   this.city = city;     }
    public String getGenre() {   return genre;      }
    public void setGenre(String genre) {    this.genre = genre;     }
}

MyResource.java:

@Path("myresource")
public class MyResource {


    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public SimpleData getIt() {

        return new SimpleData();

    }
}

过滤后的结果：