Hướng dẫn sử dụng thư viện Jackson

1347

Bài viết được sự cho phép của tác giả Nguyễn Hữu Khanh

Trong các bài trước, chúng ta đã tìm hiệu về thư viện Gson để chuyển đổi từ đối tượng Java sang JSON và từ JSON sang đối tượng Java. Trong bài này, tôi sẽ hướng dẫn bạn sử dụng thư viện Jackson, một thư viện mã nguồn mở miễn phí rất mạnh mẽ được sử dụng trong nhiều ứng dụng Java.

Giới thiệu

Jackson là một thư viện Java chứa rất nhiều chức năng để đọc và xây dựng JSON. Nó có khả năng ràng buộc dữ liệu rất mạnh mẽ và cung cấp một framework để tùy chỉnh quá trình chuyển đối tượng Java sang chuỗi JSON và chuỗi JSON sang đối tượng Java.

Tạo JSON từ đối Java

Có 3 cách để tạo JSON từ Java:

  • Từ một đối tượng Java
  • Từ cây JsonNode
  • Từ Json Stream

Phân tích chuỗi JSON

Có 3 cách thường dùng để phân tích chuỗi JSON sang Java:

  • Streaming : sử dụng JsonParser để phân tích cú pháp json. Nó cung cấp các phần tử json như là các token. Sử dụng JsonGenerator để tạo ra json từ chuỗi, số nguyên, boolean, …
  • Tree Traversing : json có thể được đọc thành một JsonNode. Node sau đó có thể đi qua để có được thuộc tính cần thiết. Một cây cũng có thể được tạo ra và sau đó được viết như chuỗi json.
  • Data Binding (liên kết dữ liệu) : sử dụng Annotation để đánh dấu các thuộc tính trên đối tượng (POJO) liên kết với các phần tử của chuỗi JSON.

Tham khảo việc làm Java Fresher mới nhất trên TopDev!

Download thư viện Jackson

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.3</version>
</dependency>

Các ví dụ

Chuyển Java Object sang JSON

Student.java

package com.gpcoder.jackson.object;

import java.util.List;

public class Student {
    private String name;
    private int age;
    private List<Subject> subjects;

    public Student() {
        super();
    }

    public Student(String name, int age, List<Subject> subjects) {
        super();
        this.name = name;
        this.age = age;
        this.subjects = subjects;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public List<Subject> getSubjects() {
        return subjects;
    }

    public void setSubjects(List<Subject> subjects) {
        this.subjects = subjects;
    }

    @Override
        public String toString() {
            return "Student [name=" + name + ", age=" + age + ", subjects=" + subjects + "]";
    }
}

Subject.java

package com.gpcoder.jackson.object;

public class Subject {
    public Subject() {
        super();
    }

    private String name;
    private float point;

    public Subject(String name, float point) {
        super();
        this.name = name;
        this.point = point;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public float getPoint() {
        return point;
    }

    public void setPoint(float point) {
        this.point = point;
           }

    @Override
    public String toString() {
        return "Subject [name=" + name + ", point=" + point + "]";
    }

}

Chương trình chuyển đối tượng Java sang JSON

package com.gpcoder.jackson;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.gpcoder.jackson.object.Student;
import com.gpcoder.jackson.object.Subject;

public class Object2JsonExample {
    public static void main(String[] args) throws Exception {
        Student student = getStudent();

        ObjectMapper mapper = new ObjectMapper();

        // Convert object to JSON string and save into a file directly
        mapper.writeValue(new File("data/result.json"), student); // Plain JSON

        // Convert object to JSON string
        String jsonInString = mapper.writeValueAsString(student);
        System.out.println("JSON: " + jsonInString);

        // Convert object to JSON string and pretty print
        jsonInString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(student);
        System.out.println("JSON pretty print: " + jsonInString);
    }

