概述

使用jackson annotations简化和增强的json解析与生成。

Jackson-2.x通用annotations列表：https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations

Jackson-1.x通用annotations列表：http://wiki.fasterxml.com/JacksonAnnotations

准备工作

基于JDK1.7,依赖Jackson框架核心类库：

jackson-core-2.5.3.jar
jackson-annotations-2.5.3.jar
jackson-databind-2.5.3.jar

Jackson - Annotations

想要了解更多内容，请查看annotations列表。下面只列出一些常用的Json注解。

@JsonProperty

它关联json字段到Java属性。可以标记属性，也可以用来标记属性的getter/setter方法。当标记属性时，可以对属性字段重命名。当标记方法时，可以把json字段关联到java属性的getter或setter方法。

@JsonCreator

json反序列化为java对象时，该注解用于定义构造函数。当从json创建java时，@JsonCreator注解的构造函数被会调用，如果没有@JsonCreator注解，则默认调用java类的无参构造函数，此时，如果java类中只有有参构造函数，而无默认的无参构造函数，在反序列化时会抛出这样的异常：com.fasterxml.jackson.databind.JsonMappingException，所以，当我们不使用@JsonCreator指定反序列化的构造函数，而又在java类中重载了构造函数时，一定要记得编写类的无参构造函数。

@JsonAnyGetter和@JsonAnySetter

用于标记类方法，设置和读取json字段作为键值对存储到map中，这两个注解标记的方法不会处理任何java类中已经定义过的属性变量，只对java中未定义的json字段作处理。

@JsonIgnoreProperties和@JsonIgnore：

用于标记属性，在json与java之间相互转化时，将忽略被此注解标记的属性。@JsonIgnoreProperties是类级别注解，可以忽略多个属性，@JsonIgnore用来标注单个属性。

@JsonTypeInfo和@JsonSubTypes

用于维持java类的子类信息，将子类对象类型信息嵌入到json中，以便反序列化创建具体的对象。

Example

下面通过例子来演示注解的使用

example.1

读取company.json，反序列化json，创建java对象，并遍历信息

company.json

[html] view plaincopy

1. {
2. "name" : "Oracle",
3. "HQ" : "California",
4. "birthDate" : "1977-01-01",
5. "departments" : [ {
6. "name" : "development",
7. "employee_number" : 5000,
8. "projectManager" : "jack",
9. "product" : "oracle_db"
10. }, {
11. "name" : "test",
12. "employee_number" : 500,
13. "projectManager" : "rose",
14. "product" : "oracle_test"
15. } ]
16. }

Company.java

[java] view plaincopy

1. package com.jackson.json.annotation;
2. import java.util.Date;
3. import com.fasterxml.jackson.annotation.JsonCreator;
4. import com.fasterxml.jackson.annotation.JsonIgnore;
5. import com.fasterxml.jackson.annotation.JsonProperty;
6. public class Company {
7. private String name;
8. @JsonProperty("HQ")   //java属性headquarters序列化到json字段的名称为HQ
9. private String headquarters;
10. private Department[] departments;
11. @JsonIgnore         //在序列化与反序列化时，忽略birthDate属性
12. private Date birthDate;
13. public Date getBirthDate() {
14. return birthDate;
15. }
16. @JsonCreator
17. public Company(@JsonProperty("name") String name) {
18. this.name = name;
19. }
20. public String getName() {
21. return name;
22. }
23. public String getHeadquarters() {
24. return headquarters;
25. }
26. public Department[] getDepartments() {
27. return departments;
28. }
29. public void setDepartments(Department[] departments) {
30. this.departments = departments;
31. }
32. }

Department.java

[java] view plaincopy

1. package com.jackson.json.annotation;
2. import java.util.HashMap;
3. import java.util.Map;
4. import com.fasterxml.jackson.annotation.JsonAnyGetter;
5. import com.fasterxml.jackson.annotation.JsonAnySetter;
6. import com.fasterxml.jackson.annotation.JsonCreator;
7. import com.fasterxml.jackson.annotation.JsonProperty;
8. public class Department {
9. private String name;
10. private String pm;
11. private Map<String, Object> otherProperties = new HashMap<String, Object>(); //otherProperties用来存放Department中未定义的json字段
12. @JsonCreator   //指定json反序列化创建Department对象时调用此构造函数
13. public Department(@JsonProperty("name") String name){
14. this.name = name;
15. }
16. @JsonProperty("projectManager")  //将company.json中projectManager字段关联到getPm方法
17. public String getPm() {
18. return pm;
19. }
20. public String getName() {
21. return name;
22. }
23. public Object get(String key) {
24. return otherProperties.get(key);
25. }
26. @JsonAnyGetter    //得到所有Department中未定义的json字段的
27. public Map<String, Object> any() {
28. return otherProperties;
29. }
30. @JsonAnySetter
31. public void set(String key, Object value) {
32. otherProperties.put(key, value);
33. }
34. }

