从Spring MVC作为JSON发送时动态忽略Java对象中的字段


105

我有这样的模型类,用于休眠

@Entity
@Table(name = "user", catalog = "userdb")
@JsonIgnoreProperties(ignoreUnknown = true)
public class User implements java.io.Serializable {

    private Integer userId;
    private String userName;
    private String emailId;
    private String encryptedPwd;
    private String createdBy;
    private String updatedBy;

    @Id
    @GeneratedValue(strategy = IDENTITY)
    @Column(name = "UserId", unique = true, nullable = false)
    public Integer getUserId() {
        return this.userId;
    }

    public void setUserId(Integer userId) {
        this.userId = userId;
    }

    @Column(name = "UserName", length = 100)
    public String getUserName() {
        return this.userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    @Column(name = "EmailId", nullable = false, length = 45)
    public String getEmailId() {
        return this.emailId;
    }

    public void setEmailId(String emailId) {
        this.emailId = emailId;
    }

    @Column(name = "EncryptedPwd", length = 100)
    public String getEncryptedPwd() {
        return this.encryptedPwd;
    }

    public void setEncryptedPwd(String encryptedPwd) {
        this.encryptedPwd = encryptedPwd;
    }

    public void setCreatedBy(String createdBy) {
        this.createdBy = createdBy;
    }

    @Column(name = "UpdatedBy", length = 100)
    public String getUpdatedBy() {
        return this.updatedBy;
    }

    public void setUpdatedBy(String updatedBy) {
        this.updatedBy = updatedBy;
    }
}

在Spring MVC控制器中,使用DAO,我可以获取对象。然后返回为JSON对象。

@Controller
public class UserController {

    @Autowired
    private UserService userService;

