2. 程式人生 > 其它 >Jsonschema2pojo從JSON生成Java類(Maven)

Jsonschema2pojo從JSON生成Java類(Maven)

阿新 • • 發佈：2021-01-23

技術標籤：javamaven大資料gradlevue

1.說明

jsonschema2pojo工具可以從JSON Schema(或示例JSON檔案)生成Java型別，
並且可以配置生成Jackson 1.x,Jackson 2.x, Moshi 1.x或者Gson庫的註解。
支援將jsonschema2pojo作為Maven外掛、Ant任務、命令列工具、
Gradle外掛或嵌入到Java應用程式中。
本文僅介紹Maven外掛使用方式。
另外該工具還提供了線上版本,
可以在網站上直接使用：jsonschema2pojo online

2.建立Maven工程

Eclipse -> File -> New -> Other... -> Maven -> Maven Project

建立一個簡單Maven工程，
pom.xml如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>edu.yuwen.util</groupId>
        <artifactId>json-file</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <artifactId>generate-jsonschema2pojo</artifactId>
    <description>jsonschema2pojo generates Java types from JSON Schema (or example JSON)</description>
</project>

3.引入Maven外掛

Maven方式生成Java類需要jsonschema2pojo-maven-plugin，
在pom.xml引入這個外掛：

<build>
    <plugins>
        <plugin>
            <groupId>org.jsonschema2pojo</groupId>
            <artifactId>jsonschema2pojo-maven-plugin</artifactId>
            <version>1.0.2</version>
            <configuration>
                <sourceDirectory>${basedir}/src/main/resources/schema</sourceDirectory>
                <targetPackage>com.example.types</targetPackage>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

裡面的配置項指定了JSON schema檔案的目錄，
以及生成的Java類的包路徑。

4.新建JSON Schema

在src/main/resources/schema目錄下
新建JSON Schema檔案address.schema.json:

{
  "$id": "https://example.com/address.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "An address similar to http://microformats.org/wiki/h-card",
  "type": "object",
  "properties": {
    "post-office-box": {
      "type": "string"
    },
    "extended-address": {
      "type": "string"
    },
    "street-address": {
      "type": "string"
    },
    "locality": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "postal-code": {
      "type": "string"
    },
    "country-name": {
      "type": "string"
    }
  },
  "required": [ "locality", "region", "country-name" ],
  "dependencies": {
    "post-office-box": [ "street-address" ],
    "extended-address": [ "street-address" ]
  }
}

5.執行Maven外掛

執行Maven命令，
執行外掛功能：
mvn generate-sources
或者
mvn package
Maven執行成功後，
會生成target/generated-sources/jsonschema2pojo/com/example/types/Address.java類。
推薦使用mvn generate-sources，
這樣生成的target目錄更乾淨些。

6.檢視Address.java

package com.example.types;

import java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

