Jackson - 快速指南

概述

Jackson 是一个简单的基于 java 的库，用于将 java 对象序列化为 JSON，反之亦然。

特征

• 便于使用。- jackson API 提供了一个高级外观来简化常用用例。

• 无需创建映射。- jackson API 为大多数要序列化的对象提供默认映射。

• 表现。- jackson 安静快速，内存占用低，适用于大型对象图或系统。

• 干净的 JSON。- Jackson 创建了一个干净紧凑的 JSON 结果，易于阅读。

• 无依赖性。- Jackson 库除了 jdk 之外不需要任何其他库。

• 开源- Jackson 库是开源的，可以免费使用。

处理JSON的三种方式

Jackson 提供了三种处理 JSON 的替代方法

• 流 API - 将 JSON 内容作为离散事件读取和写入。JsonParser 读取数据，而 JsonGenerator 写入数据。它是三者中最强大的方法，开销最低，读/写操作速度最快。它类似于 XML 的 Stax 解析器。

• 树模型- 准备 JSON 文档的内存中树表示。ObjectMapper 构建 JsonNode 节点树。这是最灵活的方法。它类似于 XML 的 DOM 解析器。

• 数据绑定- 使用属性访问器或使用注释将 JSON 与 POJO（普通旧 Java 对象）相互转换。它有两种类型。

  • 简单数据绑定- 将 JSON 与 Java 映射、列表、字符串、数字、布尔值和空对象相互转换。

  • 完整数据绑定- 将 JSON 与任何 JAVA 类型相互转换。

  ObjectMapper 读取/写入两种类型数据绑定的 JSON。数据绑定是最方便的方法，类似于 XML 的 JAXB 解析器。

环境设置

在线尝试选项

您确实不需要设置自己的环境来开始学习 Guava（一个基于 JAVA 的库）。原因很简单，我们已经在线设置了Java编程环境，以便您在进行理论工作的同时可以在线编译和执行所有可用的示例。这使您对所阅读的内容充满信心，并使用不同的选项检查结果。请随意修改任何示例并在线执行。

使用以下示例代码框右上角的Try it选项尝试以下示例：

公共类 MyFirstJavaProgram {

    公共静态无效主（字符串[]args）{
       System.out.println("你好世界");
    }
}

对于本教程中给出的大多数示例，您都会找到尝试选项，因此只需使用它并享受学习的乐趣。

本地环境设置

如果您仍然愿意为 Java 编程语言设置环境，那么本节将指导您如何在计算机上下载和设置 Java。请按照以下步骤设置环境。

Java SE 可以通过下载 Java链接免费获得。因此，您可以根据您的操作系统下载一个版本。

按照说明下载 java 并运行 .exe以在您的计算机上安装 Java。在计算机上安装 Java 后，您需要设置环境变量以指向正确的安装目录：

设置 Windows 2000/XP 的路径：

假设您已将 Java 安装在c:\Program Files\java\jdk目录中：

• 右键单击“我的电脑”并选择“属性”。

• 单击“高级”选项卡下的“环境变量”按钮。

• 现在，更改“Path”变量，使其也包含 Java 可执行文件的路径。例如，如果路径当前设置为“C:\WINDOWS\SYSTEM32”，则将路径更改为“C:\WINDOWS\SYSTEM32;c:\Program Files\java\jdk\bin”。

设置 Windows 95/98/ME 的路径：

假设您已将 Java 安装在c:\Program Files\java\jdk目录中：

• 编辑“C:\autoexec.bat”文件并在末尾添加以下行：
  “SET PATH=%PATH%;C:\Program Files\java\jdk\bin”

设置 Linux、UNIX、Solaris、FreeBSD 的路径：

应将环境变量 PATH 设置为指向 Java 二进制文件的安装位置。如果您在执行此操作时遇到问题，请参阅您的 shell 文档。

例如，如果您使用bash作为 shell，那么您可以将以下行添加到 '.bashrc:export PATH=/path/to/java:$PATH' 的末尾

流行的 Java 编辑器：

要编写 Java 程序，您需要一个文本编辑器。市场上还有更复杂的 IDE。但目前，您可以考虑以下其中一项：

• 记事本：在 Windows 计算机上，您可以使用任何简单的文本编辑器，例如记事本（本教程推荐）、TextPad。

• Netbeans：是一个开源且免费的 Java IDE，可以从http://www.netbeans.org/index.html下载。

• Eclipse：也是由eclipse开源社区开发的Java IDE，可以从http://www.eclipse.org/下载。

下载Jackson档案

从Maven Repository - Jackson下载最新版本的 Jackson jar 文件。在本教程中，下载 jackson-core-2.8.9.jar、jackson-annotations-2.8.9.jar 和 jackson-databind-2.8.9.jar 并将其复制到 C:\> jackson 文件夹中。

设置Jackson环境

设置jackson_HOME环境变量以指向计算机上存储 Guava jar 的基本目录位置。假设我们在各种操作系统上的 jackson 文件夹中提取了 jackson-core-2.8.9.jar、jackson-annotations-2.8.9.jar 和 jackson-databind-2.8.9.jar，如下所示。

设置 CLASSPATH 变量

设置CLASSPATH环境变量以指向 jackson jar 位置。假设我们在各种操作系统上将 jackson-core-2.8.9.jar、jackson-annotations-2.8.9.jar 和 jackson-databind-2.8.9.jar 存储在 jackson 文件夹中，如下所示。

首次申请

在详细介绍 Jackson 库之前，让我们先看看一个正在运行的应用程序。在此示例中，我们创建了 Student 类。我们将创建一个包含学生详细信息的 JSON 字符串，并将其反序列化为学生对象，然后将其序列化为 JSON 字符串。

在C:\>Jackson_WORKSPACE中创建一个名为 JacksonTester 的 java 类文件。

文件：JacksonTester.java

导入java.io.IOException；

导入 com.fasterxml.jackson.core.JsonParseException；
导入 com.fasterxml.jackson.databind.JsonMappingException；
导入 com.fasterxml.jackson.databind.ObjectMapper;

公共类 JacksonTester {
   公共静态无效主（字符串参数[]）{
   
      ObjectMapper 映射器 = new ObjectMapper();
      String jsonString = "{\"姓名\":\"Mahesh\", \"年龄\":21}";
      
      //将json映射到学生
      尝试{
         学生student = mapper.readValue(jsonString, Student.class);
         
         System.out.println(学生);
         
         jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(student);
         
         System.out.println(jsonString);
      }
      catch (JsonParseException e) { e.printStackTrace();}
      catch (JsonMappingException e) { e.printStackTrace(); }
      catch (IOException e) { e.printStackTrace(); }
   }
}

班级学生{
   私有字符串名称；
   私有整数年龄；
   公共学生(){}
   公共字符串 getName() {
      返回名称；
   }
   公共无效setName（字符串名称）{
      this.name = 名称；
   }
   公共 int getAge() {
      返回年龄；
   }
   公共无效setAge（int年龄）{
      this.age = 年龄；
   }
   公共字符串 toString(){
      return "学生[姓名:"+姓名+",年龄:"+年龄+"]";
   }
}

验证结果

使用javac编译器编译类，如下所示：

C:\Jackson_WORKSPACE>javac JacksonTester.java

现在运行 jacksonTester 查看结果：

C:\Jackson_WORKSPACE>java JacksonTester

验证输出

Student [ name: Mahesh, age: 21 ]
{
  "name" : "Mahesh",
  "age" : 21
}

需要记住的步骤

以下是此处需要考虑的重要步骤。

步骤1：创建ObjectMapper对象。

创建 ObjectMapper 对象。它是一个可重复使用的对象。

ObjectMapper mapper = new ObjectMapper();

第 2 步：将 JSON 反序列化为对象。

使用 readValue() 方法从 JSON 中获取对象。传递 json 字符串/ json 字符串的源和对象类型作为参数。

//Object to JSON Conversion
Student student = mapper.readValue(jsonString, Student.class);

步骤 3：将对象序列化为 JSON。

使用 writeValueAsString() 方法获取对象的 JSON 字符串表示形式。

//Object to JSON Conversion		
jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(student);

对象映射器类

