QuickRefletorとは

概要
QuickReflectorはHTML(XHTML)をベースとしたデザインHTMLファイルと、JAVA・各種スクリプト言語のロジックを非常にシンプルに連携させるフレームワークです。

具体的には、HTMLファイル内に、ファイルリクエスト時に実行したい各種スクリプト言語へのロジックソースファイルパスをタグで記述することで、HTMLファイルをシンプルに各ロジックと連携させることができます。

動作イメージ

TODO　動作イメージ（HTMLファイル内にタグがあり、そこからロジックに矢印）

記述例
<span ext:language="言語ID" ext:target="実行ロジックソースファイル"/>
${msg}
HTMLファイルには、このHTMLがリクエストされた時に実行するロジックソースファイルのパスを指定します。
また、SmartyやMayaaに類似した形式で変数を記述することで、値を出力したり、タグの表示・非表示を切り替えることが可能です。

さらに、クラスファイルの自動コンパイル・ロード・置換に対応しており、アプリケーションサーバーを起動したままソースファイルを更新するだけで、ほぼ全てのクラスファイルを置換することが可能です。
その結果、開発、保守時間が非常に短縮され、「クラスファイルの修正に伴うアプリケーションサーバーの再起動」が基本的に不要となります。

階層としての位置づけ
QuickReflectorは基本的にプレゼンテーション層をサポートするフレームワークです。
さらに、プレゼンテーション層に加え、クラスファイルの生存管理も行いますので、
クラスローダー管理も行うフレームワークでもあります。

TODO　図MVC階層図

開発言語選択の自由
QuickReflectorはHTMLから呼び出すロジックの言語を複数の言語から選択できます。