    @RequestMapping(value = "/getUser/{userId}", method = RequestMethod.GET)
    @ResponseBody
    public User getUser(@PathVariable Integer userId) throws Exception {

        User user = userService.get(userId);
        user.setCreatedBy(null);
        user.setUpdatedBy(null);
        return user;
    }
}

查看部分是使用AngularJS完成的,因此它将获得像这样的JSON

{
  "userId" :2,
  "userName" : "john",
  "emailId" : "john@gmail.com",
  "encryptedPwd" : "Co7Fwd1fXYk=",
  "createdBy" : null,
  "updatedBy" : null
}

如果我不想设置加密的密码,则将该字段也设置为null。

但是我不想这样,我不想将所有字段发送到客户端。如果我不希望发送密码,updatedby,createdby字段,则我的结果JSON应该像

{
  "userId" :2,
  "userName" : "john",
  "emailId" : "john@gmail.com"
}

我不想发送给其他数据库表的客户端的字段列表。因此,它将根据登录的用户进行更改。我该怎么做?

我希望你能回答我的问题。



该信息可能对您有所帮助stackoverflow.com/questions/12505141/…–
穆萨

Answers:


142

@JsonIgnoreProperties("fieldname")注释添加到您的POJO。

或者,您可以@JsonIgnore在反序列化JSON时在要忽略的字段名称之前使用。例:

@JsonIgnore
@JsonProperty(value = "user_password")
public String getUserPassword() {
    return userPassword;
}

GitHub范例


63
我可以动态地做吗?不在POJO中吗?我可以在Controller类中做到吗?
iCode 2014年

3
@iProgrammer:这里是一个类似的,只要你想:stackoverflow.com/questions/8179986/...
user3145373ツ

3
@iProgrammer:非常令人印象深刻的答案在这里stackoverflow.com/questions/13764280/...
user3145373ツ

11
备注:@JsonIgnorecom.fasterxml.jackson.annotation.JsonIgnore不是org.codehaus.jackson.annotate.JsonIgnore
xiaohuo

5
从请求读取和发送响应时,这都将忽略。我只想在发送响应时忽略,因为我需要请求对象中的该属性。有任何想法吗?
zulkarnain shah

32

我知道我参加聚会有点晚了,但几个月前我也碰到了这个。所有可用的解决方案对我来说都不是很吸引人(mixins?嗯!),所以我最终创建了一个新的库来使此过程更简洁。如果有人想尝试一下,可以在这里使用:https : //github.com/monitorjbl/spring-json-view

基本用法非常简单,您可以JsonView在控制器方法中使用对象,如下所示:

import com.monitorjbl.json.JsonView;
import static com.monitorjbl.json.Match.match;

@RequestMapping(method = RequestMethod.GET, value = "/myObject")
@ResponseBody
public void getMyObjects() {
    //get a list of the objects
    List<MyObject> list = myObjectService.list();

    //exclude expensive field
    JsonView.with(list).onClass(MyObject.class, match().exclude("contains"));
}

您也可以在Spring之外使用它:

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import static com.monitorjbl.json.Match.match;

ObjectMapper mapper = new ObjectMapper();
SimpleModule module = new SimpleModule();
module.addSerializer(JsonView.class, new JsonViewSerializer());
mapper.registerModule(module);

mapper.writeValueAsString(JsonView.with(list)
      .onClass(MyObject.class, match()
        .exclude("contains"))
      .onClass(MySmallObject.class, match()
        .exclude("id"));

5
谢谢!这就是我要走的路。我需要在不同位置具有相同对象的自定义JSON视图,而@JsonIgnore则无法使用。该库使完成工作变得非常简单。
杰夫,

2
您使我的代码更清洁,实现起来更容易。谢谢
anindis

@monitorjbl:这有点偏离轨道,我使用了json视图及其解决方案。但是我无法为java.util.Date类注册自定义序列化程序(无运行时/编译时错误),因为我可以注册自定义序列化程序的字符串。
Ninad

17

我可以动态地做吗?

创建视图类:

public class View {
    static class Public { }
    static class ExtendedPublic extends Public { }
    static class Internal extends ExtendedPublic { }
}

注释您的模型

@Document
public class User {

    @Id
    @JsonView(View.Public.class)
    private String id;

    @JsonView(View.Internal.class)
    private String email;

    @JsonView(View.Public.class)
    private String name;

    @JsonView(View.Public.class)
    private Instant createdAt = Instant.now();
    // getters/setters
}

在控制器中指定视图类

@RequestMapping("/user/{email}")
public class UserController {

    private final UserRepository userRepository;

    @Autowired
    UserController(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    @RequestMapping(method = RequestMethod.GET)
    @JsonView(View.Internal.class)
    public @ResponseBody Optional<User> get(@PathVariable String email) {
        return userRepository.findByEmail(email);
    }

}

数据示例:

{"id":"5aa2496df863482dc4da2067","name":"test","createdAt":"2018-03-10T09:35:31.050353800Z"}

1
这是一个奇妙而简约的答案!我想只返回@Configuration带注释的组件中的几个字段作为JSON,并跳过所有自动包含的内部字段。非常感谢!
stx

15

我们可以通过JsonProperty.Access.WRITE_ONLY在声明属性时设置对的访问权限来实现。

@JsonProperty( value = "password", access = JsonProperty.Access.WRITE_ONLY)
@SerializedName("password")
private String password;

12

@JsonInclude(JsonInclude.Include.NON_NULL)在类以及@JsonIgnore密码字段中添加(强制Jackson序列化空值)。

当然@JsonIgnore,如果您总是想忽略它们,而不仅仅是在这种特定情况下,当然也可以在createdBy和UpdatedBy上进行设置。

更新

如果您不想将注释添加到POJO本身,Jackson的Mixin注释就是一个不错的选择。查看文档


我可以动态地做吗?不在POJO中吗?我可以在我的Controller课堂上这样做吗?
iCode

您是说不想将注释添加到POJO吗?
geoand 2014年

因为有时我可能想将所有字段发送到客户端。有时字段很少。我应该发送给客户端的字段仅从控制器类中的数据库获取。之后,我只需要设置应忽略的字段即可。
iCode 2014年

12

是的,您可以指定将哪些字段序列化为JSON响应,以及将哪些字段忽略。这是实现动态忽略属性所需的操作。

1)首先,您需要在com.fasterxml.jackson.annotation.JsonFilter上的实体类上添加@JsonFilter。

import com.fasterxml.jackson.annotation.JsonFilter;

@JsonFilter("SomeBeanFilter")
public class SomeBean {

  private String field1;

  private String field2;

  private String field3;

  // getters/setters
}

2)然后,在控制器中,必须添加创建MappingJacksonValue对象并在其上设置过滤器,最后,必须返回此对象。

import java.util.Arrays;
import java.util.List;

import org.springframework.http.converter.json.MappingJacksonValue;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import com.fasterxml.jackson.databind.ser.FilterProvider;
import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;

@RestController
public class FilteringController {