ObjectMapper 是 Jackson 库的主要参与者类。ObjectMapper 类 ObjectMapper 提供了在基本 POJO（普通旧 Java 对象）之间或从通用 JSON 树模型 (JsonNode) 之间读取和写入 JSON 的功能，以及用于执行转换的相关功能。它还具有高度可定制性，可以处理不同样式的 JSON 内容，并支持更高级的对象概念，例如多态性和对象标识。ObjectMapper 还充当更高级的 ObjectReader 和 ObjectWriter 类的工厂。

类别声明

以下是com.fasterxml.jackson.databind.ObjectMapper类的声明-

public class ObjectMapper
   extends ObjectCodec
      implements Versioned, Serializable

嵌套类

领域

• protected DeserializationConfig _deserializationConfig - 定义序列化过程的基本全局设置的配置对象。

• protected DefaultDeserializationContext _deserializationContext - 蓝图上下文对象；存储在这里以允许自定义子类。

• protected InjectableValues _injectableValues - 提供在反序列化 POJO 中注入的值。

• protected JsonFactory _jsonFactory - 用于根据需要创建 JsonParser 和 JsonGenerator 实例的工厂。

• protected SimpleMixInResolver _mixIns - 定义如何应用混合注释的映射：键是接收附加注释的类型，值是具有“混合”注释的类型。

• protected ConfigOverrides _propertyOverrides - 当前活动的每类型配置覆盖，通过声明的属性类型访问。

• protected Set<Object> _registeredModuleTypes - 模块类型集（根据已注册的 Module.getTypeId() ；跟踪 iff MapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS 已启用，以便可以忽略重复的注册调用（以避免多次添加相同的处理程序） ，主要是）。

• protected ConcurrentHashMap<JavaType,JsonDeserializer<Object>> _rootDeserializers - 我们将使用单独的主级 Map 来跟踪根级反序列化器。

• protected SerializationConfig _serializationConfig - 定义序列化过程的基本全局设置的配置对象。

• protected SerializerFactory _serializerFactory - 用于构造序列化器的序列化器工厂。

• protected DefaultSerializerProvider _serializerProvider - 管理对用于序列化的序列化程序的访问的对象，包括缓存。

• protected SubtypeResolver _subtypeResolver - 用于注册子类型，根据需要将它们解析为超级/子类型。

• protected TypeFactory _typeFactory - 用于创建 JavaType 实例的特定工厂；需要允许模块添加更多自定义类型处理（主要是为了支持非 Java JVM 语言的类型）。

• protected static AnnotationIntrospector DEFAULT_ANNOTATION_INTROSPECTOR

• protected static BaseSettings DEFAULT_BASE - 基本设置包含用于所有 ObjectMapper 实例的默认值。

• protected static VisibilityChecker<?> STD_VISIBILITY_CHECKER

构造函数

方法

继承的方法

该类继承了以下类的方法：

• java.lang.Object

对象映射器示例

使用您选择的任何编辑器在C:/> Jackson_WORKSPACE中创建以下 java 程序

文件：JacksonTester.java

导入java.io.IOException；

导入 com.fasterxml.jackson.core.JsonParseException；
导入 com.fasterxml.jackson.databind.JsonMappingException；
导入 com.fasterxml.jackson.databind.ObjectMapper;

公共类 JacksonTester {
   公共静态无效主（字符串参数[]）{
   
      ObjectMapper 映射器 = new ObjectMapper();
      String jsonString = "{\"姓名\":\"Mahesh\", \"年龄\":21}";
      
      //将json映射到学生
      尝试{
         学生student = mapper.readValue(jsonString, Student.class);
         
         System.out.println(学生);
         
         jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(student);
         
         System.out.println(jsonString);
      }
      catch (JsonParseException e) { e.printStackTrace();}
      catch (JsonMappingException e) { e.printStackTrace(); }
      catch (IOException e) { e.printStackTrace(); }
   }
}

班级学生{
   私有字符串名称；
   私有整数年龄；
   公共学生(){}
   公共字符串 getName() {
      返回名称；
   }
   公共无效setName（字符串名称）{
      this.name = 名称；
   }
   公共 int getAge() {
      返回年龄；
   }
   公共无效setAge（int年龄）{
      this.age = 年龄；
   }
   公共字符串 toString(){
      return "学生[姓名:"+姓名+",年龄:"+年龄+"]";
   }
}

