XML

Java – XMLをJavaオブジェクトに変換、JavaオブジェクトをXML文字列に変換する方法

Javaでは、XMLをJavaオブジェクトに変換したり、JavaオブジェクトをXML文字列に変換するには、主にJAXB(Java Architecture for XML Binding)を使用します。

JAXBはアノテーションを利用して、XMLとJavaオブジェクト間のマッピングを簡単に行えます。

XMLをJavaオブジェクトに変換するには、Unmarshallerを使用し、逆にJavaオブジェクトをXML文字列に変換するには、Marshallerを使用します。

JAXBは標準ライブラリに含まれていましたが、Java 9以降ではモジュール化の影響で外部依存として追加する必要があります。

目次から探す

JAXB(Java Architecture for XML Binding)とは
- JAXBの主な特徴
- JAXBの利用シーン
XMLをJavaオブジェクトに変換する方法
JavaオブジェクトをXML文字列に変換する方法
エラーハンドリングと注意点
- エラーハンドリング
- 注意点
実践例：サンプルコードで学ぶXMLとJavaオブジェクトの変換
JAXB以外の選択肢
まとめ

JAXB(Java Architecture for XML Binding)とは

JAXBは、Javaプログラミング言語におけるXMLデータのバインディングを提供するAPIです。

これにより、XMLデータをJavaオブジェクトに変換したり、JavaオブジェクトをXML形式で表現したりすることが容易になります。

JAXBを使用することで、XMLの読み書きがシンプルになり、データの操作が効率的に行えるようになります。

JAXBの主な特徴

自動バインディング: XMLスキーマからJavaクラスを自動生成することが可能。
シンプルなAPI: XMLの読み書きが簡単に行えるAPIを提供。
データの整合性: XMLデータとJavaオブジェクト間の変換において、データの整合性を保つことができる。

JAXBの利用シーン

Webサービスのデータ交換
設定ファイルの読み書き
データベースとの連携

JAXBを利用することで、XMLデータの操作が直感的になり、開発効率が向上します。

次のセクションでは、XMLをJavaオブジェクトに変換する具体的な方法について解説します。

XMLをJavaオブジェクトに変換する方法

XMLをJavaオブジェクトに変換するためには、JAXBを使用します。

以下の手順でXMLデータをJavaオブジェクトに変換することができます。

必要なライブラリのインストール

JAXBはJava SE 8以降に標準で含まれていますが、Java 9以降ではモジュール化されているため、必要に応じて以下の依存関係を追加する必要があります。

Mavenを使用している場合、pom.xmlに以下を追加します。

<dependency>
    <groupId>javax.xml.bind</groupId>
    <artifactId>jaxb-api</artifactId>
    <version>2.3.1</version>
</dependency>
<dependency>
    <groupId>org.glassfish.jaxb</groupId>
    <artifactId>jaxb-runtime</artifactId>
    <version>2.3.1</version>
</dependency>

XMLデータの例

以下のようなXMLデータを考えます。

<person>
    <name>山田太郎</name>
    <age>30</age>
</person>

Javaクラスの作成

このXMLデータに対応するJavaクラスを作成します。

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name = "person")
public class Person {
    private String name;
    private int age;
    @XmlElement
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    @XmlElement
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

XMLをJavaオブジェクトに変換するコード

次に、XMLをJavaオブジェクトに変換するためのコードを記述します。

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import java.io.StringReader;
public class App {
    public static void main(String[] args) {
        String xmlData = "<person><name>山田太郎</name><age>30</age></person>";
        
        try {
            JAXBContext context = JAXBContext.newInstance(Person.class);
            Unmarshaller unmarshaller = context.createUnmarshaller();
            
            // XMLデータをJavaオブジェクトに変換
            Person person = (Person) unmarshaller.unmarshal(new StringReader(xmlData));
            
            // 結果を表示
            System.out.println("名前: " + person.getName());
            System.out.println("年齢: " + person.getAge());
        } catch (JAXBException e) {
            e.printStackTrace();
        }
    }
}

上記のコードを実行すると、以下のような出力が得られます。

名前: 山田太郎
年齢: 30

このように、JAXBを使用することで、XMLデータを簡単にJavaオブジェクトに変換することができます。

次のセクションでは、JavaオブジェクトをXML文字列に変換する方法について解説します。

JavaオブジェクトをXML文字列に変換する方法

JavaオブジェクトをXML文字列に変換するためにも、JAXBを使用します。

以下の手順でJavaオブジェクトをXML形式にシリアライズすることができます。

必要なライブラリのインストール

前のセクションで説明した通り、JAXBはJava SE 8以降に標準で含まれています。

Java 9以降を使用している場合は、Mavenを使って以下の依存関係を追加してください。

<dependency>
    <groupId>javax.xml.bind</groupId>
    <artifactId>jaxb-api</artifactId>
    <version>2.3.1</version>
</dependency>
<dependency>
    <groupId>org.glassfish.jaxb</groupId>
    <artifactId>jaxb-runtime</artifactId>
    <version>2.3.1</version>
</dependency>

Javaクラスの例

前のセクションで作成したPersonクラスを使用します。

以下がそのクラスです。

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name = "person")
public class Person {
    private String name;
    private int age;
    @XmlElement
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    @XmlElement
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

JavaオブジェクトをXML文字列に変換するコード

次に、JavaオブジェクトをXML文字列に変換するためのコードを記述します。

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import java.io.StringWriter;
public class App {
    public static void main(String[] args) {
        Person person = new Person();
        person.setName("山田太郎");
        person.setAge(30);
        
        try {
            JAXBContext context = JAXBContext.newInstance(Person.class);
            Marshaller marshaller = context.createMarshaller();
            
            // フォーマットを整える
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
            
            // JavaオブジェクトをXML文字列に変換
            StringWriter writer = new StringWriter();
            marshaller.marshal(person, writer);
            String xmlOutput = writer.toString();
            
            // 結果を表示
            System.out.println(xmlOutput);
        } catch (JAXBException e) {
            e.printStackTrace();
        }
    }
}

上記のコードを実行すると、以下のようなXML形式の文字列が得られます。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
    <name>山田太郎</name>
    <age>30</age>
</person>

このように、JAXBを使用することで、Javaオブジェクトを簡単にXML文字列に変換することができます。

次のセクションでは、エラーハンドリングと注意点について解説します。

エラーハンドリングと注意点

JAXBを使用してXMLとJavaオブジェクトの変換を行う際には、いくつかのエラーハンドリングや注意点があります。

これらを理解しておくことで、よりスムーズに開発を進めることができます。

エラーハンドリング

JAXBExceptionの処理:

JAXBを使用する際には、JAXBExceptionが発生する可能性があります。

これは、XMLの構文エラーや、Javaオブジェクトのマッピングに失敗した場合に発生します。

例外処理を適切に行い、エラーメッセージをログに記録することが重要です。