  // Here i want to ignore all properties except field1,field2.
  @GetMapping("/ignoreProperties")
  public MappingJacksonValue retrieveSomeBean() {
    SomeBean someBean = new SomeBean("value1", "value2", "value3");

    SimpleBeanPropertyFilter filter = SimpleBeanPropertyFilter.filterOutAllExcept("field1", "field2");

    FilterProvider filters = new SimpleFilterProvider().addFilter("SomeBeanFilter", filter);

    MappingJacksonValue mapping = new MappingJacksonValue(someBean);

    mapping.setFilters(filters);

    return mapping;
  }
}

这是您将得到的答复:

{
  field1:"value1",
  field2:"value2"
}

代替这个:

{
  field1:"value1",
  field2:"value2",
  field3:"value3"
}

在这里,您可以看到它忽略了属性field1和field2以外的其他属性(在这种情况下为field3)。

希望这可以帮助。


1
@Shafqat Man,非常感谢你,你是我的救星。花了将近一天的时间试图找出这种功能。这个解决方案是如此优雅和简单?并完全按照要求执行。应该标记为正确答案。
奥列格·库茨

6

如果我是您并且想要这样做,则不会在Controller层中使用我的User实体,而是创建并使用UserDto(数据传输对象)与业务(Service)层和Controller进行通信。您可以使用Apache BeanUtils(copyProperties方法)将数据从User实体复制到UserDto。


3

我创建了一个JsonUtil,可在运行时在给出响应时忽略字段。

用法示例:第一个参数应该是任何POJO类(学生),ignoreFields是您要在响应中忽略的逗号分隔字段。

 Student st = new Student();
 createJsonIgnoreFields(st,"firstname,age");

import java.util.logging.Logger;

import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.ObjectWriter;
import org.codehaus.jackson.map.ser.FilterProvider;
import org.codehaus.jackson.map.ser.impl.SimpleBeanPropertyFilter;
import org.codehaus.jackson.map.ser.impl.SimpleFilterProvider;

public class JsonUtil {

  public static String createJsonIgnoreFields(Object object, String ignoreFields) {
     try {
         ObjectMapper mapper = new ObjectMapper();
         mapper.getSerializationConfig().addMixInAnnotations(Object.class, JsonPropertyFilterMixIn.class);
         String[] ignoreFieldsArray = ignoreFields.split(",");
         FilterProvider filters = new SimpleFilterProvider()
             .addFilter("filter properties by field names",
                 SimpleBeanPropertyFilter.serializeAllExcept(ignoreFieldsArray));
         ObjectWriter writer = mapper.writer().withFilters(filters);
         return writer.writeValueAsString(object);
     } catch (Exception e) {
         //handle exception here
     }
     return "";
   }

