Liferay DXP 7.0でアプリケーション表示テンプレートを使用する

目次

  1. アプリケーション表示テンプレート(ADT)入門
  2. ADTと一緒に仕事をする。メディアギャラリー
  3. APIを使用してWiki用のADTの作成
  4. ADTのエクスポート/インポート
  5. よくある質問とトラブルシューティング

はじめに

アプリケーション表示テンプレートは、サイトテンプレートやページテンプレートと似ていますが、ポートレットレベルで動作します。 アプリケーション表示テンプレート (ADT) フレームワークは、ポータル管理者がデフォルトの表示テンプレートを上書きして、サイトコンテンツの表示方法の制限を取り除くことを可能にします。 ADTを使用すると、アセット中心のアプリケーションをレンダリングするために使用されるカスタム表示テンプレートを定義することができます。 例えば、ブログのエントリーを縦に表示するのではなく横に表示したり、アセットパブリッシャーポートレットのアセットを異なるサイズで一覧表示したりすることができます。

ユーザーが独自のカスタムフックやポートレットを開発して、パーソナライズされたルックアンドフィールを持つという同じ目標を達成することができますが、デフォルトのアプリケーション表示テンプレートは、箱から出し入れしないという利点があります。 デフォルトのフレームワークは、既存の資産で使用するために特別に設計されています。 開発者は、既存のAPIとソースコードを独自のADTの基礎として使用することができます。

グローバルコンテキストを選択すると、テンプレートはすべてのサイトで利用可能になりますが、ADTはサイトレベルで含めることができます。 ADTを適用するサイトを選ぶこと。

  1. コンパス アイコンをクリックして、サイト管理ドロップダウンリストに移動します。
    adtintro01.PNG
  2. グローバル コンテキストが選択されている場合、サイト管理の構成メニューの アプリケーション表示テンプレート ページには、利用可能なサンプル テンプレートのリストが表示されます。
    adtintro02.PNG
    adtintro03.PNG
  3. これらのサンプルテンプレートは、アプリ内で既に設定されているデフォルトのテンプレートとは異なります。 特定のサイトがテンプレートのホストに選ばれた場合、ユーザーはそのサイトのアプリ用に新しいカスタムテンプレートを作成する必要があります。
    adtintro04.PNG
  4. Liferay DXP版で新規テンプレートを作成するには、グレーのプラスボタンをクリックします。
    adtintro05.PNG

以下のリストでは、ADTsを使ってカスタマイズできるアプリを指定しています。

  • Asset Publisher
  • ブログ
  • パンくず
  • カテゴリー ナビゲーション
  • ドキュメントとメディア
  • 言語セレクタ
  • ナビゲーションメニュー
  • RSSパブリッシャー
  • サイトマップ
  • タグ ナビゲーション
  • Wiki

メディアギャラリーのカスタマイズ

このセクションでは、Media Galleryポートレットでのアプリケーション表示テンプレートの使用について説明します。 それ自体、メディアギャラリーは、メインのドキュメントポートレットとは明らかに異なるメディアファイルの保存と表示の方法をユーザーに提供します。 デフォルトの見た目はアーカイブのような感じです。 ADTを使用すると、メディアギャラリーはより印象的なものになります。

  1. 追加 > アプリケーション > コンテンツ管理 > メディア・ギャラリーに移動して、メディア・ギャラリー・アプリケーションをページに追加します。
  2. アプリの 追加ボタン > 複数メディア をクリックして、表示するカスタム写真を2枚選択します。 その後、 をクリックしてを保存し、メインのアプリケーション画面に戻ります。
  3. 写真のデフォルトフォーマットに注意してください。 このアプリの表示テンプレートを変更するには、 オプション > 構成に移動します。
  4. 表示テンプレート] ドロップダウンメニューから、 カルーセルを選択します。 その後、 保存をクリックします。
    adt06.PNG
    図4: カルーセルADTを適用した後、写真はカルーセル・スライドショーとして表示されます。
    メディア・ギャラリー・アプリケーションがカルーセル・スライド・ショーに変わりました。

Liferay DXPにバンドルされているアプリのユーザー・インターフェースをカスタマイズすることで、Liferayユーザーに究極のカスタマイズ体験を提供します。


APIを使用して

開発者はAPIを使ってADTを作成することもできます。

  • アプリケーション表示テンプレート (ADT) ポートレットは、ダイナミック データ マッピングおよびテンプレート API の上に構築されています。
  • 固有のAPI。ADT固有のAPIは非常にシンプルです。 これは主に後ほど説明する2つのクラス(PortletDisplayTemplateUtilとBasePortletDisplayTemplateHandler)のみをベースにしています。
  • サービスAPIです。ADTにはサービスAPIがありませんが(したがって、DB内の特定のテーブルはありません)、DDMのサービスAPIを再利用しています。 すべての情報はDDMTemplateテーブルに格納されています。 ADTの場合、DDMTemplateテーブルのclassNameIdフィールドはADTによってレンダリングされるエンティティのものであり(例えばBlogs)、classPKフィールドは0である。
  • DDMサービスAPIは、プラグインやWebサービスからアクセスすることができます。
  • テンプレートAPI。ADTは、テーマ、レイアウト、ウェブコンテンツにも使用される既存のFreemarkerとVelocityテンプレートレンダリングAPIを再利用しています。