验证结果

使用javac编译器编译类，如下所示：

C:\Jackson_WORKSPACE>javac JacksonTester.java

现在运行 jacksonTester 查看结果：

C:\Jackson_WORKSPACE>java JacksonTester

验证输出

Student [ name: Mahesh, age: 21 ]
{
  "name" : "Mahesh",
  "age" : 21
}

对象序列化

让我们将 java 对象序列化为 json 文件，然后读取该 json 文件以获取该对象。在此示例中，我们创建了 Student 类。我们将创建一个 Student.json 文件，其中包含 Student 对象的 json 表示形式。

在C:\>Jackson_WORKSPACE中创建一个名为 JacksonTester 的 java 类文件。

文件：JacksonTester.java

导入java.io.File；
导入java.io.IOException；

导入 com.fasterxml.jackson.core.JsonGenerationException；
导入 com.fasterxml.jackson.core.JsonParseException；
导入 com.fasterxml.jackson.databind.JsonMappingException；
导入 com.fasterxml.jackson.databind.ObjectMapper;

公共类 JacksonTester {
   公共静态无效主（字符串参数[]）{
      JacksonTester 测试器 = new JacksonTester();
      尝试 {
         学生学生=新学生();
         学生.setAge(10);
         学生.setName("Mahesh");
         测试者.writeJSON(学生);

         学生student1 = tester.readJSON();
         System.out.println(student1);

      } catch (JsonParseException e) {
         e.printStackTrace();
      } catch (JsonMappingException e) {
         e.printStackTrace();
      } catch (IOException e) {
         e.printStackTrace();
      }
   }

   私人无效 writeJSON（学生学生）抛出 JsonGenerationException，JsonMappingException，IOException{
      ObjectMapper 映射器 = new ObjectMapper();	
      mapper.writeValue(new File("student.json"), Student);
   }

   私人学生 readJSON() 抛出 JsonParseException、JsonMappingException、IOException{
      ObjectMapper 映射器 = new ObjectMapper();
      Student Student = mapper.readValue(new File("student.json"), Student.class);
      回国学生；
   }
}

班级学生{
   私有字符串名称；
   私有整数年龄；
   公共学生(){}
   公共字符串 getName() {
      返回名称；
   }
   公共无效setName（字符串名称）{
      this.name = 名称；
   }
   公共 int getAge() {
      返回年龄；
   }
   公共无效setAge（int年龄）{
      this.age = 年龄；
   }
   公共字符串 toString(){
      return "学生[姓名:"+姓名+",年龄:"+年龄+"]";
   }	
}

验证结果

使用javac编译器编译类，如下所示：

C:\Jackson_WORKSPACE>javac JacksonTester.java

现在运行 jacksonTester 查看结果：

C:\Jackson_WORKSPACE>java JacksonTester

验证输出

Student [ name: Mahesh, age: 10 ]

数据绑定

数据绑定 API 用于使用属性访问器或使用注释将 JSON 与 POJO（普通旧 Java 对象）相互转换。它有两种类型。

• 简单数据绑定- 将 JSON 与 Java 映射、列表、字符串、数字、布尔值和空对象相互转换。

• 完整数据绑定- 将 JSON 与任何 JAVA 类型相互转换。

ObjectMapper 读取/写入两种类型数据绑定的 JSON。数据绑定是最方便的方法，类似于 XML 的 JAXB 解析器。

简单的数据绑定

简单数据绑定是指将 JSON 映射到 JAVA Core 数据类型。下表说明了 JSON 类型与 Java 类型之间的关系。

让我们看看简单的数据绑定的实际应用。在这里，我们将 JAVA 基本类型直接映射到 JSON，反之亦然。

在C:\>Jackson_WORKSPACE中创建一个名为 JacksonTester 的 java 类文件。

文件：JacksonTester.java

导入java.io.File；
导入java.io.IOException；
导入java.util.HashMap；
导入java.util.Map；

导入 com.fasterxml.jackson.core.JsonParseException；
导入 com.fasterxml.jackson.databind.JsonMappingException；
导入 com.fasterxml.jackson.databind.ObjectMapper;

