XStream-クイックガイド

XStreamは、JavaオブジェクトをXMLに、またはその逆にシリアル化するための単純なJavaベースのライブラリです。

特徴

  • Easy to use − XStream APIは、一般的なユースケースを簡素化するための高レベルのファサードを提供します。

  • No need to create mapping − XStream APIは、シリアル化されるほとんどのオブジェクトにデフォルトのマッピングを提供します。

  • Performance − XStreamは高速で、メモリフットプリントが小さいため、大きなオブジェクトのグラフやシステムに適しています。

  • Clean XML − XStreamは、読みやすいクリーンでコンパクトなXML出力を生成します。

  • Object modification not required− xStreamは、プライベートフィールドやファイナルフィールドなどの内部フィールドをシリアル化し、非パブリッククラスと内部クラスをサポートします。デフォルトのコンストラクターは必須の要件ではありません。

  • Full object graph support − XStreamを使用すると、オブジェクトモデルで検出された重複参照を維持でき、循環参照もサポートされます。

  • Customizable conversion strategies −特定のタイプのカスタマイズをXMLとして表現できるようにするために、カスタム戦略を登録できます。

  • Security framework − XStreamは、マーシャリングされていないタイプを公正に制御して、操作された入力に関するセキュリティの問題を防ぎます。

  • Error messages − XMLの形式が正しくないために例外が発生すると、問題を修正するための詳細な診断が提供されます。

  • Alternative output format − XStreamは、JSONやモーフィングなどの他の出力形式をサポートします。

一般的な使用法

  • Transport − XMLはオブジェクトのテキスト表現であり、使用されるシリアル化/逆シリアル化の手法とは関係なく、ネットワークを介してオブジェクトを転送するために使用できます。

  • Persistence −オブジェクトはデータベースにXMLとして永続化でき、必要に応じてマーシャリング/アンマーシャリングできます。

  • Configuration− XMLは自明であり、構成を定義するために頻繁に使用されます。オブジェクトは、XML表現に変換した後、構成目的で使用することもできます。

  • Unit Tests − XStream APIはJUnitと互換性があり、アプリケーションモジュールの単体テストを強化するために使用できます。

この章では、Javaに適した環境をセットアップするさまざまな側面について説明します。

ローカル環境のセットアップ

Javaプログラミング言語用の環境をセットアップする場合は、このセクションで、マシンに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：\ ProgramFiles \ 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バイナリがインストールされている場所を指すように設定する必要があります。これを行うのに問題がある場合は、シェルのドキュメントを参照してください。

たとえば、シェルとしてbashを使用する場合は、「。bashrc：export PATH = / path / to / java：$ PATH」の最後に次の行を追加します。

人気のあるJavaエディター

Javaプログラムを作成するには、テキストエディタが必要です。市場にはさらに洗練されたIDEがあります。しかし今のところ、あなたは次のいずれかを考えることができます-

  • Notepad − Windowsでは、メモ帳（このチュートリアルで推奨）やTextPadなどの単純なテキストエディターを使用できます。

  • Netbeans −これは無料でダウンロードできるJavaIDEです。 https://www.netbeans.org/index.html。

  • Eclipse −これはEclipseオープンソースコミュニティによって開発されたJava IDEでもあり、からダウンロードできます。 https://www.eclipse.org/。

XStreamアーカイブをダウンロード

xstream-1.4.7.jarから最新バージョンのXStreamjarファイルをダウンロードします。このチュートリアルの執筆時点で、xstream-1.4.7.jarをダウンロードし、C：\> XStreamフォルダーにコピーしました。

OS アーカイブ名
ウィンドウズ xstream-1.4.7.jar
Linux xstream-1.4.7.jar
マック xstream-1.4.7.jar

XStream環境を設定する

をセットする XStream_HOMExstreamjarがマシンに保存されているベースディレクトリの場所を指す環境変数。次の表は、XStreamフォルダーにxstream-1.4.7.jarを抽出したと仮定して、Windows、Linux、およびMacでXStream環境を設定する方法を示しています。

シニア番号 OSと説明
1

Windows

環境変数XStream_HOMEをC：\ XStreamに設定します
2

Linux

