java 序列化时排除指定属性

java 序列化对象如何排除指定属性呢?

java 中序列化对象有多种方式:struts2 ,jackson,json-lib

(1)使用struts2 json插件

依赖的jar包:struts2-json-plugin-2.3.15.3.jar,xwork-core-2.3.15.3.jar,当然还有servlet-api.jar

范例:

1. private String getMessageJson(PushMessage message) {
2. List<Pattern> excludeProperties = new ArrayList<Pattern>();
3. Pattern pattern1 = Pattern.compile("description");
4. Pattern pattern2 = Pattern.compile("creator");// 创建者ID
5. Pattern pattern3 = Pattern.compile("modifier");// 修改者ID
6. Pattern pattern4 = Pattern.compile("deliverTime");//
7. Pattern pattern5 = Pattern.compile("description");//
8. Pattern pattern6 = Pattern.compile("createTime");//
9. Pattern pattern7 = Pattern.compile("modifyTime");//
10. excludeProperties.add(pattern1);
11. excludeProperties.add(pattern2);
12. excludeProperties.add(pattern3);
13. excludeProperties.add(pattern4);
14. excludeProperties.add(pattern5);
15. excludeProperties.add(pattern6);
16. excludeProperties.add(pattern7);
17. String pushJsonStr = null;
18. try {
19. PushMessage pushMessage = null;
20. try {
21. pushMessage = message.clone();
22. } catch (CloneNotSupportedException e) {
23. logger.error("pushmessage clone failed.", e);
24. }
25. pushJsonStr = JSONUtil.serialize(pushMessage, excludeProperties,
26. null, false, false);
27. logger.info("after struts serialize:" + pushJsonStr);
28. } catch (JSONException e) {
29. logger.error("struts serialize failed.", e);
30. }// TOOD 判断json字符串的长度是否超过了256
31. return pushJsonStr;
32. }

注意:Pattern.compile 的参数就是要排除的成员变量名称(即description,creator,modifier都是成员变量名称)

(2)使用Jackson

官网：http://jackson.codehaus.org/

参考：http://blog.csdn.net/sciurid/article/details/8624107

http://www.cnblogs.com/hoojo/archive/2011/04/22/2024628.html

依赖的jar:jackson-mapper-lgpl-1.9.9.jar,jackson-core-lgpl-1.9.9.jar

如果使用maven,则在pom.xml中添加依赖

1. <!-- Json转化模块 -->
2. <dependency>
3. <groupId>org.codehaus.jackson</groupId>
4. <artifactId>jackson-mapper-lgpl</artifactId>
5. <version>1.9.9</version>
6. </dependency>

如何排除指定属性呢?

方式一:

先把要准备排除的属性的值设置为null

然后设置mapper的包含策略,看下面的实例:

1. public void test_jackson(){
2. //      Map map=new HashMap();
3. //      map.put("name", "黄威");
4. List<Student2> stus=null;
5. stus=new ArrayList<Student2>();
6. Student2 stu=new Student2();
7. stus.add(stu);
8. stu.setAddress(null);
9. ObjectMapper mapper = new ObjectMapper();
10. mapper.setSerializationInclusion(Inclusion.NON_NULL);
11. String content = null;
12. try {
13. content = mapper.writeValueAsString(stus);
14. System.out.println(content);
15. } catch (JsonGenerationException e) {
16. e.printStackTrace();
17. } catch (JsonMappingException e) {
18. e.printStackTrace();
19. } catch (IOException e) {
20. e.printStackTrace();
21. }
22. }

我把Student2对象的属性address设置为null,那么序列化时就会排除address属性.

注意:mapper.setSerializationInclusion(Inclusion.NON_NULL); 表示排除值为null的属性(成员变量)

方式二:使用FilterProvider

1. @Test
2. public void test_jackson2(){
3. List<Student2> stus=null;
4. stus=new ArrayList<Student2>();
5. Student2 stu=new Student2();
6. stus.add(stu);
7. stu.setClassroom("36班");
8. ObjectMapper mapper = new ObjectMapper();
9. String content = null;
10. try {
11. //          content = mapper.writeValueAsString(stus);
12. SimpleBeanPropertyFilter theFilter = SimpleBeanPropertyFilter.serializeAllExcept("schoolNumber");
13. FilterProvider filters = new SimpleFilterProvider().addFilter("myFilter", theFilter);
14. content = mapper.writer(filters).writeValueAsString(stu);
15. System.out.println(content);
16. } catch (JsonGenerationException e) {
17. e.printStackTrace();
18. } catch (JsonMappingException e) {
19. e.printStackTrace();
20. } catch (IOException e) {
21. e.printStackTrace();
22. }
23. }

注意:在排除属性的对象上面增加注解:@JsonFilter("myFilter")

参考:http://www.baeldung.com/jackson-ignore-properties-on-serialization