7.2. システムリポジトリ¶

7.2.1.1. DIコンテナによるオブジェクトの構築ができる¶

DIコンテナ機能を使うことで、 xml に定義されたコンポーネントの定義を元にオブジェクトを構築できる。 構築されるオブジェクトは シングルトン となる。

DIコンテナ機能では、以下のことができる。

• setterインジェクションができる。
• 文字列や数値、真偽値を使用できる。
• ListやMapをインジェクションできる。
• 型や名前が一致するsetterへの自動インジェクションができる。
• ファクトリインジェクションができる。
• 環境依存値を管理できる。

アプリケーションからはDIコンテナに直接アクセスするのではなく、システムリポジトリ経由でアクセスする。 詳細は、 DIコンテナの情報をシステムリポジトリに設定する を参照。

7.2.1.2. オブジェクトの初期化ができる¶

オブジェクト構築後に任意の初期化処理を実行できる。

オブジェクトの依存関係によっては、初期化順に制約が発生することが考えられるため、 この機能ではオブジェクトの初期化順が指定できる。

詳細は、 オブジェクトの初期化処理を行う を参照。

7.2.3.1. xmlにルートノードを定義する¶

コンポーネント設定ファイル(xml)のルートノードは、 component-configuration とする。 schemaLocation を正しく設定すると、IDEで各要素や属性のドキュメントが参照できたり、補完機能が有効活用できる。

<component-configuration xmlns="http://tis.co.jp/nablarch/component-configuration"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://tis.co.jp/nablarch/component-configuration /component-configuration.xsd">

</component-configuration>

xmlへのコンポーネント定義方法の詳細は、以下を参照。

• Java Beansオブジェクトを設定する
• Java Beansオブジェクトの設定を上書きする
• 文字列や数値、真偽値を設定値として使う
• ListやMapを設定値として使う
• コンポーネントを自動的にインジェクションする
• 依存値を設定する
• コンポーネント設定ファイルから環境依存値を参照する
• ファクトリクラスで生成したオブジェクトをインジェクションする
• オブジェクトの初期化処理を行う
• コンポーネント設定ファイル(xml)を分割する

7.2.3.2. Java Beansオブジェクトを設定する¶

Java Beansオブジェクトは、component要素を用いて定義する。

• class属性にDIコンテナで管理するクラスのFQCNを設定する。
• name属性を使って任意の名前を設定できる。
• property子要素を使って、setterインジェクションができる。
• propertyの子要素にcomponentを定義できる。
• propertyのref属性を使って、他で定義したcomponentをsetterインジェクションできる。

以下に例を示す。

<!-- component要素を使ってJava Beansオブジェクトを設定する -->
<component name="sample" class="sample.SampleBean" />

<component name="component" class="sample.SampleComponent">
  <!--
   property要素を使ってsetterインジェクションを行う
   この例では、sampleという名前でcomponent定義されたオブジェクトがインジェクションされる
   -->
  <property name="sample" ref="sample" />

  <!-- ref属性を使わずに、propertyの子要素にcomponentを定義することもできる -->
  <property name="obj">
    <component class="sample.SampleObject" />
  </property>

  <!-- リテラル値をsetterインジェクションする -->
  <property name="limit" value="100" />
<component/>

<!-- SampleBeanのインスタンスが2つリポジトリに登録される -->
<component name="sample1" class="sample.SampleBean" />
<component name="sample2" class="sample.SampleBean" />

7.2.3.3. Java Beansオブジェクトの設定を上書きする¶

componentタグのname属性が同じオブジェクトを登録することで、前に読み込まれたオブジェクトの設定を上書きできる。 この機能は、テスト時にプロダクション環境用のオブジェクトをテスト用のオブジェクト(モック)に置き換える際に利用できる。

オブジェクトを上書きする場合は、同じ名前のオブジェクトを登録するだけで自動的に後で読み込まれたオブジェクトが優先される。

以下に例を示す。

<component name="sample" class="sample.SampleBean">
  <property name="prop" value="message" />
</component>

<!-- 同じ名前でコンポーネントを定義して上書きする -->
<component name="sample" class="sample.MockSampleBean" />

<component name="sample" class="sample.SampleBean">
  <property name="prop" value="message" />
</component>

<!--
propertyを設定していないが、上書き前のpropの値が引き継がれる
 -->
<component name="sample" class="sample.SampleBean" />

7.2.3.4. 文字列や数値、真偽値を設定値として使う¶

プロパティの型が以下の型の場合、リテラル表記で値を簡易的に設定できる。

• java.lang.String
• java.lang.String[]
• java.lang.Integer(int)
• java.lang.Integer[](int[])
• java.lang.Long(long)
• java.lang.Boolean(boolean)

以下に設定例を示す。

java.lang.String

java.lang.String型に値を設定する場合、value属性にリテラルで設定する値を記述する。

この例では、strプロパティに対して「あいうえお」が設定される。

<property name="str" value="あいうえお" />

java.lang.String[]

java.lang.String[]型に値を設定する場合、value属性に値をカンマ(,)区切りで設定する。 カンマで区切られた値が、配列の1つの要素となる。

この例では、arrayプロパティに対して「[あ, い, う, え, お]」が設定される。 なお、区切り文字である , を要素として設定することはできない。

<property name="array" value="あ,い,う,え,お" />

java.lang.Integer(int)

java.lang.Integer型及びint型に値を設定する場合、value属性に設定する値を記述する。 設定できる値は、 Integer#valueOf により変換できる値。

この例では、Integer(int)型のnumプロパティに対して「12345」が設定される。

<property name="num" value="12345" />

java.lang.Integer[](int[])

java.lang.String[]と同じように、value属性に値をカンマ(,)区切りで設定する。 各要素に設定できる値は、 Integer#valueOf により変換できる値。

java.lang.Long(long)

java.lang.Integer(int)と同じように、value属性に設定する値を記述する。 設定できる値は、 Long#valueOf により変換できる値。

java.lang.Boolean(boolean)

java.lang.Boolean型に値を設定する場合、value属性にリテラルで設定する値を記述する。 設定できる値は、 Boolean#valueOf により変換できる値。

この例では、Boolean(boolean)型のboolプロパティに対して「true」が設定される。

<property name="bool" value="true" />

7.2.3.5. ListやMapを設定値として使う¶

list要素やmap要素を使ってコンポーネント設定をすることで、ListやMapを受け取るpropertyに対するsetterインジェクションが行える。

list要素を使ったListの設定

この例では、SampleBeanのintegerListプロパティに対して、要素に[1, 2, 3]を持つListが設定される。

<component class="sample.SampleBean">
  <property name="integerList">
    <list>
      <value>1</value>
      <value>2</value>
      <value>3</value>
    </list>
  </property>
</component>

list要素にも任意の名前を設定でき、property要素で名前参照することができる。 この例は、上の例と同じ設定となる。

<list name="numList">
  <value>1</value>
  <value>2</value>
  <value>3</value>
</list>

<component class="sample.ListSample">
  <!-- numListという名前のListを設定する -->
  <property name="integerList" ref="numList" />
</component>

Listに対しては、任意のJava Beansオブジェクトを設定できる。 この例では、handlersプロパティに対して SampleHandler1 、 SampleHandler2 、 SampleHandler3 を持つListが設定される。 なお、下の例にもあるがcomponent-ref要素を使用することで、名前参照することができる。

<component name="sampleHandler3" class="sample.SampleHandler3" />

<component class="sample.ListSample">
  <property name="handlers">
    <list>
      <component class="sample.SampleHandler1" />
      <component class="sample.SampleHandler2" />
      <component-ref name="sampleHandler3" />
    </list>
  </property>
</component>

map要素を使ったMapの設定