/**
 * An address similar to http://microformats.org/wiki/h-card
 * 
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
    "post-office-box",
    "extended-address",
    "street-address",
    "locality",
    "region",
    "postal-code",
    "country-name"
})
public class AddressSchema {

    @JsonProperty("post-office-box")
    private String postOfficeBox;
    @JsonProperty("extended-address")
    private String extendedAddress;
    @JsonProperty("street-address")
    private String streetAddress;
    /**
     * 
     * (Required)
     * 
     */
    @JsonProperty("locality")
    private String locality;
    /**
     * 
     * (Required)
     * 
     */
    @JsonProperty("region")
    private String region;
    @JsonProperty("postal-code")
    private String postalCode;
    /**
     * 
     * (Required)
     * 
     */
    @JsonProperty("country-name")
    private String countryName;
    @JsonIgnore
    private Map<String, Object> additionalProperties = new HashMap<String, Object>();

    @JsonProperty("post-office-box")
    public String getPostOfficeBox() {
        return postOfficeBox;
    }

    @JsonProperty("post-office-box")
    public void setPostOfficeBox(String postOfficeBox) {
        this.postOfficeBox = postOfficeBox;
    }

    @JsonProperty("extended-address")
    public String getExtendedAddress() {
        return extendedAddress;
    }

    @JsonProperty("extended-address")
    public void setExtendedAddress(String extendedAddress) {
        this.extendedAddress = extendedAddress;
    }

    @JsonProperty("street-address")
    public String getStreetAddress() {
        return streetAddress;
    }

    @JsonProperty("street-address")
    public void setStreetAddress(String streetAddress) {
        this.streetAddress = streetAddress;
    }

    /**
     * 
     * (Required)
     * 
     */
    @JsonProperty("locality")
    public String getLocality() {
        return locality;
    }

    /**
     * 
     * (Required)
     * 
     */
    @JsonProperty("locality")
    public void setLocality(String locality) {
        this.locality = locality;
    }

    /**
     * 
     * (Required)
     * 
     */
    @JsonProperty("region")
    public String getRegion() {
        return region;
    }

    /**
     * 
     * (Required)
     * 
     */
    @JsonProperty("region")
    public void setRegion(String region) {
        this.region = region;
    }

    @JsonProperty("postal-code")
    public String getPostalCode() {
        return postalCode;
    }

    @JsonProperty("postal-code")
    public void setPostalCode(String postalCode) {
        this.postalCode = postalCode;
    }

    /**
     * 
     * (Required)
     * 
     */
    @JsonProperty("country-name")
    public String getCountryName() {
        return countryName;
    }

    /**
     * 
     * (Required)
     * 
     */
    @JsonProperty("country-name")
    public void setCountryName(String countryName) {
        this.countryName = countryName;
    }

    @JsonAnyGetter
    public Map<String, Object> getAdditionalProperties() {
        return this.additionalProperties;
    }

    @JsonAnySetter
    public void setAdditionalProperty(String name, Object value) {
        this.additionalProperties.put(name, value);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append(AddressSchema.class.getName()).append('@').append(Integer.toHexString(System.identityHashCode(this))).append('[');
        sb.append("postOfficeBox");
        sb.append('=');
        sb.append(((this.postOfficeBox == null)?"<null>":this.postOfficeBox));
        sb.append(',');
        sb.append("extendedAddress");
        sb.append('=');
        sb.append(((this.extendedAddress == null)?"<null>":this.extendedAddress));
        sb.append(',');
        sb.append("streetAddress");
        sb.append('=');
        sb.append(((this.streetAddress == null)?"<null>":this.streetAddress));
        sb.append(',');
        sb.append("locality");
        sb.append('=');
        sb.append(((this.locality == null)?"<null>":this.locality));
        sb.append(',');
        sb.append("region");
        sb.append('=');
        sb.append(((this.region == null)?"<null>":this.region));
        sb.append(',');
        sb.append("postalCode");
        sb.append('=');
        sb.append(((this.postalCode == null)?"<null>":this.postalCode));
        sb.append(',');
        sb.append("countryName");
        sb.append('=');
        sb.append(((this.countryName == null)?"<null>":this.countryName));
        sb.append(',');
        sb.append("additionalProperties");
        sb.append('=');
        sb.append(((this.additionalProperties == null)?"<null>":this.additionalProperties));
        sb.append(',');
        if (sb.charAt((sb.length()- 1)) == ',') {
            sb.setCharAt((sb.length()- 1), ']');
        } else {
            sb.append(']');
        }
        return sb.toString();
    }

    @Override
    public int hashCode() {
        int result = 1;
        result = ((result* 31)+((this.postOfficeBox == null)? 0 :this.postOfficeBox.hashCode()));
        result = ((result* 31)+((this.streetAddress == null)? 0 :this.streetAddress.hashCode()));
        result = ((result* 31)+((this.postalCode == null)? 0 :this.postalCode.hashCode()));
        result = ((result* 31)+((this.locality == null)? 0 :this.locality.hashCode()));
        result = ((result* 31)+((this.countryName == null)? 0 :this.countryName.hashCode()));
        result = ((result* 31)+((this.additionalProperties == null)? 0 :this.additionalProperties.hashCode()));
        result = ((result* 31)+((this.extendedAddress == null)? 0 :this.extendedAddress.hashCode()));
        result = ((result* 31)+((this.region == null)? 0 :this.region.hashCode()));
        return result;
    }

    @Override
    public boolean equals(Object other) {
        if (other == this) {
            return true;
        }
        if ((other instanceof AddressSchema) == false) {
            return false;
        }
        AddressSchema rhs = ((AddressSchema) other);
        return (((((((((this.postOfficeBox == rhs.postOfficeBox)||((this.postOfficeBox!= null)&&this.postOfficeBox.equals(rhs.postOfficeBox)))&&((this.streetAddress == rhs.streetAddress)||((this.streetAddress!= null)&&this.streetAddress.equals(rhs.streetAddress))))&&((this.postalCode == rhs.postalCode)||((this.postalCode!= null)&&this.postalCode.equals(rhs.postalCode))))&&((this.locality == rhs.locality)||((this.locality!= null)&&this.locality.equals(rhs.locality))))&&((this.countryName == rhs.countryName)||((this.countryName!= null)&&this.countryName.equals(rhs.countryName))))&&((this.additionalProperties == rhs.additionalProperties)||((this.additionalProperties!= null)&&this.additionalProperties.equals(rhs.additionalProperties))))&&((this.extendedAddress == rhs.extendedAddress)||((this.extendedAddress!= null)&&this.extendedAddress.equals(rhs.extendedAddress))))&&((this.region == rhs.region)||((this.region!= null)&&this.region.equals(rhs.region))));
    }

}

