LIFERAY-HOOK 开发指南

LIFERAY HOOK 开发步骤备注：适用版本号完全相同的IDE，SDK，否则会报错。

一、Liferay提供hook的目的是减少二次开发的代码与liferay核心工程的耦合，通过hook我们主要可以主要做以下六件事情：1、覆盖事件处理程序：如程序启动事件（application.startup.events）、登录注销事件（login.events.pre、login.events.post）、session的创建销毁事件等。

2、语言包：比如对liferay的某些翻译不满意，需要自定义，则可以使用hook 覆盖liferay的语言包。

3、liferay工程的portlet JSP内容：比如想在顶部的top_bar里面添加内容、想修改liferay的用户编辑界面、想修改用户登录界面等等。

4、覆盖portal.properties里面的属性配置：可以在hook工程里面覆盖一些liferay的portal.properties 里面属性配置，但是请注意，在hook工程里面只能覆盖部分的属性设置。

不能覆盖的如果需要可以在root/WEB-INF/classes 里面添加 portal-ext.properties，这个同可以覆盖所有的。

5、覆盖liferay的services里面的方法，如UserLocalService、GroupLocalService、OrganizationLocalService等等。

6、Liferay的Model监听程序，比如user、group、blog等的创建、更新、查看；插件的部署；集群的消息传递等等监听程序。

二、创建一个HOOK 工程1、在liferay IDE中，New Liferay Project-->选择hook-->输入project Name，点击完成，即可创建一个hook工程。

2、在IDE的工具条中，选择New Liferay hook，选择我们要创建的hook类型，如下图：三、重写或者覆盖JSP 页面1、在liferay IDE中，New Liferay Project-->选择hook-->输入project Name，点击完成，即可创建一个hook工程。

2、在IDE的工具条中，选择New Liferay hook，选择我们要创建的hook类型，如下图：custom JSp:为自定义的JSP文件portal properties：覆盖portal属性Services:这个可以可以做两件事情一是覆盖事件处理程序；二是覆盖service 类Lanuage properties:这个覆盖或者新增国际化的语言文件。

3、点击下一步，进入Create Custom JSPs 页面，在这个页面，可以通过add from liferay按钮来选择需要重写的JSP 文件如图这里选择terms_of_use.jsp 文件，该文件是用户协议界面可以在该文件中做想要的内容修改4、修改完成后重新发布一下，使用一个新创建的账号登陆，在用户协议界面就可以看到刚刚修改的效果了5、此时可以在源文件liferay-portal-[version]/tomcat-[tomcat-version]/webapps/ROOT/html/portal 目录下看到2 个文件，一个是terms_of_use.jsp ，另一个是terms_of_use.properties.jsp 文件，后者是修改之前的文件，前者是修改之后的文件6、如果想要修改后的文件包含修改之前的文件，可以在terms_of_use.jsp中添加<liferay-util:buffer var="html"><liferay-util:include page="/html/portlet/blogs/search.portal.jsp" />//此处的路径为源文件的路径</liferay-util:buffer><!--以下是新添加的内容--><%html = StringUtil.add(html,"Didn't find what you were looking for? Refine your search and " +"try again!","\n");%><%= html %>即可。

四、创建国际化文档1、在docroot/WEB-INF 目录下的liferay-hook.xml 中添加如下内容<language-properties>content/Language_zh_CN.properties</language-properties>注意放置的位置，如果不对的话，有时会报错，具体可以参看下面目录的文档liferay-portal-6.1.1-ce-ga2\tomcat-7.0.27\webapps\ROOT\dtd\liferay-hook_6_1_0.dtd2、“content/Language_zh_CN.properties”是国际化文件的目录，放在src 根目录下，如果没有，可以自己创建只有知道需要变换的参数值（value）才可以修改。

3、IDE 提供的图形界面方法也是这样实现的。

五、Application Adapters 定制站点1、liferay-hook.xml中添加<hook><custom-jsp-dir>/META-INF/custom_jsps</custom-jsp-dir><custom-jsp-global>false</custom-jsp-global></hook>当部署hook 时，liferay 会自动安装Application adapter 到实例当中去2、创建一个新的view.jsp 目录为：/META-INF/custom_jsps/html/portlet/navigationJSP 内容为：<%@ taglib uri="/tld/util" prefix="liferay-util" %><liferay-util:includepage="/html/portlet/navigation/view.jsp"useCustomPage="false"/><!--useCustomPage="false" 的作用是使得当前JSP 包含被覆盖的original view.jsp 文档--> <p>This was modified by the Example Application Adapter.</p>当前文件同样可以在ROOT 文件夹中找到。

3、发布应用后登陆，在管理-->站点设置中的Application Adapter 下拉列表中可以找到刚刚创建的应用，名字是创建的HOOK 的工程名。

4、返回到导航的portlet 即可以看见view.jsp 中的文本。