adt07.PNG

 

カスタムADTの作成

ADT APIを活用するには、ユーザーが従う必要があるいくつかのステップがあります。 これらのステップには、ポートレットを登録して ADT を使用し、権限を定義し、ユーザーに ADT 機能を公開することが含まれます。 以下の手順を使用してください。

  1. カスタムの *PortletDisplayTemplateHandler コンポーネントを作成して登録します。 Liferayは、ユーザーが拡張できる基本実装として、 BasePortletDisplayTemplateHandler を提供しています。 TemplateHandler インターフェイスのJavadocをチェックして、各テンプレートハンドラのメソッドについて学びましょう。
    Componentアノテーションは、プロパティjavax.portlet.nameをポートレットのポートレット名として設定することで、ハンドラを特定のポートレットに結びつけます。 ポートレットクラスにも同じプロパティがあるはずです。 例:
    	@Component(
    		immediate = true,
    		property = {
    			"javax.portlet.name="AssetCategoriesNavigationPortletKeysASSET_CATEGORIES_NAVIGATIONserviceTemplateHandlerclasspreEachofthemethodsinthisclasshaveasignificantroleindefiningandimplementingADTsforthecustomportletViewthelistbelowforadetailedexplanationforeachmethoddefinedspecificallyforADTsbrbrbgetClassNamebDefinesthetypeofentrytheportletisrenderingbrbgetNamebDeclaresthenameoftheADTtypetypicallythenameoftheportletbrbgetResourceNamebSpecifieswhichresourceisusingtheADTegaportletforpermissioncheckingThismethodmustreturntheportletsFullyQualifiedPortletIDFQPIbrbgetTemplateVariableGroupsbDefinesthevariablesexposedinthetemplateeditorliolAsanexamplecodePortletDisplayTemplateHandlercodeimplementationlookatWikiPortletDisplayTemplateHandlerjavaolliSincetheabilitytoaddADTsisnewtotheportletconfigurethepermissionssothatadministrativeuserscangrantpermissionstotherolesthatwillbeallowedtocreateandmanagedisplaytemplatesOnlegacyPortal62addtheactionkeycodeADD_PORTLET_DISPLAY_TEMPLATEcodetotheuportletsusrcmainresourcesresourceactionsdefaultxmlfilepreltxmlversion"1.0"?>
    	<!DOCTYPE resource-action-mapping PUBLIC "-//Liferay//DTD Resource Action Mapping 7.0.0//EN" "http://www.liferay.com/dtd/liferay-resource-action-mapping_7_0_0.dtd">
    		vresource-action-mapping>
    
        ...
    
        		< portlet-resource >
            		<portlet-name> yourportlet </portlet-name>
            		<permissions>
                		<supports>
                    		<action-key> ADD_PORTLET_DISPLAY_TEMPLATE </action-key>
                    		<action-key>ADD_TO_PAGE </action-key>
                    		<action-key>CONFIGURATION </action-keyv
                   	 	<action-key>VIEW </action-key>
                	</supports>
                	</permissions>
        		</portlet-resource>
    
        ...
    		</resource-action-mapping>
    	
  2. ポートレットが正式に ADT をサポートするようになった今、他のユーザーに ADT オプションを公開してください。 ポートレットの設定を制御するために使用する JSP ファイルに タグを含めるだけです。

    例えば、設定JSPファイルに を挿入すると便利かもしれません。
    	<aui:fieldset>
    		<div class="display-template">
            	<liferay-ddm:template-selector
                		classNameId="<%= YourEntity.class.getName() %>"
                		displayStyle="<%= displayStyle %>"
                		displayStyleGroupId="<%= displayStyleGroupId %>"
                		refreshURL="<%= PortalUtil.getCurrentURL(request) %>"
                		showEmptyOption="<%= true %>"
            	/>
    		</div>
    	</aui:fieldset>
    	
    このJSPでは、 タグは、ポートレットの設定メニューで使用する表示テンプレートのドロップダウンメニューを指定します。 変数 displayStyledisplayStyleGroupId は、ポートレットがこのタグlibとポートレットは BaseJSPSettingsConfigurationAction または DefaultConfigurationActionを使用します。 それ以外の場合は、これらのパラメータの値を取得し、設定クラスに手動で格納します。
    JSPの例として、Wikiアプリケーションの configuration.jspを参照してください。
  3. ユーザーは、選択した ADT でポートレットをレンダリングするために、ビューコードを拡張する必要があります。 これにより、ユーザーはビューのどの部分が ADT によってレンダリングされ、何がテンプレート・コンテキストで利用可能になるかを決めることができます。

    まず、ADTに必要なJava変数を初期化します。
    	<%
    	String displayStyle = GetterUtil.getString(portletPreferences.getValue("displayStyle", StringPool.BLANK));
    	long displayStyleGroupId = GetterUtil.getLong(portletPreferences.getValue("displayStyleGroupId", null), scopeGroupId);
    	%>
    	
    次に、ADTが設定されているかどうかをテストし、レンダリングされるエンティティを取得し、ADTを使用してレンダリングします。 タグ <liferay-ddm:template-renderer> はこのプロセスを支援します。 これは自動的に選択されたテンプレートを使用するか、テンプレートが選択されていない場合はそのボディをレンダリングします。
    以下に、これを実装する例のコードを示します。
    <liferay-ddm:template-renderer
        className="<%= YourEntity.class.getName() %>"
        contextObjects="<%= contextObjects %>"
        displayStyle="<%= displayStyle %>"
        displayStyleGroupId="<%= displayStyleGroupId %>"
        entries="<%= yourEntities %>"
    >
    
        <%-- The code that will be rendered by default when there is no
        template available should be inserted here. --%>
    
    </liferay-ddm:template-renderer>
    
    このステップでは、ユーザーは表示設定を扱う変数(displayStyledisplayStyleGroupId)を初期化し、以下に示す他のパラメータと共にタグに渡しました。
    className: エンティティのクラス名。
    contextObjects: Map<String, Object> に、ユーザーが望む任意のオブジェクトをテンプレートコンテキストに渡すことができます。
    エントリ: エンティティのリストを受け付けます (例: リスト<YourEntity>)。

    これを実装する例については、 configuration.jspを参照してください。

     

  4. このカスタムポートレットの動作を見るために、ユーザーは新しいカスタムテンプレートを作成し、Wikiポートレットを修正することができます。
    1. Liferay DXPのユーザーは、左側のメニュー サイト管理 > 設定 > アプリケーション表示テンプレートをクリックすることができます。
    2. クリック 追加 > ${your template}をクリックします。
    3. テンプレートエディタで、テンプレートに名前を付けます。
    4. エディタにFreeMarkerまたはVelocityのコードを入力します。 サンプルです。
      			<#if entries?has_content>
      				Quick List:
      				<ul>
      				<#list entries as curEntry>
      					<li>${curEntry.name} - ${curEntry.streetAddress}, ${curEntry.city}, ${curEntry.stateOrProvince}</li>
          				</#list>
          			</ul>
      			</#if>
      			
    5. カスタムポートレットに移動し、 オプション > 設定を選択します。 表示テンプレート ドロップダウンをクリックします。 カスタムADTを選択し、 をクリックしてを保存します。

テンプレートのエクスポートとインポート

ユーザーは、アプリケーションの表示テンプレートをあるサイトから別のサイトにLAR形式でエクスポートしたり、インポートしたりするオプションがあります。 これは非常に簡単にできます。 それにもかかわらず、LARは同じメジャーバージョンのLiferayでしかインポートできないことに注意してください(例:6.1のLARは6.2にインポートできず、6.2のLARはDXPにインポートできません)。

  1. エクスポートするアプリケーション表示テンプレートを選択します。
  2. 3つのドット(オプション)メニューをクリックします。
  3. エクスポートをクリックします。
  4. LARに名前を与えます。 Wiki ADT1 またはデフォルトの名前を使用します。
    adt08.PNG
  5. をクリックして、デフォルト設定を使用して をエクスポートします。
  6. LARをダウンロードしてください。
    adt09.PNG
  7. テンプレートをインポートするサイトに移動します。
  8. 3つのドット(オプション)メニューをクリックします。
  9. をクリックして、をインポートします。
  10. LARをドラッグ&ドロップするか、ファイルエクスプローラを使用します。
    adt10.PNG
  11. インポート画面が表示されるまで、初期設定のままで続行します。
  12. をクリックして、をインポートします。 テンプレートが正常にインポートされたことを確認します。 第2サイトにADTが登場しました。

よくある質問とトラブルシューティング

ADTの安全性は?

Javaセキュリティの面では、ユーザーはテンプレート・コンテキストからいくつかのクラスやパッケージを非表示にしたいかもしれません。 DXP では、コントロールパネル > 設定 > システム設定 > ファンデーション > FreeMarker/Velocity Engine に移動して、制限されたクラス、パッケージ、および変数を定義します。 特に、FreeMarker と Velocity Engine Restricted 変数に割り当てられたデフォルト値のリストに serviceLocator を追加したいと思うかもしれません。

どんなパフォーマンスチューニングが必要なのか?

ポートレットがレンダリングされると、アプリケーションの表示テンプレートを使用すると、追加の処理タスクが導入されます。 Liferayのベストプラクティスでは、カスタムテンプレートを可能な限り最小限にし、より複雑な操作に既存のAPIを使用することを提案しています。 利用者は、最終的な目標とサーバ負荷に対する期待値を評価する必要があります。 ユーザーは、独自のパフォーマンステストを実行する必要があります。 最後に、ユーザーは、Systems Settings > Foundation > Freemarker/Velocity Engine に移動し、Resource Modification チェックフィールドを設定することで、テンプレートキャッシュを調整することができます。

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています