Template Engine -Velocity- varlal.com 2013/2/25
1.目的
　テンプレートエンジンの考え方を理解するとともに、java のテンプレートエンジンである「Velocity」の使い方
を理解することを目的とする。※また、ウィキペディアやブログの情報も含んでいるため、このレポートに関してすべて
を鵜呑みにしてはならない。
2.テンプレートエンジン
2.1 テンプレートエンジンとは
　Fig.1 にあるように、テンプレートとデータを分離して管理し、それをまとめること
で、ひとつのドキュメントを作成するいわゆるコンパイラのようなものである。テンプ
レートとデータを分離すること言う考え方は、MVC モデルで言うところの View に
相当している[１]。（MVC モデルでは、プログラムを Model,View,Controller
という３つの要素に分割してお互いに呼び出しあって処理が実行されていきます。）
　テンプレートは、共通部分を抽象化して効率化を図るという設計思想がある。この
ため、似たような構成のページである web ページの設計は楽になるはずである。な
ぜなら、ヘッダ・ログイン名など共通して作成できるからである。しかし、テンプレート
内で、for/foreach などの繰り返し文や if 文などの条件分岐文を記述しなければ
ならない点で、MVC モデルの View に似ているといえど、controller が混ざって
いることになることになる[２]。
2.2 テンプレートエンジンの有名所？
　本当に多くのテンプレートエンジンが存在している。
Table １に示してあるのは、ほんの一例で、perl・ruby・python のテンプレートエンジンも数多く存在する。php
では Smarty が有名で、java ベースのテンプレートエンジンは、velocity と FreeMarker が有名らしい。
2.3 ライセンスと MVC モデルについて
　今回のレポートの内容とは異なるため割愛するが、オープンソースのライセンスについてと MVC モデルは知っ
ておいたほうがいいと思う。MVC モデルについては[３]の web ページがわかりやすいかもしれない。
　Fig. 1: テンプレート
エンジンの処理フロー
*[１]より参照
Table 1: テンプレートエンジンの一例
テンプレートエンジン名 対応言語 ライセンス
LGPL
BSD License
Symfony2 MIT License
velocity Apache License 2.0
BSD-like License
多言語 Apache License 2.0
Smarty php
SimpleTemplate php
php
java
FreeMarker java
Mustache（マスタッシュ）
　[１]ウィキペディア「テンプレートエンジン」：http://ja.wikipedia.org/wiki/
　[2]テンプレートの考え方：http://pukiwiki.tuntunkun.com/index.php
　[3]MVC モデルを絵でわかりやすく説明：http://hijiriworld.com/web/mvc-concept/
Template Engine -Velocity- varlal.com 2013/2/25
3.Velocity
　Velocity の使い方は、[4]で非常にわかりやすくまとめられている。よって、このレポートの内容を読んだ後に復
習として、読んで実践してみると良いだろう。
　まず、次の２つの言葉を覚えます。
・VelocityContext
・Velocity Template Language（VTL）
VelocityContext とは、テンプレート内で書かれた変数名と java の中での変数名の対応表のようなもの。
VTL とは、テンプレートを作るときに使用する言語で、変数名の使用や繰り返し文/条件分岐文などが使用できる。
VelocityContext と VTL を使った.vm ファイルを、統合してひとつのドキュメントが出来上がる。
ここで、java がどこで使われているかというと、VelocityContext を生成する部分 と、それらを統合する部分で
ある。VelocityContext を生成するのは手書きでもおｋだと思うのだけれども、それだと、例えば Fig.2 の
$user の値が常に「四次元太郎」になってしまう。よって、VelocityContext は java で動的に作る必要がある。
3.1Velocity を使ってみよう[5]
　１．ダウンロード　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　
　Velocity の公式サイトのダウンロード http://velocity.apache.org/download.cgi から最新のバー
ジョンの Velocity Engine を選択してダウンロードし適当に解凍します（現時点では velocity-1.7 が最新版）。
この時に Engine 以外にも tools などがあるので、Engine をダウンロードします。
[4]Velocity：http://www.techscore.com/tech/Java/ApacheJakarta/Velocity/index/
[5]Velocity で Helloworld：http://wdsdx.com/node/55
Fig. 2: 簡単な例　*[４]より参照
Template Engine -Velocity- varlal.com 2013/2/25
　２．プロジェクトの作成　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　
　解凍したファイルのうち、以下の JAR ファイルを外部 JAR として追加する。 logkit 以外は基本的に必須です。
・velocity-1.7.jar
・lib/commons-collections-3.2.1.jar
・lib/commons-lang-2.4.jar
・lib/oro-2.0.8.jar
・lib/avalon-logkit-2.1.jar
次に Velocity の設定ファイルを作ります。
velocity.properties
runtime.log.logsystem.avalon.logger = velocity
input.encoding = UTF-8
output.encoding = UTF-8
プロジェクトの構成は進めていくと、右の Fig.3 のようになります。
あとは、扱う情報を保存するクラス（ここでは src/entity/に入れる）を作り、
その情報をどのように表示するかを VTL で記述した.vm ファイルを作り、そ
れらを統合（マージ）してドキュメントを作るクラスを作れば良い。
　３．エンティティの作成　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　
　表示したい情報（データ）を保持するクラスを作成します（これをエンティティ=実体と呼ぶことにする）。
src/entity/Hello.java
package entity;
import java.util.List;
public class Hello {
private String name;
private List<String> list;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public List<String> getList() {
return list;
}
public void setList(List<String> list) {
this.list = list;
}
}
Fig. 3: プロジェクトの構成
Template Engine -Velocity- varlal.com 2013/2/25
　４．テンプレートの作成　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　
　さっき作成したHelloクラスをどのように表示させるかを記述したテンプレートを作ります。
template/hello.vm
$hello.name
---------------------
#foreach($s in $hello.list)
リスト：$s
#end
---------------------
　５．サンプルクラスの作成　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　
０．エンティティにデータを入力する。
１.エンティティからVelocityContextを作成。
２.vmファイルを読み込む。
３．VelocityContextと.vmファイルをマージする。
４．マージ結果を標準出力する。
という動作を行うクラスを作成する。
src/sample/Helloworld.java
package sample;
import java.io.StringWriter;
import java.util.Arrays;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import entity.Hello;
public class Helloworld {
public static void main(String[] args) {
Hello hello = new Hello();
hello.setName("Hello World!!");
hello.setList(Arrays.
asList
("h", "e", "l", "l", "o"));
try {
Velocity.
init
("velocity.properties");
VelocityContext context = new VelocityContext();
context.put("hello", hello);
StringWriter writer = new StringWriter();
Template template = Velocity.
getTemplate
("template/hello.vm");
template.merge(context, writer);
System.
out
.println(writer.toString());
writer.flush();
} catch (Exception e) {
e.printStackTrace();
}
}
}
Template Engine -Velocity- varlal.com 2013/2/25
　５．実行　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　
　実行すると以下のようになる。
Hello World!!
---------------------
リスト：h
リスト：e
リスト：l
リスト：l
リスト：o
---------------------
　６．サンプルのクラスのソースを読む【理解】　　　　　　　　　　　　　　　　　　　　　　　　　　　
　さっき書いた src/sample/Helloworld.java にコメントをつけることで、どこで何をしているのかを理解
します。まずは自分でやってみた後、下のコメント例を参考にしてください。
public static void main(String[] args) {
　　//データを保存するインスタンスを作る。（エンティティの作成）
Hello hello = new Hello();
//インスタンスにデータを入れる。
hello.setName("Hello World!!");
hello.setList(Arrays.
asList
("h", "e", "l", "l", "o"));
try {
　　//設定ファイルを読み込む。
Velocity.
init
("velocity.properties");
//VelocityContextを作成する。
VelocityContext context = new VelocityContext();
//テンプレート内の変数helloとjava内のインスタンス（エンティティ）hello　を関連付ける。
context.put("hello", hello);
//ドキュメントを保存するwriterを作る。
StringWriter writer = new StringWriter();
//テンプレートを読み込む。
Template template = Velocity.
getTemplate
("template/hello.vm");
//テンプレートとVelocityContextをマージしてwriterに保存する。
template.merge(context, writer);
//マージした結果のwriterを出力する。
System.
out
.println(writer.toString());
//flushする。
writer.flush();
} catch (Exception e) {
e.printStackTrace();
}
}
Template Engine -Velocity- varlal.com 2013/2/25
　７．どうやって繋がっているかを把握する【理解】　　　　　　　　　　　　　　　　　　　　　　　　　
　サンプルのクラスにコメントをつけることで、VelocityContextと.vmファイルをマージする流れは理解で
きたと思います。次にどのように繋がっているかを見ていきます。src/entity/Hello.java の中のgetは使
用していないので消して、実行してみます。
src/entity/Hello.java
package entity;
import java.util.List;
public class Hello {
private String name;
private List<String> list;
public void setName(String name) {
this.name = name;
}
public void setList(List<String> list) {
this.list = list;
}
}
また、setやgetを作るのが面倒なとき、例えば以下のような例では、
右クリック　-　Sorce　-　Generate getters and setters で自動生成できます（Eclipse）。
velocityのエンティティを作る際に活躍するでしょう。
import java.util.Date;
public class document {
public String DocumentName;//題名
public Date RegistDate; //登録日付
public String Authur; //著者
public String Keyword; //キーワード
public String Abstruct; //概要・アブストラクト
}
　８．マージした時の出力先【理解】　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　
　今回、マージしたドキュメントを保存してある変数writerは、StringWriterクラスです。これは、
java.io.StringWriterで使えるようになる、いわゆる標準(画面)出力用のバッファです。
//テンプレートとVelocityContextをマージしてwriterに保存する。
template.merge(context, writer);
の第二引数はWriterクラスが指定されています。Writerクラスの直系のサブクラスは以下のようなものが
あります。単に画面に出力したい時はStringWriterを使い、ファイルに出力したい時はBufferedWriterや
PrintWriterを使うと良いでしょう。
Writerクラスの直系のサブクラス
BufferedWriter, CharArrayWriter, FilterWriter, OutputStreamWriter, PipedWriter, PrintWriter, StringWriter
結果：
$hello.name
---------------------
---------------------
となってしまい。読み込めていないことがわ
かります。
よって、テンプレートのプロパティ参照に
は、getterを使っていることがわかります。