言語ID言語
javaJava(http://java.sun.com/)

rhinoRhino - JavaScript for Java(http://www.mozilla.org/rhino/)
beanshellBeanShell - Lightweight scripting for Java(http://www.beanshell.org/)

pnutspnuts(https://pnuts.dev.java.net/)
jythonThe Jython project(http://www.jython.org/Project/index.html)

judoscriptJudo Language(http://www.judoscript.com/judo.html)
※2008/4/30 現在

これらロジックの言語は、ext:language 指定毎に変更できますので、
ページごとに異なる言語を選択することも可能です。
今後も対応言語を増やしていく予定です。

従来の開発上の課題と解消方法
従来のWEBアプリケーション開発上の課題について、QuickReflectorがどのように解決できるか説明します。

ターゲット
課題
QuickReflectorによる解決

保守性向上

ロジックソースファイル(JAVAファイル等)を修正した場合、Tomcatを再起動する必要がある。または、オートデプロイ後、コンテキストの再起動まで時間がかかる。
そのため、結果的にメンテナンス時間が発生し、サービスを一旦停止にしなければならない。
ロジックソースファイルを更新しておくだけで、htmlへのアクセス時に自動的に更新されたロジックソースファイルをコンパイル、クラスロードし実行します。
そのためアプリケーションサーバーを停止させずにロジックの置き換えが可能です。
⇒顧客、サービス利用者にメリット大、保守コスト減少

開発時間短縮
開発中にロジックソースファイルを少し修正しただけでも、アプリケーションサーバー（コンテキスト）の再起動が必要となり、待ち時間がもったいない。
かといって、JSPベースの開発ではロジックがJSPに記述されることになり、保守・テスト・開発に支障をきたしてしまう。

ローカル開発環境でQuickReflectorベースで開発することで、ロジックソースファイルを修正してもアプリケーションサーバーを起動する必要が無いので、
非常に「サクサク」と羽が生えたような感覚の開発・動作確認スピードで進められます（体感的にはPerl,PHPと同じレベル）。
⇒開発・テスト時間短縮、開発コスト減少

開発言語選択選定の自由度
JAVAでロジックを開発したいが、jython(phyton)技術者しかいない。
初期開発は jython を利用し、状況に応じて JAVA で部分的にロジックを再構築することも可能。
⇒システムの成長・負荷状況・開発人員のスキルに合わせた言語選択が可能

デザイナーとプログラマーの分業
デザインHTMLを修正した場合、それをプログラマーがJSP等に反映させる必要がるため、プログラマーの手間が増える。
デザインHTMLに事前に一定の（ブラウザで動作確認可能な）タグを追加することで、デザインHTMLファイルをロジックから完全に分離することができ、
プログラマーがデザインHTMLをメンテナンスする必要が無くなります。
⇒デザイン修正・リリースをプログラマー等の開発者が行う必要が無くなり、完全な分業が可能

リンクについて
当サイトへのリンクはトップページ (http://quickreflector.sourceforge.net/) へお願いします。
トップよりも下のページは更新により構成が変わる可能性があります。

開発元

PowerBEANS

機能一覧

QuickReflectorが提供する機能

• HTML(XHTML)レンダリング機能
• HTML(XHTML)への値バインド機能
• HTML(XHTML)不正タグチェック機能
• HTMLの不要改行・空行削除出力機能
• HTMLコメント削除出力機能
• JAVAソースファイル自動コンパイル・ロード機能
• JAVAソースファイルコンパイル時の中間ファイル生成機能
• 各種スクリプト言語ファイル実行機能(インタープリター)
• ファイルインクルード機能
• フォワード、リダイレクト機能
• HTTPヘッダ出力機能
• オブジェクトトランザクション機能

コンセプト

基本コンセプト

QuickReflectorは



QuickにWebアプリを開発し、

Quickな保守・メンテナンスを提供することで、

QuickなJAVAベースWebアプリ開発が可能、というイメージを持てる、



ことを基本コンセプトとしています。

ライセンス

QuickReflector は、BSD ライセンスに従ってご利用ください。



ソースコードはこちらから入手可能です。

サンプルプロジェクト導入方法

サンプルプロジェクトについて

1. ダウンロード

2． Eclipse　WEB プロジェクト作成

3． WEB プロジェクトの設定

4． WEB プロジェクトの起動

サンプルプロジェクトについて

QuickReflectorの開発環境を構築する際は、QuickReflectorサンプルプロジェクトを利用する素早く開発環境を構築することが可能です。

そこで、サンプルプロジェクトを利用してEclipseに動的Webプロジェクトを構築する手順を説明します。

1. ダウンロード

SouceForgeダウンロード一覧ページより、最新の quickreflector-examples.zip をダウンロードして解凍します。

2． Eclipse　WEB プロジェクト作成

解凍した　quickreflector-examples　フォルダのフォルダ名を変更します。（仮に myqr-project とします）

さらに、Eclipseプロジェクト作成時に予期しない問題の発生を防ぐため .classpath,.project　ファイル, .settingsディレクトリ を削除しておきます。

（この時、myqr-project ディレクトリのフルパスが D:\myqr-project　であるものとします）

次に、Eclipse の 新規プロジェクトウィザードで「動的Webプロジェクト」 または 「Dynamic Web Project」を選択し、 以下の設定で新規プロジェクトを作成します。

Project name:myqr-project
Project contents
　　Directory:D:\myqr-project

※上記の他の設定はデフォルト値で構いません。

3． WEB プロジェクトの設定

以下の設定を行います。

• プロジェクトプロパティの [Java のビルドパス]
  
  ソースパスに "myqr-project/pages" を追加します。




• ライブラリファイルコピー
  
  myqr-project/WebContent/WEB-INF/lib ディレクトリに以下のファイルをコピーし、プロジェクトを更新します。
  

  　ant.jar
  　ant-launcher.jar
  　quickreflector-silvergear.jar
  　quickreflector-webcore.jar
  　servlet-api.jar
  




• web.xml の修正
  

  myqr-project/WebContent/WEB-INF/web.xml を開き、pagesource-root　の値を実際のパスにします。
  

  修正前) 
  <init-param>
  	<param-name>pagesource-root</param-name>
  	<param-value>c:/temp/quickreflector/quickreflector-examples</param-value>
  </init-param>
  
  修正後)
  <init-param>
  	<param-name>pagesource-root</param-name>
  	<param-value>D:/myqr-project</param-value>
  </init-param>
  




• Tomcatにクラスパスを追加
  
  プロジェクトを[サーバーで実行]で一度実行・停止しサーバーを追加します。
  
  そして、[サーバー]ビューで追加したサーバーを選択し、[開く]で「サーバーの概要」ビューを表示します。
  
  ここで、[起動構成を開く]-[クラスパス] を選択し、[ユーザーエントリー] に 先ほど WEB-INF/lib に追加したjarファイルを追加します。

以上で設定は完了です。

4． WEB プロジェクトの起動

[サーバー]ビューで追加したサーバーを選択し、[始動]でTomcatを起動します。



起動後、以下のURLにアクセスすると、サンプルの動作を確認可能です。

http://localhost:8080/myqr-project/examples/sample1.jsx

http://localhost:8080/myqr-project/examples/sample2.jsx

http://localhost:8080/myqr-project/examples/sample3.jsx

http://localhost:8080/myqr-project/examples/sample4.jsx

http://localhost:8080/myqr-project/examples/sample5.jsx

http://localhost:8080/myqr-project/examples/sample6.jsx

http://localhost:8080/myqr-project/examples/sample7.jsx

http://localhost:8080/myqr-project/examples/sample8.jsx



sample1.jsx の場合は、sample1.html が表示されています。その他のファイルも同様です。



※ web.xml を以下のように設定すると、sample1.html へのアクセスでも同様の結果を得られます。

	<servlet-mapping>
		<servlet-name>JsxServlet</servlet-name>

		<url-pattern>*.html</url-pattern>
	</servlet-mapping>

以上でサンプルプロジェクトが動作する開発環境が整いました。

このプロジェクトをベースに開発をスタートさせていください。



※うまく動作しない場合は こちら も確認してください。

ページの開発

ページを作る
タグ要素を表示制御する(コメント)
変数を参照する
変数に値を設定する
HTTPヘッダを書く
他のページを組み込む
ループを書く

ページを作る

ページの元となるソースファイル(htmlファイル)は web.xml に記述した pagesource-root が指すディレクトリの下の、pagesource が指すディレクトリの下に保存してください。このディレクトリ以下のパスがそのまま URL のコンテキストパスに対応するようになっています。


ソースファイルの拡張子は .html です。中身は XHTML として記述してください。ただし、DOCTYPE は XHTML でなくともかまいません。DOCTYPE はそのまま出力に使われます。（現状DOCTYPEの指定はできません。近いうちに指定ができるように対処します）

※xhtmlの記述が正しければ特にエラーは出力されません

タグ要素を表示制御する(コメント)

タグ要素は通常、そのまま出力されます。出力されないようにしたいときは、以下に挙げる３つの方法から選択できます。

• タグを<!-- -->で括る。
• タグを削除する。
• タグに ext:show="!true" という属性を追加する。

ext:show を指定する方法は QuickReflector の拡張機能です。ext:show="true" とすると出力されるようになります。

この機能を使うと、HTMLファイルを直接ブラウジングしたときには表示、アプリケーションで出力したときには非表示になりますので、
HTMLファイルに直接デザイナー向けのコメントや、ダミーデータを記述することが可能になります。

例)コメントの出しわけ

comment1.html

<html><body>
<!-- HTML Comment　(開発者向けコメント) -->
<span ext:show="!true">QuickReflectorのコメント(デザイナー向けコメント)</span>
</body></html>

comment1.html を直接ブラウザで表示した場合

QuickReflectorのコメント(デザイナー向けコメント)

comment1.html をQuickReflectorを通してブラウザ表示した場合

(何も表示されません)

※HTMLコメントの出力レベルを設定できる機能がありますが、現在はインターフェースが変更される可能性が高いため、仕様が固まってから公開します。

変数を参照する

htmlで変数を参照するには、事前にロジック側で VariableContainer#put で画面に表示するオブジェクトを格納しておきます。

その上でhtmlをレンダリングすると、 ${ と } で括った領域は出力の際に対応する変数の値で置換されます。

たとえば、${data} とするとページに対して与えられた変数マップから "data" をキーとする値を参照し、その値を展開します。

また、変数にHTMLタグを含む文字列が格納されており、それをHTMLエスケープせず
そのまま出力したい場合は、

　${data.NOESCAPE}

と記述します。



例) 各オブジェクトを表示

var1.html

<html><body>

<span ext:language="java" ext:target="Var1.java"/>

msg=${msg}<br/>
<br/>
array[0]=${array.0}<br/>
<br/>
list[1]=${list.1}<br/>
<br/>

map.name=${map.name}<br/>

</body>
</html>

Var1.java

package examples;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import quickreflector.webcore.helper.Parameters;
import quickreflector.webcore.helper.scriptdriver.JavaPageMarker;
import quickreflector.webcore.variablecontainer.VariableContainer;

public class Var1 implements JavaPageMarker {

	public void invoke( Parameters params ) throws Exception {
		// 変数コンテナを取り出す。
		VariableContainer container = params.getVariables();

		// 各変数を格納
		container.put("msg", "Hello!");
		
		String[] strings = {"My", "Name"};
		container.put("array", strings);
		
		List list = new ArrayList();
		list.add("List1");
		list.add("List2");
		container.put("list", list);
		
		Map map = new HashMap();
		map.put("name", "ミスター");
		container.put("map", map);
	}
}

var1.htmlへのアクセス結果

msg=Hello!

array[0]=My

list[1]=List2

map.name=ミスター

ext:language="java" の場合、指定したJAVAファイルは JavaPageMarker を実装する必要があります。

さらに

public void invoke( Parameters params )

メソッドを宣言することで、html上の

<span ext:language="java" ext:target="Var1.java"/>

が解析されたタイミングで、Var1#invoke メソッドが実行されます。

${data}の data が示すオブジェクトが子要素を持つ場合、以下の参照例で示すように子要素を展開できます。



${} 記載方法

変数参照の途中で ; (セミコロン)を入れると } の直前までをコメントとみなします。${key; キー参照}という記述で展開内容をコメントとして残しておくことができます。

${} の中に ${} を入れて再帰的に展開させることはできません。${key${num}} と記述すると、"key${num" という変数を探して結果を展開し、最後の } がテキストとして出力されます。

また、変数にはプリフィックスをつけることができます。これは変数が格納されている場所を示すもので、プリフィックスとコロンを変数の頭につけて位置を直接に指定できます。

プリフィックスとして提供されるのは以下の８種類で、それぞれが参照するオブジェクトが違います。



プリフィックス一覧

プリフィックスをつけないで変数を取り扱うと表の下の方から参照し、最初に見つかった値を利用します。また、書き込みの場合はPAGEプリフィックスが示すマップへ書き込みを行います。



例) プリフィクスの利用例

var2.html

<!-- リクエストパラメータ name を出力 -->
name=${REQUEST:name}
<!-- どこかのスコープに存在する name を出力 -->
name=${name}

Var2.java

// リクエストパラメータ name を取得
String name = (String) container.get("REQUEST:name");
// セッションに独自クラスUserInfoを設定
container.put("SESSION:userInfo", userInfo);

変数に値を設定する

<span ext:set="def">
  # 値の設定ができます
  count = 18
  number = 21
  SESSION:data = data
</span>

上記の記述でページソース内で変数に値を割り当てることができます。
１行にひとつずつ「変数名 = 値」という設定ができます。右辺の値は左右の空白を除去した文字列として割り当てられます。
span タグの中を<!-- -->で括っても処理されます。

HTTPヘッダを書く

<span ext:set="http-header">
  # HTTPヘッダを設定できます
  Content-Type: text/html; charset=Windows-31J
</span>

上記の記述でページ出力の際のHTTPヘッダの内容を設定することができます。
１行にひとつずつ「変数名 : 値」という設定ができます。両辺の値は左右の空白を除去した文字列として割り当てられます。
span タグの中を<!-- -->で括っても処理されます。

他のページを組み込む

<span ext:include="./other.html"/>
  この位置に記述した内容は破棄されます
