9. 設定ファイルの設定

2006.01.27　株式会社四次元データ　里見玲爾

この章では設定ファイルの設定について解説します。

9.1. 設定ファイルとは

設定ファイル(プロパティファイルとも呼ばれる)とは、Velocityエンジンを起動する際に読み込むファイルです。 この設定ファイルの内容によりVelocityの処理が変わってきます。

設定ファイルはjava.util.Propertiesと同じように、"設定するキー" = "値"の形で設定します。 たとえば、

  directive.foreach.counter.name = velocityCount

のようになります。 また値には、String(数字やbooleanなど)、Stringのコンマ区切りリスト、ファイルパスのコンマ区切りリストがあります。

9.2. 設定ファイルの読み込み

javaコードで設定ファイルを読み込む方法は3種類あり、 それらはすべてVelocityクラスまたはVelocityEngineクラスのinit()メソッドを使います。

9.2.1. デフォルトの使用

デフォルトの設定ファイルを使用する場合は次のように記述します。

　import org.apache.velocity.app.Velocity;
  (略)
  
  Velocity.init();
  
  ・・・
  (略)

引数を持たないinit()メソッドを使用すると、 Velocityエンジンはデフォルトの設定ファイルを使って起動します。 デフォルトの設定ファイルは、Velocityのjarファイル内にあるvelocity.propertiesファイルですので、 必要なときに確認してみてください。

9.2.2. 任意の設定ファイルの使用

任意の設定ファイル(sample.properties)を使用するには次のように記述します。

　import org.apache.velocity.app.Velocity;
　(略)

  Velocity.init("sample.properties");
  
  ・・・
  (略)

デフォルト以外の設定ファイルを使用する場合は、 init(String filename)の形のメソッドを使ってVelocityエンジンを起動します。
またこのときに読み込む設定ファイルで記述されている設定キーについては、 ファイル内の設定値に変更されますが、 設定されていないキーの部分はすべてデフォルト値が利用されます。 そのため自分で設定ファイルを作るときには、変更したいキーだけを設定したファイルを作ればよいのです。 作った設定ファイルは、デフォルトの設定ファイルと同じフォルダに置いておきます。

9.2.3. java.util.Propertiesの使用

この方法は、設定ファイルではなくjavaのオブジェクトを使ってVelocityを起動する方法です。 次のように記述します。

  import org.apache.velocity.app.Velocity;
  import java.util.Properties;
  (略)
  
  Properties p = new Properties;
  p.setProperty("resource.loader", "FILE");
  
  Velocity.init(p);
  
  ・・・
  (略)

この方法は設定ファイルを先に記述せずに、 java.util.PropertiesオブジェクトにsetPropertyメソッドを使って設定を追加していくので、 コードの上で設定を行う感じになります。 初期化の部分ではinit(java.util.Properties)メソッドを使用しています。 この場合でも9.2.2と同様に、設定した部分以外はデフォルト値が利用されます。