OFBiz进阶之HelloWorld（一）创建热部署模块

创建热部署模块

参考文档 https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Tutorial+-+A+Beginners+Development+Guide

In this part, you will learn how to create and load your own custom component and add first screen that shows “This is practice application”

1 在目录hot-deploy下创建目录practice（即为要创建的模块名称）

2 在目录hot-deploy/practice下创建文件ofbiz-component.xml

 <?xml version="1.0" encoding="UTF-8"?>
 <ofbiz-component name="practice"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/ofbiz-component.xsd">
       <resource-loader   name="main" type="component"/>
     <webapp name="practice"
        title="Practice"
        server="default-server"
        base-permission="OFBTOOLS"
        location="webapp/practice"
        mount-point="/practice"
        app-bar-display="false"/>
 </ofbiz-component>

2.1 ofbiz-component.xml文件说明：

a. ofbiz通过ofbiz-component.xml文件识别此模块

b. 节点（resource-loader name）可以灵活设置，此处设置为main。type告诉ofbiz我们要加载一个component

 <resource-loader name="main" type="component"/>

c. 节点webapp有很多属性，通常如下：

 <webapp name="practice"
        title="Practice"
        server="default-server"
        base-permission="OFBTOOLS"
        location="webapp/practice"
        mount-point="/practice"
        app-bar-display="false"/>

　　name :  web应用名称。

　　title : 应用的标题，将被展示在顶部导航中。

　　server : ofbiz通过此处值知道使用的是什么server。

　　base-permission :

　　location : 默认跟路径

　　mount-point : 访问此服务的URL，本例中应为：localhost:8080/practice。

　　app-bar-display :

3 创建 web app

3.1 创建webapp文件夹

在目录hot-deploy/practice下创建文件夹webapp，这个目录下包括模块的所有webapp相关文件。

webapp下内容遵循J2EE webapp标准。

3.2 创建practice文件夹

在目录hot-deploy/practice/webapp下创建文件夹practice（为webapp名称）。

注意：一个模块可以有多个webapp，例如marketing模块有两个webappp（marketing和sfa）；

3.3 创建WEB-INF文件夹

在目录hot-deploy/practice/webapp/practice下创建WEB-INF文件夹：

一个OFBiz web application 需要放置两个配置文件（controller.xml 和 web.xml ）。

a. controller.xml : 告诉OFBiz一个请求过来该如何处理，通过哪个action去处理，通过那个page去渲染。

b. web.xml : 告诉OFBiz 此web applation 可用的资源（database and business logic access），怎样去处理web相关问题，比如欢迎页面、重定向、错误页面等。

3.4 创建web.xml(web.xml遵循J2EE的webapp规格)

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
 <web-app>
     <context-param>
         <param-name>webSiteId</param-name>
         <param-value>PRACTICE</param-value>
         <description>A unique ID used to look up the WebSite entity to get
             information about catalogs, etc.</description>
     </context-param>
     <context-param>
         <param-name>localDispatcherName</param-name>
         <param-value>practice</param-value>
         <description>A unique name used to identify/recognize the local
             dispatcher for the Service Engine</description>
     </context-param>
     <context-param>
         <param-name>mainDecoratorLocation</param-name>
         <param-value>component://practice/widget/PracticeScreens.xml</param-value>
         <!-- change the path to the following if the above doesn't work for you -->
         <!-- <param-value>component://practice/webapp/practice/widget/PracticeScreens.xml</param-value> -->
         <description>The location of the main-decorator screen to use for this
             webapp; referred to as a context variable in screen def XML files.</description>
     </context-param>

     <filter>
         <filter-name>ContextFilter</filter-name>
         <display-name>ContextFilter</display-name>
         <filter-class>org.ofbiz.webapp.control.ContextFilter</filter-class>
         <init-param><param-name>disableContextSecurity</param-name><param-value>N</param-value></init-param>
         <init-param>
             <param-name>allowedPaths</param-name>
             <param-value>/error:/control:/select:/index.html:/index.jsp:/default.html:/default.jsp:/images:/includes/maincss.css</param-value>
         </init-param>
         <init-param>
             <param-name>errorCode</param-name>
             <param-value>403</param-value>
         </init-param>
         <init-param>
             <param-name>redirectPath</param-name>
             <param-value>/control/main</param-value>
         </init-param>
     </filter>
     <filter-mapping>
         <filter-name>ContextFilter</filter-name>
         <url-pattern>/*</url-pattern>
     </filter-mapping>

     <servlet>
         <servlet-name>ControlServlet</servlet-name>
         <display-name>ControlServlet</display-name>
         <description>Main Control Servlet</description>
         <servlet-class>org.ofbiz.webapp.control.ControlServlet</servlet-class>
         <load-on-startup>1</load-on-startup>
     </servlet>
     <servlet-mapping>
         <servlet-name>ControlServlet</servlet-name>
         <url-pattern>/control/*</url-pattern>
     </servlet-mapping>

     <session-config>
         <session-timeout>60</session-timeout><!-- in minutes -->
     </session-config>

     <welcome-file-list>
         <welcome-file>index.jsp</welcome-file>
         <welcome-file>index.html</welcome-file>
         <welcome-file>index.htm</welcome-file>
     </welcome-file-list>
 </web-app>

3.5 创建controller.xml

 <?xml version="1.0" encoding="UTF-8"?>
 <site-conf xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/site-conf.xsd">
        <include location="component://common/webcommon/WEB-INF/common-controller.xml"/>
        <description>Practice Component Site Configuration File</description>
        <owner>Copyright 2001-2009 The Apache Software Foundation</owner>
        <handler name="screen" type="view" class="org.ofbiz.widget.screen.ScreenWidgetViewHandler"/>
        <!-- Request Mappings -->
        <request-map uri="main">
            <security https="false" auth="false"/>
            <response name="success" type="view" value="main"/>
        </request-map>
        <!-- end of request mappings -->
        <!-- View Mappings -->
        <view-map name="main" type="screen" page="component://practice/widget/PracticeScreens.xml#main"/>
        <!-- change the path to the following if the above doesn't work for you -->
        <!-- <view-map name="main" type="screen" page="component://practice/webapp/practice/widget/PracticeScreens.xml#main"/> -->

        <!-- end of view mappings -->
 </site-conf>

3.6 创建error文件夹

在目录hot-deploy/practice/webapp/practice下创建文件夹error，并且在此文件夹创建error.jsp

3.7 创建widget文件夹

在目录hot-deploy/practice下创建文件夹widget，并且创建PracticeScreens.xml文件

 <?xml version="1.0" encoding="UTF-8"?>
 <screens xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/widget-screen.xsd">
     <screen name="main">
         <section>
             <widgets>
                 <label text="This is first practice"/>
             </widgets>
         </section>
     </screen>
 </screens>

3.8 运行

http://localhost:8080/practice/control/main