JavaクラスからXSDを生成する方法はありますか？

1年 ago

陽, 向宇

4 minutes

最近の投稿では、JavaのJAXBについて学び、XSDからJavaクラスを生成する方法を学びました。今日は、JavaクラスからXSDを生成する方法について学びます。

JavaクラスからXSDを生成する

マヴンプロジェクトでJAXB-2 Mavenプラグインを使用して、JavaクラスからXSDを生成します。

JAXB2 Maven Plugin uses JAXB SchemaGenerator utility to generate XSD from java classes.
Java classes should have JAXB annotations to be used by this plugin.
Minimum java version required is Java 5

最初に、新しいMavenプロジェクトを作成します。任意の名前、グループID、アーティファクトIDを付けることができます。プロジェクトをビルドすると、target/generated-resources/schemagenディレクトリにXSDクラスが生成されます。ビルド後、プロジェクトの構造は以下の画像のようになります。以下が私たちが持っている最終的なpom.xmlファイルです。

<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>jaxb-schemagen</groupId>
	<artifactId>jaxb-schemagen</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<dependencies>
		<dependency>
			<groupId>javax.xml.bind</groupId>
			<artifactId>jaxb-api</artifactId>
			<version>2.1</version>
		</dependency>
	</dependencies>

	<build>
		<pluginManagement>
			<plugins>
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-compiler-plugin</artifactId>
					<version>2.5.1</version>
				</plugin>
			</plugins>
		</pluginManagement>

		<plugins>
			<plugin>
				<groupId>org.codehaus.mojo</groupId>
				<artifactId>jaxb2-maven-plugin</artifactId>
				<version>1.5</version>
				<executions>
					<execution>
						<id>schemagen</id>
						<goals>
							<goal>schemagen</goal>
						</goals>
					</execution>
				</executions>

				<configuration>
					<transformSchemas>
						<transformSchema>
							<uri>https://www.example.org/employee</uri>
							<toPrefix>empns</toPrefix>
							<toFile>employee.xsd</toFile>
						</transformSchema>
						<transformSchema>
							<uri>https://www.example.org/address</uri>
							<toPrefix>addrns</toPrefix>
							<toFile>address.xsd</toFile>
						</transformSchema>
					</transformSchemas>
					<includes>
						<include>com/scdev/bean/*</include>
					</includes>
					<verbose>true</verbose>

				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

いくつかの注意点は、jaxbの依存関係、schemagenの実行ゴール、およびtransformSchemaの設定です。transformSchemaの設定は、生成されるXSDファイルの名前と名前空間の接頭辞を指定するために使用されます。ここには、XSDを生成するために使用されるJavaクラス、Employee.javaがあります。

package com.scdev.bean;


import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlType;

@XmlType(namespace = "https://www.example.org/employee")
public class Employee {
    private String name;
    private int id;
    private String role;
    private Address address;


    public String getName() {
        return name;
    }


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


    @XmlAttribute
    public int getId() {
        return id;
    }


    public void setId(int id) {
        this.id = id;
    }


    public String getRole() {
        return role;
    }


    public void setRole(String role) {
        this.role = role;
    }


    public Address getAddress() {
        return address;
    }


    public void setAddress(Address address) {
        this.address = address;
    }
}

クラスとフィールドidに使用される名前空間のあるXmlTypeアノテーションに注意してください。このクラスは、プロジェクトをビルドするとemployee.xsdスキーマを生成します。フィールドには別のカスタムクラスであるAddressフィールドがあるため、成功したスキーマの生成のためにこのクラスにもアノテーションを付ける必要があります。以下は、jaxbアノテーションを持つaddressクラスです。Address.java

package com.scdev.bean;

import javax.xml.bind.annotation.XmlType;

@XmlType(namespace = "https://www.example.org/address")
public class Address {
    private String city;
    private int zip;
    private String addressLine1;
    private String addressLine2;
    public String getCity() {
        return city;
    }
    public void setCity(String city) {
        this.city = city;
    }
    public int getZip() {
        return zip;
    }
    public void setZip(int zip) {
        this.zip = zip;
    }
    public String getAddressLine1() {
        return addressLine1;
    }
    public void setAddressLine1(String addressLine1) {
        this.addressLine1 = addressLine1;
    }
    public String getAddressLine2() {
        return addressLine2;
    }
    public void setAddressLine2(String addressLine2) {
        this.addressLine2 = addressLine2;
    }
    
}

このクラスは、pom.xmlファイルのtransformSchemaで名前が一致しているため、address.xsdを生成します。プロジェクトのセットアップは完了しており、コマンドmvn clean installでプロジェクトをビルドするだけでXSDファイルが生成されます。私のプロジェクトでは、以下のように生成されたXSDファイルがあります。employee.xsd

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns:addrns="https://www.example.org/address" targetNamespace="https://www.example.org/employee" version="1.0">

  <xs:import namespace="https://www.example.org/address" schemaLocation="address.xsd"/>

  <xs:complexType name="employee">
    <xs:sequence>
      <xs:element minOccurs="0" name="address" type="ns1:address"/>
      <xs:element minOccurs="0" name="name" type="xs:string"/>
      <xs:element minOccurs="0" name="role" type="xs:string"/>
    </xs:sequence>
    <xs:attribute name="id" type="xs:int" use="required"/>
  </xs:complexType>
</xs:schema>

アドレス.xsd

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema xmlns:xs="https://www.w3.org/2001/XMLSchema" targetNamespace="https://www.example.org/address" version="1.0">

  <xs:complexType name="address">
    <xs:sequence>
      <xs:element minOccurs="0" name="addressLine1" type="xs:string"/>
      <xs:element minOccurs="0" name="addressLine2" type="xs:string"/>
      <xs:element minOccurs="0" name="city" type="xs:string"/>
      <xs:element name="zip" type="xs:int"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

JavaクラスからXSDを生成する際の手順は以上です。非常に簡単で、JavaクラスからXSDを生成する素晴らしい方法です。役立つことや理解しやすいと思いますので、ぜひ活用してください。