在编组之前动态隐藏一些字段（java到json） [英] Hide some fields dynamically before marshalling (java to json)

问题描述

我有一个jax-rs端点应该返回一个JSON对象，但我想选择一些字段并隐藏其他字段，我的代码是这样的：

I have a jax-rs endpoint that should return a JSON object but i want to select some fields and hide some others, my code is like this :

import javax.ws.rs.BadRequestException;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;

import org.apache.commons.lang3.StringUtils;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

@Component
@Path("/customers")
@Api(value = "Customers resource", produces = MediaType.APPLICATION_JSON_VALUE)
public class CustomersEndpoint{
    private final CustomersService customersService;

    public CustomersEndpoint(CustomersService customersService) {
        this.customersService = customersService;
    }
@GET
    @Path("{customerResourceId}")
    @Produces(MediaType.APPLICATION_JSON_VALUE)
    @ApiOperation(value = "Get customer details")
    @ApiResponses(value = { @ApiResponse(code = 200, message = "Listing the customer details", response = **Customer**.class)") })
    public **Customer** getCustomerDetails(@ApiParam(value = "ID of customer to fetch") @PathParam("customerResourceId") String customerId,
                                      @QueryParam(value = "Retrieve only selected fields [by comma]") String fields )
            throws ApiException {       

        return this.customersService.getCustomerDetails(customerId,fields);
    }

我的情况是，我想仅为选定的字段返回自定义客户。

My case here that i want to return a custom "Customer" for only selected fields.

I我正在使用jax-rs，jackson来解组/ marshall对象为JSON。

I'm using jax-rs, jackson to unmarshall/marshall Object to JSON.

请解决任何问题。

例子客户类：

import java.util.ArrayList;
import java.util.List;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Customer {

        public Customer() {

            }

    public Customer(String customerId,String phoneNumber) {

        this.customerId=customerId;
        this.phoneNumber=phoneNumber;
    }

    /**
     * customer identifier
     */
    @JsonPropertyDescription("customer identifier")
    @JsonProperty("customerId")
    private String customerId;

    /**
     * customer phone number
     */
    @JsonPropertyDescription("customer phone number")
    @JsonProperty("phoneNumber")
    private String phoneNumber;
    /**
     * customer first number
     */
    @JsonPropertyDescription("customer first number")
    @JsonProperty("firstName")
    private String firstName;
    /**
     * customer last number
     */
    @JsonPropertyDescription("customer last number")
    @JsonProperty("lastName")
    private String lastName;
public String getCustomerId() {
        return customerId;
    }
    public Customer setCustomerId(String customerId) {
        this.customerId = customerId;
        return this;
    }

    public String getPhoneNumber() {
        return phoneNumber;
    }
    public Customer setPhoneNumber(String phoneNumber) {
        this.phoneNumber = phoneNumber;
        return this;
    }
    public String getFirstName() {
        return firstName;
    }
    public Customer setFirstName(String firstName) {
        this.firstName = firstName;
        return this;
    }
    public String getLastName() {
        return lastName;
    }
    public Customer setLastName(String lastName) {
        this.lastName = lastName;
        return this;
    }
}

输出：

{
  "customerId": "string",
  "phoneNumber": "string",
  "firstName": "string",
  "lastName": "string",
}

=>选择后的结果：fields = phoneNumber，customerId

=> Result after select : fields =phoneNumber,customerId

{
  "customerId": "string",
  "phoneNumber": "string"
}

我知道实例化对象时不知道设置'隐藏'属性并包含此注释 @JsonInclude（JsonInclude.Include.NON_NULL）将是一个解决方案，但它需要太多的代码和维护。

I know when instantiate the object and do not set 'hide' properties and to include this annotation @JsonInclude(JsonInclude.Include.NON_NULL) would be a solution but it takes too much code and maintenance.

推荐答案

我认为您应该为该过滤器添加一个组件：

I think you should to add a component to that filter :

@Component
public class CustomerFilterConfig {


    public static  Set<String> fieldNames = new HashSet<String>();

      @Bean
      public ObjectMapper objectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();
        SimpleFilterProvider simpleFilterProvider = new SimpleFilterProvider().setFailOnUnknownId(false);
        FilterProvider filters =simpleFilterProvider.setDefaultFilter(SimpleBeanPropertyFilter.filterOutAllExcept(fieldNames)).addFilter("customerFilter", SimpleBeanPropertyFilter.filterOutAllExcept(fieldNames));    
        objectMapper.setFilterProvider(filters);
        return objectMapper;
      } 


}

然后添加模型中的过滤器：

then to add that filter in your model :

@JsonFilter("customerFilter")
public class Customer {...}

最后使用该过滤器：

String fields = "A,B,C,D";
CustomerFilterConfig.fieldNames.clear();
CustomerFilterConfig.fieldNames.addAll(Arrays.asList(fields.split(",")));

这篇关于在编组之前动态隐藏一些字段（java到json）的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！