Liferay7 BPM门户开发之33: Portlet之间通信的3种方式（sessionIPC Render ParameterIPC EventCookies）

Posted 2020-08-19 昕友软件开发

 

文章介绍了5种方式，4种是比较常用的：

• Portlet session
• IPC Public Render Parameters
• IPC Event
• Cookies

参考地址：

https://web.liferay.com/zh/community/wiki/-/wiki/Main/Portlet%E9%97%B4%E7%9A%84%E9%80%9A%E4%BF%A1

 

方式１：Session

portlet session作用域：

• APPLICATION_SCOPE 　：全局

• PORTLET_SCOPE：单一实例范围，默认作用域

步骤１：为了在不同的Portlet之间传递信息，需要把默认的作用域范围修改

liferay-portlet.xml　设置不支持私有会话

<portlet>
        <private-session-attributes>false</private-session-attributes>
</portlet>

 

步骤2：设置Seesion 

PortletSession session = renderRequest.getPortletSession();
session.setAttribute("sessionName1", some-value ,PortletSession.APPLICATION_SCOPE);

 

步骤3：在Portlet2中获取 Seesion中的值 

    PortletSession ps = renderRequest.getPortletSession();
    String tabNames = (String)ps.getAttribute("sessionName1",PortletSession.APPLICATION_SCOPE);

这种方法最为简单．

 

方式2:IPC Render Parameter

在portal-ext.properties里添加下面的属性，我们可以使不同页面中的Portlet互相分享其 Render的状态：

    portlet.public.render.parameter.distribution=ALL_PORTLETS

步骤1：在“Sender-Portlet”中添加下面的属性 

    <portlet-app>
        <portlet>
            <supported-public-render-parameter>id1</supported-public-render-parameter>
        </portlet>
         
        <public-render-parameter>
            <identifier>id1</identifier>
            <qname xmlns:x="http://abc.com/userId">x:param1</qname>
        </public-render-parameter>
    </portlet-app>

Note:We can declare a list of public paramters for a portlet application.

注意：我们可以为Portlet声明一个 Public Render Parameter 列表。

步骤2 

我们可以在processAction方法中设置 Public Render Parameter 。作为key，我们使用的是定义好了的 Public Render Parameter 标识符：

    public void processAction(ActionRequest  request, ActionResponse response) throws IOException, PortletException  {
        ........
        response.setRenderParameter("id1", “someIdValue”); ........
    }

步骤3：“Receiver Portlet”的“portlet.xml”文件 

在porltet定义中指定哪个 Public Render Parameter 允许被分享

    <portlet-app>
        <portlet>
            <portlet-name >PortletB< /portlet-name>
            <supported-public-render-parameter>id1</supported-public-render-parameter>
        </portlet >
        <public-render-parameter>
            <identifier>id1</identifier>
            <qname xmlns:x="http://abc.com/userId">x:param1</qname>
        </public-render-parameter>
    </portlet-app>

步骤4 

Portlet可以通过使用 request.getPublicParameterMap() 方法读取 Public Render Parameter 。

注意：因为 Public Render Parameter 被合并到全局 parameter中了，所以我们也可以用下面的方法去读取：

    request.getParameter(“id1”);

步骤5 

我们也可以使用下面的方法去移除一个 Public Render Parameter ：

    response.removePublicRenderParameter("id1")

例子：
ＪＳＰ：

view.jsp

<%@ taglib uri="http://java.sun.com/portlet_2_0" prefix="portlet" %>
<%@ taglib uri="http://liferay.com/tld/aui" prefix="aui" %>
<portlet:defineObjects />
 
<portlet:actionURL var="actionURL" name="setRenderParameter"/>
 
<aui:form action="<%=actionURL.toString() %>" method="post">
<aui:input name="name" label="Set Your Name In Public"/>
<aui:button-row>
<aui:button type="submit" value="Set"/>
</aui:button-row>
</aui:form>

接收的ＪＳＰ
<%@page import="com.liferay.portal.kernel.util.ParamUtil"%>
<%@ taglib uri="http://java.sun.com/portlet_2_0" prefix="portlet" %>
 
<portlet:defineObjects />
 
<!-- In JSP we can directly read public render parameter -->
<!-- Also public render parameter is available in any other life cycle methods -->
 
<%
String name = ParamUtil.getString(request, "myname");
%>
 
<H3>Public parameter name is ‘myname‘</H3>
<H3>Its value is </H3>
<b><%=name %></b>

 

方式3:IPC Event

 略．

可参考地址：

https://web.liferay.com/zh/community/wiki/-/wiki/Main/Portlet%E9%97%B4%E7%9A%84%E9%80%9A%E4%BF%A1

 

方式４:Cookies

这种方式不推荐．

有一些局限性：

1. 不允许超过4KB的数据

2.每个服务器限制了最多只能有20个Cookies。