新手写OFBiz的HelloWorld

本人没有学过web2.0，但按照http://www.opensourcestrategies.com/ofbiz/hello_world1.php的这篇文章，也使用OFBiz跑起一个简单的Helloworld页面了，看来rp不错！下面写一下我搭建的过程。

1. 我们需要在ofbiz主目录下的hot-deploy目录下建立一个hello1文件夹，

文章对hot-deploy的说明如下：

The advantage of the hot-deploy/ directory is that components here are loaded automatically when OFBiz starts

我的理解是hot-deploy就是用来放我们写的网站/网页的地方

2. 在我们建的hello文件夹中建立一个ofbiz-component.xml的文件，如图：

向里面写入这些内容：

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 
 3 <ofbiz-component name="hello1"
 4         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 5         xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/ofbiz-component.xsd">
 6     <resource-loader name="main" type="component"/>
 7     <webapp name="hello1" 
 8             title="My First OFBiz Application" 
 9             server="default-server" 
10             location="webapp/hello1" 
11             mount-point="/hello1"
12             app-bar-display="false"/>     
13 </ofbiz-component>

文章中对这个文件的作用做了如下的描述：

ofbiz-component.xml file to tell OFBiz about your applicaton component: its data model (tables), business logic (services) and workflow, UI layer (web or GUI applications), any seed data it may have, and what other resources it requires.
我们来分析一下这段代码说明了什么：

l 我们的组件名叫做"hello1“

l resource-loader的名字叫做main

l 只有一个web应用，名字也叫“hello1”

l 这个叫hello1的web应用使用的是“default-server”这个服务器

l 这个应用的位置在webapp/hello1目录下

l 这个应用在使用url访问的时候应该用“/hello1”来访问

3. 在这个hello1目录中,我们建立一个webapp目录,如图所示

以后我们的代码就放在里面.进入到webapp目录中,我们还要再新建一个hello1目录，这里hello的名字是要对应之前写的

<webapp name="hello1"

这一句代码

4. 进入到这个hello1目录中，我们建立一个WEB-INF文件夹以及一个叫做main.ftl的文件，如图所示：

这个main.ftl的作用我的理解是它定义了显示给用户看的页面是什么样子的。他

是一个Freemarker的template file。Freemarker是什么可以查看这个网址

http://www.zzbaike.com/wiki/FreeMarker

简单来说它是用来设计HTML web页面的，特别适用于基于MVC模式的应用程序。

我们在这个文件中输入以下内容：

1 <html>
2 <head>
3 <title>Hello World</title>
4 </head>
5 <body>
6 <h1>HELLO</h1>
7 <p>Hello world!</p>
8 </body>
9 </html>

对于目前我们的程序来说，main.ftl就是一个简单的html文件。

5. 我们进入到WEB-INF这个目录中，创建两个xml文件，一个是web.xml，另一个是controller.xml，如图所示：

需要知道的是，每一个OFBiz的web应用，都至少需要这两个文件。

l controller.xml告诉OFBiz如何处理访问者不同的请求，针对不同的请求采取什么样的动作，返回什么样的界面。

l web.xml则告诉OFBiz对于这个web应用，可以使用那些资源，如数据库之类的。

我们在controller.xml中写入如下内容：

 1 <?xml version="1.0" encoding="UTF-8" ?>
 2 
 3 <site-conf xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 4         xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/site-conf.xsd">
 5     <description>First Hello World Site Configuration File</description>
 6     <owner>Open For Business Project (c) 2005 </owner>
 7     <errorpage>/error/error.jsp</errorpage>
 8 
 9     <handler name="java" type="request" class="org.ofbiz.webapp.event.JavaEventHandler"/>
10     <handler name="soap" type="request" class="org.ofbiz.webapp.event.SOAPEventHandler"/>
11     <handler name="service" type="request" class="org.ofbiz.webapp.event.ServiceEventHandler"/>
12     <handler name="service-multi" type="request" class="org.ofbiz.webapp.event.ServiceMultiEventHandler"/>
13     <handler name="simple" type="request" class="org.ofbiz.webapp.event.SimpleEventHandler"/>
14 
15     <handler name="ftl" type="view" class="org.ofbiz.webapp.ftl.FreeMarkerViewHandler"/>
16     <handler name="jsp" type="view" class="org.ofbiz.webapp.view.JspViewHandler"/>
17     <handler name="screen" type="view" class="org.ofbiz.widget.screen.ScreenWidgetViewHandler"/>
18 
19     <handler name="http" type="view" class="org.ofbiz.webapp.view.HttpViewHandler"/>
20 
21     <preprocessor>
22         <!-- Events to run on every request before security (chains exempt) -->
23         <!-- <event type="java" path="org.ofbiz.webapp.event.TestEvent" invoke="test"/> -->
24         <event type="java" path="org.ofbiz.securityext.login.LoginEvents" invoke="checkExternalLoginKey"/>
25     </preprocessor>
26     <postprocessor>
27         <!-- Events to run on every request after all other processing (chains exempt) -->
28         <!-- <event type="java" path="org.ofbiz.webapp.event.TestEvent" invoke="test"/> -->
29     </postprocessor>
30 
31     <!-- Request Mappings -->
32     <request-map uri="main">
33         <response name="success" type="view" value="main"/>
34     </request-map>
35 
36     <!-- end of request mappings -->
37 
38     <!-- View Mappings -->
39     <view-map name="error" page="/error/error.jsp"/>
40     <view-map name="main" type="ftl" page="main.ftl"/>
41     <!-- end of view mappings -->
42 </site-conf>