XStream_HOME = / usr / local / XStreamをエクスポートします
3

Mac

XStream_HOME = / Library / XStreamをエクスポートします

CLASSPATH変数を設定する

をセットする CLASSPATHXStreamjarの場所を指す環境変数。次の表は、xstream-1.4.7.jarをXStreamフォルダーに格納したと仮定して、Windows、Linux、およびMacシステムでCLASSPATH変数を設定する方法を示しています。

シニア番号 OSと説明
1

Windows

環境変数CLASSPATHを％CLASSPATH％;％XStream_HOME％\ xstream-1.4.7.jar;に設定します。
2

Linux

export CLASSPATH = $ CLASSPATH：$ XStream_HOME / xstream-1.4.7.jar;
3

Mac

export CLASSPATH = $ CLASSPATH：$ XStream_HOME / xstream-1.4.7.jar;

XStreamライブラリの詳細に入る前に、動作中のアプリケーションを見てみましょう。この例では、StudentクラスとAddressクラスを作成しました。学生オブジェクトを作成し、それをXML文字列にシリアル化します。次に、同じXML文字列を逆シリアル化して、学生オブジェクトを取得します。

C：\> XStream_WORKSPACEにXStreamTesterという名前のJavaクラスファイルを作成します。

File: XStreamTester.java

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;

import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.stream.StreamResult;
import org.xml.sax.InputSource;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.io.xml.StaxDriver;

public class XStreamTester {

   public static void main(String args[]) {
      XStreamTester tester = new XStreamTester();
      XStream xstream = new XStream(new StaxDriver());
      
      Student student = tester.getStudentDetails();
      
      //Object to XML Conversion
      String xml = xstream.toXML(student);
      System.out.println(formatXml(xml));
      
      //XML to Object Conversion
      Student student1 = (Student)xstream.fromXML(xml);
      System.out.println(student1);
   }
   
   private Student getStudentDetails() {
   
      Student student = new Student();
      student.setFirstName("Mahesh");
      student.setLastName("Parashar");
      student.setRollNo(1);
      student.setClassName("1st");

      Address address = new Address();
      address.setArea("H.No. 16/3, Preet Vihar.");
      address.setCity("Delhi");
      address.setState("Delhi");
      address.setCountry("India");
      address.setPincode(110012);

      student.setAddress(address);
      return student;
   }
   
   public static String formatXml(String xml) {
   
      try {
         Transformer serializer = SAXTransformerFactory.newInstance().newTransformer();
         
         serializer.setOutputProperty(OutputKeys.INDENT, "yes");
         serializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
         
         Source xmlSource = new SAXSource(new InputSource(
            new ByteArrayInputStream(xml.getBytes())));
         StreamResult res =  new StreamResult(new ByteArrayOutputStream());            
         
         serializer.transform(xmlSource, res);
         
         return new String(((ByteArrayOutputStream)res.getOutputStream()).toByteArray());
         
      } catch(Exception e) {
         return xml;
      }
   }
}

class Student {
   private int rollNo;
   private String firstName;
   private String lastName;
   private String className;
   private Address address;

   public String getFirstName() {
      return firstName;
   }
   
   public void setFirstName(String firstName) {
      this.firstName = firstName;
   }
   
   public String getLastName() {
      return lastName;
   }
   
   public void setLastName(String lastName) {
      this.lastName = lastName;
   }
   
   public int getRollNo() {
      return rollNo;
   }
   
   public void setRollNo(int rollNo) {
      this.rollNo = rollNo;
   }
   
   public String getClassName() {
      return className;
   }
   
   public void setClassName(String className) {
      this.className = className;
   }
   
   public Address getAddress() {
      return address;
   }
   
   public void setAddress(Address address) {
      this.address = address;
   }
   
   public String toString() {
      StringBuilder stringBuilder = new StringBuilder();
      
      stringBuilder.append("Student [ ");
      stringBuilder.append("\nfirstName: ");
      stringBuilder.append(firstName);
      stringBuilder.append("\nlastName: ");
      stringBuilder.append(lastName);
      stringBuilder.append("\nrollNo: ");
      stringBuilder.append(rollNo);
      stringBuilder.append("\nclassName: ");
      stringBuilder.append(className);
      stringBuilder.append("\naddress: ");
      stringBuilder.append(address);
      stringBuilder.append(" ]");
      
      return stringBuilder.toString();
   }
}

class Address {
   private String area;
   private String city;
   private String state;
   private String country;
   private int pincode;

   public String getArea() {
      return area;
   }

   public void setArea(String area) {
      this.area = area;
   }

   public String getCity() {
      return city;
   }

   public void setCity(String city) {
      this.city = city;
   }

   public String getState() {
      return state;
   }

   public void setState(String state) {
      this.state = state;
   }

   public String getCountry() {
      return country;
   }

   public void setCountry(String country) {
      this.country = country;
   }

   public int getPincode() {
      return pincode;
   }

   public void setPincode(int pincode) {
      this.pincode = pincode;
   }

   public String toString() {

      StringBuilder stringBuilder = new StringBuilder();

      stringBuilder.append("\nAddress [ ");
      stringBuilder.append("\narea: ");
      stringBuilder.append(area);
      stringBuilder.append("\ncity: ");
      stringBuilder.append(city);
      stringBuilder.append("\nstate: ");
      stringBuilder.append(state);
      stringBuilder.append("\ncountry: ");
      stringBuilder.append(country);
      stringBuilder.append("\npincode: ");	
      stringBuilder.append(pincode);
      stringBuilder.append(" ]");

      return stringBuilder.toString();
   }
}

Verify the Result

を使用してクラスをコンパイルします javac 次のようにコンパイラ-

C:\XStream_WORKSPACE>javac XStreamTester.java

XStreamTesterを実行して、結果を確認します-

C:\XStream_WORKSPACE>java XStreamTester

Verify the output as follows

<?xml version = "1.0" encoding = "UTF-8"?>
<Student>
   <firstName>Mahesh</firstName>
   <lastName>Parashar</lastName>
   <rollNo>1</rollNo>
   <className>1st</className>
   <address>
      <area>H.No. 16/3, Preet Vihar.</area>
      <city>Delhi</city>
      <state>Delhi</state>
      <country>India</country>
      <pincode>110012</pincode>
   </address>
</Student>

Student [ 
   firstName: Mahesh
   lastName: Parashar
   rollNo: 1
   className: 1st
   address: 
   Address [ 
      area: H.No. 16/3, Preet Vihar.
      city: Delhi
      state: Delhi
      country: India
      pincode: 110012
   ] 
]

覚えておくべき手順

ここで考慮すべき重要な手順は次のとおりです。

ステップ1：XStreamオブジェクトを作成する

StaxDriverを渡してXStreamオブジェクトを作成します。StaxDriverは、Staxプルパーサー（Java 6から入手可能）を使用し、高速のxmlパーサーです。

XStream xstream = new XStream(new StaxDriver());

ステップ2：オブジェクトをXMLにシリアル化する

toXML（）メソッドを使用して、オブジェクトのXML文字列表現を取得します。

//Object to XML Conversion
String xml = xstream.toXML(student);

ステップ3：XMLを逆シリアル化してオブジェクトを取得する

fromXML（）メソッドを使用して、XMLからオブジェクトを取得します。

//XML to Object Conversion		
Student student1 = (Student)xstream.fromXML(xml);

エイリアシングは、生成されたXMLをカスタマイズしたり、XStreamを使用して特定のフォーマットされたXMLを使用したりするための手法です。次のXML形式を使用してStudentオブジェクトをシリアル化/逆シリアル化するとします。

<student name = "Suresh">
   <note>
      <title>first</title>
      <description>My first assignment.</description>
   </note>
   
   <note>
      <title>second</title>
      <description>My second assignment.</description>
   </note>
</student>

上記のXML形式に基づいて、モデルクラスを作成しましょう。

class Student {
   private String studentName;
   private List<Note> notes = new ArrayList<Note>();
   
   public Student(String name) {
      this.studentName = name;
   }
   
   public void addNote(Note note) {
      notes.add(note);
   }
   
   public String getName() {
      return studentName;
   }
   
   public List<Note> getNotes() {
      return notes;
   }
}

class Note {
   private String title;
   private String description;

   public Note(String title, String description) {
      this.title = title;
      this.description = description;
   }

   public String getTitle() {
      return title;
   }

   public String getDescription() {
      return description;
   }     
}

XStreamを使用して上記のオブジェクトのシリアル化をテストしてみましょう。

C：\> XStream_WORKSPACE \ com \ tutorialspoint \ xstreamにXStreamTesterという名前のJavaクラスファイルを作成します。

File: XStreamTester.java

package com.tutorialspoint.xstream;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;

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

import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.stream.StreamResult;

import org.xml.sax.InputSource;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.io.xml.StaxDriver;

public class XStreamTester {
   public static void main(String args[]) {
   
      XStreamTester tester = new XStreamTester();
      XStream xstream = new XStream(new StaxDriver());
      Student student = tester.getStudentDetails();
      
      //Object to XML Conversion
      String xml = xstream.toXML(student);
      System.out.println(formatXml(xml));		
   }	

   private Student getStudentDetails() {
   
      Student student = new Student("Mahesh");
      
      student.addNote(new Note("first","My first assignment."));
      student.addNote(new Note("second","My Second assignment."));
      
      return student;
   }

   public static String formatXml(String xml) {
   
      try {
         Transformer serializer = SAXTransformerFactory.newInstance().newTransformer();
         
         serializer.setOutputProperty(OutputKeys.INDENT, "yes");
         serializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
         
         Source xmlSource = new SAXSource(new InputSource(
            new ByteArrayInputStream(xml.getBytes())));
         StreamResult res =  new StreamResult(new ByteArrayOutputStream());            
         
         serializer.transform(xmlSource, res);
         
         return new String(((ByteArrayOutputStream)res.getOutputStream()).toByteArray());
         
      } catch(Exception e) {
         return xml;
      }
   }
}

class Student {
   private String studentName;
   private List<Note> notes = new ArrayList<Note>();
   
   public Student(String name) {
      this.studentName = name;
   }
   
   public void addNote(Note note) {
      notes.add(note);
   }
   
   public String getName() {
      return studentName;
   }
   
   public List<Note> getNotes() {
      return notes;
   }
}

class Note {
   private String title;
   private String description;
   
   public Note(String title, String description) {
      this.title = title;
      this.description = description;
   }
   
   public String getTitle() {
      return title;
   }
   
   public String getDescription() {
      return description;
   }     
}

Verify the Result

を使用してクラスをコンパイルします javac 次のようにコンパイラ-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>javac XStreamTester.java

XStreamTesterを実行して、結果を確認します-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>java XStreamTester

次のように出力を確認します-

<?xml version = "1.0" encoding = "UTF-8"?>
<com.tutorialspoint.xstream.Student>
   <studentName>Mahesh</studentName>
   <notes>
      <com.tutorialspoint.xstream.Note>
         <title>first</title>
         <description>My first assignment.</description>
      </com.tutorialspoint.xstream.Note>
      
      <com.tutorialspoint.xstream.Note>
         <title>second</title>
         <description>My Second assignment.</description>
     </com.tutorialspoint.xstream.Note>
   </notes>
</com.tutorialspoint.xstream.Student>

上記の結果では、Studentオブジェクト名は完全修飾されています。学生タグとして置き換えるには、次のセクションに従ってください。

  • クラスエイリアシング

  • フィールドエイリアシング

  • 暗黙的なコレクションのエイリアシング

  • 属性エイリアシング

  • パッケージのエイリアシング

XStreamは、コーディングの代わりに自動構成と同様に注釈をサポートします。前の章では、コードで次の構成を見てきました。

xstream.alias("student", Student.class);
xstream.alias("note", Note.class);

xstream.useAttributeFor(Student.class, "studentName");
xstream.aliasField("name", Student.class, "studentName");
xstream.addImplicitCollection(Student.class, "notes");

次のコードスニペットは、アノテーションを使用して同じ作業をはるかに簡単に行う方法を示しています。

@XStreamAlias("student")   //define class level alias
class Student {

   @XStreamAlias("name")   //define field level alias
   @XStreamAsAttribute     //define field as attribute
   private String studentName;
   