7.引入外掛依賴

當把Address.java放到工程的src/main/java目錄下時，
Java編譯會報錯，
這是因為生成的型別依賴於Commons Lang的equals、hashCode和toString。
一些模式結構也會以Jackson註釋的形式產生解析器提示。
需要在pom.xml中新增必要的依賴：

<dependencies>
    <dependency>
        <groupId>commons-lang</groupId>
        <artifactId>commons-lang</artifactId>
        <version>2.4</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.5.4</version>
    </dependency>
</dependencies>

8.新建JSON檔案

上面演示了從JSON Schema生成Java類，
下面演示從JSON檔案生成Java類，
首先在src\main\resources\json目錄下，
新建一個JOSN檔案person.json：

{
    "name":"bob",
    "age":33
}

9.修改外掛配置

主要是指定了sourceType和sourceDirectory，
指定了原始檔的格式是json和所在目錄。

<build>
    <plugins>
        <plugin>
            <groupId>org.jsonschema2pojo</groupId>
            <artifactId>jsonschema2pojo-maven-plugin</artifactId>
            <version>1.0.2</version>
            <configuration>
                <sourceType>json</sourceType>
                <sourceDirectory>${basedir}/src/main/resources/json</sourceDirectory>
                <outputDirectory>${basedir}/src/main/java</outputDirectory>
                <targetPackage>com.example.types</targetPackage>
                <addCompileSourceRoot>true</addCompileSourceRoot>
                <annotationStyle>jackson2</annotationStyle>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

10.生成Person.java類

mvn generate-sources執行成功後，
會生成src/main/java/com/example/types/Person.java：

package com.example.types;

import java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
    "name",
    "age"
})
public class Person {

    @JsonProperty("name")
    private String name;
    @JsonProperty("age")
    private Integer age;
    @JsonIgnore
    private Map<String, Object> additionalProperties = new HashMap<String, Object>();

    @JsonProperty("name")
    public String getName() {
        return name;
    }

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

    @JsonProperty("age")
    public Integer getAge() {
        return age;
    }

    @JsonProperty("age")
    public void setAge(Integer age) {
        this.age = age;
    }

    @JsonAnyGetter
    public Map<String, Object> getAdditionalProperties() {
        return this.additionalProperties;
    }

    @JsonAnySetter
    public void setAdditionalProperty(String name, Object value) {
        this.additionalProperties.put(name, value);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append(Person.class.getName()).append('@').append(Integer.toHexString(System.identityHashCode(this))).append('[');
        sb.append("name");
        sb.append('=');
        sb.append(((this.name == null)?"<null>":this.name));
        sb.append(',');
        sb.append("age");
        sb.append('=');
        sb.append(((this.age == null)?"<null>":this.age));
        sb.append(',');
        sb.append("additionalProperties");
        sb.append('=');
        sb.append(((this.additionalProperties == null)?"<null>":this.additionalProperties));
        sb.append(',');
        if (sb.charAt((sb.length()- 1)) == ',') {
            sb.setCharAt((sb.length()- 1), ']');
        } else {
            sb.append(']');
        }
        return sb.toString();
    }

    @Override
    public int hashCode() {
        int result = 1;
        result = ((result* 31)+((this.name == null)? 0 :this.name.hashCode()));
        result = ((result* 31)+((this.additionalProperties == null)? 0 :this.additionalProperties.hashCode()));
        result = ((result* 31)+((this.age == null)? 0 :this.age.hashCode()));
        return result;
    }

    @Override
    public boolean equals(Object other) {
        if (other == this) {
            return true;
        }
        if ((other instanceof Person) == false) {
            return false;
        }
        Person rhs = ((Person) other);
        return ((((this.name == rhs.name)||((this.name!= null)&&this.name.equals(rhs.name)))&&((this.additionalProperties == rhs.additionalProperties)||((this.additionalProperties!= null)&&this.additionalProperties.equals(rhs.additionalProperties))))&&((this.age == rhs.age)||((this.age!= null)&&this.age.equals(rhs.age))));
    }
}

11.外掛配置項說明

  1. sourceType:兩個可選值，JSON Schema或者JSON檔案，預設為JSON Schema。
  2. sourceDirectory:原始檔所在的目錄，會將該目錄下所有檔案進行轉換，不支援指定單個檔案，如果不想全部轉換，可以新增一個excludes節點。
  3. outputDirectory:生成Java Pojo類的(根)目錄，生成Java類的目錄為此目錄+包目錄，預設值為target/generated-sources/jsonschema2pojo。
  4. targetPackage:生成的Java pojo類的包路徑。
  5. addCompileSourceRoot:是否將輸出目錄作為專案的原始碼根目錄。
  6. annotationStyle:生成的(欄位)註解樣式，五個可選值：jackson1、jackson2、gson、moshi1和none，預設是jackson2，如果fastjson等工具不支援的，需要設定為none。

更多配置項的使用請參考：jsonschema2pojo-maven-plugin Optional Parameters

12.參考文章

使用maven根據JSON檔案自動生成Java POJO類(Java Bean)原始檔jsonschema2pojo github

相關推薦

Jsonschema2pojo從JSON生成Java類(Maven)

技術標籤：javamaven大資料gradlevue 1.說明 jsonschema2pojo工具可以從JSON Schema(或示例JSON檔案)生成Java型別， 並且可以配置生成Jackson 1.x,Jackson 2.x, Moshi 1.x或者Gson庫的註解。 支援將jsonschema2

利用json2POJO with Lombok 外掛自動生成java類的操作

前言 很多時候，我們定義介面或者呼叫別人的介面時，手裡只有一份介面文件，文件中提供一段示例json格式的報文，我們需要根據json中的欄位，挨個去定義java POJO 的欄位屬性。

JAVA 16位ID生成工具類含16位不重複的隨機數數字+大小寫

本文介紹了Java隨機數，分享給大家，也順便做個筆記 package com.fty.util; import java.security.SecureRandom;

Java小工具類（一）json的K-V轉換為Java類屬性

場景：最近研究gitlab的api，通過post\\get json物件的方式去新建或修改專案、組、鉤子等操作，其json物件需要大量的key-value屬性，新建一個專案類需要一個個敲屬性感覺十分繁瑣，就寫了這樣一個工具，將json物件輸

IDEA使用Maven骨架建立的web專案沒有生成java、resources、test資料夾，不要再看治標不治本的辦法了

問題示意圖： 搜尋引擎中能搜到的各類解決辦法都是相互抄襲，根本治標不治本，自己手動建立資料夾的方式還需要抄？本機永久解決辦法如下：

學習SSM整合中使用mysql-conector-java自動將資料庫中表資訊提取生成bean類的細節錯誤

跟著視訊學習時，在編寫生成配置檔案generatorConfiguration時，因為本身是macos系統，所以在路徑的斜槓編寫錯誤，從而導致了程式無錯誤執行後，沒有生成相應的Bean類，如下圖

從資料庫動態生成enum類（示例）

public TypeInfo GetBusinessUnitEnum() { // Create a dynamic assembly in the current application domain,

JAVA讀取EXCEL_自動生成實體類

程式碼實現PropertyAnno.java import java.lang.annotation.ElementType; import java.lang.annotation.Retention;

json轉java物件，java物件轉json，自定義工具類封裝物件與寫給客戶端

技術標籤：javajson jackson：apache jar包 一.jackson的方法 ObjectMapper類的靜態方法： 1.將json轉物件的方法:

從零開始學JAVA——類的成員之四，程式碼塊（或初始化塊）

技術標籤：javajava 類的成員之四，程式碼塊（或初始化塊） 1.程式碼塊的使用：用來初始化類、物件2.程式碼塊如果有修飾的話，只能使用static3.分類：靜態程式碼塊與非靜態程式碼塊4.靜態程式碼塊

批量根據xml檔案生成java實體類

應用背景： 本人是醫療軟體的開發者， 有許多要跟其他廠商互動的資料， 這次是要接收來自平臺的xml格式的資料。 使用dom4j一樣可以解析，但是這樣的話後期不容易維護，而且程式可讀性也差。（其實主要還是不能用Alt

Java中類轉json的基類實現

類轉json的基類實現 專案地址 github地址 實現原理 使用反射獲取類的屬性名和屬性內容。具體原理可以自己查一下資料

使用 Java 和 Maven (JBake) 生成靜態網站

使用 JBake（“mvn generate-resources”）構建您的靜態網站或部落格。使用佈局、巨集和資料檔案。

從資料庫表生成C#類

DECLARE @TableName sysname = \'T_Location\'; DECLARE @Result VARCHAR(MAX) = \'public class \' + @TableName + \'

學到了_IDEA從資料庫表生成實體類

目錄 IDEA連線資料庫 選擇表生成實體 自定義配置 照舊，先說點廢話，因為以前太蠢了，每次資料庫裡的表的欄位要去生成實體物件時，都哼哧哼哧自己手動去寫那些該死的欄位名，還有可能手寫寫錯，如今我終於悟了，

通過原始碼，例項詳解java類載入機制

之前的文章中，介紹了class的位元組碼靜態結構，這些類需要jvm載入到其在記憶體中分配的執行時資料區才會生效，這個過程包含：載入 -> 連結 -> 初始化 幾個階段，其中連結階段又有驗證 -> 準備 -> 解析三

java類載入之初始化過程（附面試題）

類或介面的初始化過程就是執行它們的初始化方法<clinit>。這個方法是由編譯器在編譯的時候生成到class檔案中的，包含類靜態field賦值指令和靜態語句塊（static{}）中的程式碼指令兩部分，順序和原始碼中的順序

JVM—【03】認識Java類的生命週期、類載入的過程、雙親委派機制

1. 初識類載入 JVM把描述類的資料從Class檔案載入到記憶體，並對資料進行校驗、轉換解析和初始化，最終形成可以被虛擬機器器直接使用的Java型別，這就是虛擬機器器的類載入機制。

Java類載入和類的生命週期

類載入 什麼是類載入 類載入做的工作有: 將類的.class檔案中的二進位制資料讀入到記憶體中，將其放在執行時資料區的方法區內

如何測試Java類的執行緒安全性

這篇文章主要介紹瞭如何測試Java類的執行緒安全性,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下