    private static Student getStudent() {
        Subject math = new Subject("Math", 10.0f);
        Subject physical = new Subject("Physical", 8.5f);
        List<Subject> subjects = new ArrayList<>();
        subjects.add(math);
        subjects.add(physical);

        return new Student("GP Coder", 28, subjects);
    }
}

Thực thi chương trình trên, một file result.json được tạo ra trong thư mục data của project, console của ide hiển thị kết quả như sau:

JSON: {"name":"GP Coder","age":28,"subjects":[{"name":"Math","point":10.0},{"name":"Physical","point":8.5}]}

JSON pretty print: {
  "name" : "GP Coder",
  "age" : 28,
  "subjects" : [ {
    "name" : "Math",
    "point" : 10.0
  }, {
    "name" : "Physical",
    "point" : 8.5
  } ]
}

Phân tích JSON sang Java Object

package com.gpcoder.jackson;

import java.io.File;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.gpcoder.jackson.object.Student;

public class Json2ObjectExample {
    public static void main(String[] args) throws Exception {
        ObjectMapper mapper = new ObjectMapper();

        // Convert JSON string from file to Object
        Student student = mapper.readValue(new File("data/result.json"), Student.class);
        System.out.println(student);

        // Convert JSON string to Object
        String jsonInString = "{"name":"GP Coder","age":28,"subjects":[{"name":"Math","point":10.0},{"name":"Physical","point":8.0}]}";
        student = mapper.readValue(jsonInString, Student.class);
        System.out.println(student);

        // Pretty print
        jsonInString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(student);
        System.out.println(jsonInString);
    }
}

Kết quả thực thi chương trình trên:

Student [name=GP Coder, age=28, subjects=[Subject [name=Math, point=10.0], Subject [name=Physical, point=8.5]]]

Student [name=GP Coder, age=28, subjects=[Subject [name=Math, point=10.0], Subject [name=Physical, point=8.0]]]

{
  "name" : "GP Coder",
  "age" : 28,
  "subjects" : [ {
    "name" : "Math",
    "point" : 10.0
  }, {
    "name" : "Physical",
    "point" : 8.0
  } ]
}

Chuyển Json Array sang Java List

package com.gpcoder.jackson;

import java.util.ArrayList;
import java.util.List;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.gpcoder.jackson.object.Student;
import com.gpcoder.jackson.object.Subject;

public class ArrayExample {
    public static void main(String[] args) throws Exception {

        ObjectMapper mapper = new ObjectMapper();

        Student student1 = getStudent(1);
        Student student2 = getStudent(2);

        Student[] students = { student1, student2 };

        // Convert array object to JSON string
        String jsonInString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(students);
        System.out.println("JSON: " + jsonInString);

        // Convert a JSON Array format to a Java List object
        List<Student> list = mapper.readValue(jsonInString, new TypeReference<List<Student>>() {
        });
        for (Student student : list) {
            System.out.println(student);
        }
    }

    private static Student getStudent(int id) {
        Subject math = new Subject("Math", 10.0f);
        Subject physical = new Subject("Physical", 8.5f);
        List<Subject> subjects = new ArrayList<>();
        subjects.add(math);
        subjects.add(physical);

        return new Student("GP Coder " + id, 28, subjects);
    }
}

Kết quả thực thi chương trình trên:

JSON: [ {
  "name" : "GP Coder 1",
  "age" : 28,
  "subjects" : [ {
    "name" : "Math",
    "point" : 10.0
  }, {
   "name" : "Physical",
    "point" : 8.5
  } ]
}, {
    "name" : "GP Coder 2",
    "age" : 28,
    "subjects" : [ {
      "name" : "Math",
      "point" : 10.0
    }, {
      "name" : "Physical",
      "point" : 8.5
    } ]
} ]
Student [name=GP Coder 1, age=28, subjects=[Subject [name=Math, point=10.0], Subject [name=Physical, point=8.5]]]
Student [name=GP Coder 2, age=28, subjects=[Subject [name=Math, point=10.0], Subject [name=Physical, point=8.5]]]

Chuyển Json Object sang Java Map

package com.gpcoder.jackson;

import java.util.Map;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.gpcoder.jackson.object.Subject;

public class MapExample {
    public static void main(String[] args) throws Exception {

        ObjectMapper mapper = new ObjectMapper();

        Subject math = new Subject("Math", 10.0f);

        // Convert array object to JSON string
        String jsonInString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(math);
        System.out.println("JSON: " + jsonInString);

        // Convert a JSON to a Map
        Map<String, Object> map = mapper.readValue(jsonInString, new TypeReference<Map<String, Object>>() {
        });
        System.out.println("Map: " + map);
    }
}

Kết quả thực thi chương trình trên:

JSON: {
  "name" : "Math",
  "point" : 10.0
}
Map: {name=Math, point=10.0}