   public static String createJson(Object object) {
        try {
         ObjectMapper mapper = new ObjectMapper();
         ObjectWriter writer = mapper.writer().withDefaultPrettyPrinter();
         return writer.writeValueAsString(object);
        }catch (Exception e) {
         //handle exception here
        }
        return "";
   }
 }    

2

我已经解决了仅使用@JsonIgnore@kryger建议的方法。因此,您的吸气剂将变为:

@JsonIgnore
public String getEncryptedPwd() {
    return this.encryptedPwd;
}

您可以@JsonIgnore此处描述的那样在字段,设置器或获取器上设置课程。

并且,如果您只想在序列化方面保护加密密码(例如,当您需要登录用户时),请将此@JsonProperty注释添加到您的字段中

@JsonProperty(access = Access.WRITE_ONLY)
private String encryptedPwd;

更多信息在这里


1

我已经找到了Spring和Jackson的解决方案

首先在实体中指定过滤器名称

@Entity
@Table(name = "SECTEUR")
@JsonFilter(ModelJsonFilters.SECTEUR_FILTER)
public class Secteur implements Serializable {

/** Serial UID */
private static final long serialVersionUID = 5697181222899184767L;

/**
 * Unique ID
 */
@Id
@JsonView(View.SecteurWithoutChildrens.class)
@Column(name = "id")
@GeneratedValue(strategy = GenerationType.IDENTITY)
private long id;

@JsonView(View.SecteurWithoutChildrens.class)
@Column(name = "code", nullable = false, length = 35)
private String code;

/**
 * Identifiant du secteur parent
 */
@JsonView(View.SecteurWithoutChildrens.class)
@Column(name = "id_parent")
private Long idParent;

@OneToMany(fetch = FetchType.LAZY)
@JoinColumn(name = "id_parent")
private List<Secteur> secteursEnfants = new ArrayList<>(0);

}

然后,您可以看到带有弹簧配置中使用的默认FilterProvider的常量过滤器名称类

public class ModelJsonFilters {

public final static String SECTEUR_FILTER = "SecteurFilter";
public final static String APPLICATION_FILTER = "ApplicationFilter";
public final static String SERVICE_FILTER = "ServiceFilter";
public final static String UTILISATEUR_FILTER = "UtilisateurFilter";

public static SimpleFilterProvider getDefaultFilters() {
    SimpleBeanPropertyFilter theFilter = SimpleBeanPropertyFilter.serializeAll();
    return new SimpleFilterProvider().setDefaultFilter(theFilter);
}

}

弹簧配置:

@EnableWebMvc
@Configuration
@ComponentScan(basePackages = "fr.sodebo")

public class ApiRootConfiguration extends WebMvcConfigurerAdapter {

@Autowired
private EntityManagerFactory entityManagerFactory;


/**
 * config qui permet d'éviter les "Lazy loading Error" au moment de la
 * conversion json par jackson pour les retours des services REST<br>
 * on permet à jackson d'acceder à sessionFactory pour charger ce dont il a
 * besoin
 */
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {

    super.configureMessageConverters(converters);
    MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
    ObjectMapper mapper = new ObjectMapper();

    // config d'hibernate pour la conversion json
    mapper.registerModule(getConfiguredHibernateModule());//

    // inscrit les filtres json
    subscribeFiltersInMapper(mapper);

    // config du comportement de json views
    mapper.configure(MapperFeature.DEFAULT_VIEW_INCLUSION, false);

    converter.setObjectMapper(mapper);
    converters.add(converter);
}

/**
 * config d'hibernate pour la conversion json
 * 
 * @return Hibernate5Module
 */
private Hibernate5Module getConfiguredHibernateModule() {
    SessionFactory sessionFactory = entityManagerFactory.unwrap(SessionFactory.class);
    Hibernate5Module module = new Hibernate5Module(sessionFactory);
    module.configure(Hibernate5Module.Feature.FORCE_LAZY_LOADING, true);

    return module;

}

/**
 * inscrit les filtres json
 * 
 * @param mapper
 */
private void subscribeFiltersInMapper(ObjectMapper mapper) {

    mapper.setFilterProvider(ModelJsonFilters.getDefaultFilters());

}

}

最后,我可以在需要时在restConstoller中指定特定的过滤器。

@RequestMapping(value = "/{id}/droits/", method = RequestMethod.GET)
public MappingJacksonValue getListDroits(@PathVariable long id) {

    LOGGER.debug("Get all droits of user with id {}", id);

    List<Droit> droits = utilisateurService.findDroitsDeUtilisateur(id);

    MappingJacksonValue value;

    UtilisateurWithSecteurs utilisateurWithSecteurs = droitsUtilisateur.fillLists(droits).get(id);

    value = new MappingJacksonValue(utilisateurWithSecteurs);

    FilterProvider filters = ModelJsonFilters.getDefaultFilters().addFilter(ModelJsonFilters.SECTEUR_FILTER, SimpleBeanPropertyFilter.serializeAllExcept("secteursEnfants")).addFilter(ModelJsonFilters.APPLICATION_FILTER,
            SimpleBeanPropertyFilter.serializeAllExcept("services"));

    value.setFilters(filters);
    return value;

}

5
为什么这么复杂的问题很简单
Humoyun Ahmad

1

广场@JsonIgnore上的字段或它的吸气剂,或创建一个自定义DTO

@JsonIgnore
private String encryptedPwd;

或如上所述,通过ceekay@JsonPropertyaccess属性设置为仅写入来对其进行注释

@JsonProperty( value = "password", access = JsonProperty.Access.WRITE_ONLY)
private String encryptedPwd;

0

创建UserJsonResponse类并填充所需字段是否是一种更干净的解决方案?

要返回所有模型时,直接返回JSON似乎是一个很好的解决方案。否则,它只会变得混乱。

例如,在将来,您可能想要一个与任何Model字段都不匹配的JSON字段,那么您将面临更大的麻烦。


0

这是上面回答的干净实用工具:

@GetMapping(value = "/my-url")
public @ResponseBody
MappingJacksonValue getMyBean() {
    List<MyBean> myBeans = Service.findAll();
    MappingJacksonValue mappingValue = MappingFilterUtils.applyFilter(myBeans, MappingFilterUtils.JsonFilterMode.EXCLUDE_FIELD_MODE, "MyFilterName", "myBiggerObject.mySmallerObject.mySmallestObject");
    return mappingValue;
}

//AND THE UTILITY CLASS
public class MappingFilterUtils {

    public enum JsonFilterMode {
        INCLUDE_FIELD_MODE, EXCLUDE_FIELD_MODE
    }
    public static MappingJacksonValue applyFilter(Object object, final JsonFilterMode mode, final String filterName, final String... fields) {
        if (fields == null || fields.length == 0) {
            throw new IllegalArgumentException("You should pass at least one field");
        }
        return applyFilter(object, mode, filterName, new HashSet<>(Arrays.asList(fields)));
    }

    public static MappingJacksonValue applyFilter(Object object, final JsonFilterMode mode, final String filterName, final Set<String> fields) {
        if (fields == null || fields.isEmpty()) {
            throw new IllegalArgumentException("You should pass at least one field");
        }

        SimpleBeanPropertyFilter filter = null;
        switch (mode) {
            case EXCLUDE_FIELD_MODE:
                filter = SimpleBeanPropertyFilter.serializeAllExcept(fields);
                break;
            case INCLUDE_FIELD_MODE:
                filter = SimpleBeanPropertyFilter.filterOutAllExcept(fields);
                break;
        }

        FilterProvider filters = new SimpleFilterProvider().addFilter(filterName, filter);
        MappingJacksonValue mapping = new MappingJacksonValue(object);
        mapping.setFilters(filters);
        return mapping;
    }
}

-5

在您的实体类中添加@JsonInclude(JsonInclude.Include.NON_NULL)注释以解决问题

它看起来像

@Entity
@JsonInclude(JsonInclude.Include.NON_NULL)

完全不相关地回答。问题的目的是不同的,而答案是关于其他的东西。-1表示
Hammad Dar
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.