如果没有导航，可以自行添加步骤：添加---->导航六：定制动作1、在目录example-hook/docroot/WEB-INF/src/com/liferay/sample/hook下创建一个LoginAction.java 文件package com.liferay.sample.hook;import com.liferay.portal.kernel.events.Action;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;public class LoginAction extends Action {public void run(HttpServletRequest req, HttpServletResponse res) {System.out.println("## My custom login action");}}2、src 根目录下创建一个portal.properties 配置文件添加 login.events.pre=com.liferay.sample.hook.LoginAction3、在liferay-hook.xml 文件中添加上面的配置文件的路径信息<portal-properties>portal.properties</portal-properties>4、重新发布，并重新登录，即可在后台看见字符串“## My custom login action”5、2,3 步骤也可以直接在 liferay-hook.xml 中配置<event><event-class>com.liferay.sample.hook.LoginAction</event-class> <event-type>login.events.pre</event-type></event>七、portal.properties该配置文件中有些属性的值是可以有多个的，例如：login.events.pre但是有些属性的值是唯一的，例如：e.required该配置文件中具体有哪些属性可以定义，可以参看文件liferay-portal-6.1.1-ce-ga2\tomcat-7.0.27\webapps\ROOT\dtd\liferay-hook_6_1_0.dtd八、Struts Actions使用效果类似servlet，Struts Actions是接口，分为2个：com.liferay.portal.kernel.struts.StrutsActioncom.liferay.portal.kernel.struts.StrutsPortletAction该StrutsAction接口用于portal正规的Struts动作，如/ C/portal/ update_email_address。

该StrutsPortletAction接口用于类似Struts动作，但是用于portlet。

系统自带的struts action 在liferay-portal-6.1.1-ce-ga2\tomcat-7.0.27\webapps\ROOT\dtd\struts-config.dtd的文件中有定义1、在struts-config.xml 中可以看到<action path="/login/login"type="com.liferay.portlet.login.action.LoginAction"><forwardname="portlet.login.login"path="portlet.login.login"/><forwardname="portlet.login.login_redirect"path="portlet.login.login_redirect"/></action>2、在liferay-hook.xml中添加如下代码，放在</hook> 之前<struts-action><!--自定义的action，当发生“/portal/sample”请求时触发--><struts-action-path>/portal/sample</struts-action-path><struts-action-impl>com.liferay.sample.hook.action.ExampleStrutsAction</struts-action-impl></struts-action><struts-action><!--重写的action，当发生“/login/login”请求时触发--><struts-action-path>/login/login</struts-action-path><struts-action-impl>com.liferay.sample.hook.action.ExampleStrutsPortletAction</struts-action-impl></struts-action>3、根目录下创建包com.liferay.sample.hook.action创建ExampleStrutsPortletAction类内容如下：package com.liferay.sample.hook.action;import com.liferay.portal.kernel.struts.BaseStrutsPortletAction;import com.liferay.portal.kernel.struts.StrutsPortletAction;import com.liferay.portal.theme.ThemeDisplay;import com.liferay.portal.kernel.util.WebKeys;import javax.portlet.ActionRequest;import javax.portlet.ActionResponse;import javax.portlet.PortletConfig;import javax.portlet.RenderRequest;import javax.portlet.RenderResponse;import javax.portlet.ResourceRequest;import javax.portlet.ResourceResponse;public class ExampleStrutsPortletAction extends BaseStrutsPortletAction {public void processAction(StrutsPortletAction originalStrutsPortletAction,PortletConfig portletConfig, ActionRequest actionRequest,ActionResponse actionResponse)throws Exception {ThemeDisplay themeDisplay =(ThemeDisplay)actionRequest.getAttribute(WebKeys.THEME_DISPLAY);Long currentuser = themeDisplay.getUserId();if (currentuser != null) {System.out.println("Wrapped /login/ action2");}originalStrutsPortletAction.processAction(originalStrutsPortletAction, portletConfig, actionRequest,actionResponse);}public String render(StrutsPortletAction originalStrutsPortletAction,PortletConfig portletConfig, RenderRequest renderRequest,RenderResponse renderResponse)throws Exception {System.out.println("Wrapped /login/ action");return originalStrutsPortletAction.render(null, portletConfig, renderRequest, renderResponse);}public void serveResource(StrutsPortletAction originalStrutsPortletAction,PortletConfig portletConfig, ResourceRequest resourceRequest,ResourceResponse resourceResponse)throws Exception {originalStrutsPortletAction.serveResource(originalStrutsPortletAction, portletConfig, resourceRequest,resourceResponse);}}在创建ExampleStrutsAction类package com.liferay.sample.hook.action;import com.liferay.portal.kernel.struts.BaseStrutsAction;import com.liferay.portal.kernel.util.ParamUtil;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;public class ExampleStrutsAction extends BaseStrutsAction {public String execute(HttpServletRequest request, HttpServletResponse response)throws Exception {String name = ParamUtil.get(request, "name", "World");request.setAttribute("name", name);return "/portal/sample.jsp";}}4、在/custom_jsps/html/portal目录下创建sample.jsp 页面，添加代码<%String name = (String)request.getAttribute("name");%>Hello <%= name %>!5、在src 根目录下创建portal.properties，如果没有的话添加属性参数Auth.public.paths=/portal/sample6、重启服务器，就可以在后台看见Wrapped /login/ action登陆后：Wrapped /login/ action2Wrapped /login/ action7、输入地址：http://localhost:8080/c/portal/sample显示如下内容，则自定义的action 及相应的JSP 发布成功（此处注意地址，如果404报错，则说明发布失败）九、Services这个demo是对登陆事件响应的一个重写。