   try {
       // JAXB処理
   } catch (JAXBException e) {
       System.err.println("JAXBエラー: " + e.getMessage());
   }

XMLの構文エラー:

XMLデータが不正な場合、変換処理は失敗します。

XMLの構文を事前に検証することが推奨されます。

不正なデータ型:

Javaオブジェクトのフィールドに対して、XMLデータが不正な型である場合、変換に失敗します。

例えば、整数型のフィールドに文字列が入っている場合などです。

注意点

XMLスキーマの整合性:
XMLデータがJavaクラスに正しくマッピングされるためには、XMLスキーマとJavaクラスの整合性が必要です。

フィールド名やデータ型が一致していることを確認してください。

エンコーディングの設定:
XMLのエンコーディングがUTF-8であることを確認してください。

特に日本語などのマルチバイト文字を扱う場合、エンコーディングの設定が重要です。

JAXBアノテーションの使用:
JAXBでは、XMLとJavaオブジェクトのマッピングを行うためにアノテーションを使用します。

適切なアノテーションを使用し、フィールドの可視性(public/private)に注意してください。

バージョン管理:
JAXBのバージョンによっては、APIの変更がある場合があります。

使用しているJavaのバージョンに応じたJAXBのバージョンを選択することが重要です。

これらのエラーハンドリングと注意点を考慮することで、JAXBを使用したXMLとJavaオブジェクトの変換がよりスムーズに行えるようになります。

次のセクションでは、実践例としてサンプルコードを通じてXMLとJavaオブジェクトの変換を学びます。

実践例：サンプルコードで学ぶXMLとJavaオブジェクトの変換

ここでは、XMLとJavaオブジェクトの相互変換を実際のサンプルコードを通じて学びます。

以下の例では、Personクラスを使用して、XMLデータをJavaオブジェクトに変換し、さらにJavaオブジェクトをXML文字列に変換する一連の流れを示します。

XMLデータの準備

まず、変換に使用するXMLデータを用意します。

以下のXMLデータを使用します。

<person>
    <name>佐藤花子</name>
    <age>25</age>
</person>

Javaクラスの定義

次に、XMLデータに対応するJavaクラスを定義します。

Personクラスは以下のようになります。

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name = "person")
public class Person {
    private String name;
    private int age;
    @XmlElement
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    @XmlElement
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

XMLをJavaオブジェクトに変換するコード

次に、XMLデータをJavaオブジェクトに変換するコードを記述します。

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import java.io.StringReader;
public class App {
    public static void main(String[] args) {
        String xmlData = "<person><name>佐藤花子</name><age>25</age></person>";
        
        try {
            JAXBContext context = JAXBContext.newInstance(Person.class);
            Unmarshaller unmarshaller = context.createUnmarshaller();
            
            // XMLデータをJavaオブジェクトに変換
            Person person = (Person) unmarshaller.unmarshal(new StringReader(xmlData));
            
            // 結果を表示
            System.out.println("名前: " + person.getName());
            System.out.println("年齢: " + person.getAge());
        } catch (JAXBException e) {
            e.printStackTrace();
        }
    }
}

JavaオブジェクトをXML文字列に変換するコード

次に、JavaオブジェクトをXML文字列に変換するコードを記述します。

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import java.io.StringWriter;
public class App {
    public static void main(String[] args) {
        Person person = new Person();
        person.setName("佐藤花子");
        person.setAge(25);
        
        try {
            JAXBContext context = JAXBContext.newInstance(Person.class);
            Marshaller marshaller = context.createMarshaller();
            
            // フォーマットを整える
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
            
            // JavaオブジェクトをXML文字列に変換
            StringWriter writer = new StringWriter();
            marshaller.marshal(person, writer);
            String xmlOutput = writer.toString();
            
            // 結果を表示
            System.out.println(xmlOutput);
        } catch (JAXBException e) {
            e.printStackTrace();
        }
    }
}

上記のコードを実行すると、以下のような出力が得られます。

XMLをJavaオブジェクトに変換した結果

名前: 佐藤花子
年齢: 25

JavaオブジェクトをXML文字列に変換した結果

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<person>
    <name>佐藤花子</name>
    <age>25</age>
</person>

この実践例を通じて、XMLとJavaオブジェクトの相互変換の流れを理解できたと思います。

JAXBを使用することで、XMLデータの操作が非常に簡単になり、開発効率が向上します。

次のセクションでは、JAXB以外の選択肢について解説します。

JAXB以外の選択肢

JAXBはXMLとJavaオブジェクトの変換において非常に便利なライブラリですが、他にもいくつかの選択肢があります。

以下に、JAXBの代替として利用できるライブラリやフレームワークを紹介します。

DOM (Document Object Model)

概要: DOMはXML文書をツリー構造で表現するAPIです。

XMLをプログラムで操作するための基本的な方法を提供します。

特徴:
XML文書全体をメモリに読み込むため、大きなXMLファイルには不向き。
ノードを直接操作できるため、柔軟性が高い。
使用例:
XMLの特定の要素を検索したり、変更したりする場合に便利。

SAX (Simple API for XML)

概要: SAXはXMLをストリームとして処理するためのAPIです。

XML文書を逐次的に読み込むため、メモリ効率が良いです。

特徴:
大きなXMLファイルを扱う際に適している。
イベント駆動型であるため、特定の要素に対する処理を定義する必要がある。
使用例:
大量のデータを持つXMLファイルを解析する場合に有効。

XStream

概要: XStreamはJavaオブジェクトとXMLの相互変換を簡単に行うためのライブラリです。
特徴:
シンプルなAPIで、アノテーションを使用せずにJavaオブジェクトをXMLに変換できる。
JSONやYAMLなど、他のフォーマットへの変換もサポート。
使用例:
簡単にXMLを生成したい場合や、異なるフォーマットへの変換が必要な場合に便利。

Jackson

概要: Jacksonは主にJSONの処理に使用されるライブラリですが、XMLの処理もサポートしています。
特徴:
高速で、柔軟なデータバインディングを提供。
JSONとXMLの両方を扱えるため、異なるデータフォーマットを統一的に扱いたい場合に便利。
使用例:
RESTful APIでJSONとXMLの両方を扱う場合に適している。

Simple XML Framework

概要: Simple XML Frameworkは、XMLとJavaオブジェクトの変換を簡単に行うための軽量なライブラリです。
特徴:
アノテーションを使用して、XMLのマッピングを簡単に定義できる。
シンプルで使いやすいAPIを提供。
使用例:
小規模なプロジェクトや、シンプルなXML処理が必要な場合に適している。

これらの選択肢は、プロジェクトの要件やデータの特性に応じて使い分けることが重要です。

JAXBが最適な選択肢である場合もあれば、他のライブラリがより適している場合もあります。

各ライブラリの特徴を理解し、適切なものを選択することで、開発効率を向上させることができます。

まとめ

この記事では、XMLとJavaオブジェクトの相互変換に関する基本的な知識や具体的な実装方法について詳しく解説しました。

JAXBを使用することで、XMLデータをJavaオブジェクトに変換したり、逆にJavaオブジェクトをXML形式に変換したりするプロセスが簡単に行えることがわかりました。

これを機に、実際のプロジェクトでXMLとJavaの連携を試みて、データ処理の効率を向上させてみてはいかがでしょうか。

JAXB(Java Architecture for XML Binding)とは

JAXBの主な特徴

JAXBの利用シーン

XMLをJavaオブジェクトに変換する方法

必要なライブラリのインストール

XMLデータの例

Javaクラスの作成

XMLをJavaオブジェクトに変換するコード

JavaオブジェクトをXML文字列に変換する方法

必要なライブラリのインストール

Javaクラスの例

JavaオブジェクトをXML文字列に変換するコード

エラーハンドリングと注意点

エラーハンドリング

注意点

実践例：サンプルコードで学ぶXMLとJavaオブジェクトの変換

XMLデータの準備

Javaクラスの定義

XMLをJavaオブジェクトに変換するコード

JavaオブジェクトをXML文字列に変換するコード

XMLをJavaオブジェクトに変換した結果

JavaオブジェクトをXML文字列に変換した結果

JAXB以外の選択肢

DOM (Document Object Model)

SAX (Simple API for XML)

XStream

Jackson

Simple XML Framework

まとめ

関連記事