Mayaaの経験を活かして、JSPを注意して使う方法

これは Mayaa Advent Calendar 2015 の21日目です。昨日は「テンプレートエンジン(Mayaa, Mixer2, Thymeleaf, JSF2.x)を比較してみて」でした。

クリスマスまであと5日です。

テンプレートエンジンを比較してみて

前回までに、Mayaa, Mixer2, Thymeleaf, JSFのどれを使うべきかについて結論を出しました。しかし、JSPを使わなければいけないケースもありますし、簡単なプログラムではライブラリを導入せず、さっとJSPだけで済ませたい時もあります。

そんなわけで、これまでの経験を元に、JSPを使う際の注意点を考えてみたいと思います。

JSPでいしがみメソッド

m:id含め、プログラム都合の識別子は常に大文字を使う

プログラムに制御情報を書いてしまうのでこの限りではないですが、せめて見えやすくしたいところです。また、中にごちゃごちゃした式を書いていくのはアレなので、taglibやヘルパー関数にまとめたいです。

僕はJSTLやtaglibは中途半端過ぎて嫌いなので、ヘルパーにまとめます。ヘルパー関数はimport staticを使うのが良いと思います。

m:idのする仕事を4種類に限定する

JSPはなんでも出来てしまいます。それこそ、いきなりスクリプトレットで、プログラムを書いてしまうことも出来ますが、それはやめましょう。Mayaaでのいしがみメソッドで使う4種類の仕事のみをJSPでもやるようにしましょう。

4種類の実装方法はルールに従う

こんな感じでスタイルを統一しましょう。

HERE:

名前: <%= escape(bean.getName()) %>

IF:

<% if (bean.isHoge()) { %>
<div>
    ほげほげです。
</div>
<% } %>

TAG:

<a
  href="<%= adjustPath(bean.getUrl()) %>"
>リンク</a>

LOOP:

<% for (int i = 0; i < bean.getSize(); i++) { %>
<div>
    <%= i %>回目のほげほげです。
</div>
<% } %>

LOOP系のm:idはindexには長い名前を使い、maxを十分に大きな値を設定する

これはケースバイケースで考えてください。あまり長い名前にすると、テンプレートが見づらくなりますが、iとかjにすると、ブロックを移動した時に動かなくなるかもしれません。

writeプロセッサーでエスケープを解除するときは全部する

escapeヘルパー関数を作ると良いです。

tableタグだけは特別に扱う

ここは心配がいらないです。

m:idをパラメータ対応にする

これも心配がいらないです。
適宜ヘルパー関数をパラメータ化するのが良いと思います。

PathAdjusterを効果的に使う

ここが意味することは、PathAdjusterみたいなものをヘルパー関数として作ると良いことがあります。JSPテンプレートにベタに絶対パスを調整するコードを書かず常に adjustPath(~) のように囲っておくと、後々良いことがあるはずです。

ヘッダー・フッター・共通部品はiframeタグをうまく使う

<jsp:include>タグを使うのが良いと思います。<%@ include file="" %>ディレクティブを使うべきケースはほぼないと思います。

テンプレート上のコメントは、ソース表示時に見えないようにする

<%-- --%>を使いましょう。

単語はなるべくテンプレート側に書く

これは正反対になります。
単語はテンプレートに書いてはいけません。
どこかのファイルにテーブル化しておくべきです。

nekoHTMLパーサーをいじる

パーサもへったくれもないので、気をつけてValidなHTMLを書いてください。出力したページをバリデータにかけても良いかもしれません。

まとめ

以上、見てみると、意外と、Mayaaでの経験がそのままJSPで活かせそうです。JSPを注意して使うことによって、テンプレートがスパゲッティにならないですみます。

ただ、そう思って自分もJSPを扱っていますが、それでもやはり、JSPはぐちゃぐちゃでデザイナーには読めないものになってしまいますし、常にヘルパー関数を使うようなルールを運用するのはめんどくさく、結局Mayaaを使ったほうが楽だったのではないかと感じてしまうことが多いです。パフォーマンスも良くありません。

ある程度の規模のプログラムを作るときは、JSPは避けるべきだと思います。

テンプレートエンジン(Mayaa, Mixer2, Thymeleaf, JSF2.x)を比較してみて

これは Mayaa Advent Calendar 2015 の20日目です。昨日は「Mayaaに慣れた僕がJSF2.x Faceletsを試してみる」でした。

さて、クリスマスまであと6日です。
僕のよく行く飲食店もクリスマスモードになっています\(^o^)/

アドベントカレンダーも残すところあお6回、最後はまとめ記事になると思いますので、記事を書けるのはあと5回、名残惜しさもあります。

しかしそうこうするうちに今日があと3時間を切っていたので油断なりません。「頓挫したカレンダー」にならぬよう最後まで頑張ります!

テンプレートエンジンを比較してみて

昨日までの3回に渡って色々なテンプレートエンジンを試してみました。

ためしてみることで、それぞれの特徴がわかりました。
マトリックスにしてみるとこんな感じです。

名前 独立性 パフォーマンス デザインフレンドリー 手軽さ
Mayaa
(Servlet依存)

(Mayaaファイル作成が必要)
Mixer2
JAXB次第
Thymeleaf
Velocityより速いらしい
JSF2.0 Facelets
×

それぞれの特長

Mayaa

特長

  • デザイナーとの協業の追求については、一日の長がある
  • とにかくそれ専用として設計されているため機能が充実している
  • ドキュメントや実績が豊富

このブログのアドベントカレンダーを最初から読んでくだされば、デザイナーとの協業は心配することがないと思います。

欠点

  • Servletに依存が強い(JSPと同じレイヤーであるため、JSPの置き換えにしかならない)
  • パフォーマンスが不利であること
  • HTML5 サポートとうたえていない

    • 閉じタグ忘れなどinvalidなHTMLすら扱えるようにするために利用しているnekoHTMLパーサーがHTML5に対応していないため

HTML5問題についてはnekoHTMLをオフにして、XHTMLをテンプレートとして使用すれば他のテンプレートエンジンと同等になるため、実質的に大きく劣っているわけではありません。

他2については設計上の思想から仕方がないところです。

Mixer2

特長

  • PathAdjusterなどMayaaの影響を受けた機能を備えている
  • Mayaa同様テンプレートに制御情報を記述させない設計
  • Java標準のJAXBを利用しているため、独立性が強く
  • JUnitと親和性が強く、デザインをユニットテストできる

欠点

  • 制御情報をJavaで書かなければならないためコード量が多い
  • 同じid属性を使用するため、デザイナーとプログラマーが同時に使わなければならない

Thymeleaf

特長

  • m:idをいちいち定義せずすぐに使える
  • 依存性が低く単独でも動作する
  • Spring Bootなどに標準対応している
  • パフォーマンスが良い

欠点

  • テンプレートに制御情報の記述が必要

JSF2.x Facelets

特長

  • Java標準であること

欠点

  • 完全な意味での、プログラマー・デザイナーの協業は達成できない

どのテンプレートエンジンを使うべきか

以上を踏まえて考えると、僕は次のように思います。

Mayaaが向いているプロジェクトではMayaaを使うべき

Mayaaが向いている案件とは、

  • 一つの機能に対して、非常に頻繁にデザインの書き換えを行う
  • または、非常に沢山のバリエーションを作る
  • コンシューマー向けでデザインを重視したサイト
  • SEOが必要でサーバーサイドテンプレートエンジンが必要

詳しくは8日目も参考にしてください。

SEOが不要であれば、SPAにしてしまうことも選択肢の一つ

SEOが不要であれば、サーバーサイドはJSONだけを吐き出せば良く、フロント側はBackbone.jsやAngularJS、React.jsを使うという作戦も検討の余地があります。

CRUDを作るとき、AngularJSは非常に手っ取り早いです。Angularではjsファイルを使いまわして、HTMLファイルを複数作るなんてことも出来ます。