   @XStreamImplicit        //define list as an implicit collection
   private List<Note> notes = new ArrayList<Note>();
   
   @XStreamOmitField       //omit a field to not to be a part of XML
   private int type;
}

XStreamを使用して上記の注釈をテストしてみましょう。

C：\> XStream_WORKSPACE \ com \ tutorialspoint \ xstreamにXStreamTesterという名前のJavaクラスファイルを作成します。

ファイル：XStreamTester.java

package com.tutorialspoint.xstream;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;

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

import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.stream.StreamResult;

import org.xml.sax.InputSource;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.annotations.XStreamImplicit;
import com.thoughtworks.xstream.annotations.XStreamOmitField;
import com.thoughtworks.xstream.io.xml.StaxDriver;

public class XStreamTester {

   public static void main(String args[]) {

      XStreamTester tester = new XStreamTester();
      XStream xstream = new XStream(new StaxDriver());
      Student student = tester.getStudentDetails();
      
      xstream.processAnnotations(Student.class);		

      //Object to XML Conversion
      String xml = xstream.toXML(student);
      System.out.println(formatXml(xml));		
   }
   
   private Student getStudentDetails() {
   
      Student student = new Student("Mahesh");
      
      student.addNote(new Note("first","My first assignment."));
      student.addNote(new Note("second","My Second assignment."));
      student.setType(1);
      
      return student;
   }

   public static String formatXml(String xml) {
   
      try {
         Transformer serializer = SAXTransformerFactory.newInstance().newTransformer();
         
         serializer.setOutputProperty(OutputKeys.INDENT, "yes");
         serializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
         
         Source xmlSource = new SAXSource(new InputSource(
            new ByteArrayInputStream(xml.getBytes())));
         StreamResult res = new StreamResult(new ByteArrayOutputStream());            
         
         serializer.transform(xmlSource, res);
         
         return new String(((ByteArrayOutputStream)res.getOutputStream()).toByteArray());
         
      } catch(Exception e) {
         return xml;
      }
   }
}

@XStreamAlias("student")
class Student {

   @XStreamAlias("name")
   @XStreamAsAttribute   
   private String studentName;

   @XStreamImplicit
   private List<Note> notes = new ArrayList<Note>();

   public Student(String name) {
      this.studentName = name;
   }

   public void addNote(Note note) {
      notes.add(note);
   }

   public String getName() {
      return studentName;
   }

   public List<Note> getNotes() {
      return notes;
   }
   
   @XStreamOmitField		
   private int type;

   public int getType() {
      return type;
   }

   public void setType(int type) {
      this.type = type;
   }
}

@XStreamAlias("note")
class Note {
   private String title;
   private String description;

   public Note(String title, String description) {
      this.title = title;
      this.description = description;
   }

   public String getTitle() {
      return title;
   }

   public String getDescription() {
      return description;
   }     
}

結果を確認する

を使用してクラスをコンパイルします javac 次のようにコンパイラ-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>javac XStreamTester.java

XStreamTesterを実行して、結果を確認します-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>java XStreamTester

次のように出力を確認します-

<?xml version = "1.0" encoding = "UTF-8"?>
<student name = "Mahesh">
   <note>
      <title>first</title>
      <description>My first assignment.</description>
   </note>

   <note>
      <title>second</title>
      <description>My Second assignment.</description>
   </note>
</student>

XStreamフレームワークに注釈を処理するように指示するには、xmlをシリアル化する前に次のコマンドを追加する必要があります。

xstream.processAnnotations(Student.class);

または

xstream.autodetectAnnotations(true);

XStreamコンバーターはXStreamライブラリーの主要コンポーネントであり、オブジェクトをXMLに、またはその逆に変換する役割を果たします。XStreamは、プリミティブ、文字列、ファイル、コレクション、配列、日付などの一般的なタイプ用の多数のコンバーターを提供します。

コンバーターの使用

オブジェクトを単一の文字列に変換することを目的としたSingleValueConvertorを使用してみましょう。SingleValueConvertorを使用して、オブジェクトを属性文字列として記述します。

コンバーターを作成する

class NameConverter implements SingleValueConverter {

