共通ライブラリが提供するJSP Tag Library と EL Functions ================================================================================ .. only:: html .. contents:: 目次 :depth: 3 :local: | .. _TagLibAndELFunctionsOverview: Overview -------------------------------------------------------------------------------- 共通ライブラリでは、JSPの実装をサポートする機能として、以下に示すJSP Tag Library と EL Functionsを提供している。 | .. _TagLibAndELFunctionsOverviewTagLibs: JSP Tag Library ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 共通ライブラリから提供しているJSP Tag Libraryを以下に示す。 .. tabularcolumns:: |p{0.05\linewidth}|p{0.25\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 5 25 60 * - | 項番 - | タグ名 - | 概要 * - 1. - \ :ref:`TaglibAndELFunctionsHowToUseTaglibPagination`\ - ページネーションリンクを出力する。 * - 2. - \ :ref:`TaglibAndELFunctionsHowToUseTaglibMessagesPanel`\ - 処理結果メッセージを出力する。 * - 3. - \ :ref:`TaglibAndELFunctionsHowToUseTaglibTransaction`\ - トランザクショントークンをhidden項目として出力する。 | .. _TagLibAndELFunctionsOverviewELFunctions: EL Functions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 共通ライブラリから提供しているEL Functionsを以下に示す。 \ **XSS対策関連**\ .. tabularcolumns:: |p{0.05\linewidth}|p{0.25\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 5 25 60 * - | 項番 - | 関数名 - | 概要 * - 1. - \ :ref:`TaglibAndELFunctionsHowToUseELFunctionH`\ - 指定されたオブジェクトを文字列に変換し、変換した文字列内のHTML特殊文字をエスケープする。 * - 2. - \ :ref:`TaglibAndELFunctionsHowToUseELFunctionJs`\ - 指定された文字列内のJavaScript特殊文字をエスケープする。 * - 3. - \ :ref:`TaglibAndELFunctionsHowToUseELFunctionHjs`\ - 指定された文字列内のJavaScript特殊文字をエスケープ後、HTML特殊文字をエスケープする。(\ ``f:h(f:js())``\ のショートカット関数) \ **URL関連**\ .. tabularcolumns:: |p{0.05\linewidth}|p{0.25\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 5 25 60 * - | 項番 - | 関数名 - | 概要 * - 4. - \ :ref:`TaglibAndELFunctionsHowToUseELFunctionQuery`\ - 指定されたオブジェクトから、UTF-8でURLエンコーディングされたクエリ文字列を生成する。 * - 5. - \ :ref:`TaglibAndELFunctionsHowToUseELFunctionU`\ - 指定された文字列をUTF-8でURLエンコーディングする。 \ **DOM関連**\ .. tabularcolumns:: |p{0.05\linewidth}|p{0.25\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 5 25 60 * - | 項番 - | 関数名 - | 概要 * - 6. - \ :ref:`TaglibAndELFunctionsHowToUseELFunctionLink`\ - 指定されたURLにジャンプするハイパーリンク(\ ````\ タグ)を生成する。 * - 7. - \ :ref:`TaglibAndELFunctionsHowToUseELFunctionBr`\ - 指定された文字列内の改行コードを\ ``
``\ タグに変換する。 \ **ユーティリティ**\ .. tabularcolumns:: |p{0.05\linewidth}|p{0.25\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 5 25 60 * - | 項番 - | 関数名 - | 概要 * - 8. - \ :ref:`TaglibAndELFunctionsHowToUseELFunctionCut`\ - 指定された文字列から、指定された文字数を抜き出す。 | .. _TagLibAndELFunctionsHowToUse: How to use -------------------------------------------------------------------------------- 共通ライブラリから提供している JSP Tag Library と EL関数の使用方法を以下に示す。なお、他の章で使用方法の説明があるものについては、該当箇所へのハイパーリンクを貼っている。 | .. _TaglibAndELFunctionsHowToUseTaglibPagination: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ ````\ タグは、 ページ検索の結果(\ ``org.springframework.data.domain.Page``\ )に格納されている情報を参照して、 ページネーションリンクを出力するJSP Tag Libraryである。 ページネーション機能の説明及び本タグの使用方法は、「\ :doc:`./Pagination`\ 」の以下の節を参照されたい。 * ページネーションリンクについては、「\ :ref:`pagination_overview_page_display_paginationlink`\ 」 * 本タグのパラメータ値については、「\ :ref:`pagination_overview_page_display_paginationlink_taglibparameters`\ 」 * 本タグを使用したJSPの基本的な実装方法については、「\ :ref:`pagination_how_to_use_make_jsp_basic_paginationlink`\ 」 * ページネーションリンクのレイアウトの変更方法については、「\ :ref:`pagination_how_to_use_make_jsp_layout`\ 」 | .. _TaglibAndELFunctionsHowToUseTaglibMessagespanel: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ ````\ タグは、処理結果メッセージ(\ ``org.terasoluna.gfw.common.message.ResultMessage``\ や例外が保持するメッセージなど)を出力するJSP Tag Libraryである。 本タグの使用方法は、「\ :doc:`../WebApplicationDetail/MessageManagement`\ 」の以下の節を参照されたい。 * 本タグを使用したメッセージの表示方法については、「\ :ref:`message-display`\ 」 * 本タグのパラメータ値については、「\ :ref:`message-management-messagepanel-attribute`\ 」 | .. _TaglibAndELFunctionsHowToUseTaglibTransaction: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ ````\ タグは、トランザクショントークンをhidden項目(\ ``"``\ )として出力するJSP Tag Libraryである。 トランザクショントークンチェック機能の説明及び本タグの使用方法は、「\ :doc:`./DoubleSubmitProtection`\ 」の以下の節を参照されたい。 * トランザクショントークンチェック機能については、「\ :ref:`doubleSubmit_how_to_use_transaction_token_check`\ 」 * 本タグの使用方法については、「\ :ref:`doubleSubmit_how_to_use_transaction_token_check_jsp`\ 」 .. note:: 本タグは、HTML標準の\ ``
``\ タグを使用する際にトランザクショントークンをサーバに送信するために使用する。 Spring Framework提供の\ ````\ タグ(JSP Tag Library)を使用する際は、共通ライブラリから提供している\ ``org.terasoluna.gfw.web.token.transaction.TransactionTokenRequestDataValueProcessor``\ が自動でトランザクショントークンを埋め込む仕組みになっているため、本タグを使用する必要はない。 | .. _TaglibAndELFunctionsHowToUseELFunctionH: f:h() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ ``f:h()``\ は、引数に指定されたオブジェクトを文字列に変換し、変換した文字列内のHTML特殊文字をエスケープするEL Functionである。 HTML特殊文字とエスケープ仕様については、「\ :ref:`xss_how_to_use_ouput_escaping`\ 」を参照されたい。 | f:h() 関数仕様 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ **引数**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.Object``\ - HTML特殊文字が含まれる可能性があるオブジェクト .. note:: 指定されたオブジェクトは、 * 配列の場合は、\ ``java.util.Arrays#toString``\ メソッド * 配列以外の場合は、指定されたオブジェクトの \ ``toString``\ メソッド を使用して文字列に変換される。 \ **戻り値**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.String``\ - HTMLエスケープ後の文字列 引数で指定されたオブジェクトが\ ``null``\ の場合は、空文字(\ ``""``\ )を返却する。 | f:h() 使用方法 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ ``f:h()``\ の使用方法については、「\ :ref:`xss_how_to_use_h_function_example`\ 」を参照されたい。 | .. _TaglibAndELFunctionsHowToUseELFunctionJs: f:js() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ ``f:js()``\ は、引数に指定された文字列内のJavaScript特殊文字をエスケープするEL Functionである。 JavaScript特殊文字とエスケープ仕様については、「\ :ref:`xss_how_to_use_javascript_escaping`\ 」を参照されたい。 | f:js() 関数仕様 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ **引数**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.String``\ - JavaScript特殊文字が含まれる可能性がある文字列 \ **戻り値**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.String``\ - JavaScriptエスケープ後の文字列 引数で指定された文字列が\ ``null``\ の場合は、空文字(\ ``""``\ )を返却する。 | f:js() 使用方法 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ ``f:js()``\ の使用方法については、「\ :ref:`xss_how_to_use_js_function_example`\ 」を参照されたい。 | .. _TaglibAndELFunctionsHowToUseELFunctionHjs: f:hjs() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ ``f:hjs()``\ は、引数に指定された文字列内のJavaScript特殊文字をエスケープした後に、HTML特殊文字をエスケープするEL Function(\ ``f:h(f:js())``\ のショートカット関数)である。 * 本関数の用途については、「\ :ref:`xss_how_to_use_event_handler_escaping`\ 」を参照されたい。 * JavaScript特殊文字とエスケープ仕様については、「\ :ref:`xss_how_to_use_javascript_escaping`\ 」を参照されたい。 * HTML特殊文字とエスケープ仕様については、「\ :ref:`xss_how_to_use_ouput_escaping`\ 」を参照されたい。 | f:hjs() 関数仕様 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ **引数**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.String``\ - JavaScript特殊文字又はHTML特殊文字が含まれる可能性がある文字列 \ **戻り値**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.String``\ - JavaScript及びHTMLエスケープ後の文字列 引数で指定された文字列が\ ``null``\ の場合は、空文字(\ ``""``\ )を返却する。 | f:hjs() 使用方法 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ ``f:hjs()``\ の使用方法については、「\ :ref:`xss_how_to_use_hjs_function_example`\ 」を参照されたい。 | .. _TaglibAndELFunctionsHowToUseELFunctionQuery: f:query() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | \ ``f:query()``\ は、引数に指定されたJavaBean(フォームオブジェクト)又は\ ``java.util.Map``\ オブジェクトから、クエリ文字列を生成するEL Functionである。 | クエリ文字列内のパラメータ名とパラメータ値は、UTF-8でURLエンコーディングされる。 | | URLエンコーディング仕様を以下に示す。 | | 本関数では、クエリ文字列のパラメータ名とパラメータ値に対して、\ `RFC 3986 `_\ ベースのURLエンコーディングを行う。 | RFC 3986では、クエリ文字列のパート以下のように定義している。 .. figure:: ./images_TagLibAndELFunctions/TagLibAndELFunctionsRFC3986UriSyntax.png :width: 90% * query = \*( pchar / "\ ``/``\ " / "\ ``?``\ " ) * pchar = unreserved / pct-encoded / sub-delims / "\ ``:``\ " / "\ ``@``\ " * unreserved = ALPHA / DIGIT / "\ ``-``\ " / "\ ``.``\ " / "\ ``_``\ " / "\ ``~``\ " * sub-delims = "\ ``!``\ " / "\ ``$``\ " / "\ ``&``\ " / "\ ``'``\ " / "\ ``(``\ " / "\ ``)``\ " / "\ ``*``\ " / "\ ``+``\ " / "\ ``,``\ " / "\ ``;``\ " / "\ ``=``\ " * pct-encoded = "\ ``%``\ " HEXDIG HEXDIG 本関数では、クエリ文字列として使用できる文字のうち、 * "\ ``=``\ " (パラメータ名とパラメータ値のセパレータ文字) * "\ ``&``\ " (複数のパラメータを扱う場合のセパレータ文字) * "\ ``+``\ " (HTMLのformからサブミットした時に半角スペースを表す文字) をpct-encoded形式の文字列にエンコーディングする。 .. warning:: Spring Framework 4までは、クエリ文字列として使用できる文字のうち("\ ``=``\ ", "\ ``&``\ ", "\ ``+``\ ")の3文字をSpring Frameworkがエンコーディングしていたが、Spring Framework 5から、クエリ文字列のエンコードを行う\ ``org.springframework.web.util.UriComponentsBuilder``\ や\ ``org.springframework.web.util.UriUtils.encodeQueryParam``\ メソッドの仕様が変更され、"\ ``+``\ "はエンコーディング対象外となった。 共通ライブラリの\ ``f:query()``\ , \ ``f:u()``\ では、内部で上記の仕様変更されたクラスを利用しているが、独自に"\ ``+``\ "をエンコーディングすることで仕様変更の影響を受けないようにしている。 ガイドラインでは紹介していないが、上記の仕様変更されたクラスを直接利用して\ ``query``\ を含むURIを生成しているアプリケーションでは、"\ ``+``\ "がエンコーディング対象外となったことによる影響を受ける可能性がある為、注意すること。なお、\ ``UriComponentsBuilder``\ では、クエリパラメータに含まれる\ ``unreserved``\ 文字以外をエンコーディングする機能を提供している為、当機能を用いる事でクエリパラメータに含まれる "\ ``+``\ "のエンコーディングは可能である。\ ``UriComponentsBuilder``\ を利用してURIをエンコーディングする方法については、\ `Spring Framework Documentation -URI Encoding- `_\ を参照されたい。 | f:query() 関数仕様 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ **引数**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.Object``\ - クエリ文字列の生成元となるオブジェクト(JavaBean又は\ ``Map``\ ) JavaBeanを指定した場合はプロパティ名がリクエストパラメータ名となり、\ ``Map``\ を指定した場合はキー名がリクエストパラメータとなる。 JavaBeanのプロパティ及び\ ``Map``\ の値としてサポートしている型は以下の通りである。 * \ ``Iterable``\ インタフェースの実装クラス * 配列 * \ ``Map``\ インタフェースの実装クラス * JavaBean * シンプル型 (\ ``DefaultFormattingConversionService``\ を使って\ ``String``\ 型へ変換可能なクラス) ネスト構造をもつJavaBean及び\ ``Map``\ も指定可能である。 .. note:: 指定されたオブジェクトのシンプル型のプロパティ値は、\ ``org.springframework.format.support.DefaultFormattingConversionService``\ の \ ``convert``\ メソッドを使用して文字列に変換される。 \ ``ConversionService``\ については、\ `Spring Framework Documentation -Spring Type Conversion- `_\ を参照されたい。 \ **戻り値**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.String``\ - 引数で指定されたオブジェクトを元に生成したクエリ文字列(UTF-8でURLエンコーディング済みの文字列) 引数で指定されたオブジェクトが、JavaBean又は\ ``Map``\ 以外の場合は、空文字(\ ``""``\ )を返却する。 .. note:: \ **クエリ文字列への変換ルール**\ \ ``f:query()``\ は、Spring Web MVCのバインディング処理(``WebDataBinder``)で扱うことができる形式に変換している。 具体的には以下のルールでクエリ文字列に変換している。 \ **[リクエストパラメータ名]**\ .. tabularcolumns:: |p{0.45\linewidth}|p{0.30\linewidth}|p{0.25\linewidth}| .. list-table:: :header-rows: 1 :widths: 45 30 25 * - 条件 - パラメータ名の変換仕様 - 変換例 * - プロパティの型が\ ``Iterable``\ の実装クラス又は配列の場合 - プロパティ名 + \ ``[要素位置]``\ - \ ``status[0]=accepting``\ * - プロパティの型が\ ``Iterable``\ の実装クラス又は配列で値の要素が空の場合、および型が\ ``Boolean``\ で値が\ ``null``\ の場合 - | プロパティ名 | (\ ``[要素位置]``\ は付与しない) - \ ``status=``\ * - プロパティの型が\ ``Map``\ の実装クラスの場合 - プロパティ名 + \ ``[Mapのキー名]``\ - \ ``status[accepting]=Accepting Order``\ * - プロパティの型(\ ``Iterable``\ 、配列、\ ``Map``\ の要素型)がJavaBeanの場合 - プロパティ名を"\ ``.``\ " (ドット)でつなげた値 - | \ ``mainContract.name=xxx``\ | \ ``subContracts[0].name=xxx``\ * - プロパティの型がシンプル型の場合 - プロパティ名 - \ ``userId=xxx``\ * - プロパティの値が\ ``null``\ の場合(プロパティの型が\ ``Boolean``\ の場合を除く) - "\ ``_``\ " (アンダースコア) + プロパティ名 - | \ ``_mainContract.name=``\ | \ ``_status[0]=``\ | \ ``_status[accepting]=``\ \ **[リクエストパラメータ値]**\ .. tabularcolumns:: |p{0.45\linewidth}|p{0.30\linewidth}|p{0.25\linewidth}| .. list-table:: :header-rows: 1 :widths: 45 30 25 :class: longtable * - 条件 - パラメータ値の変換仕様 - 変換例 * - プロパティの値が\ ``null``\ の場合(プロパティの型が\ ``Boolean``\ の場合を除く) - ブランク文字列 - \ ``_userId=``\ * - プロパティの型が\ ``Iterable``\ の実装クラス又は配列で値の要素が空の場合、および型が\ ``Boolean``\ で値が\ ``null``\ の場合 - ブランク文字列 - \ ``status=``\ * - プロパティの値が\ ``null``\ でない場合 - \ ``DefaultFormattingConversionService``\ を使って\ ``String``\ 型へ変換した値 - \ ``targetDate=20150801``\ Spring Web MVCのバインディング処理(\ ``WebDataBinder``\ )のデフォルト設定では「"\ ``_``\ "(アンダースコア) + プロパティ名」のリクエストパラメータが送信された場合、 \ ``List``\ 、配列、 \ ``Map``\ に対してはそれぞれに対応する空のオブジェクトをバインドし、\ ``boolean``\ 及び\ ``Boolean``\ 型のプロパティに対しては\ ``Boolean``\ 型のfalseをバインドする。 詳細は、\ `WebDataBinder#getEmptyValueのJavadoc `_\ を参照されたい。 terasoluna-gfw-webでは、\ ``Boolean``\ 型プロパティで\ ``null``\ がfalseに変換されてしまうことを防ぐために「”_" (アンダースコア) + プロパティ名」のリクエストパラメータを送信しないようにしている。 | f:query() 使用方法 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | \ ``f:query()``\ の使用方法については、「\ :ref:`pagination_how_to_use_make_jsp_basic_search_criteria`\ 」を参照されたい。 | ここでは、ページネーションリンクを使用してページを切り替える際に、検索条件を引き継ぐ際の手段として、本関数を使用している。また、関数の仕様と注意点についても記載しているので、これについても一読されたい。 | .. _TaglibAndELFunctionsHowToUseELFunctionU: f:u() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ ``f:u()``\ は、引数に指定された文字列をUTF-8でURLエンコーディングするEL Functionである。 | 本関数は、クエリ文字列内のパラメータ値に設定する値をURLエンコーディングするために用意している。 | URLエンコーディング仕様は、「\ :ref:`TaglibAndELFunctionsHowToUseELFunctionQuery`\ 」を参照されたい。 | f:u() 関数仕様 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ **引数**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.String``\ - URLエンコードが必要な文字が含まれる可能性がある文字列 \ **戻り値**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.String``\ - URLエンコード後の文字列 引数で指定された文字列が\ ``null``\ の場合は、空文字(\ ``""``\ )を返却する。 | f:u() 使用方法 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. code-block:: jsp
Go to Yahoo Search
.. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - 上記例では、本関数を使用してURLエンコードした値を検索サイトのリクエストパラメータに設定している。 | .. _TaglibAndELFunctionsHowToUseELFunctionLink: f:link() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ ``f:link()``\ は、引数に指定されたURLにジャンプするためのハイパーリンク(\ ````\ タグ)を出力するEL Functionである。 .. warning:: 本関数では、URLエンコーディングや特殊文字のエスケープ処理は行われない点に注意すること。 | f:link() 関数仕様 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ **引数**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.String``\ - リンク先のURL文字列 URL文字列は、HTTP又はHTTPSスキーマのURL形式である必要がある。 （e.g : \ ``http://hostname:80/terasoluna/global.ex?id=123``\ ） \ **戻り値**\ .. tabularcolumns:: |p{0.10\linewidth}|p{0.20\linewidth}|p{0.60\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 20 60 * - 項番 - 型 - 説明 * - 1. - \ ``java.lang.String``\ - 引数に指定された文字列を元に生成したハイパーリンク(\ ````\ タグ) 引数に指定された文字列が、 * 引数で指定された文字列が\ ``null``\ の場合は、空文字(\ ``""``\ ) * HTTP又はHTTPSスキーマのURL形式でない場合は、ハイパーリンクを生成せず入力値の文字列 を返却する。 | f:link() 使用方法 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" \ **実装例**\ .. code-block:: jsp \ **出力例**\ .. code-block:: html .. tabularcolumns:: |p{0.10\linewidth}|p{0.90\linewidth}| .. list-table:: :header-rows: 1 :widths: 10 90 * - 項番 - 説明 * - | (1) - | 引数に指定されたURL文字列からハイパーリンクを生成する。 * - | (2) - | 引数で指定したURL文字列が、\ ````\ タグの \ ``href``\ 属性と、ハイパーリンクのリンク名に設定される。 .. warning:: URLにリクエストパラメータを付加する場合は、リクエストパラメータの値はURLエンコーディングする必要がある。リクエストパラメータを付加する場合は、\ ``f:query()``\ 関数や\ ``f:u()``\ 関数を使用して、リクエストパラメータの値を適切にURLエンコーディングすること。 また、戻り値の説明でも記載しているが、引数のURL文字列の形式が適切でない場合は、ハイパーリンクを生成せず入力値の文字列を返却する仕様としている。そのため、引数に指定するURL文字列としてユーザからの入力値を使用する場合は、文字列出力処理と同様のHTML特殊文字のエスケープ処理(\ :doc:`../../Security/XSS`\ )が必要になるケースがある。 | .. _TaglibAndELFunctionsHowToUseELFunctionBr: f:br() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \ ``f:br()``\ は、引数に指定された文字列内の改行コード（\ ``CRLF``\ , \ ``LF``\ , \ ``CR``\ ）を\ ``
``\ タグに変換するEL Functionである。 .. tip:: 改行コードを含む文字列をブラウザ上の表示として改行する場合は、改行コードを\ ``
``\ タグに変換する必要がある。 例えば、入力画面のテキストエリア(\ ``