Terry.Li-彬

??<!-- PK fields -->

??<column name="entryId" type="String" primary="true" />

??<!-- Audit fields -->

??<column name="companyId" type="String" />
??<column name="userId" type="String" />
??<column name="userName" type="String" />
??<column name="createDate" type="Date" />
??<column name="modifiedDate" type="Date" />

??<!-- Other fields -->

??<column name="name" type="String" />

??<!-- Order -->

??<order by="asc">
???<order-column name="name" case-sensitive="false" />
??</order>

??<!-- Finder methods -->

??<finder name="CompanyId" return-type="Collection">
???<finder-column name="companyId" />
??</finder>
??<finder name="UserId" return-type="Collection">
???<finder-column name="userId" />
??</finder>

??<!-- References -->

??<reference package-path="com.liferay.portal" entity="User" />
?</entity>
?<exceptions>
??<exception>EntryName</exception>
?</exceptions>
</service-builder>
???
<!--package-path 是指我們即將建立 portlet 的上級目錄 -->
<!-- portlet name 就是我們新建文件夾名稱 myuser ， short-name 沒有作研究不太清楚使用途徑 -->
<!--entity name 是和我們即將建立的和數據庫表 a_user 一一對應實體的類名 , 可以和數據庫表名不同，
但為方便起見一般和表名保持一致 -->
(2) 修改 ant 文件，增加 ant 任務
建好 service.xml 文件后，我們在 ext-ejb 目錄下打開 build-perent.xml 在
<target name="build-service">
…….
</target>
下面添加任務
<target name="build-service-portlet-usertest">
?<antcall target="build-service">
?<param name="service.file"
?value="src/com/ext/portlet/myuser/service.xml" />
?</antcall>
</target>
然后在 myexlipse 的 ant 視圖里面打開 ext-ejb 目錄下的 build.xml 執行 build-service-portlet-usertest 任務。
我們發現在 ext-ejb/src/com/ext/portlet/myuser 下面多了幾個目錄和文件。這是都是系統自動產生的
ebernate 的實體類和持久化類。如果我們再細心些也可發現在 ext-ejb\classes\META-INF 目錄下配置文件
都多些內容。系統已經自動將對應的實體類、持久化類、工具類等配置為相應的 javabean 、 ejb 、 webservice 等
。無疑節省了很多時間，而且減少我們人工配置的錯誤。

業務實現編碼
? 現在我們要實現一個查詢功能，將數據庫中表名 a_user 中所有記錄的 username 查詢出來，并顯示在前臺。
? 打開 myuser/service/Persistence 下 a_userPersistence.java 文件，建立一個方法名為 findAllUsername ：

public List findAllUsername () throws SystemException {
??????? Session session = null;
??????? try {
??????????? session = openSession();
??????????? StringBuffer query = new StringBuffer();
??????????? query.append("FROM com.ext.portlet.myuser.model.a_user ");
??????????? Query q = session.createQuery(query.toString());
??????????? q.setCacheable(true);
??????????? return q.list();
??????? } catch (HibernateException he) {
??????????? throw new SystemException(he);
??????? } finally {
??????????? closeSession(session);
??????? }
}

