これは Mayaa Advent Calendar 2015 の16日目です。昨日は「Mayaaでサイトを作るときのワークフロー」でした。
今日も11日目の続編を書きます。
とは言え、PathAdjusterの書き換えについては
5日目
SourceDescriptorについては
昔の記事
InjectionResolverについては、
これも昔の記事
で紹介していました。
そうすると、残っているのはProcessorです。
独自のProcessorを作ろう
独自のプロセッサーが必要になるのはどういう時でしょうか？
例えば、こんな時だと思います。
- 毎回Mayaaファイルに同じような記述をしている。もっと楽をしたい！
- Mayaaファイルに"${ }"でJavaScriptを書いたりせず、独自記法で直接Javaオブジェクトにアクセスして高速化を図りたい
思いつくのはこんな感じです。
Processorを極めると、Mayaaを極めるといった感じがします。
独自Processorの作り方
プロセッサーの登録には、mldというファイルが必要になります。これは、そのプロセッサーがどんな属性を受け取るのかなどを設定します。
記述例は、Mayaaのソースコード 内にある、
/mayaa/src-impl/org/seasar/mayaa/impl/engine/processor/mayaa.mld
を見てみるのが一番わかり易いと懐います。
ということで、独自のmldファイルを作って、my.mldとしてみます。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE library
PUBLIC "-//The Seasar Foundation//DTD Mayaa Library Definition 1.0//EN"
"http://mayaa.seasar.org/dtd/mld_1_0.dtd">
<library uri="http://example.jp/mymayaa">
<description>My Mayaa processors</description>
<processor name="if" class="jp.example.MyIfProcessor">
<property name="test" expectedClass="boolean"/>
</processor>
<processor name="write"
class="jp.example.MyWriteProcessor">
<property name="value" expectedClass="java.lang.String"/>
<property name="escape" expectedClass="boolean" default="false"/>
</processor>
</library>
この例では、writeプロセッサーとifプロセッサーを独自拡張しようとしています。
このファイルはどこに置けばよいでしょうか？
こちらの情報によると
WEB-INF/lib
jar内 META-INF/
classes/以下全ディレクトリ
などに置けば有効になります。
とのことです。
ということで、classes/META-INFなどのディレクトリを切って、
org.seasar.mayaa.provider.ServiceProvider
まどと一緒に入れてしまうのが良いと思います。
Processorを実装する
プロセッサーの実装例は、すでにあるプロセッサーのソースを読むのが一番早いです。
今回はこんな感じのプロセッサーを作ってみたいと思います。
- my:writeプロセッサー
- escapeXml, escapeEol, escapeWhitespaceを毎回書くのはめんどくさいから、
escape='false'で全部指定出来るようにする
- escapeXml, escapeEol, escapeWhitespaceを毎回書くのはめんどくさいから、
- my:ifプロセッサー
- テンプレート側にm:NOT=""を付けることで条件を反転して動作する
これらを実装すればMayaaファイルを一気にすっきりさせられそうです！
実装例（MyWriteProcessor）
public class MyWriteProcessor extends org.seasar.mayaa.impl.engine.processor.WriteProcessor {
public void setEscape(ProcessorProperty escape) {
setEscapeEol(escape);
setEscapeWhitespace(escape);
setEscapeXml(escape);
}
}
実装例（MyIfProcessor）
public class MyIfProcessor extends org.seasar.mayaa.impl.engine.processor.IfProcessor {
private volatile boolean created = false;
private ProcessorProperty _test;
// MLD property, expectedClass=boolean
public void setTest(ProcessorProperty test) {
if (test == null) {
throw new IllegalArgumentException();
}
_test = test;
super.setTest(_test);
}
@Override
public ProcessStatus doStartProcess(Page topLevelPage) {
if (!created) {
synchronized (this) {
if (!created) {
ProcessorTreeWalker[] childProcessors = new ProcessorTreeWalker[getChildProcessorSize()];
for (int i = 0; i < childProcessors.length; i++) {
childProcessors[i] = getChildProcessor(i);
}
clearChildProcessors();
ProcessorTreeWalker echoNode = createNode(this, "echo");
for (int i = 0; i < childProcessors.length; i++) {
if (childProcessors[i] != null) {
echoNode.addChildProcessor(childProcessors[i]);
}
}
echoNode.addChildProcessor(createNode(this, "doBody"));
addChildProcessor(echoNode);
created = true;
}
}
}
if (_test == null) {
throw new IllegalStateException("test attribute is empty." + getInjectedNode().getSystemID() + " (" + getInjectedNode().getLineNumber() + ")");
}
boolean test = ObjectUtil.booleanValue(_test.getValue().execute(null), false);
NodeAttribute attr = getOriginalNode().getAttribute(SpecificationUtil.createQName("NOT"));
if (attr != null) {
test = !test;
}
return test ? ProcessStatus.EVAL_BODY_INCLUDE : ProcessStatus.SKIP_BODY;
}
static ProcessorTreeWalker createNode(TemplateProcessor node, String name) {
QName qname = QNameImpl.getInstance(name);
LibraryManager libraryManager = ProviderUtil.getLibraryManager();
ProcessorDefinition def = libraryManager.getProcessorDefinition(qname);
SpecificationNodeImpl echo = new SpecificationNodeImpl(qname);
TemplateProcessor proc = def.createTemplateProcessor(node.getOriginalNode(), echo);
proc.setOriginalNode(node.getOriginalNode());
proc.setInjectedNode(echo);
return proc;
}
}
Ifの方が結構複雑な感じですね。これは、複数のプロセッサーの仕事をまとめるために、初めてレンダリングするときに、前後にプロセッサーを足しています。
さすがにもう少しスマートなやり方もあるかもしれません。
記述例
Mayaaファイル先頭のxmlns属性に、今回使った名前空間を追加しないと使えません。今回はhttp://example.jp/mymayaaというものを書きましたが、実際は自分が所属するドメインなどユニークなものを使ってください。
<?xml version='1.0' encoding='UTF-8' ?>
<m:mayaa xmlns:m="http://mayaa.seasar.org" xmlns:my="http://example.jp/mymayaa" >
<!-- XXXの時にのみ表示します -->
<my:if m:id="IF_XXX" test="${request.XXX}" />
<!-- YYYを出力します。 -->
<my:write m:id="YYY" escape="false" />
</m:mayaa>
<div m:id="IF_XXX">XXXです</div>
<div m:id="IF_XXX" m:NOT="">XXXではありません</div>
<span m:id="YYY_HERE">YYYを出力</span>
まとめ
このように、プロセッサーは簡単に作れます。上手くやると、Mayaaファイルをとてもすっきりさせたり、独自のテンプレート記法を自由に生み出せることが出来るでしょう。
MyIfProcessorと同じような仕掛けで、for, forEachプロセッサーは簡単に作れます。
Mayaaファイルの書き方がかったるいなーなどと思ったら、Processorの作成に挑戦することをおすすめします。
おまけ:じつはMayaaは何でもプロセッサーで処理する
Mayaaの内部構造を理解すると、例えば「静的文字列を出力する」（LiteralCharactersProcessor）もプロセッサーだったりします。<!CDATA句もCDATAProcessorというのがあったりします。
Mayaaのレンダリングはプロセッサーであることを理解しておくと、何かあった時の調査に役立つと思います。
