资讯专栏INFORMATION COLUMN

Java中的JSON数据绑定框架Jackson使用介绍

mengera88 / 1417人阅读

摘要:系列文章地址文档可以轻松的将对象转换成对象和文档,同样也可以将转换成对象。在项目中如果要引入,可以直接利用或者引入注意,项目已经自动依赖了与,不需要额外重复引入。

</>复制代码

  1. Github 系列文章地址

Jackson

</>复制代码

  1. jackson-databind文档

Jackson可以轻松的将Java对象转换成json对象和xml文档,同样也可以将json、xml转换成Java对象。在项目中如果要引入Jackson,可以直接利用Maven或者Gradle引入:

</>复制代码

  1. ...
  2. 2.7.0
  3. ...
  4. ...
  5. com.fasterxml.jackson.core
  6. jackson-databind
  7. ${jackson.version}
  8. ...

注意,databind项目已经自动依赖了jackson-core与jackson-annotation,不需要额外重复引入。

Convert Java to JSON

首先声明有一个简单的POJO:

</>复制代码

  1. // Note: can use getters/setters as well; here we just use public fields directly:
  2. public class MyValue {
  3. public String name;
  4. public int age;
  5. // NOTE: if using getters/setters, can keep fields `protected` or `private`
  6. }

然后创建一个ObjectMapper实例用于进行转化:

</>复制代码

  1. ObjectMapper mapper = new ObjectMapper(); // create once, reuse

</>复制代码

  1. MyValue value = mapper.readValue(new File("data.json"), MyValue.class);
  2. // or:
  3. value = mapper.readValue(new URL("http://some.com/api/entry.json"), MyValue.class);
  4. // or:
  5. value = mapper.readValue("{"name":"Bob", "age":13}", MyValue.class);

我们可以参考一个实例,将某个Staff的信息转化为JSON然后写入到文件中,首先来定义实体类:

</>复制代码

  1. package com.mkyong.json;
  2. import java.math.BigDecimal;
  3. import java.util.List;
  4. public class Staff {
  5. private String name;
  6. private int age;
  7. private String position;
  8. private BigDecimal salary;
  9. private List skills;
  10. //getters and setters

然后具体的将Java实体类转化为JSON的语句为:

</>复制代码

  1. package com.mkyong.json;
  2. import java.io.File;
  3. import java.io.IOException;
  4. import java.math.BigDecimal;
  5. import java.util.ArrayList;
  6. import java.util.List;
  7. import com.fasterxml.jackson.core.JsonGenerationException;
  8. import com.fasterxml.jackson.databind.JsonMappingException;
  9. import com.fasterxml.jackson.databind.ObjectMapper;
  10. public class Jackson2Example {
  11. public static void main(String[] args) {
  12. Jackson2Example obj = new Jackson2Example();
  13. obj.run();
  14. }
  15. private void run() {
  16. ObjectMapper mapper = new ObjectMapper();
  17. Staff staff = createDummyObject();
  18. try {
  19. // Convert object to JSON string and save into a file directly
  20. mapper.writeValue(new File("D:staff.json"), staff);
  21. // Convert object to JSON string
  22. String jsonInString = mapper.writeValueAsString(staff);
  23. System.out.println(jsonInString);
  24. // Convert object to JSON string and pretty print
  25. jsonInString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(staff);
  26. System.out.println(jsonInString);
  27. } catch (JsonGenerationException e) {
  28. e.printStackTrace();
  29. } catch (JsonMappingException e) {
  30. e.printStackTrace();
  31. } catch (IOException e) {
  32. e.printStackTrace();
  33. }
  34. }
  35. private Staff createDummyObject() {
  36. Staff staff = new Staff();
  37. staff.setName("mkyong");
  38. staff.setAge(33);
  39. staff.setPosition("Developer");
  40. staff.setSalary(new BigDecimal("7500"));
  41. List skills = new ArrayList<>();
  42. skills.add("java");
  43. skills.add("python");
  44. staff.setSkills(skills);
  45. return staff;
  46. }
  47. }

最终的输出为:

</>复制代码

  1. //new json file is created in D:staff.json"
  2. {"name":"mkyong","age":33,"position":"Developer","salary":7500,"skills":["java","python"]}
  3. {
  4. "name" : "mkyong",
  5. "age" : 33,
  6. "position" : "Developer",
  7. "salary" : 7500,
  8. "skills" : [ "java", "python" ]
  9. }
Properties:属性处理 Rename:属性重命名

</>复制代码

  1. public class Name {
  2. @JsonProperty("firstName")
  3. public String _first_name;
  4. }

在将Name实体类转化为JSON的时候,就会变成:

</>复制代码

  1. { "firstName" : "Bob" }
Ignore:属性忽略

</>复制代码

  1. public class Value {
  2. public int value;
  3. @JsonIgnore public int internalValue;
  4. }

最终生成的JSON是如下格式:

</>复制代码

  1. { "value" : 42 }

也可以在类的头部统一声明:

</>复制代码

  1. @JsonIgnoreProperties({ "extra", "uselessValue" })
  2. public class Value {
  3. public int value;
  4. }

那么如下的JSON字符串也是可以被转化为该实体类的:

</>复制代码

  1. { "value" : 42, "extra" : "fluffy", "uselessValue" : -13 }

对于意外地未知属性,也可以统一忽略:

</>复制代码

  1. @JsonIgnoreProperties(ignoreUnknown=true)
  2. public class PojoWithAny {
  3. public int value;
  4. }
@JsonView:动态控制展示的成员变量

首先定义一个简单的View控制类:

</>复制代码

  1. package com.mkyong.json;
  2. public class Views {
  3. public static class Normal{};
  4. public static class Manager extends Normal{};
  5. }

在下面的代码实现中,如果是选择了Normal View,那么salary属性将会被隐藏,而在Manager View状态下,任何属性都会被展示。

</>复制代码

  1. package com.mkyong.json;
  2. import java.math.BigDecimal;
  3. import java.util.List;
  4. import com.fasterxml.jackson.annotation.JsonView;
  5. public class Staff {
  6. @JsonView(Views.Normal.class)
  7. private String name;
  8. @JsonView(Views.Normal.class)
  9. private int age;
  10. @JsonView(Views.Normal.class)
  11. private String position;
  12. @JsonView(Views.Manager.class)
  13. private BigDecimal salary;
  14. @JsonView(Views.Normal.class)
  15. private List skills;

在进行Object转化为JSON的过程中,进行视图控制:

</>复制代码

  1. package com.mkyong.json;
  2. import java.io.IOException;
  3. import java.math.BigDecimal;
  4. import java.util.ArrayList;
  5. import java.util.List;
  6. import com.fasterxml.jackson.core.JsonGenerationException;
  7. import com.fasterxml.jackson.databind.JsonMappingException;
  8. import com.fasterxml.jackson.databind.ObjectMapper;
  9. public class Jackson2Example {
  10. public static void main(String[] args) {
  11. Jackson2Example obj = new Jackson2Example();
  12. obj.run();
  13. }
  14. private void run() {
  15. ObjectMapper mapper = new ObjectMapper();
  16. Staff staff = createDummyObject();
  17. try {
  18. // Salary will be hidden
  19. System.out.println("Normal View");
  20. String normalView = mapper.writerWithView(Views.Normal.class).writeValueAsString(staff);
  21. System.out.println(normalView);
  22. String jsonInString = "{"name":"mkyong","age":33,"position":"Developer","salary":7500,"skills":["java","python"]}";
  23. Staff normalStaff = mapper.readerWithView(Views.Normal.class).forType(Staff.class).readValue(jsonInString);
  24. System.out.println(normalStaff);
  25. // Display everything
  26. System.out.println("
  27. Manager View");
  28. String managerView = mapper.writerWithView(Views.Manager.class).writeValueAsString(staff);
  29. System.out.println(managerView);
  30. Staff managerStaff = mapper.readerWithView(Views.Manager.class).forType(Staff.class).readValue(jsonInString);
  31. System.out.println(managerStaff);
  32. } catch (JsonGenerationException e) {
  33. e.printStackTrace();
  34. } catch (JsonMappingException e) {
  35. e.printStackTrace();
  36. } catch (IOException e) {
  37. e.printStackTrace();
  38. }
  39. }
  40. private Staff createDummyObject() {
  41. Staff staff = new Staff();
  42. staff.setName("mkyong");
  43. staff.setAge(33);
  44. staff.setPosition("Developer");
  45. staff.setSalary(new BigDecimal("7500"));
  46. List skills = new ArrayList<>();
  47. skills.add("java");
  48. skills.add("python");
  49. staff.setSkills(skills);
  50. return staff;
  51. }
  52. }

最终输出的结果为:

</>复制代码

  1. Normal View
  2. {"name":"mkyong","age":33,"position":"Developer","skills":["java","python"]}
  3. Staff [name=mkyong, age=33, position=Developer, salary=null, skills=[java, python]]
  4. Manager View
  5. {"name":"mkyong","age":33,"position":"Developer","salary":7500,"skills":["java","python"]}
  6. Staff [name=mkyong, age=33, position=Developer, salary=7500, skills=[java, python]]
Convert JSON to Java

将JSON转化为Java的实体类同样需要用到ObjectMapper对象:

</>复制代码

  1. mapper.writeValue(new File("result.json"), myResultObject);
  2. // or:
  3. byte[] jsonBytes = mapper.writeValueAsBytes(myResultObject);
  4. // or:
  5. String jsonString = mapper.writeValueAsString(myResultObject);

而如果我们要将JSON转化为Java中的List或者Map的话,可以采用如下方式:

</>复制代码

  1. //将某个JSON转化为List
  2. String json = "[{"name":"mkyong"}, {"name":"laplap"}]";
  3. List list = mapper.readValue(json, new TypeReference>(){});
  4. //将某个JSON转化为Map
  5. String json = "{"name":"mkyong", "age":33}";
  6. Map map = mapper.readValue(json, new TypeReference>(){});

还是来看一个实例,:

</>复制代码

  1. package com.mkyong.json;
  2. import java.io.File;
  3. import java.io.IOException;
  4. import java.math.BigDecimal;
  5. import java.util.ArrayList;
  6. import java.util.List;
  7. import com.fasterxml.jackson.core.JsonGenerationException;
  8. import com.fasterxml.jackson.databind.JsonMappingException;
  9. import com.fasterxml.jackson.databind.ObjectMapper;
  10. public class Jackson2Example {
  11. public static void main(String[] args) {
  12. Jackson2Example obj = new Jackson2Example();
  13. obj.run();
  14. }
  15. private void run() {
  16. ObjectMapper mapper = new ObjectMapper();
  17. try {
  18. // Convert JSON string from file to Object
  19. Staff staff = mapper.readValue(new File("D:staff.json"), Staff.class);
  20. System.out.println(staff);
  21. // Convert JSON string to Object
  22. String jsonInString = "{"name":"mkyong","salary":7500,"skills":["java","python"]}";
  23. Staff staff1 = mapper.readValue(jsonInString, Staff.class);
  24. System.out.println(staff1);
  25. //Pretty print
  26. String prettyStaff1 = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(staff1);
  27. System.out.println(prettyStaff1);
  28. } catch (JsonGenerationException e) {
  29. e.printStackTrace();
  30. } catch (JsonMappingException e) {
  31. e.printStackTrace();
  32. } catch (IOException e) {
  33. e.printStackTrace();
  34. }
  35. }
  36. }

最终的输出为:

</>复制代码

  1. Staff [name=mkyong, age=33, position=Developer, salary=7500, skills=[java, python]]
  2. Staff [name=mkyong, age=0, position=null, salary=7500, skills=[java, python]]
  3. {
  4. "name" : "mkyong",
  5. "age" : 0,
  6. "position" : null,
  7. "salary" : 7500,
  8. "skills" : [ "java", "python" ]
  9. }
Tree Model:抽象的JSON数据类型,类似于FastJSON中的JSONObject

</>复制代码

  1. // can be read as generic JsonNode, if it can be Object or Array; or,
  2. // if known to be Object, as ObjectNode, if array, ArrayNode etc:
  3. ObjectNode root = mapper.readTree("stuff.json");
  4. String name = root.get("name").asText();
  5. int age = root.get("age").asInt();
  6. // can modify as well: this adds child Object as property "other", set property "type"
  7. root.with("other").put("type", "student");
  8. String json = mapper.writeValueAsString(root);
  9. // with above, we end up with something like as "json" String:
  10. // {
  11. // "name" : "Bob", "age" : 13,
  12. // "other" : {
  13. // "type" : "student"
  14. // }
  15. // }
Constructor:自定义构造器

默认情况下,Jackson使用默认的构造器创建新的对象,不过你也可以使用@JsonCreator@JsonProperty注解来自定义对象创建函数与值的绑定。

</>复制代码

  1. public class CtorPOJO {
  2. private final int _x, _y;
  3. @JsonCreator
  4. public CtorPOJO(@JsonProperty("x") int x, @JsonProperty("y") int y) {
  5. _x = x;
  6. _y = y;
  7. }
  8. }

</>复制代码

  1. public class DelegatingPOJO {
  2. private final int _x, _y;
  3. @JsonCreator
  4. public DelegatingPOJO(Map delegate) {
  5. _x = (Integer) delegate.get("x");
  6. _y = (Integer) delegate.get("y");
  7. }
  8. }

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/64807.html

相关文章

  • Spring Boot 参考指南(开发Web应用程序)

    摘要:开发应用程序非常适合应用程序开发,通过使用嵌入式或,你可以创建一个自包含的服务器。如果你还没有开发过一个应用程序,你可以按照入门部分中的示例进行操作。自动配置为大多数应用程序提供了良好的自动配置。 27. 开发Web应用程序 Spring Boot非常适合web应用程序开发,通过使用嵌入式Tomcat、Jetty、Undertow或Netty,你可以创建一个自包含的HTTP服务器。大多...

    roadtogeek 评论0 收藏0
  • 基于Spring Security Role过滤Jackson JSON输出内容

    摘要:在本文中,我们将展示如何根据中定义的用户角色过滤序列化输出。请注意,此方法要求我们在处理具有多个角色的用户时要小心。 在本文中,我们将展示如何根据Spring Security中定义的用户角色过滤JSON序列化输出。 为什么我们需要过滤? 让我们考虑一个简单但常见的用例,我们有一个Web应用程序,为不同角色的用户提供服务。例如,这些角色为User和Admin。 首先,让我们定义一个要...

    zhangyucha0 评论0 收藏0
  • Android干货框架集锦,搭建项目必不可少

    摘要:最佳解析最佳解析最佳解析是一个依赖注入框架,由谷歌开发,最早的版本由公司开发。在对的介绍中指出,即,这里的即数据结构中的有向无环图。也就是说,是一个基于有向无环图结构的依赖注入库,因此的使用过程中不能出现循环依赖。 在开发过程中使用过很多优秀框架,比如网络的okhttp,图片的Fresco,注入的Gagger2等,都是非常优秀的框架。 所以今天在此介绍下至今本人知道的一些比较流行主流且...

    zhisheng 评论0 收藏0

发表评论

0条评论

mengera88

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<