DeserializationExample.java

[java] view plaincopy

1. package com.jackson.json.annotation;
2. import java.io.File;
3. import com.fasterxml.jackson.databind.DeserializationFeature;
4. import com.fasterxml.jackson.databind.ObjectMapper;
5. public class DeserializationExample {
6. public static void main(String[] args) throws Exception {
7. ObjectMapper mapper = new ObjectMapper();
8. mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES); //禁止未知属性打断反序列化
9. Company company = mapper.readValue(new File("company_back.json"), Company.class);
10. System.out.print("company_name:"+company.getName()+"\t");
11. System.out.print("headquarters:"+company.getHeadquarters()+"\t");
12. System.out.println("birthDate:"+company.getBirthDate()); //birthDate被标记为@JsonIgnore，所以此处得到的值应该为null
13. Department[] departments = company.getDepartments();
14. for (Department department : departments) {
15. System.out.print("department_name:" + department.getName()+"\t");
16. System.out.print("employee_number:" + department.getPm()+"\t");
17. //Department中未定义的字段product,employee_number
18. System.out.print("product:"+department.get("product")+"\t");
19. System.out.println("projectManager:"+department.get("employee_number"));
20. }
21. }
22. }

程序运行控制台打印结果如下：

[html] view plaincopy

1. company_name:Oracle headquarters:California birthDate:null
2. department_name:development employee_number:jack    product:oracle_db   projectManager:5000
3. department_name:test    employee_number:rose    product:oracle_test projectManager:500

example.2

下面例子演示，当java对象中包含List<Object>属性时，如何序列化与反序列化。

当java对象中含List<Object>时，如果Object一个抽象类或接口，这里就会出现java多态的现象，比如，List<Animal>,Animal是个抽象类，并且有多个子类时，由于List中保存的Animal没有明确指向具体的子类或实现类，json反序列化java对象时就会抛出提示：Exception in thread "main" com.fasterxml.jackson.databind.JsonMappingException:Can not construct instance of Animal, problem: abstract types either need to be mapped to concrete types, have custom deserializer, or be instantiated with additional type information

@JsonTypeInfo与@JsonSubTypes就是解决此类问题，通过注解，可以在序列化时，保存具体的类型信息到json中，当json反序列到java对象时，就可以根据具体类型信息创建正确的java对象。

Zoo.java

[java] view plaincopy

1. package com.jackson.json.databinding.list;
2. import java.util.List;
3. import com.fasterxml.jackson.annotation.JsonCreator;
4. import com.fasterxml.jackson.annotation.JsonProperty;
5. public class Zoo {
6. public String name;
7. public String city;
8. public List<Animal> animals;
9. @JsonCreator
10. public Zoo(@JsonProperty("name") String name, @JsonProperty("city") String city) {
11. this.name = name;
12. this.city = city;
13. }
14. public void setAnimals(List<Animal> animals) {
15. this.animals = animals;
16. }
17. @Override
18. public String toString() {
19. return "Zoo [name=" + name + ", city=" + city + ", animals=" + animals
20. + "]";
21. }
22. }

Animal.java

[java] view plaincopy

1. package com.jackson.json.databinding.list;
2. import com.fasterxml.jackson.annotation.JsonSubTypes;
3. import com.fasterxml.jackson.annotation.JsonSubTypes.Type;
4. import com.fasterxml.jackson.annotation.JsonTypeInfo;
5. import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
6. import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
7. @JsonTypeInfo(use=Id.CLASS,include=As.PROPERTY,property="@class")
8. @JsonSubTypes({@Type(value=Lion.class,name="lion"),@Type(value=Elephant.class,name="elephant")})
9. public abstract class Animal {
10. String name;
11. String type;
12. }

Lion.java

[java] view plaincopy

1. package com.jackson.json.databinding.list;
2. import com.fasterxml.jackson.annotation.JsonCreator;
3. import com.fasterxml.jackson.annotation.JsonProperty;
4. public class Lion extends Animal {
5. private String name;
6. @JsonCreator
7. public Lion(@JsonProperty("name") String name) {
8. this.name = name;
9. }
10. public String getName() {
11. return name;
12. }
13. public String getType() {
14. return "carnivorous";
15. }
16. @Override
17. public String toString() {
18. return "Lion [name=" + name + ", getName()=" + getName()
19. + ", getType()=" + getType() + "]";
20. }
21. }

Elephant.java

[java] view plaincopy

