この章では、CoherenceのオブジェクトをシリアライズするためのPortable Object Format (POF)の使用方法について説明します。この説明は、Javaクライアントに対するPOFの使用方法に固有のものです。.NET拡張クライアントを構築する際のPOFの操作方法の詳細は、『Oracle Coherenceリモート・クライアントの開発』の.NETクライアントの統合オブジェクトの構築に関する項を参照してください。C++拡張クライアントを構築する際のPOFの操作方法の詳細は、『Oracle Coherenceリモート・クライアントの開発』のC++クライアントの統合オブジェクトの構築に関する項を参照してください。
この章には次の項が含まれます:
Coherenceは値オブジェクトをキャッシュします。これらのオブジェクトは、(セッション・データや一時データなどの)内部ソースのデータ、または(データベースやメインフレームなどの)外部ソースのデータのいずれでもかまいません。
キャッシュに配置されたオブジェクトはシリアライズ可能である必要があります。シリアライズは、多くの場合、クラスタ化されたデータ管理における最も費用を要する部分になるため、Coherenceではデータのシリアライズ/デシリアライズ用に様々なオプションを用意しています。
com.tangosol.io.pof.PofSerializer
- Portable Object Format (POF)は言語に依存しないバイナリ形式です。POFは領域と時間の両面で効率を向上させるように設計された、Coherenceの推奨シリアライズ・オプションです。「オブジェクトをシリアライズするためのPOF APIの使用」を参照してください。
java.io.Serializable
- 最も単純で処理の遅いオプション。
java.io.Externalizable
- 開発者が手動でシリアライズを実装する必要がありますが、パフォーマンスの大幅な向上が見込めます。java.io.Serializable
と比べて、シリアライズされたデータのサイズを2倍以上削減できます(分散キャッシュでは、一般的にデータがシリアライズされた形式でキャッシュされるため特に有用です)。最も重要なのは、CPU使用率が劇的に削減されるということです。
com.tangosol.io.ExternalizableLite
- java.io.Externalizable
と非常によく似ていますが、より効率的なI/Oストリームの実装を使用することで、パフォーマンスの向上とメモリー使用量の削減を図れます。
com.tangosol.run.xml.XmlBean
- ExternalizableLite
のデフォルトの実装(詳細は、API JavadocでXmlBean
を参照してください)。
注意: オブジェクトをシリアライズする場合は、Javaのシリアライズ機能によって、すべての参照可能オブジェクトが自動的に( |
シリアライズとは、オブジェクトをバイナリ形式にエンコードするプロセスです。これは、Coherenceを使用してデータをネットワーク上で移動させることが必要になった場合に重要となる機能です。POFは言語に依存しないバイナリ形式です。POFは領域と時間の両面で効率を向上させるように設計されており、Coherenceの使用時に不可欠なものとなっています。POFバイナリ・ストリームの詳細は、付録E「PIF-POFバイナリ形式」を参照してください。
シリアライズで使用可能なオプションには、標準Javaシリアライズ、POF、独自のカスタム・シリアライズ・ルーチンなどいくつかあります。各オプションには、それぞれトレードオフがあります。標準Javaシリアライズは簡単に実装可能であり、循環オブジェクト・グラフをサポートし、オブジェクトIDを保持します。ただし、比較的動作が低速で、冗長なバイナリ形式が使用され、Javaオブジェクトのみが処理対象となります。
POFには、次の利点があります。
現在はJava、.NETおよびC++をサポートしており、言語に依存しません。
非常に効率的です。1つのString
、1つのlong
および3つのints
を備えた簡単なテスト・クラスでは、標準のJavaシリアライズと比較して、シリアライズおよびデシリアライズが7倍高速化され、生成されるバイナリのサイズが1/6になります。
バージョニングが可能です。オブジェクトの向上を図ることが可能であり、上位および下位の互換性があります。
シリアライズ・ロジックを外部化することができます。
索引付けされ、オブジェクト全体をデシリアライズせずに値を抽出できます。「POFエクストラクタとPOFアップデータの使用」を参照してください。
POFには、オブジェクトのシリアライズおよびデシリアライズの方法を認識するシリアライズ・ルーチンの実装が必要です。オブジェクトのシリアライズには、com.tangosol.io.pof.PortableObject
インタフェースとcom.tangosol.io.pof.PofSerializer
インタフェースという2つのインタフェースが使用可能です。POFは、PortableObject
またはPofSerializer
インタフェースを実装せずにシリアライズを自動的に実装する注釈もサポートしています。詳細は、「オブジェクトをシリアライズするためのPOF注釈の使用」を参照してください。
この項には次のトピックが含まれます:
PortableObject
インタフェースは、次の2つのメソッドで構成されるインタフェースです。
public void readExternal(PofReader reader)
public void writeExternal(PofWriter writer)
POFストリームに対する書込みまたは読取りを行う各要素に数値を指定することで、POF要素に索引が付けられます。索引はPOFストリームにおいて書込みと読取りが実行される各要素に対して一意である必要があります。索引はスーパー・クラスと派生クラスの間で一意である必要があるため、派生タイプが存在する場合には特に注意が必要です。次の例では、PortableObject
インタフェースの実装を示します。
public void readExternal(PofReader in) throws IOException { m_symbol = (Symbol) in.readObject(0); m_ldtPlaced = in.readLong(1); m_fClosed = in.readBoolean(2); } public void writeExternal(PofWriter out) throws IOException { out.writeObject(0, m_symbol); out.writeLong(1, m_ldtPlaced); out.writeBoolean(2, m_fClosed); }
PofSerializer
インタフェースには、シリアライズ・ロジックをシリアライズするクラスから外部化する手段が用意されています。これは、CoherenceでPOFを使用する場合に、クラスの構造を変更したくないときには特に役立ちます。PofSerializer
インタフェースは、次の2つのメソッドで構成されています。
public Object deserialize(PofReader in)
public void serialize(PofWriter out, Object o)
PortableObject
インタフェース同様、POFストリームに対して書込みまたは読取りが実行される要素はすべて一意に索引付けされている必要があります。PofSerializer
インタフェースの実装例を、次に示します。
例20-1 PofSerializerインタフェースの実装
public Object deserialize(PofReader in) throws IOException { Symbol symbol = (Symbol)in.readObject(0); long ldtPlaced = in.readLong(1); bool fClosed = in.readBoolean(2); // mark that reading the object is done in.readRemainder(null); return new Trade(symbol, ldtPlaced, fClosed); } public void serialize(PofWriter out, Object o) throws IOException { Trade trade = (Trade) o; out.writeObject(0, trade.getSymbol()); out.writeLong(1, trade.getTimePlaced()); out.writeBoolean(2, trade.isClosed()); // mark that writing the object is done out.writeRemainder(null); }
POFの索引をオブジェクトの属性に割り当てるときには、次のガイドラインに従ってください。
読取りと書込みの順序: シリアライズ・ルーチンの最低索引値から開始して、最高索引値で終了します。値をデシリアライズする場合には、書込みと同じ順序で読取りを実行します。
非連続の索引を指定することはできますが、読取りまたは書込みが連続して実行される必要があります。
サブクラス作成時に索引の範囲を予約する場合: 索引は派生タイプ間で累積されます。そのため、各派生タイプがそのスーパークラスで予約されたPOF索引範囲を認識する必要があります。
索引を他の目的に使用しない: 進化をサポートするためには、クラス・リビジョン全体で属性の索引を他の目的に使用しないようにすることが必須です。
ラベルの索引: public static final int
でラベル付けされている索引は、さらに簡単に使用できます。特に、POFエクストラクタとPOFアップデータを使用する場合には簡単です。「POFエクストラクタとPOFアップデータの使用」を参照してください。ラベル付けされた索引の読取りおよび書込みも、上述の説明と同じ順序で実行される必要があります。
POFは、POFストリーム内で複数回出現するオブジェクトに対するオブジェクトIDおよび参照の使用をサポートします。オブジェクトにはIDのラベルが付けられ、同じPOFストリーム内の2回目以降に出現するラベル付きオブジェクトのインスタンスはそのIDで参照されます。
参照を使用すると、同じオブジェクトを複数回エンコードしないで済み、データ・サイズの削減に役立ちます。参照は通常、かなりサイズが大きい多数のオブジェクトが複数回作成される場合、またはネストされたデータ構造か循環データ構造をオブジェクトが使用する場合に使用されます。ただし、大量のデータを含むが繰り返しはほとんどないアプリケーションの場合、オブジェクトIDおよび参照の追跡で発生するオーバーヘッドが原因で、オブジェクト参照の使用により得られる利点はわずかなものになります。
オブジェクトIDおよび参照の使用には、次の制限があります。
オブジェクト参照は、ユーザー定義のオブジェクト・タイプに対してのみサポートされています。
オブジェクト参照は、Evolvable
オブジェクトに対してはサポートされません。
オブジェクト参照は、キーに対してはサポートされません。
参照をサポートしていないPOFコンテキストで書き出されたオブジェクトは、参照をサポートしているPOFコンテキストで読み取ることはできません。この逆も当てはまります。
POFエクストラクタを使用して、オブジェクトIDおよび参照を使用するPOFオブジェクトを問い合せることはできません。かわりに、ValueExtractor
APIを使用してオブジェクト値を問い合せるか、オブジェクト参照を無効にしてください。
この項には次のトピックが含まれます:
オブジェクト参照は、デフォルトでは有効になっておらず、pof-config.xml
構成ファイル内で有効にするか、またはSimplePofContext
クラスの使用時にプログラムによって有効にする必要があります。
POF構成ファイルでオブジェクト参照を有効にするには、<pof-config>
要素内に<enable-references>
要素を含めて、値をtrue
に設定します。例:
<?xml version='1.0'?> <pof-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.oracle.com/coherence/coherence-pof-config" xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-pof-config coherence-pof-config.xsd"> ... <enable-references>true</enable-references> </pof-config>
SimplePofContext
クラスの使用時にオブジェクト参照を有効にするには、プロパティをtrue
に設定してsetReferenceEnabled
メソッドをコールします。例:
SimplePofContext ctx = new SimplePofContext(); ctx.setReferenceEnabled(true);
循環オブジェクトまたはネストされたオブジェクトは、オブジェクトの作成時に手動でIDを登録する必要があります。そうしないと、親オブジェクトを参照する子オブジェクトは、参照マップ内で親のIDを見つけることができません。オブジェクトIDは、com.tangosol.io.pof.PofReader.registerIdentity
メソッドを使用して、デシリアライズ・ルーチン中にシリアライザから登録できます。
次の例は、循環参照を含む2つのオブジェクト(Customer
とProduct
)、およびCustomer
オブジェクトのIDを登録するシリアライザの実装を示しています。
Customer
オブジェクトの定義は次のとおりです。
public class Customer { private String m_sName; private Product m_product; public Customer(String sName) { m_sName = sName; } public Customer(String sName, Product product) { m_sName = sName; m_product = product; } public String getName() { return m_sName; } public Product getProduct() { return m_product; } public void setProduct(Product product) { m_product = product; } }
Product
オブジェクトの定義は次のとおりです。
public class Product { private Customer m_customer; public Product(Customer customer) { m_customer = customer; } public Customer getCustomer() { return m_customer; } }
デシリアライズの間にIDを登録するシリアライザ実装の定義は次のとおりです。
public class CustomerSerializer implements PofSerializer
{
@Override
public void serialize(PofWriter pofWriter, Object o) throws IOException
{
Customer customer = (Customer) o;
pofWriter.writeString(0, customer.getName());
pofWriter.writeObject(1, customer.getProduct());
pofWriter.writeRemainder(null);
}
@Override
public Object deserialize(PofReader pofReader) throws IOException
{
String sName = pofReader.readString(0);
Customer customer = new Customer(sName);
pofReader.registerIdentity(customer);
customer.setProduct((Product) pofReader.readObject(1));
pofReader.readRemainder();
return customer;
}
}
Coherenceには、com.tangosol.io.pof.ConfigurablePofContext
シリアライザ・クラスが用意されていて、それによりPOFのシリアライズ・オブジェクトが適切なシリアライズ・ルーチン(PofSerializer
実装、またはPortableObject
インタフェースを介した呼び出しによる)にマップされます。
クラスにシリアライズ・ルーチンが指定されると、そのクラスはpof-config.xml
構成ファイルを使用してConfigurablePofContext
クラスに登録されます。POF構成ファイルには<user-type-list
要素があり、それにはPortableObject
を実装するクラスまたはそれらに関連付けられているPofSerializer
を持つクラスのリストが記載されています。各クラスに対する<type-id
は一意である必要があり、すべてのクラスタ・インスタンス(拡張クライアントを含む)で一致している必要があります。POFの構成要素の詳細は、付録D「POFユーザー定義型の構成要素」を参照してください。
POF構成ファイルの例を次に示します。
<?xml version='1.0'?> <pof-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.oracle.com/coherence/coherence-pof-config" xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-pof-config coherence-pof-config.xsd"> <user-type-list> <include>coherence-pof-config.xml</include> <!-- User types must be above 1000 --> <user-type> <type-id>1001</type-id> <class-name>com.examples.MyTrade</class-name> <serializer> <class-name>com.examples.MyTradeSerializer</class-name> </serializer> </user-type> <user-type> <type-id>1002</type-id> <class-name>com.examples.MyPortableTrade</class-name> </user-type> </user-type-list> </pof-config>
注意: Coherenceでは、最初の1000個のtype-idは内部使用のために予約されています。上の例に示されているように、 |
CoherenceでConfigurablePofContext
シリアライザ・クラスを使用する場合には、必要な精度のレベルに基づいた、次の3通りの構成が可能です。
サービスごと - 各サービスには、ConfigurablePofContext
シリアライザ・クラスの完全な構成が用意されており、オペレーション構成ファイルにある事前定義済の構成が参照されます。
すべてのサービス - すべてのサービスでグローバルConfigurablePofContext
シリアライザ・クラスの構成が使用されます。独自の構成を提供するサービスによってグローバルな構成がオーバーライドされます。グローバル構成を完全構成にして、オペレーション構成ファイルに含まれる事前定義済の構成を参照することも可能です。
JVM - ConfigurablePofContext
シリアライザ・クラスはJVM全体に対して有効化されます。
ConfigurablePofContext
クラスを使用するようにサービスを構成するには、キャッシュ構成ファイルのキャッシュ・スキームに<serializer>
要素を追加します。<serializer>
要素の完全なリファレンスは、「serializer」を参照してください。
次の例では、ConfigurablePofContext
クラスを使用するように構成された分散キャッシュを示しており、カスタムPOF構成ファイルを定義しています。
<distributed-scheme> <scheme-name>example-distributed</scheme-name> <service-name>DistributedCache</service-name> <serializer> <instance> <class-name>com.tangosol.io.pof.ConfigurablePofContext</class-name> <init-params> <init-param> <param-type>String</param-type> <param-value>my-pof-config.xml</param-value> </init-param> </init-params> </instance> </serializer> </distributed-scheme>
次の例では、オペレーション構成ファイルのデフォルトの定義を参照します。デフォルトのConfigurablePofContext
シリアライザ定義を確認するには、「serializer」を参照してください。
<distributed-scheme> <scheme-name>example-distributed</scheme-name> <service-name>DistributedCache</service-name> <serializer>pof</serializer> </distributed-scheme>
ConfigurablePofContext
クラスをすべてのサービスに対してグローバルに構成するには、キャッシュ構成ファイルの<defaults>
要素内に<serializer>
要素を追加します。次の例は両方とも、シリアライザをすべてのキャッシュ・スキームの定義に対してグローバルに構成するものであり、個々のキャッシュ・スキームの定義内にその他の構成を追加する必要はありません。<defaults>
要素の完全なリファレンスは、「defaults」を参照してください。
次の例では、ConfigurablePofContext
クラスに対するグローバルな構成を示しており、カスタムPOF構成ファイルを定義しています。
<?xml version='1.0'?> <cache-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.oracle.com/coherence/coherence-cache-config" xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-cache-config coherence-cache-config.xsd"> <defaults> <serializer> <instance> <class-name>com.tangosol.io.pof.ConfigurablePofContext</class-name> <init-params> <init-param> <param-type>String</param-type> <param-value>my-pof-config.xml</param-value> </init-param> </init-params> </instance> </serializer> </defaults> ...
次の例では、オペレーション構成ファイルのデフォルトの定義を参照します。デフォルトのConfigurablePofContext
シリアライザ定義を確認するには、「serializer」を参照してください。
<?xml version='1.0'?> <cache-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.oracle.com/coherence/coherence-cache-config" xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-cache-config coherence-cache-config.xsd"> <defaults> <serializer>pof</serializer> </defaults> ...
次のシステム・プロパティを使用して、POFを使用するようにJVMインスタンス全体を構成できます。
tangosol.pof.enabled=true
- JVMインスタンス全体でPOFを有効化します。
tangosol.pof.config=
CONFIG_FILE_PATH
- 使用するPOF構成ファイルへのパスです。このファイルがクラスパスにない場合には、ファイル・リソースとして存在するはずです(例: file:///opt/home/coherence/mycustom-pof-config.xml
)。
POF注釈は、オブジェクトに対するシリアライズおよびデシリアライズ・ルーチンを自動的に実装する方法を提供します。POF注釈は、PofSerializer
インタフェースの実装であるPofAnnotationSerializer
クラスを使用して、シリアライズおよびデシリアライズされます。注釈は、PortableObject
およびPofSerializer
インタフェースの使用に代わる手段を提供し、オブジェクトをシリアライズ可能なものにするために必要な時間とコードを削減します。
この項には次のトピックが含まれます:
クラスとそのプロパティがPOFシリアライズ可能であることを示すには、次の2つの注釈を使用できます。
@Portable
– クラスをPOFシリアライズ可能としてマークします。注釈は、クラス・レベルでのみ許可され、メンバーを持ちません。
@PortableProperty
– メンバー変数またはメソッド・アクセッサをPOFシリアライズ可能属性としてマークします。注釈付きのメソッドは、アクセッサの表記法(get
、set
、is
)に従う必要があります。メンバーを使用して、POF索引だけでなく、シリアライズまたはデシリアライズの前後に実行されるカスタム・コーディックを指定できます。索引値を省略し、自動的に割り当てることができます。カスタム・コーディックが入力されない場合は、デフォルトのコーディックが使用されます。
次の例では、クラス、メソッドおよびプロパティの注釈付け、およびプロパティの索引値の明示的な割当てを示します。POF索引付けの詳細は、「POF索引の割当てのガイドライン」を参照してください。
@Portable public class Person { @PortableProperty(0) public String getFirstName() { return m_firstName; } private String m_firstName; @PortableProperty(1) private String m_lastName; @PortableProperty(2) private int m_age; }
POF注釈付きオブジェクト(すべてのPOFオブジェクトなど)は、pof-config.xml
ファイルの<user-type>
要素内に登録されている必要があります。POFの構成要素の詳細は、付録D「POFユーザー定義型の構成要素」を参照してください。POF構成ファイルを手動で作成するかわりに、POF構成ジェネレータ・ツールを使用して、@Portable
注釈を使用するオブジェクトに基づいて自動的にPOF構成ファイルを作成できます。POF構成ジェネレータ・ツールの詳細は、「POF構成ファイルの生成」を参照してください。
POF注釈付きオブジェクトは、オブジェクトがPortableObject
を実装しておらず、Portable
として注釈が付けられている場合は、PofAnnotationSerializer
シリアライザを使用します。ただし、オブジェクトに注釈が付けられており、ユーザー定義型の定義に含める必要がない場合は、自動的にシリアライザが使用されます。次の例では、注釈付きのPerson
オブジェクトに対するユーザー定義型を登録します。
<?xml version='1.0'?> <pof-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.oracle.com/coherence/coherence-pof-config" xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-pof-config coherence-pof-config.xsd"> <user-type-list> <include>coherence-pof-config.xml</include> <!-- User types must be above 1000 --> <user-type> <type-id>1001</type-id> <class-name>com.examples.Person</class-name> </user-type> </user-type-list> </pof-config>
POF構成ジェネレータ・コマンドライン・ツールは、@Portable
注釈が含まれるクラスのユーザー定義型エントリを含むPOF構成ファイルを自動的に作成します。このツールは、POF構成ファイルを手動で作成するかわりとなり、ビルド・プロセスの一部として最適です。
POF構成ジェネレータ・コマンドライン・ツールを起動するには、COHERENCE_HOME
/bin/pof-config-gen
スクリプト(.cmd
または.sh
)を使用するか、com.tangosol.io.pof.generator.Executor
クラスを直接実行します。詳細な使用方法を確認するには、-help
引数を使用します。使用方法を次に示します。
pof-config-gen [OPTIONS] -root
-root
引数は必須で、POF注釈付きのクラスをスキャンする場所(別々のディレクトリ、JARファイルまたはGARファイル)をリストします。見つかった注釈付きのクラスのそれぞれにつき、ユーザー定義型のエントリおよびIDが生成され、結果として生成されたpof-config.xml
ファイルが現在の作業ディレクトリに書き込まれます。例:
pof-config-gen.cmd -root c:\src\myPofClasses.jar
注意: GARファイルをルートとして指定した場合、出力はカウント接尾辞の付いた新しいGARファイル( |
次のオプションの引数を指定できます。
-out
: -out
引数を使用して、出力ディレクトリのパス、またはパスとファイル名を指定します。デフォルトの出力ディレクトリは作業ディレクトリです。ディレクトリのみを指定した場合のデフォルトのファイル名は、pof-config.xml
です。ディレクトリを指定した場合にpof-config.xml
ファイルがすでに存在する場合は、カウント接尾辞の付いた新しいファイルが作成されます(pof-config-
n
.xml
)。パスとファイル名を指定した場合にそのファイルが現在存在する場合は、ファイルが上書きされます。
-config
: -config
引数を使用して、既存のPOF構成ファイルのパスとファイル名を指定し、そのファイルに含まれる既存のユーザー定義型を生成されるPOF構成ファイルに追加します。既存のユーザー定義型のIDは、生成されたファイルで保持されます。POF構成ファイルを複数回生成する場合、この引数を使用して下位互換性をサポートできます。
-include
: -include
引数を使用して、生成されるPOF構成ファイル内で(-config
引数で指定された)既存のPOF構成ファイルの参照のみを行うかどうかを指定します。この引数を使用すると、既存のファイルを参照する<include>
要素が生成されます。既存のユーザー定義型およびIDは、生成されるファイルに再作成されません。実行時には、クラスパスに参照先のファイルを配置する必要があります。
注意: 既存のPOF構成ファイル内にCoherence固有のPOF構成ファイル( |
-packages
: -packages
引数を使用して、クラスのスキャンを特定のパッケージに制限します。パッケージはカンマ区切りリストで入力します。
-startTypeId
: -startTypeId
引数を使用して、ユーザー定義型のIDの割当てを開始する際のID番号を指定します。1000までのIDは、Coherence固有のタイプ用に予約されているため、使用できません。
次の例では、c:\classes\pof
ディレクトリをスキャンし、新しいPOF構成ファイルをmy-pof-config.xml
という名前でc:\tmp
ディレクトリに作成しますが、このファイルには(参照によって)既存のc:\tmp\pof-config.xml
ファイルがインクルードされます。
pof-config-gen.cmd -out c:\tmp\my-pof-config.xml -config c:\tmp\pof-config.xml -include -root c:\classes\pof
POF注釈は、索引値を明示的に割り当てて管理する必要性を軽減する自動索引付けをサポートしています。@PortableProperty
注釈を定義する場合は、索引値を省略します。索引割当ては、プロパティ名によって決定されます。明示的な索引値を割り当てるプロパティには、自動索引値は割り当てられません。次の表は、自動索引付けアルゴリズムの順序付けセマンティックを示しています。自動索引付けは(プロパティc
に示すように)明示的に定義された索引を保持しており、索引が省略されている場合は索引値を割り当てます。
プロパティ名 | 明示的な索引 | 決定された索引 |
---|---|---|
c |
1 |
1 |
a |
省略 |
0 |
b |
省略 |
2 |
注意: 自動索引付けは現在、Evolvableクラスをサポートしていません。 |
自動索引付けを有効にするには、POF構成ファイルでオブジェクトをユーザー定義型として登録するときに、PofAnnotationSerializer
シリアライザ・クラスを明示的に定義する必要があります。コンストラクタ内のfAutoIndex
ブール・パラメータは、自動索引付けを有効にするもので、true
に設定する必要があります。例:
<user-type>
<type-id>1001</type-id>
<class-name>com.examples.Person</class-name>
<serializer>
<class-name>com.tangosol.io.pof.PofAnnotationSerializer</class-name>
<init-params>
<init-param>
<param-type>int</param-type>
<param-value>{type-id}</param-value>
</init-param>
<init-param>
<param-type>class</param-type>
<param-value>{class}</param-value>
</init-param>
<init-param>
<param-type>boolean</param-type>
<param-value>true</param-value>
</init-param>
</init-params>
</serializer>
</user-type>
コーディックにより、シリアライズまたはデシリアライズの前後にコードを実行できます。コーディックでは、PofWriter
およびPofReader
インタフェースを使用して、ポータブル・プロパティをエンコードおよびデコードする方法を定義します。コーディックは通常、デシリアライズの際に失われる可能性がある具体的な実装に対して、またはオブジェクトのシリアライズの前にPofWriter
インタフェースで特定のメソッドを明示的にコールするために使用されます。
コーディックを作成するには、com.tangosol.io.pof.reflect.Codec
インタフェースを実装するクラスを作成します。次の例では、リンクされているリスト・タイプの具体的な実装を定義するコーディックを示します。
public static class LinkedListCodec implements Codec { public Object decode(PofReader in, int index) throws IOException { return (List<String>) in.readCollection(index, new LinkedList<String>()); } public void encode(PofWriter out, int index, Object value) throws IOException { out.writeCollection(index, (Collection) value); { }
プロパティにコーディックを割り当てるには、コーディックを@PortableProperty
注釈のメンバーとして入力します。コーディックが指定されない場合、デフォルトのコーディック(DefaultCodec
)が使用されます。次の例では、上記のLinkedListCodec
コーディックの割当てを示します。
@PortableProperty(codec = LinkedListCodec.class) private List<String> m_aliases;
Coherenceでは、ValueExtractor
インスタンスとValueUpdater
インスタンスを使用して、キャッシュに格納されたオブジェクトの値が抽出および更新されます。PofExtractor
インスタンスとPofUpdater
インスタンスは、POFの索引付けされた状態を利用して、シリアライズ・ルーチンまたはデシリアライズ・ルーチン全体を実行せずにオブジェクトを抽出または更新します。
PofExtractor
とPofUpdater
により、Coherenceの非プリミティブ・タイプを使用するときの柔軟性が向上します。多くの拡張クライアントの場合、グリッド内に対応するJavaクラスは不要です。POFエクストラクタとPOFアップデータはバイナリをナビゲートできるため、キーと値全体をObjec形式にデシリアライズしなくても済みます。これは、索引付けする値をPOFエクストラクタを使用してプルするだけで索引付けできることを意味します。ただし、キャッシュ・ストアを使用している場合は、対応するJavaクラスが必要です。この場合、キーと値のデシリアライズ・バージョンがキャッシュ・ストアに渡され、バックエンドに書き込まれます。
POFは索引付けされているため、バイナリを抽出用または更新用の特定の要素まで迅速に横断できます。POF値オブジェクトを横断し、目的のPOF値オブジェクトを返すのは、PofNavigator
インタフェースの役目です。Coherenceには、出荷状態で、整数索引に基づいてPOF値を移動できるSimplePofPath
クラスが用意されています。最も簡単な形式では、抽出または更新する属性の索引を提供します。次の例を参照してください。
public class Contact implements PortableObject { ... // ----- PortableObject interface --------------------------------------- public void readExternal(PofReader reader) throws IOException { m_sFirstName = reader.readString(FIRSTNAME); m_sLastName = reader.readString(LASTNAME); m_addrHome = (Address) reader.readObject(HOME_ADDRESS); m_addrWork = (Address) reader.readObject(WORK_ADDRESS); m_mapPhoneNumber = reader.readMap(PHONE_NUMBERS, null); } public void writeExternal(PofWriter writer) throws IOException { writer.writeString(FIRSTNAME, m_sFirstName); writer.writeString(LASTNAME, m_sLastName); writer.writeObject(HOME_ADDRESS, m_addrHome); writer.writeObject(WORK_ADDRESS, m_addrWork); writer.writeMap(PHONE_NUMBERS, m_mapPhoneNumber); } .... // ----- constants ------------------------------------------------------- public static final int FIRSTNAME = 0; public static final int LASTNAME = 1; public static final int HOME_ADDRESS = 2; public static final int WORK_ADDRESS = 3; public static final int PHONE_NUMBERS = 4; ... }
POFストリームへの書込みまたはPOFストリームからの書込みを実行中の各データ・メンバーに対する定数が存在することに注意してください。この方法に従えば、POFエクストラクタとPOFアップデータを容易に使用できてシリアライズ・ルーチンの書込みも簡素化されるという、優れた利点が得られます。各索引にラベルを付けることで、索引の操作はさらに容易になります。前述のように、最も簡単な場合では、WORK_ADDRESS
索引を使用して連絡先から勤務先のアドレスを抽出できます。SimplePofPath
により、ints
のArray
を使用してPofValues
を横断できるようになります。たとえば、勤務先のアドレスの郵便番号を取得するには、[WORK_ADDRESS, ZIP]
を使用します。次の例で、詳細を示します。
POFエクストラクタは通常、キャッシュに問い合せる場合に使用され、問合せのパフォーマンスを向上させます。たとえば、上記で示したクラスを使用して、姓がJones
であるすべての連絡先のキャッシュに問い合せる場合、問合せは次のとおりです。
ValueExtractor veName = new PofExtractor(String.class, Contact.LASTNAME); Filter filter = new EqualsFilter(veName, "Jones"); // find all entries that have a last name of Jones Set setEntries = cache.entrySet(filter);
この例では、PofExtractor
には便利なコンストラクタがあり、SimplePofPath
を使用して1つの索引(この例ではContact.LASTNAME
の索引)を取得します。地域コードが01803
であるすべての連絡先を検索する場合、問合せは次のとおりです。
ValueExtractor veZip = new PofExtractor( String.class, new SimplePofPath(new int[] {Contact.WORK_ADDRESS, Address.ZIP})); Filter filter = new EqualsFilter(veZip, "01803"); // find all entries that have a work address in the 01803 zip code Set setEntries = cache.entrySet(filter);
前述の例では、PofExtractor
コンストラクタには抽出された値またはnull
のクラスを持つ最初の引数があります。型情報を渡すのは、POFがシリアライズされた値で圧縮形式を使用するからです(使用可能な場合)。たとえば、一部の数値は、型が値を暗示する特殊なPOF固有型として示されています。その結果、POFの値を受け取る側では、その型を暗黙的に認識できることが必要になります。PofExtractor
は、コンストラクタで提供されたクラスを型情報のソースとして使用します。このクラスがnull
の場合、PofExtractor
はシリアライズされた状態から型を推測しますが、抽出される型は予想した型と異なることがあります。実際には、String
型はPOFストリームから適切に推測されるので、前述の例ではnull
を使用すれば十分です。ただし、通常はnull
を使用しないでください。
POFアップデータは、オブジェクトの値を抽出するのではなく、更新するという点を除いて、POFエクストラクタと同じ方法で動作します。姓がJones
であるすべてのエントリをSmith
に変更するには、次のようにUpdaterProcessor
クラスを使用します。
ValueExtractor veName = new PofExtractor(String.class, Contact.LASTNAME); Filter filter = new EqualsFilter(veName, "Jones"); ValueUpdater updater = new PofUpdater(Contact.LASTNAME); // find all Contacts with the last name Jones and change them to have the last // name "Smith" cache.invokeAll(filter, new UpdaterProcessor(updater, "Smith"));
注意: この機能は、これらの例では |
値オブジェクトのようなキー・オブジェクトは、POFを使用してシリアライズできます。ただし、次の問題について考慮する必要があります。
POFではクロス・プラットフォームのオブジェクト形式を定義しますが、必ずしも対称的な変換を提供できるわけではありません。すなわち、シリアライズ・オブジェクトをデシリアライズすると、オブジェクトの型は元の型と異なります。これは、Javaの一部のデータ型は、.NETおよびC++プラットフォームに相当するものが存在しないために発生します。結果として、非対称のPOF変換を持つ可能性があるクラスは、キャッシュおよび他のJavaコレクションのキー(またはキーの一部)として使用しないでください。
java.util.Date
型は使用しないようにしてください。POFは、(java.util.Date
を拡張した)java.sql.Timestamp
にシリアライズするように設計されています。それらの2つのクラスのワイヤ・フォーマットは同一であり、それらのワイヤ表現をデシリアライズすると、必ずjava.sql.Timestamp
インスタンスになります。残念ながら、それらの2つのベース・クラスのequals
メソッドでは、Javaコレクションのキーの対称要件は破壊されます。つまり、D
(java.util.Date
)とT
(java.sql.Timestamp
)という2つのオブジェクトがあり、これらのオブジェクトがPOFワイヤ・フォーマットの観点から等しい場合に、D.equals(T)
はtrueになりますが、T.equals(D)
はfalseになります。そのため、java.util.Date
は使用しないでください。キーの対称要件を破壊しないようにするには、日付のLong
表現かjava.sql.Timestamp
型を使用します。
POFオブジェクト参照を使用しているキーはシリアライズできません。また、POFオブジェクト参照では循環参照がサポートされます。そのため、キー・クラスに循環参照が含まれないようにする必要があります。