返回表 a_user 所有記錄，并以 list 方式存儲。題外話，一般系統已經自動產生了主要字段的查詢方法，
我們可以直接拿來用或者稍作改動都可以使用。
按一般慣例， a_userPersistence 一般是不暴露給外面類，我們都是通過它的一個持久化輔助類來調用。
打開 a_userUtil.java, 同樣在里面增加方法 findAllUsername
?public static java.util.List findAllUsername ()
??????? throws com.liferay.portal.SystemException {
??????? return getPersistence().findAllUsername ();
}
然后我們在 spring 的 service 層同樣增加一個方法。 Service 層的接口 a_userLocalService 里面增加一個函數
public List getAllUsers() throws SystemException;
在 Service 層接口 a_userLocalService 的實現 a_userLocalServiceImpl.java 增加對應方法，并調用持久層輔
助類 userUtil 方法 findAllUsername
??public List getAllUsers() throws SystemException {
???return a_userUtil. findAllUsername ();
?}
同樣 spring 的 service 層 也是通過輔助類作為對外唯一入口，所以在 a_userLocalServiceUtil 里面增加一
個方法 findAllUsername 作為 service 層的方法 findAllUsername 的入口。
public static List getAllUsers() throws SystemException{
??
??try{
???a_userLocalService service = a_userLocalServiceFactory.getService();
???return service.getAllUsers();
??}catch (SystemException se) {
???throw se;
??}
??catch (Exception e) {
???throw new com.liferay.portal.SystemException(e);
??}
??
?}
需要注意的是 service 層接口對應具體實現是由工廠類指定。他們捆綁關系可以查看 spring 配置文件信息。
在執行 ant 的 build-service-portlet-usertest 任務已經完成了。
在 myuser/action 目錄下建立一個 ViewUserAction.java 文件，完成響應客戶端請求。
public class ViewUsersAction extends PortletAction {

?public ActionForward render(
???ActionMapping mapping, ActionForm form, PortletConfig config,
???RenderRequest req, RenderResponse res)
??throws Exception {

??if (req.getWindowState().equals(WindowState.NORMAL)) {
???return mapping.findForward("portlet.ext.myuser.view");
??}
??else {
???
???List users = a_userLocalServiceUtil.getAllUsers();
???List usernames = new ArrayList();
???for (int i=0;i<users.size();i++){
????usernames.add( ((a_user) users.get(i)).getUsername());
???}
???req.setAttribute("users", usernames);

?return mapping.findForward("portlet.ext.myuser.view_users");
??}
?}
}
里面大概功能是如果 porlet 的窗口狀態時普通，則定向到一個叫 portlet.ext.myuser.view 的目標上。
如果窗口狀態是最大化，那么就從調用 userLocalServiceUtil, 從數據庫里面獲取所有人員信息。
Portlet 的生成
建立自己的 portlet 。在 myuser 下面新建文件 UsersPortlet.java
public class UsersPortlet extends StrutsPortlet {
?public void doView(RenderRequest req, RenderResponse res)
??throws IOException, PortletException {

??PortletPreferences prefs = req.getPreferences();

??System.out.println(prefs.getValue("user", ""));

??super.doView(req, res);
?}
}
該 portlet 重載了 doview 方法。如果自己 portlet 對 view 和 edit 有自己特性，那么只要重載 doview 和 doedit 就可以了。
現在 portlet 的內容是空的，我們用 jsp 頁面來展示用戶名稱方式來填充 portlet 里面內容。
在 ext-web/docroot/html/portlet/ext 目錄下建立目錄 myuser, 并在 myuser 目錄下建立 init.jsp 文件

<%@ include file="/html/common/init.jsp" %>

<portlet:defineObjects />

<% PortletPreferences prefs = renderRequest.getPreferences();

建立 view.jsp 文件：

<%@ include file="/html/portlet/ext/myuser/init.jsp" %>
<a href="<portlet:renderURL
windowState="<%= WindowState.MAXIMIZED.toString() %>" />">
MyUser
?<%= prefs.getValue("user", "") %>
</a>
該 jsp 內容是顯示默認的初始用戶名。具體值從初始化配置參數里獲取。

建立 view_users.jsp
<%@ include file="/html/portlet/ext/myuser/init.jsp" %>
<% List reports = (List)request.getAttribute("users");%>

<%
for (int i = 0; i < reports.size(); i++) {
?String reportName = (String)reports.get(i);
%>

?<%= reportName %><br>

<%
}
%>
該 jsp 頁面目的是展示所有從數據庫里面取出來的用戶名。

Ok ，完成以上工作后，我們整個 portlet 編碼工作已經宣告結束，接下來的是配置 portlet
參數工作。
Portlet 的配置

是 portlet 配置信息文件存放 Ext-web/web-inf 目錄下，在 port-ext.xml 文件里面添加

<portlet>
??<portlet-name>EXT_users</portlet-name>
??<display-name>myusers</display-name>
??<portlet-class>com.ext.portlet.myuser.UsersPortlet</portlet-class>
??<init-param>
???<name>view-action</name>
???<value>/ext/myuser/view_users</value>
??</init-param>
??<expiration-cache>0</expiration-cache>
??<supports>
???<mime-type>text/html</mime-type>
??</supports>
?<resource-bundle>com.liferay.portlet.StrutsResourceBundle</resource-bundle>
??<portlet-preferences>
???<preference>
????<name>user</name>
????<value>jack</value>
???</preference>
??</portlet-preferences>
??<security-role-ref>
???<role-name>power-user</role-name>
??</security-role-ref>
??<security-role-ref>
???<role-name>user</role-name>
??</security-role-ref>
?</portlet>

<portlet-name> 必須唯一，不得已有 portlet 名字沖突。 <display-name> 也必須唯一。
<portlet-class> 指向我們的建立 portlet 類。
?<name>view-action</name> 里面值是指 view 這個 action 對應的 actionurl 。 <portlet-preferences>
里面參數值是提供給這個 portlet 使用的參數初始值。這里配置是指 portlet 里面使用到參數名 user 的值是 jack 。
如 portlet 不需要初始值參數，則該項不需要配置。

在 liferay-portlet-ext.xml 文件里面添加
<portlet>
??<portlet-name>EXT_users</portlet-name>
??<struts-path>ext/myuser</struts-path>
??<use-default-template>false</use-default-template>
</portlet>

<portlet-name> 的值必須和 portlet-ext.xml 文件里面 <portlet-name> 值一致。

在 liferay-display 。 Xml 文件節點 <category name="category.test">
下面添加
<portlet id="EXT_users" /> id 必須和 portlet-ext 里面的 <portlet-name> 一致。

在 struts-config.xml 文件里面添加內容：
<action path="/ext/myuser/view_users"
???????? type="com.ext.portlet.myuser.action.ViewUsersAction">
<forward name="portlet.ext.myuser.view_1"
??path="portlet.ext.myuser.view" />
<forward name="portlet.ext.myuser.view_users_1"
path="portlet.ext.myuser.view_users" />
</action>

就是說，當前臺提交一個 actionUrl 為 /ext/myuser/view_users 請求的時候，由 ViewUsersAction 負責處理這個
action 操作。后面 2 個 forward 指的是在 ViewUsersAction 定向返回請求目標頁面。
…………
return mapping.findForward("portlet.ext.myuser.view_1");

………
return mapping.findForward("portlet.ext.myuser.view_users_1");

findForward 的值為避免與其他 findForward 值沖突，一般將包名也帶上，保證不會重名。

在 tiles-defs.xml 文件里面添加內容：
<definition name="portlet.ext.myuser.view" extends="portlet">
?<put name="portlet_content" ?value="/portlet/ext/myuser/view.jsp" />
</definition>
<definition name="portlet.ext.myuser.view_users" extends="portlet">
?<put name="portlet_content" value="/portlet/ext/myuser/view_users.jsp" />
</definition>

該 name 的值即隨同 struct-config.xml 配置信息里面 forward 參數 path 值對應的，指向真正的目標頁面。

最后我們在 ext-ejb/classes/content 目錄下 language-ext.properties 文件里面增加內容：
javax.portlet.title.EXT_user=MyUsers
即 portlet 顯示出來時候，在 portlet 上面標題信息。

Portlet 常見問題
1.? 運行提示 portlet path 找不到，則一般是 liferay-port-ext 文件里面 portlet 的 struts–path 有問題。
2.? 啟動提示 jaas.config 錯誤，沒有在 tomcat 的 jdk 參數配置 jaas.config 文件或配置路徑不對
3.? 提示 html/../.. 找不到，一般是 struts-config 文件里面 path 路徑有問題。
4.? 有執行和數據庫存取數據時候，提示 “columnname_” 字段不存在，去修改 ext-hbm.xml 文件， ant 執行
build service 任務時候，產生 ext-hbm.xml 信息有時會不準確，將對應的 <property name="columnname"
column="columnname_ " /> 的 column 調整為數據庫對應正確的字段名。
5.? 大家在清除不用的 portlet 時候，請先登錄系統，將不用的 portlet 關閉，然后再刪除或屏蔽對應的代碼。
不然直接刪除或屏蔽代碼，重新啟動后，會提示 portlet 找不到。注冊后的 portlet 會寫信息到數據庫中。

?