Liferay 6.1开发学习（二）：创建一个Portlet工程

关注

转载最新推荐文章于 2025-09-28 13:18:34 发布 1.6k 阅读 AI 写同款· GEO 优化 ›

Liferay7开发系列（四）Portlet Liferay门户中的Web应用程序称为portlet。与许多Web应用程序一样，portlet处理请求并生成响应。在响应中，portlet返回内容（例如HTML、XHTML）以在浏览器中显示。portlet和其他Web应用程序之间的一个关键区别是portlet运行在Web页面的一部分中。在编写portlet应用程序时，您只需关注该应用程序：页面的其余部分（导航、顶部横幅和界面的任何其他全局... 阅读详情

使用Liferay的SDK创建一个简单的Portlet，此Portlet不包括业务逻辑、不包括数据库，只有简单的页面展现，用以说明Portlet的开发过程。

一、创建Portlet工程

1、打开Liferay IDE，File-->New-->Liferay Project

2、为Portlet工程取名为Study，点击完成。或者点击下一步，默认选择Liferay MVC。

补充说明：

Portlet:这个是一般做Liferay开发选择的项目，一般说Liferay插件工程，通常都是指的Portlet工程。他的结构和内容和普通的WEB工程区别不大。

Hook:Liferay的Hook是什么东西呢？这个单词中文可以翻译成钩子。是用于重写或覆盖Liferay的一些默认方法或页面。为开发提供了一种在不直修改Liferay核心源码的情况下修改Liferay核心功能的方法。

Ext:扩展工程的开发方法是Liferay早期版本推荐的开发方法，在6.x版本之后对ext开发模式逐渐不再推荐，主要使用Portlet的开发方法。扩展开发可以继承Liferay的Portal的大部分接口方法，而Portlet里面可以使用的接口方法均是Services包里面暴露的API。但是和Liferay的核心工程耦合太大，当Liferay的版本升级时对Ext工程的影响太大，基本需要重新修改。所以一般不推荐使用Ext模式。

Layout:布局模板，Liferay的布局是可以定制的，如一个页面中是两栏式还是三栏式，每个栏里面又有几行等等，可以使用此模式进行快速开发。

Theme:主题包。Liferay IDE提供的可以帮助开发人员、设计人员快速开发Liferay主题包的功能，通过此模式提供的向导工具等，为主题包的开发大大的提供了便利。

Portlet部署

Liferay的开发大量依赖Ant（也可以使用maven）,在Liferay的开过程中，编译、代码生成、打包、部署等都是基于Ant完成的。

1、Liferay 的IDE在Liferay的portlet开发模式下，ant面板默认是可见的，如果找不到可以通过Window-->Show View-->Ant(如果没有可以在other里面找到)

2、在ant页板里面，点击Add-buildfiles将Build.xml文件添加进来。

3、点击Study-portlet前面的小三角，在出现的下拉菜单里面，双击deploy，等待Liferay完成部署操作。

如果在此时出现如下错误：

Task cannot continue because ECJ is not installed.

ECJ was automatically installed. Please rerun your task.

原因是ECJ包没有找到，ECJ是什么？ECJ, the Eclipse Compiler for Java, is an open source incremental compiler used by the Eclipse JDT. It is an option for Liferay builds and is in many cases faster than Javac or Jikes. The jar for ECJ is included in Liferay release 4.4.0 and later.http://www.liferay.com/community/wiki/-/wiki/Main/ECJ这是官方解释。大概意思是ECJ是一个编译优化包，可以提升比Javac和JIKES更好的编译速度。要想使编译通过，有两个两个方法：

方法一：禁用ECJ。在Liferay的SDK下面找到build.Administrator.properties，此处中间的Administrator名称不一定是这样的，具体体系名称是根据当前系统的用户名生成的。在里面添加如下内容

javac.compiler=modern
#javac.compiler=org.eclipse.jdt.core.JDTCompilerAdapter

方法二：将ECJ的包添加到ant的路径里面。ecj.jar包可以在Liferay的工程的源码包\lib\development下面找到。将此包添加到ant的路径里面。Windows-->preferences-->Ant-->Runtime，在右边的Classpath-->Ant Home Entries(Default) -->Add External JARs，将ecj包添加进来。

4、启动Tomcat。此portlet工程会自动部署。

5、打开http://localhost:8080/，登录系统。点击左上角的添加-->更多-->示例，在这里面可以看到我们刚建立的study portlet，点击添加，可以将此portlet添加到页面上。

Portlet工程结构

一个Portlet工程的大概结构如下：

1、src:这里存储Java相关文件包，后面会看到还有一个services包。

2、web.xml:此web.xml和普通的web工程的web.xml文件一样。

3、build.xml，此文件为ant的构建文件，一般不需要修改继承自SDK。

4、Liferay-plugin-package.properties，此文件为包工程的元数据信息文件，一般开发不需要关注。

5、portlet.xml:portlet定义描述文件，这个文件是标准的portlet 2.0(JSR 268)规范的文件。在这里定义的信息为portlet的名称、初始化参数、模式类型、portlet的相关信息、权限等。在此文件里面我们可以看到view-template对应的的是/view.jsp，当我们在Liferay里面添加此portlet后，看到的页面内容就是view.jsp里面的内容。下面的security-rol-ref定义的是哪些角色拥有此portlet的权限。

6、Liferay-portlet.xml：此文件是liferay扩展的portlet的内容，portlet.xml文件里面是标准的Portlet内容，所有的Portal容器的portlet.xml文件描述、结构都是一样的。但liferay基于自身平台的需求，又添加了一个Liferay-portlet.xml来扩展portlet的信息。在这里可以看到角色映射，以及Liferay的一些个性化信息，后面有需要的时候详细说明。

7、liferay-display.xml:在上一个步骤里面我们在添加portlet的时候，看到study这个portlet是位于示例这个目录下面的，此文件就是定义相关的portlet是放置在哪个目录下面显示的。

说明：

在Liferay里面，portlet的名称一般不要重复，portlet.xml，liferay-portlet.xml，lifray-display.xml这三个文件之间的关联就是通过portlet 名称做标识进行关联。

转自：http://www.huqiwen.com/2012/09/01/liferay-6-1-development-study-2-create-portlet-project/

收录于