1. package com.jackson.json.databinding.list;
2. import com.fasterxml.jackson.annotation.JsonCreator;
3. import com.fasterxml.jackson.annotation.JsonProperty;
4. public class Elephant extends Animal {
5. private String name;
6. @JsonCreator
7. public Elephant(@JsonProperty("name") String name) {
8. this.name = name;
9. }
10. public String getName() {
11. return name;
12. }
13. public String getType() {
14. return "herbivorous";
15. }
16. @Override
17. public String toString() {
18. return "Elephant [getName()=" + getName() + ", getType()=" + getType()
19. + "]";
20. }
21. }

SerializeExmaple.java

[java] view plaincopy

1. package com.jackson.json.databinding.list;
2. import java.io.File;
3. import java.io.IOException;
4. import java.util.ArrayList;
5. import java.util.List;
6. import com.fasterxml.jackson.databind.ObjectMapper;
7. import com.fasterxml.jackson.databind.SerializationFeature;
8. public class SerializeExample {
9. public static void main(String[] args) throws Exception {
10. Zoo zoo = new Zoo("SH Wild Park", "ShangHai");
11. Lion lion = new Lion("Samba");
12. Elephant elephant = new Elephant("Manny");
13. List<Animal> animals = new ArrayList<Animal>();
14. animals.add(lion);
15. animals.add(elephant);
16. zoo.setAnimals(animals);
17. ObjectMapper mapper = new ObjectMapper();
18. mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
19. mapper.writeValue(new File("zoo.json"), zoo);
20. }
21. }

生成zoo.json内容如下：

[html] view plaincopy

1. {
2. "name" : "SH Wild Park",
3. "city" : "ShangHai",
4. "animals" : [ {
5. "@class" : "com.jackson.json.databinding.list.Lion",
6. "name" : "Samba",
7. "type" : "carnivorous"
8. }, {
9. "@class" : "com.jackson.json.databinding.list.Elephant",
10. "name" : "Manny",
11. "type" : "herbivorous"
12. } ]
13. }

反序列化，DeserializeExmaple.java

[java] view plaincopy

1. package com.jackson.json.databinding.list;
2. import java.io.File;
3. import com.fasterxml.jackson.databind.ObjectMapper;
4. public class DeserializeExample {
5. public static void main(String[] args) throws Exception {
6. ObjectMapper mapper = new ObjectMapper();
7. Zoo zoo = mapper.readValue(new File("zoo.json"), Zoo.class);
8. System.out.println(zoo);
9. }
10. }

这里对反序列化后的Zoo对象不作详细遍历了，只打印toString看一下，结果如下，正确创建了Lion和Elephant对象

[html] view plaincopy

1. Zoo [name=SH Wild Park, city=ShangHai, animals=[Lion [name=Samba, getName()=Samba, getType()=carnivorous], Elephant [getName()=Manny, getType()=herbivorous]]]

我们还可以用另一个种方法来替代JsonSubTypes注释，现在，我们对Animal.java类稍作修改，隐去@JsonSubTypes注解，保留@JsonInfoType注解.这一次，我们直接序列化List<Animal>

SerializeExample2.java

[java] view plaincopy

1. package com.jackson.json.databinding.list;
2. import java.io.File;
3. import java.io.IOException;
4. import java.util.ArrayList;
5. import java.util.List;
6. import com.fasterxml.jackson.core.type.TypeReference;
7. import com.fasterxml.jackson.databind.ObjectMapper;
8. import com.fasterxml.jackson.databind.SerializationFeature;
9. public class SerializeExample {
10. public static void main(String[] args) throws Exception {
11. Zoo zoo = new Zoo("SH Wild Park", "ShangHai");
12. Lion lion = new Lion("Samba");
13. Elephant elephant = new Elephant("Manny");
14. List<Animal> animals = new ArrayList<Animal>();
15. animals.add(lion);
16. animals.add(elephant);
17. zoo.setAnimals(animals);
18. ObjectMapper mapper = new ObjectMapper();
19. mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
20. mapper.writerFor(new TypeReference<List<Animal>>() {
21. }).writeValue(new File("animal.json"), animals);
22. }
23. }

生成 animal.json,内容如下：

[html] view plaincopy

1. [ {
2. "@class" : "com.jackson.json.databinding.list.Lion",
3. "name" : "Samba",
4. "type" : "carnivorous"
5. }, {
6. "@class" : "com.jackson.json.databinding.list.Elephant",
7. "name" : "Manny",
8. "type" : "herbivorous"
9. } ]

总结

当采用数据绑定(DataBinding)方式处理json时，适当的使用Jackson Annotations可以帮助我们更好的解决问题，特别体现在序列化List时，解决多态的问题，以保证反序化到java对象时的正确性。@JsonAnyGetter,@JsonAnySetter,@JsonProperty都是很常用的注解，可以帮助我们更简洁的处理java对象与json之间的相互转化。

转自 http://blog.csdn.net/java_huashan/article/details/46428971