   public Object fromString(String name) {
      String[] nameparts = name.split(",");
      return new Name(nameparts[0], nameparts[1]);
   }
   
   public String toString(Object name) {
      return ((Name)name).getFirstName() + "," + ((Name)name).getLastName();
   }
   
   public boolean canConvert(Class type) {
      return type.equals(Name.class);
   }	
}

コンバーターを登録する

xstream.registerConverter(new NameConverter());

コンバーターなしの例

まず、XStreamでコンバーターを使用せずにコードをテストしましょう。

C：\> XStream_WORKSPACE \ com \ tutorialspoint \ xstreamにXStreamTesterという名前のJavaクラスファイルを作成します。

File: XStreamTester.java

package com.tutorialspoint.xstream;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;

import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.stream.StreamResult;

import org.xml.sax.InputSource;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.io.xml.StaxDriver;

public class XStreamTester {
   public static void main(String args[]) {
   
      XStreamTester tester = new XStreamTester();
      XStream xstream = new XStream(new StaxDriver());
      Student student = tester.getStudentDetails();
      xstream.autodetectAnnotations(true);
      
      //Object to XML Conversion
      String xml = xstream.toXML(student);
      System.out.println(formatXml(xml));
   }
   
   private Student getStudentDetails() {
      Student student = new Student("Mahesh","Parashar");
      return student;
   }
   
   public static String formatXml(String xml) {
   
      try {
      
         Transformer serializer = SAXTransformerFactory.newInstance().newTransformer();
         
         serializer.setOutputProperty(OutputKeys.INDENT, "yes");
         serializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
         
         Source xmlSource = new SAXSource(new InputSource(
            new ByteArrayInputStream(xml.getBytes())));
         StreamResult res =  new StreamResult(new ByteArrayOutputStream());
         
         serializer.transform(xmlSource, res);
         
         return new String(((ByteArrayOutputStream)res.getOutputStream()).toByteArray());
         
      } catch(Exception e) {
         return xml;
      }
   }
}

@XStreamAlias("student")
class Student {

   @XStreamAlias("name")
   @XStreamAsAttribute
   private Name studentName;

   public Student(String firstName, String lastName) {
      this.studentName = new Name(firstName, lastName);
   }

   public Name getName() {
      return studentName;
   }	
}

class Name {
   private String firstName;
   private String lastName;

   public Name(String firstName, String lastName) {
      this.firstName = firstName;
      this.lastName = lastName;
   }

   public String getFirstName() {
      return firstName;
   }

   public String getLastName() {
      return lastName;
   }     
}

Verify the Result

を使用してクラスをコンパイルします javac 次のようにコンパイラ-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>javac XStreamTester.java

XStreamTesterを実行して、結果を確認します-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>java XStreamTester

次のように出力を確認します-

<?xml version = "1.0" encoding = "UTF-8"?>
<student>
   <name>
      <firstName>Mahesh</firstName>
      <lastName>Parashar</lastName>
   </name>
</student>

コンバーターの例

XStreamのコンバーターでコードをテストしてみましょう。

C：\> XStream_WORKSPACE \ com \ tutorialspoint \ xstreamにXStreamTesterという名前のJavaクラスファイルを作成します。

File: XStreamTester.java

package com.tutorialspoint.xstream;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;

import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.stream.StreamResult;

import org.xml.sax.InputSource;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.converters.SingleValueConverter;
import com.thoughtworks.xstream.io.xml.StaxDriver;

public class XStreamTester {

   public static void main(String args[]) {
   
      XStreamTester tester = new XStreamTester();
      XStream xstream = new XStream(new StaxDriver());
      Student student = tester.getStudentDetails();		
      
      xstream.autodetectAnnotations(true);
      xstream.registerConverter(new NameConverter());
      
      //Object to XML Conversion
      String xml = xstream.toXML(student);
      System.out.println(formatXml(xml));		
   }	

   private Student getStudentDetails() {
      Student student = new Student("Mahesh","Parashar");		
      return student;
   }