この例では、mapプロパティに対してentryに「{key1=1, key2=2, key3=3}」を持つMapが設定される。

<property name="map">
  <map>
    <entry key="key1" value="1" />
    <entry key="key2" value="2" />
    <entry key="key3" value="3" />
  </map>
</property>

mapにも任意の名前を設定でき、property要素で名前参照することができる。 この例は、上の例と同じ設定となる。

  <map name="map">
    <entry key="key1" value="1" />
    <entry key="key2" value="2" />
    <entry key="key3" value="3" />
  </map>

<component class="sample.ListSample">
  <!-- mapという名前のMapを設定する -->
<property name="map" ref="map">
</component>

value-component要素を使用することで、任意のBeanをMapの値として設定することもできる。

<property name="settings">
  <map>
    <entry key="sample1">
      <value-component class="sample.SampleBean1" />
    </entry>
    <entry key="sample2">
      <value-component class="sample.SampleBean2" />
    </entry>
  </map>
</property>

7.2.3.6. コンポーネントを自動的にインジェクションする¶

コンポーネントのpropertyタグの定義を省略した場合でも、自動的にコンポーネントをインジェクションする機能を提供する。 この機能ではcomponent要素のautowireType属性を使用することで、自動インジェクションタイプを指定することができる。

autowireType属性に指定可能なタイプは以下の通り。

ByType

DIコンテナ上にそのプロパティの型が1つしか存在しない場合に、そのコンポーネントを自動的にインジェクションする。 デフォルトではこのタイプが使用される。

ByName

プロパティ名と一致する名称のコンポーネントが存在する場合に、そのコンポーネントを自動的にインジェクションする。 なお、プロパティとコンポーネントの型が一致しない場合はエラーとなる。

None

自動インジェクションを行わない。

デフォルト(ByType)の設定で自動インジェクションする例を以下に示す。

インジェクション対象のクラスを作成する

インジェクション対象のインタフェース及び実装クラスを作成する。 この例では、インタフェースを作成しているが、インタフェースの作成は必須ではない。

public interface SampleComponent {
}

public class BasicSampleComponent implements SampleComponent {
}

インジェクション対象のオブジェクトを使用するクラスを作成する

上記で作成したクラスを使って処理を行うクラスを作成する。 このクラスは、setterインジェクションで上記のクラスを受け取る。

public class SampleClient {
  private SampleComponent component;

  public void setSampleComponent(SampleComponent component) {
    this.component = component;
  }
}

コンポーネント設定ファイルにコンポーネントを定義する

この例では、 SampleClient に sampleComponent propertyを定義していないが、SampleComponentを実装したクラスの設定が1つだけなので、 sampleComponent propertyには自動的に BasicSampleComponent が設定される。

<component name="sampleComponent" class="sample.BasicSampleComponent" />

<component name="sampleClient" class="sample.SampleClient" />

上記の設定は、以下のように明示的にpropertyを定義した場合と同じ動作となる。

<component name="sampleComponent" class="sample.BasicSampleComponent" />

<component name="sampleClient" class="sample.SampleClient">
  <property name="sampleComponent" ref="sampleComponent" />
</component>

7.2.3.7. コンポーネント設定ファイル(xml)を分割する¶

全ての定義を1つのコンポーネント設定ファイルに定義するとxmlが巨大となり、メンテナンス性が悪くなる問題がある。 このため、xmlファイルを複数ファイルに分割できる機能を提供している。

xmlファイルを分割する際には、機能単位などある程度の粒度でファイルを分割すると良い。 分割したxmlファイルは、import要素で読み込む事ができる。

以下に例を示す。

この例では、3つのxmlファイルがロードされる。

<import file="library/database.xml" />
<import file="library/validation.xml" />
<import file="handler/multipart.xml" />

7.2.3.8. 依存値を設定する¶

テスト環境や本番環境で異なる値(データベースの接続情報やディレクトリのパスなど)は、環境設定ファイルで管理できる。

