PortletMVC4Spring構成ファイル
PortletMVC4SpringアプリケーションのWEB-INFフォルダには、次の記述子、Springコンテキスト、およびプロパティファイルがあります。
web.xml→ Webアプリケーション記述子portlet.xml→ ポートレットアプリケーション記述子liferay-portlet.xml→ Liferay固有のポートレット記述子liferay-display.xml→ Liferay固有のディスプレイ記述子spring-context/portlet-application-context.xml→ ポートレットアプリケーションコンテキストspring-context/portlet/[portlet]-context.xml→ ポートレットコンテキストliferay-plugin-package.properties→ パッケージ記述子
各ファイルの例が提供され、ポートレット固有のコンテンツがハイライト表示されています。
web.xml
サーブレットコンテナはweb.xmlを処理します。 このファイルは、ポートレットをレンダリングするサーブレットと、ポートレットアプリケーションのコンテキスト、サーブレット、フィルタ、リスナーなどを指定します。 web.xmlの例を次に示します。
<?xml version="1.0"?>
<web-app version="3.1" xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd">
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring-context/portlet-application-context.xml</param-value>
</context-param>
<servlet>
<servlet-name>ViewRendererServlet</servlet-name>
<servlet-class>com.liferay.portletmvc4spring.ViewRendererServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>ViewRendererServlet</servlet-name>
<url-pattern>/WEB-INF/servlet/view</url-pattern>
</servlet-mapping>
<filter>
<filter-name>delegatingFilterProxy</filter-name>
<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
</filter>
<filter-mapping>
<filter-name>delegatingFilterProxy</filter-name>
<url-pattern>/WEB-INF/servlet/view</url-pattern>
<dispatcher>FORWARD</dispatcher>
<dispatcher>INCLUDE</dispatcher>
</filter-mapping>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
</web-app>
<context-param/> 要素は、ポートレット アプリケーション コンテキストへのパスを指定します (後述)。
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring-context/portlet-application-context.xml</param-value>
</context-param>
<servlet/> および <servlet-mapping/> 要素は、サーブレットとそのビューの内部的な場所を設定します。
<servlet>
<servlet-name>ViewRendererServlet</servlet-name>
<servlet-class>com.liferay.portletmvc4spring.ViewRendererServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>ViewRendererServlet</servlet-name>
<url-pattern>/WEB-INF/servlet/view</url-pattern>
</servlet-mapping>
ViewRendererServlet。 ポートレットリクエストをサーブレットリクエストに変換し、Spring Web MVCインフラストラクチャと、JSP、Thymeleaf、Velocityなどのインフラストラクチャのレンダラーを使用してビューをレンダリングできるようにします。
フィルタとフィルタマッピングは転送するように設定されており、必要に応じてサーブレットビューが含まれます。
<filter>
<filter-name>delegatingFilterProxy</filter-name>
<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
</filter>
<filter-mapping>
<filter-name>delegatingFilterProxy</filter-name>
<url-pattern>/WEB-INF/servlet/view</url-pattern>
<dispatcher>FORWARD</dispatcher>
<dispatcher>INCLUDE</dispatcher>
</filter-mapping>
リスナーは、アプリケーションのコンテキストを処理するように構成されています。
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
Liferayのプロジェクトアーキタイプは、このすべての定型コードを生成します。
portlet.xml
portlet.xmlファイルは、ポートレットコンテナにポートレットアプリケーションを記述します。 以下に例を示します。
<?xml version="1.0"?>
<portlet-app xmlns="http://xmlns.jcp.org/xml/ns/portlet" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/portlet http://xmlns.jcp.org/xml/ns/portlet/portlet-app_3_0.xsd" version="3.0">
<portlet>
<portlet-name>portlet1</portlet-name>
<display-name>com.mycompany.my.form.jsp.portlet</display-name>
<portlet-class>com.liferay.portletmvc4spring.DispatcherPortlet</portlet-class>
<init-param>
<name>contextConfigLocation</name>
<value>/WEB-INF/spring-context/portlet/portlet1-context.xml</value>
</init-param>
<expiration-cache>0</expiration-cache>
<supports>
<mime-type>text/html</mime-type>
<portlet-mode>view</portlet-mode>
</supports>
<resource-bundle>content.portlet1</resource-bundle>
<portlet-info>
<title>com.mycompany.my.form.jsp.portlet</title>
<short-title>com.mycompany.my.form.jsp.portlet</short-title>
<keywords>com.mycompany.my.form.jsp.portlet</keywords>
</portlet-info>
<security-role-ref>
<role-name>administrator</role-name>
</security-role-ref>
<security-role-ref>
<role-name>guest</role-name>
</security-role-ref>
<security-role-ref>
<role-name>power-user</role-name>
</security-role-ref>
<security-role-ref>
<role-name>user</role-name>
</security-role-ref>
</portlet>
<filter>
<filter-name>SpringSecurityPortletFilter</filter-name>
<filter-class>com.liferay.portletmvc4spring.security.SpringSecurityPortletFilter</filter-class>
<lifecycle>ACTION_PHASE</lifecycle>
<lifecycle>RENDER_PHASE</lifecycle>
<lifecycle>RESOURCE_PHASE</lifecycle>
</filter>
<filter-mapping>
<filter-name>SpringSecurityPortletFilter</filter-name>
<portlet-name>portlet1</portlet-name>
</filter-mapping>
</portlet-app>
このアプリケーションには、portlet1という名前のポートレットが1つあります。
<portlet-name>portlet1</portlet-name>
<display-name>com.mycompany.my.form.jsp.portlet</display-name>
<portlet-class>com.liferay.portletmvc4spring.DispatcherPortlet</portlet-class>
<portlet-name/> は内部的なものであり、 <display-name/> はユーザーに表示されます。 <portlet-class/> はポートレットの Java クラスを指定します。
重要：すべてのPortletMVC4Springポートレットは、<portlet-class>com.liferay.portletmvc4spring.DispatcherPortlet</portlet-class>を指定する必要があります。
<supports/> 要素は、ポートレットテンプレートが使用するMIME 種別を宣言する必要があります。
<resource-bundle/> は、ポートレットのローカライズされた Java メッセージ プロパティへのパスを設定します。 たとえば、次の要素はcontent/portlet1.propertiesのプロパティを参照します。
<resource-bundle>content.portlet1</resource-bundle>
<portlet-info/> 要素には、ポートレットのタイトルと予約キーワードがリストされます。
<security-role-ref/> 要素は、ポートレットが担当するデフォルトのユーザー ロールを宣言します。
最後に、 <filter/> という名前の SpringSecurityPortletFilter は、クロスサイトリクエストフォージェリ (CSRF) を防ぎます。
<filter>
<filter-name>SpringSecurityPortletFilter</filter-name>
<filter-class>com.liferay.portletmvc4spring.security.SpringSecurityPortletFilter</filter-class>
<lifecycle>ACTION_PHASE</lifecycle>
<lifecycle>RENDER_PHASE</lifecycle>
<lifecycle>RESOURCE_PHASE</lifecycle>
</filter>
<filter-mapping>
<filter-name>SpringSecurityPortletFilter</filter-name>
<portlet-name>portlet1</portlet-name>
</filter-mapping>
ポートレット XSD は portlet.xmlを定義します。 次に、Liferay固有のポートレット記述子について説明します。
liferay-portlet.xml
liferay-portlet.xml ファイルは、より多くの開発者機能を提供するLiferay固有の設定を適用します。 以下に例を示します。
<?xml version="1.0"?>
<!DOCTYPE liferay-portlet-app PUBLIC "-//Liferay//DTD Portlet Application 7.4.0//EN" "http://www.liferay.com/dtd/liferay-portlet-app_7_4_0.dtd">
<liferay-portlet-app>
<portlet>
<portlet-name>portlet1</portlet-name>
<icon>/resources/images/icon.png</icon>
<requires-namespaced-parameters>false</requires-namespaced-parameters>
</portlet>
<role-mapper>
<role-name>administrator</role-name>
<role-link>Administrator</role-link>
</role-mapper>
<role-mapper>
<role-name>guest</role-name>
<role-link>Guest</role-link>
</role-mapper>
<role-mapper>
<role-name>power-user</role-name>
<role-link>Power User</role-link>
</role-mapper>
<role-mapper>
<role-name>user</role-name>
<role-link>User</role-link>
</role-mapper>
</liferay-portlet-app>
この<portlet/>要素は、アイコンをポートレットに関連付け、名前空間化されたパラメーターが不要であることを示します。
<role-mapper/> 要素は、ポートレットをデフォルトの Liferay DXP ユーザーロールに関連付けます。
liferay-portlet-app-[version].dtd ファイル は、 liferay-portlet.xml ファイルを定義します。
liferay-display.xml
liferay-display.xmlは、表示特性をポートレットに適用します。 たとえば、次の記述子は、ポートレットをLiferay DXPの［ウィジェットの追加］メニューのウィジェットカテゴリに関連付けます。
<?xml version="1.0"?>
<!DOCTYPE display PUBLIC "-//Liferay//DTD Display 7.4.0//EN" "http://www.liferay.com/dtd/liferay-display_7_4_0.dtd">
<display>
<category name="category.sample">
<portlet id="portlet1" />
</category>
</display>
詳細については、 liferay-display-[version].dtd ファイル を参照してください。
次に、アプリケーションコンテキストを見てみましょう。
ポートレットアプリケーションコンテキスト
このコンテキストは、アプリケーションのすべてのポートレットに適用されます。 ここで、ビューリゾルバー、リソースバンドル、セキュリティBean、プロキシなどを指定します。 以下に例を示します。
<?xml version="1.0"?>
<beans
xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
<context:annotation-config />
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="viewResolver">
<property name="contentType" value="text/html;charset=UTF-8" />
<property name="prefix" value="/WEB-INF/views/" />
<property name="suffix" value=".jspx" />
<property name="viewClass" value="com.liferay.portletmvc4spring.PortletJstlView" />
</bean>
<bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource">
<property name="basenames">
<list>
<value>content.portlet1</value>
</list>
</property>
<property name="defaultEncoding" value="UTF-8" />
</bean>
<bean id="springSecurityPortletConfigurer" class="com.liferay.portletmvc4spring.security.SpringSecurityPortletConfigurer" />
<bean id="delegatingFilterProxy" class="org.springframework.web.filter.DelegatingFilterProxy">
<property name="targetBeanName" value="springSecurityFilterChain" />
</bean>
</beans>
上記のビューリゾルバーBeanは、JSPXビューテンプレートを処理します。 たとえば、Thymeleafビューテンプレートを解決するには、次のBeanを指定できます。
<bean class="org.thymeleaf.templateresolver.ServletContextTemplateResolver" id="templateResolver">
<property name="prefix" value="/WEB-INF/views/"/>
<property name="suffix" value=".html"/>
<property name="templateMode" value="HTML"/>
</bean>
<bean class="org.thymeleaf.spring5.SpringTemplateEngine" id="templateEngine">
<property name="templateResolver" ref="templateResolver"></property>
<property name="enableSpringELCompiler" value="true" />
</bean>
<bean class="org.thymeleaf.spring5.view.ThymeleafViewResolver" id="viewResolver">
<property name="templateEngine" ref="templateEngine"/>
<property name="order" value="1"/>
</bean>
コンテキストのspringSecurityPortletConfigurer Beanは、Spring Securityの使用を容易にします。
<bean id="springSecurityPortletConfigurer"
class="com.liferay.portletmvc4spring.security.SpringSecurityPortletConfigurer" />
アプリケーションの各ポートレットのコンテキストを指定することもできます。
ポートレットコンテキスト
ポートレットに固有のBeanは、ポートレットのコンテキストに入ります。 アノテーションはPortletMVC4Springポートレットを開発する最も簡単な方法であるため、ポートレットコンテキストでMVCアノテーションスキャンを指定する必要があります。
<?xml version="1.0"?>
<beans
xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<context:component-scan base-package="portlet1**"/>
<mvc:annotation-driven/>
</beans>
ポートレットコンテキストの命名規則は、[portlet-name]-context.xmlです。 ポートレットを独自のコンテキストに関連付けるには、アプリケーションのportlet.xmlファイルを編集し、<portlet/>要素をポートレットのコンテキストにマップする<init-param/>要素を追加します。
<init-param>
<name>contextConfigLocation</name>
<value>/WEB-INF/spring-context/portlet/portlet1-context.xml</value>
</init-param>
最後にアプリケーションパッケージについて説明します。
liferay-plugin-package.properties
このファイルは、アプリケーションの名前、バージョン、Javaパッケージのインポート/エクスポート、およびOSGiメタデータを指定します。 パッケージプロパティファイルの例を次に示します。
author=N/A
change-log=
licenses=N/A
liferay-versions=7.2.0+
long-description=
module-group-id=com.mycompany
module-incremental-version=1
name=com.mycompany.my.form.jsp.portlet
page-url=
short-description=my portlet short description
tags=myTag
Bundle-Version: 1.0.0
Import-Package: com.liferay.portal.webserver,com.liferay.portal.kernel.servlet.filters.invoker
この OSGi メタデータ ヘッダーを使用して、 必要な Java パッケージをインポートします。
Import-Package: com.liferay.portal.webserver,\
com.liferay.portal.kernel.servlet.filters.invoker
ポートレット アプリケーションの WAR ファイルをデプロイすると、 WAB ジェネレーター によって、指定された OSGi メタデータが、Liferay のランタイム フレームワークにデプロイされる結果の Web アプリケーション バンドル (WAB) に追加されます。
liferay-plugin-package-[version].dtd ファイル は、 liferay-plugin-package.properties ファイルについて説明しています。