</span>

上記の記述で他のページを現在のページの出力に組み込むことができます。タグの中に記述した内容はすべて破棄されます。

これは JSP が持つ jsp:include の機能とは異なり、他のページの出力結果を取り込むものではないためパラメータ指定はできません。

なお、XMLの制約により組み込まれる側のページには少なくとも一つのタグがなければなりません。このタグが紛れ込むことを避けるため、ext:wrap="false" という属性をページのタグに入れておくことができます。

ループを書く

<span ext:loop="3,i">
  label${i; ループ変数は0からカウントアップされます。}<br>
</span>

上記の記述でlabel0,label1,label2という文字列を3行にわたって展開することができます。ext:loopの値として指定できるのは、0以上の整数値あるいは java.util.Collection の派生クラス、または配列を示すキー値です。整数値のほかはページ作成だけでは供給できないため、プログラム作成の方で解説しています。



例) ループの例

Loop1.java

package examples;
import java.util.ArrayList;
import java.util.List;

import quickreflector.webcore.helper.Parameters;
import quickreflector.webcore.helper.scriptdriver.JavaPageMarker;
import quickreflector.webcore.variablecontainer.VariableContainer;

public class Loop1 implements JavaPageMarker {

	public void invoke( Parameters params ) throws Exception {
		// 変数コンテナを取り出す。
		VariableContainer container = params.getVariables();

		// 変数を格納
		List list = new ArrayList();
		list.add(new Bean("Mr"));
		list.add(new Bean("Mss"));
		container.put("bean_list", list);
	}
}

Bean.java

package examples;

public class Bean {

	private String name;
	public Bean(String name) {
		this.name = name;
	}
	public String getName() {return name;}
	public void setName(String name) {this.name = name;}
}

loop1.html

<html><body>
<span ext:language="java" ext:target="Loop1.java"/>

<span ext:loop="bean_list,b">
  name=${b.name}<br/>
</span>
</body>
</html>

出力結果

name=Mr
name=Mss

ロジックの開発

ロジックを作る

ロジッククラスの特徴

リクエストパラメータを取得する

セッションにアクセスする

フォワード、リダイレクトする

ロジックを作る

htmlファイル内のspan タグの属性に ext:target が定義されていると、その属性値をロジックファイルへの相対パス、として解釈し、
そのロジックファイルをコンパイル・ロード・実行します。

コンパイル、ロードはロジックファイルが前回コンパイル時から変更されていた場合のみ行います。



例) var3.html リクエスト時に Var3.java を実行

var3.html

<html><body>

<span ext:language="java" ext:target="Var3.java"/>
</body>
</html>

ロジックファイル Var3.java

package examples;

import quickreflector.webcore.helper.Parameters;
import quickreflector.webcore.helper.scriptdriver.JavaPageMarker;

public class Var3 implements JavaPageMarker {

	public void invoke( Parameters params ) throws Exception {
	}
}

ロジックファイル内でリクエストパラメータ取得、セッション処理、他クラス呼び出し、など実際の処理を行います。

※ロジックファイルは各種スクリプト言語に対応していますが、ここでは Javaのみを対象として説明します。

ロジッククラスの特徴

ロジッククラスには以下の特徴があります。

• 常にSingletonインスタンスで管理されます。そのためクラス変数は定数のみ宣言してください。
• 独自のクラスを継承することが可能です。ただし、JavaPageMarker インターフェースは親クラスか子クラスで実装されている必要があります。

リクエストパラメータを取得する

リクエストパラメータを取得するには、

contaner.get("REQUEST:パラメータ名")

と記述します。

慣れるまではcontanerに明示的にリクエストプリフィクスを指定した方が良いでしょう。

パラメータが存在しない場合は null を返します。

例) ロジックファイル Req.java

package examples;
import quickreflector.webcore.helper.Parameters;
import quickreflector.webcore.helper.scriptdriver.JavaPageMarker;
import quickreflector.webcore.variablecontainer.VariableContainer;

public class Req implements JavaPageMarker {

	public void invoke( Parameters params ) throws Exception {
		// 変数コンテナを取り出す。
		VariableContainer container = params.getVariables();

		// リクエストパラメータ name を取得
		String name = (String)container.get("REQUEST:name");
	}
}

セッションにアクセスする

HTTPセッションを操作するには、

[取得] contaner.get("SESSION:属性名")

[設定] contaner.put("SESSION:属性名", オブジェクト)

と記述します。



例) ロジックファイル Ses.java

package examples;
import java.util.HashMap;
import java.util.Map;

import quickreflector.webcore.helper.Parameters;
import quickreflector.webcore.helper.scriptdriver.JavaPageMarker;
import quickreflector.webcore.variablecontainer.VariableContainer;

public class Ses implements JavaPageMarker {

	public void invoke( Parameters params ) throws Exception {
		// 変数コンテナを取り出す。
		VariableContainer container = params.getVariables();

		// セッションからDummyMapを取得
		Map map = (Map)container.get("SESSION:dummyMap");
		if (map == null) {
			map = new HashMap();
			map.put("user_id", "0");
			// セッションにDummyMapを格納
			container.put("SESSION:dummyMap", map);
		}
	}
}

フォワード、リダイレクトする

ページの出力を中止してフォワード、リダイレクト、エラーステータス返却、中止等を行いたい場合は、
params から getRenderer() でレンダラを取り出し、
setAbort( Object ) メソッドで実行します。

その際、以下のプリフィックスを指定して動作を指定します。



abort プリフィックス一覧

例) ロジックファイル ForwardRedirect.java

package examples;
import quickreflector.silvergear.Renderer;
import quickreflector.webcore.helper.Parameters;
import quickreflector.webcore.helper.scriptdriver.JavaPageMarker;
import quickreflector.webcore.variablecontainer.VariableContainer;

public class ForwardRedirect implements JavaPageMarker {

	public void invoke( Parameters params ) throws Exception {
		// 変数コンテナを取り出す。
		VariableContainer container = params.getVariables();

		// リクエストパラメータ name を取得
		String name = (String)container.get("REQUEST:name");
		
		Renderer renderer = params.getRenderer();
		if (name == null) {
			// name が存在しない場合は
			// http://www.sourceforge.net/ へリダイレクト
			renderer.setAbort("SEND:http://www.sourceforge.net/");
		} else {
			// その他はx.jsx へフォワード
			renderer.setAbort("FORWARD:/examples/x.jsx");
		}
	}
}

setAbortでフォワードした場合は、それまでのhtmlのレンダリング内容は破棄され、
新たにフォワード先のhtml,ロジックが実行されます。



その際、全htmlに共通の初期処理を行うよう記述している場合は、フォワード後に再度初期処理が実行されても、
問題ないように動作することを考慮して開発する必要があります。

技術情報 SilverGear

技術情報 SilverGear

このページは準備中です。

技術情報 WebCore

技術情報 WebCore

このページは準備中です。

不具合・要望・問い合わせ等の連絡先

不具合の報告先

SourceForge.net Bugsに投稿してください。

英語でも日本語でも構いません。

機能追加要望・技術的な質問

Open Discussionに投稿してください。

英語でも日本語でも構いません。

その他の問い合わせ

PB-Lab 問い合わせよりお問い合わせ下さい。

英語でも日本語でも構いません。