   public static String formatXml(String xml) {

      try {
      
         Transformer serializer = SAXTransformerFactory.newInstance().newTransformer();
         
         serializer.setOutputProperty(OutputKeys.INDENT, "yes");         
         serializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
         
         Source xmlSource = new SAXSource(new InputSource(
            new ByteArrayInputStream(xml.getBytes())));
         StreamResult res = new StreamResult(new ByteArrayOutputStream());            
         
         serializer.transform(xmlSource, res);
         
         return new String(((ByteArrayOutputStream)res.getOutputStream()).toByteArray());
         
      } catch(Exception e) {   
         return xml;
      }
   }
}

@XStreamAlias("student")
class Student {

   @XStreamAlias("name")
   @XStreamAsAttribute	
   private Name studentName;

   public Student(String firstName, String lastName) {
      this.studentName = new Name(firstName, lastName);
   }

   public Name getName() {
      return studentName;
   }	
}

class Name {
   private String firstName;
   private String lastName;

   public Name(String firstName, String lastName) {
      this.firstName = firstName;
      this.lastName = lastName;
   }

   public String getFirstName() {
      return firstName;
   }

   public String getLastName() {
      return lastName;
   }     
}

class NameConverter implements SingleValueConverter  {

   public Object fromString(String name) {
      String[] nameparts = name.split(",");
      return new Name(nameparts[0], nameparts[1]);
   }

   public String toString(Object name) {
      return ((Name)name).getFirstName() + "," + ((Name)name).getLastName();
   }

   public boolean canConvert(Class type) {
      return type.equals(Name.class);
   }
}

Verify the Result

を使用してクラスをコンパイルします javac 次のようにコンパイラ-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>javac XStreamTester.java

XStreamTesterを実行して、結果を確認します-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>java XStreamTester

次のように出力を確認します-

<?xml version = "1.0" encoding = "UTF-8"?>
<student name = "Mahesh,Parashar"/>

カスタムコンバーター

XStreamは、java.io.ObjectInputStreamおよびjava.io.ObjectOutputStreamの代替実装を提供するため、オブジェクトのストリームをXMLからシリアル化または逆シリアル化できます。これは、一度に1つのオブジェクトをメモリに保持して、オブジェクトの大きなセットを処理する場合に特に便利です。

構文：createObjectOutputStream（）

ObjectOutputStream objectOutputStream = xstream.createObjectOutputStream(
   new FileOutputStream("test.txt"));

構文：createObjectInputStream（）

ObjectInputStream objectInputStream = xstream.createObjectInputStream(
   new FileInputStream("test.txt"));

XStreamのオブジェクトストリームを使用してコードをテストしてみましょう。

C：\> XStream_WORKSPACE \ com \ tutorialspoint \ xstreamにXStreamTesterという名前のJavaクラスファイルを作成します。

ファイル：XStreamTester.java

package com.tutorialspoint.xstream;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.io.xml.StaxDriver;

public class XStreamTester {
   public static void main(String args[]) {
   
      XStreamTester tester = new XStreamTester();
      XStream xstream = new XStream(new StaxDriver());
      
      xstream.autodetectAnnotations(true);
      
      Student student1 = new Student("Mahesh","Parashar");
      Student student2 = new Student("Suresh","Kalra");
      Student student3 = new Student("Ramesh","Kumar");
      Student student4 = new Student("Naresh","Sharma");
      
      try {
      
         ObjectOutputStream objectOutputStream = xstream.createObjectOutputStream(
            new FileOutputStream("test.txt"));
         
         objectOutputStream.writeObject(student1);
         objectOutputStream.writeObject(student2);
         objectOutputStream.writeObject(student3);
         objectOutputStream.writeObject(student4);
         objectOutputStream.writeObject("Hello World");
         
         objectOutputStream.close();
         
         ObjectInputStream objectInputStream = xstream.createObjectInputStream(
            new FileInputStream("test.txt"));
         
         Student student5 = (Student)objectInputStream.readObject();
         Student student6 = (Student)objectInputStream.readObject();
         Student student7 = (Student)objectInputStream.readObject();
         Student student8 = (Student)objectInputStream.readObject();
         
         String text = (String)objectInputStream.readObject();
         
         System.out.println(student5);
         System.out.println(student6);
         System.out.println(student7);
         System.out.println(student8);
         System.out.println(text);
      
      } catch (IOException e) {
         e.printStackTrace();
         
      } catch (ClassNotFoundException e) {
         e.printStackTrace();
      }
   }
}

@XStreamAlias("student")
class Student {

   private String firstName;
   private String lastName;
   
   public Student(String firstName, String lastName) {
      this.firstName = firstName;
      this.lastName = lastName;
   }

   public String getFirstName() {
      return firstName;
   }

   public String getLastName() {
      return lastName;
   }   

   public String toString() {
      return "Student [ firstName: "+firstName+", lastName: "+ lastName+ " ]";
   }	
}

結果を確認する

を使用してクラスをコンパイルします javac 次のようにコンパイラ-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>javac XStreamTester.java

XStreamTesterを実行して、結果を確認します-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>java XStreamTester

次のように出力を確認します-

Student [ firstName: Mahesh, lastName: Parashar ]
Student [ firstName: Suresh, lastName: Kalra ]
Student [ firstName: Ramesh, lastName: Kumar ]
Student [ firstName: Naresh, lastName: Sharma ]
Hello World

C：\> XStream_WORKSPACE \ com \ tutorialspoint \ xstreamフォルダーにあるtest.txtの内容を確認します。

<?xml version = "1.0" ?>
<object-stream>
   <student>
      <firstName>Mahesh</firstName>
      <lastName>Parashar</lastName>
   </student>
   
   <student>
      <firstName>Suresh</firstName>
      <lastName>Kalra</lastName>
   </student>
   
   <student>
      <firstName>Ramesh</firstName>
      <lastName>Kumar</lastName>
   </student>
   
   <student>
      <firstName>Naresh</firstName>
      <lastName>Sharma</lastName>
   </student>
   <string>Hello World</string>
</object-stream>

XStreamは、適切なドライバーでXStreamオブジェクトを初期化することにより、JSONをサポートします。XStreamは現在、JettisonMappedXmlDriverおよびJsonHierarchicalStreamDriverをサポートしています。

XStreamでjson処理を使用してコードをテストしてみましょう。

C：\> XStream_WORKSPACE \ com \ tutorialspoint \ xstreamにXStreamTesterという名前のJavaクラスファイルを作成します。

ファイル：XStreamTester.java

package com.tutorialspoint.xstream;

import java.io.Writer;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
import com.thoughtworks.xstream.io.json.JsonHierarchicalStreamDriver;
import com.thoughtworks.xstream.io.json.JsonWriter;

public class XStreamTester {

   public static void main(String args[]) {

      XStreamTester tester = new XStreamTester();
      XStream xstream = new XStream(new JsonHierarchicalStreamDriver() {
      
         public HierarchicalStreamWriter createWriter(Writer writer) {
            return new JsonWriter(writer, JsonWriter.DROP_ROOT_MODE);
         }
      });

      Student student = new Student("Mahesh","Parashar");

      xstream.setMode(XStream.NO_REFERENCES);
      xstream.alias("student", Student.class);
      
      System.out.println(xstream.toXML(student));
   }
}

@XStreamAlias("student")
class Student {

   private String firstName;
   private String lastName;

   public Student(String firstName, String lastName) {
      this.firstName = firstName;
      this.lastName = lastName;
   }

   public String getFirstName() {
      return firstName;
   }

   public String getLastName() {
      return lastName;
   }   
	
   public String toString() {
      return "Student [ firstName: "+firstName+", lastName: "+ lastName+ " ]";
   }	
}

結果を確認する

を使用してクラスをコンパイルします javac 次のようにコンパイラ-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>javac XStreamTester.java

XStreamTesterを実行して、結果を確認します-

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>java XStreamTester

次のように出力を確認します-

{
   "firstName": "Mahesh",
   "lastName": "Parashar"
}
ja/tutorial
es/tutorial
de/tutorial
fr/tutorial
th/tutorial
pt/tutorial
ru/tutorial
vi/tutorial
it/tutorial
ko/tutorial
tr/tutorial
id/tutorial
pl/tutorial
hi/tutorial
japost
espost
depost
frpost
thpost
ptpost
rupost
vipost
itpost
kopost
trpost
idpost
plpost
hipost

© Copyright 2021 - 2024 | All Rights Reserved