可以对此做一下简单的分析：

l 可以看出有9个handler。这些hanlder用于处理请求或者提供界面。他们都是Java的类来着。

这个对应servlet的请求

这个对应service engine的请求

至于那些type为view的，用于针对browser based on Freemarker templates, velocity, JSP, or the OFBiz screen widget.提供不同的界面

l pre-和post-processors。他们是servlet，将会在每一个web请求操作的之前和之后运行。对于我们写的这个web应用，只有pre-processor，

至于它做了什么我现在不是很清楚。

l request mappings。用于将URI（统一资源标识符，是一个用于标识某一互联网资源名称的字符串。该种标识允许用户对网络中（一般指万维网）的资源通过特定的协议进行交互操作。URI由包括确定语法和相关协议的方案所定义。）请求映射到具体的request handler或者view handler。

对于我们这个web应用，只有一个请求，就是”/mian”

l view mappings。我的理解是用于将某一个变量映射到具体的页面文件。如：

<view-map name="main" type="ftl" page="main.ftl"/>

我们就吧main映射到了之前写的main.ftl文件。

对于web.xml，我们写入如下的内容：

 1 <?xml version="1.0"?>
 2 <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
 3 
 4 <web-app>
 5     <display-name>Hello 1</display-name>
 6     <description>The First Hello World Application</description>
 7 
 8     <context-param>
 9         <param-name>entityDelegatorName</param-name>
10         <param-value>default</param-value>
11         <description>The Name of the Entity Delegator to use, defined in entityengine.xml</description>
12     </context-param>
13     <context-param>
14         <param-name>localDispatcherName</param-name>
15         <param-value>hello1</param-value>
16         <description>A unique name used to identify/recognize the local dispatcher for the Service Engine</description>
17     </context-param>
18     <context-param>
19         <param-name>serviceReaderUrls</param-name>
20         <param-value>/WEB-INF/services.xml</param-value>
21         <description>Configuration File(s) For The Service Dispatcher</description>
22     </context-param> 
23 
24     <filter>
25         <filter-name>ContextFilter</filter-name>
26         <display-name>ContextFilter</display-name>
27         <filter-class>org.ofbiz.webapp.control.ContextFilter</filter-class>
28         <init-param>
29             <param-name>disableContextSecurity</param-name>
30             <param-value>N</param-value>
31         </init-param>
32         <init-param>
33             <param-name>allowedPaths</param-name>
34             <param-value>/control:/select:/index.html:/index.jsp:/default.html:
35                                /default.jsp:/images:/includes/maincss.css</param-value>
36         </init-param>
37         <init-param>
38             <param-name>errorCode</param-name>
39             <param-value>403</param-value>
40         </init-param>
41         <init-param>
42             <param-name>redirectPath</param-name>
43             <param-value>/control/main</param-value>
44         </init-param>        
45     </filter>
46     <filter-mapping>
47         <filter-name>ContextFilter</filter-name>
48             <url-pattern>/*</url-pattern>
49     </filter-mapping> 
50 
51     <listener><listener-class>
52               org.ofbiz.webapp.control.ControlEventListener</listener-class></listener>
53     <listener><listener-class>
54               org.ofbiz.webapp.control.LoginEventListener</listener-class></listener>
55     <!-- NOTE: not all app servers support mounting implementations of the HttpSessionActivationListener interface -->
56     <!-- <listener><listener-class>
57           org.ofbiz.webapp.control.ControlActivationEventListener</listener-class></listener> -->
58   
59     <servlet>
60         <servlet-name>ControlServlet</servlet-name>
61         <display-name>ControlServlet</display-name>
62         <description>Main Control Servlet</description>
63         <servlet-class>org.ofbiz.webapp.control.ControlServlet</servlet-class>
64         <load-on-startup>1</load-on-startup>
65     </servlet>
66     <servlet-mapping>
67         <servlet-name>ControlServlet</servlet-name>
68         <url-pattern>/control/*</url-pattern>
69     </servlet-mapping>
70 
71     <session-config>
72         <session-timeout>60</session-timeout> <!-- in minutes -->
73     </session-config>
74 
75     <welcome-file-list>
76         <welcome-file>index.jsp</welcome-file>
77         <welcome-file>index.html</welcome-file>
78         <welcome-file>index.htm</welcome-file>
79     </welcome-file-list>
80 </web-app>

至于做了什么，我现在还无法分析。

6. 最后，就是启动startofbiz.bat这个脚本，然后访问

http://localhost:8080/hello1/control/main

当你看到如下的显示：

那么恭喜你，成功地写了第一个OFBiz的helloworld程序啦！

posted on 2012-07-09 20:22 烈焰飞龙阅读(671) 评论(0) 收藏举报