コンシューマー向けではない場合は、JSF / Thymeleaf が選択候補に上がる

フレームワークに何を使うかで判断が分かれると思います。
Java EEの時はJSF, Springの時はThymeleafが良いと思います。

デザイン重視ではあるが、多くのバリエーションを作成しない場合は、Thymeleafが有力

デザインのバリエーションを並立する場合、制御情報のコピペが発生してしまうことが懸念点であるので、Thymeleafはデメリットが出てきますが、変更であれば、その問題がありません。

費用対効果を考えた上で、デザイナーを自立させるよりも、プログラマーとデザイナーが都度協力したほうが良い判断であれば、MayaaよりもThymeleafの方が向いています。

デザインをJUnitでテストしたい時は、Mixer2しかない

現状、ユニットテスト可能な唯一のテンプレートエンジンがMixer2です。
そのため、むしろ、機能の変更が頻繁に発生するときに威力を発揮するかもしれません。
機能の変更に対するデザインへのリグレッションテストが自動でできるのはMixer2だけです。

まとめ

このように、それぞれのテンプレートエンジンは、ターゲットとしている問題が微妙に違っていて、それぞれのニーズがあるかぎり、どれかがどれかを排除してしまうことはないものです。

プロジェクトを開始する際にどのテンプレートエンジンを使えばよいか、そのプロジェクトの性格から判断するべきです。

その時、この記事が参考になれば、幸いです。

Mayaaに慣れた僕がJSF2.x Faceletsを試してみる

これは Mayaa Advent Calendar 2015 の19日目です。昨日は「Mayaaに慣れた僕がThymeleafを試してみる」でした。

さて、一昨日、昨日と、MayaaのライバルとみなされるJava HTMLテンプレート、Mixer2とThymeleafを試してみました。思えば2年前、JJUGのLT大会で、テンプレートエンジンネタでぶつけてきたときを思い出します。

1 yusuke テンプレートエンジンを制する者が世界を制す
2 nabedge 進撃のMixer2 – 立体機動テンプレートエンジン
3 eiryu Thymeleafでハマったこと
4 susumuis from JSP to Design-friendly Template Endine / JSPからMayaaに移行した本当の話
5 smilelx_xl(+susumuis) テンプレートエンジンを利用したプログラマーとデザイナーの共同開発で大切なこと(仮)
:
:

実際にためしてみると、あながち競合する技術ではないのかなと印象を持ちました。

そういえば、忘れてました!Java EE本家、JSFのFacelets書式はXHTML形式なので、これも、検討対象となりそうです。今日はこれで、デザインーとの協業が可能か、いしがみメソッドは適用可能かを、見てみたいと思います。

Java EEといったら、NetBeans

僕は普段、Eclipseを使い、Androidの時はAndroid Studioを使いますが、Java EEの時はNetBeansを使います。

詳しくは、Introduction to JavaServer Faces 2.x というドキュメントが分かりやすいです。今回はもっとシンプルに作ってみます。

Hello World

NetBeansで[新規プロジェクト] - [Java Web]を選び、フレームワークに「JavaSever Faces」を選んで、ライブラリにJSF2.2を選べば雛形が作られます。

WEB-INF/index.xhtmlを次のように作成します。

<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
      xmlns:h="http://xmlns.jcp.org/jsf/html">
    <h:head>
        <title>Facelet Title</title>
    </h:head>
    <h:body>
        <h:outputText value="#{helloBean.hello}"/>
    </h:body>
</html>

タグ名にh:が付いている時点で、Mayaa、Mixer2、Thymeleafとは毛色が違います。

デザインエディットするときはサーバーを立ち上げるか、開発環境のエディタを使う必要があります。デザイナーが作成したHTMLを元にプログラマーが埋め込む方式であれば、いいかもしれません。

ループはどうするか?

ループするときはこんな感じになります。

例えばこんな感じのItemクラスを作って

public class Item {    
    private String name;
    public Item(String name) {
        this.name = name;
    }
    public String getName() {
        return name;
    }
}

管理ビーンのプロパティにリストとして登録してみます。

@Named(value = "helloBean")
@Dependent
public class HelloBean {
    private String hello = "Hello World";
    private List<Item> list = new ArrayList<>();

    public HelloBean() {
        list.add(new Item("りんご"));
        list.add(new Item("ばなな"));
        list.add(new Item("みかん"));
    }

    public String getHello() {
        return hello;
    }    
    public List<Item> getList() {
        return list;
    }
}

テンプレートは

<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
      xmlns:h="http://xmlns.jcp.org/jsf/html"
      xmlns:ui="http://xmlns.jcp.org/jsf/facelets">
    <h:head>
        <title>Facelet Title</title>
    </h:head>
    <h:body>
        <h1>sample</h1>
        <h:outputText value="#{helloBean.hello}"/>
        <ui:repeat var="row" value="#{helloBean.list}">
            <div><h:outputText value="#{row.name}"/></div>
        </ui:repeat>
    </h:body>
</html>

結果

<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head id="j_idt2">
        <title>Facelet Title</title></head><body>
        <h1>sample</h1>Hello World
            <div>りんご</div>
            <div>ばなな</div>
            <div>みかん</div></body>
</html>

ふむふむ。大体分かってきました。
JSFは基本的にはPrimeFacesを使ったコンポーネント指向の開発しかできないイメージでしたが、テンプレート主体の開発もできそうです。

いしがみメソッド検証

JSFをテンプレート主義で使った想定で検証してみます。

m:id含め、プログラム都合の識別子は常に大文字を使う

Mayaaで言うところのm:id、Thymeleafに言うところのth:ifなどの独自属性は、JSFでは独自タグになります。

m:idのする仕事を4種類に限定する

-出力: h:outputText
-分岐: c:if
-繰り返し: ui-repeat
-属性: pt:属性名

4種類の実装方法はルールに従う

このルールに対応するとしたら、「使うタグはある程度限定する」といったところになると思います。

h:inputTextのようなコンポーネントは便利ですが、どこまで使うかはプロジェクトごとのポリシーとして、決めてから使うのが良いと思います。

LOOP系のm:idはindexには長い名前を使い、maxを十分に

ui:repeatに変数名を取れるので、ここではiとかjとかは使わず適度な長さの名前をつければ良いと思います。

Mayaaで長い名前をつけるべきとしたのは、名前がMayaaファイル内に隠蔽されているためなので、Thymeleaf同様、表に出てくる場合はそれほど神経質になる必要はありません。

writeプロセッサーでエスケープを解除するときは全部する

エスケープしないテキストは escape="false" という属性をつけるだけです。

tableタグだけは特別に扱う

uiなどの独自タグが使えるので、Mayaa、Mixer2のようなHTMLにこだわったテンプレートエンジンほどここは問題にならないと思います。

m:idをパラメータ対応にする

Thymeleafと同様、式を直接書けてしまうので、m:idを減らすためのパラメータという要求は発生しないと思います。

PathAdjusterを効果的に使う

"/"で始まっていないパスは相対パスと想定されて動作するようです。その時の調整ロジックをフックできるかについては、すみません、よくわかりませんでした。

ヘッダー・フッター・共通部品はiframeタグをうまく使う

直接テンプレートを開くことはあまり得意ではなさそうなので、これは諦めるしかなさそうです。

テンプレート上のコメントは、ソース表示時に見えないようにする

<ui:remove> </ui:remove>
を使うのが良いそうです。

単語はなるべくテンプレート側に書く

これはできそうです。

nekoHTMLパーサーをいじる

もちろん、そんな必要はありません。

まとめ

JSFというと、結構複雑なコンポーネント指向の仕組みだと思いましたが、テンプレート指向でもけっこう行けることがわかりました。

プロジェクト内で、使うタグのルールを定めることで、デザイナーとの連携も可能かもしれません。