公共类 JacksonTester {
   公共静态无效主（字符串参数[]）{
      JacksonTester 测试器 = new JacksonTester();
         尝试 {
            ObjectMapper 映射器 = new ObjectMapper();

            Map<String,Object> StudentDataMap = new HashMap<String,Object>();
            int[] 标记 = {1,2,3};

            学生学生=新学生();
            学生.setAge(10);
            学生.setName("Mahesh");
            // JAVA 对象
            StudentDataMap.put("学生", 学生);
            // JAVA 字符串
            StudentDataMap.put("姓名", "Mahesh Kumar");   		
            // JAVA 布尔值
            StudentDataMap.put("已验证", Boolean.FALSE);
            // 大批
            StudentDataMap.put("分数", 分数);

            mapper.writeValue(new File("student.json"), StudentDataMap);
            //结果student.json
			//{
            // "学生":{"姓名":"马赫什","年龄":10},
            // "标记":[1,2,3],
            //“已验证”：假，
            //“名称”：“马赫什·库马尔”
            //}
            StudentDataMap = mapper.readValue(new File("student.json"), Map.class);

            System.out.println(studentDataMap.get("学生"));
            System.out.println(studentDataMap.get("姓名"));
            System.out.println(studentDataMap.get("已验证"));
            System.out.println(studentDataMap.get("分数"));
      } catch (JsonParseException e) {
         e.printStackTrace();
      } catch (JsonMappingException e) {
         e.printStackTrace();
      } catch (IOException e) {
            e.printStackTrace();
      }
   }
}

班级学生{
   私有字符串名称；
   私有整数年龄；
   公共学生(){}
   公共字符串 getName() {
      返回名称；
   }
   公共无效setName（字符串名称）{
      this.name = 名称；
   }
   公共 int getAge() {
      返回年龄；
   }
   公共无效setAge（int年龄）{
      this.age = 年龄；
   }
   公共字符串 toString(){
      return "学生[姓名:"+姓名+",年龄:"+年龄+"]";
   }	
}

验证结果

使用javac编译器编译类，如下所示：

C:\Jackson_WORKSPACE>javac JacksonTester.java

现在运行 jacksonTester 查看结果：

C:\Jackson_WORKSPACE>java JacksonTester

验证输出

{name=Mahesh, age=10}
Mahesh Kumar
false
[1, 2, 3]

完整的数据绑定

完整数据绑定是指将 JSON 映射到任何 JAVA 对象。

//Create an ObjectMapper instance
ObjectMapper mapper = new ObjectMapper();	
//map JSON content to Student object
Student student = mapper.readValue(new File("student.json"), Student.class);
//map Student object to JSON content
mapper.writeValue(new File("student.json"), student);

让我们看看简单的数据绑定的实际应用。在这里，我们将 JAVA 对象直接映射到 JSON，反之亦然。

在C:\>Jackson_WORKSPACE中创建一个名为 JacksonTester 的 java 类文件。

文件：JacksonTester.java

导入java.io.File；
导入java.io.IOException；

导入 com.fasterxml.jackson.core.JsonGenerationException；
导入 com.fasterxml.jackson.core.JsonParseException；
导入 com.fasterxml.jackson.databind.JsonMappingException；
导入 com.fasterxml.jackson.databind.ObjectMapper;

公共类 JacksonTester {
   公共静态无效主（字符串参数[]）{
      JacksonTester 测试器 = new JacksonTester();
      尝试 {
         学生学生=新学生();
         学生.setAge(10);
         学生.setName("Mahesh");
         测试者.writeJSON(学生);

         学生student1 = tester.readJSON();
         System.out.println(student1);

      } catch (JsonParseException e) {
         e.printStackTrace();
      } catch (JsonMappingException e) {
         e.printStackTrace();
      } catch (IOException e) {
         e.printStackTrace();
      }
   }

   私人无效 writeJSON（学生学生）抛出 JsonGenerationException，JsonMappingException，IOException{
      ObjectMapper 映射器 = new ObjectMapper();	
      mapper.writeValue(new File("student.json"), Student);
   }

   私人学生 readJSON() 抛出 JsonParseException、JsonMappingException、IOException{
      ObjectMapper 映射器 = new ObjectMapper();
      学生学生=mapper.rea