環境設定ファイルは、以下のようにシンプルなkey-value形式で記述する。 詳細な記述ルールは、 環境設定ファイルの記述ルール を参照。

database.url = jdbc:h2:mem:sample
database.user = sa
database.password = sa

以下に例を示す。

環境依存値

database.url = jdbc:h2:mem:sample
database.user = sa
database.password = sa

7.2.3.9. コンポーネント設定ファイルから環境依存値を参照する¶

コンポーネント設定ファイル(xml)から環境設定ファイルを読み込み、Java Beansオブジェクトの設定値として使用できる。

DIコンテナで管理するオブジェクトに対して環境依存値を設定(インジェクション)する場合は、 コンポーネント設定ファイルに環境依存値のキー値を ${ と } で囲んで記述する。

なお、この記法を環境設定ファイルで使用することはできない。(環境設定ファイル内では、他の環境依存値は参照できない。)

以下に例を示す。

環境設定ファイル

database.url = jdbc:h2:mem:sample
database.user = sa
database.password = sa

コンポーネント設定ファイル

環境設定ファイルを読み込む場合には、config-file要素を使用する。 この例のようにファイル名指定で読み込んだり、特定ディレクトリ配下のファイルを一括で読み込むことができる。

上記の環境設定ファイルの名前が「database.properties」の場合、 JdbcDataSource の url には、「jdbc:h2:mem:sample」が設定される。

<!-- database.propertiesファイルの読み込み -->
<config-file file="database.properties" />

<component class="org.h2.jdbcx.JdbcDataSource">
  <property name="url" value="${database.url}" />
</component>

環境設定ファイルにはconfigファイルとpropertiesファイルの二種類があり、configファイルはnablarchの独自仕様によりパースされ、 propertiesファイルはjava.util.Propertiesによりパースされる。configファイルはnablarchの独自仕様であることから 環境設定ファイルにはpropertiesファイルを推奨する。

環境設定ファイルの仕様は、 環境設定ファイルの記述ルール を参照。

7.2.3.10. システムプロパティを使って環境依存値を上書きする¶

環境依存値は、システムプロパティ( java.lang.System#getProperties() で取得できる値)で上書きできる。 システムプロパティは、環境設定ファイルに設定した値より優先されるため、vmオプションで容易に設定値を上書きすることができる。

例えば、特定のバッチアプリケーションだけ設定値を変えたいといった場合に、システムプロパティを使用して環境依存値を上書きするといったことができる。

以下に例を示す。

環境設定ファイル

message=上書きされるメッセージ

システムプロパティで値を上書きする

javaコマンドの -D オプションでシステムプロパティを設定することで、環境設定ファイルの値を上書きすることができる。 この例の場合、 message の値は「上書きするメッセージ」となる。

java -Dmessage=上書きするメッセージ

7.2.3.11. ファクトリクラスで生成したオブジェクトをインジェクションする¶

Java Beansとして実装されているクラスであれば、setterインジェクションを使用して値を設定しオブジェクトを生成することができる。 しかし、ベンダー提供やOSSなどのJava Beansとして実装されていないオブジェクトをシステムリポジトリで管理したい場合がある。

この場合は、ファクトリクラスを作成しファクトリクラス経由でオブジェクトを生成することで、これらのクラスをシステムリポジトリで管理できるようになる。

以下に手順を示す。

ファクトリクラスを作成する

ファクトリクラスは、 ComponentFactory インタフェースを実装し作成する。

実装例

public class SampleComponentFactory implements ComponentFactory<SampleComponent> {
  // 生成するオブジェクトへの設定値
  private String configValue;

  public void setConfigValue(String configValue) {
    this.configValue = configValue;
  }

  public SampleComponent createObject() {
    // オブジェクトを生成する。
    // この例では、このクラスにsetterインジェクションした値を使ってオブジェクトを生成する。
    return new SampleComponent(configValue);
  }
}

コンポーネント設定ファイルにファクトリクラスを設定する

ファクトリクラスを通常のコンポーネントと同じように設定することで、 自動的にファクトリクラスが生成したオブジェクトが設定される。

<!-- ファクトリクラスの定義 -->
<component name="sampleComponent" class="sample.SampleComponentFactory">
  <property name="configValue" value="設定値" />
</component>

<!-- ファクトリクラスで生成したオブジェクトを設定するクラス -->
<component class="sample.SampleBean">
  <!-- sampleObjectプロパティにファクトリクラスで生成したオブジェクトが設定される -->
  <property name="sampleObject" ref="sampleComponent" />
</component>

7.2.3.12. オブジェクトの初期化処理を行う¶

オブジェクトの初期化処理を行うためには、以下の手順が必要となる。

1. Initializable インタフェースを実装する。
2. コンポーネント設定ファイルに初期化対象のリストを設定する。

以下に詳細な手順を示す。

Initializableインタフェースを実装する

initialzie で初期化処理を行う。

public class SampleComponent implements Initializable {
  public void initialize() {
    // プロパティにインジェクションされた値などを元に初期化処理を行う
  }
}

コンポーネント設定ファイルに初期化対象のリストを設定する

初期化対象のオブジェクトを BasicApplicationInitializer に設定する。

初期化対象のオブジェクトの初期化順を意識する必要がある場合は、先に初期化を行いたいオブジェクトをより上に設定する。 下の設定例の場合、以下の順で初期化が行われる。

1. sampleObject
2. sampleObject3
3. sampleObject2

重要

BasicApplicationInitializer のコンポーネント名は、 必ず initializer とすること。

<!-- 初期化対象のオブジェクトの設定 -->
<component name="sampleObject" class="sample.SampleComponent" />
<component name="sampleObject2" class="sample.SampleComponent2" />
<component name="sampleObject3" class="sample.SampleComponent3" />

<component name="initializer"
    class="nablarch.core.repository.initialization.BasicApplicationInitializer">

  <!-- initializeListプロパティにlist要素で初期化対象のオブジェクトを列挙する -->
  <property name="initializeList">
    <list>
      <component-ref name="sampleObject"/>
      <component-ref name="sampleObject3" />
      <component-ref name="sampleObject2" />
    </list>
  </property>

</component>

7.2.3.13. DIコンテナの情報をシステムリポジトリに設定する¶

DIコンテナの情報をシステムリポジトリにロードすることで、アプリケーション内の全ての箇所からDIコンテナ上のオブジェクトにアクセスできる。

コンポーネント設定ファイルをロードし、システムリポジトリに設定する例を以下に示す。

この例では、 web-boot.xml を元に構築されたDIコンテナの情報がシステムリポジトリに設定される。

XmlComponentDefinitionLoader loader
    = new XmlComponentDefinitionLoader("web-boot.xml");
SystemRepository.load(new DiContainer(loader));

7.2.3.14. システムリポジトリからオブジェクトを取得する¶

システムリポジトリ上からオブジェクトを取得する場合には、 SystemRepository クラスを使用する。

なお、システムリポジトリには事前にDIコンテナの情報を設定しておく必要がある。 詳細は、 DIコンテナの情報をシステムリポジトリに設定する を参照。

以下のように、component要素(listやmap要素を含む)に設定したname属性の値を指定して、オブジェクトを取得できる。

コンポーネント定義

<component name="sampleComponent" class="sample.SampleComponent" />

<component name="component" class="sample.Component" >
  <property name="component2">
    <component name="component2" class="sample.Component2" />
  </property>
</component>

取得例

// SystemRepository#getを使用して取得する。
SampleComponent sample = SystemRepository.get("sampleComponent");

// ネストしたcomponentは、親の名前と自身の名前を"."で連結し取得する。
Component2 component2 = SystemRepository.get("component.component2");