欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

OFBiz进阶--OFBiz开发之[component]-模块目录结构

程序员文章站 2022-06-17 12:31:07
...

OFBiz进阶--OFBiz开发之[component]-模块目录结构

 

 

1. 目录的生成方式

           请参看[OFBiz进阶--OFBiz开发之[ant create-component]创建模块]

 

 

2 分析按规范构建的模块目录结构(假设模块名称为 learn)

learn - 模块根目录(模块名称, 一般模块请求与之同名)

  ├build - 当前已经编译的java代码和任何java库。他们能够使这个应用程序运行,但不能仅仅靠它运行.

    ├classes - 这里是 已经编译过的 *.class 文件; java源文件在当前模块的 src 内

    ├lib - 将当前模块的独有的 *.class 文件打包成jar包, 名称为 learn.jar 或 ofbiz-learn.jar

    ├javadoc - 由当前模块的 build.xml执行ant指令[docs/docs-all] 自动将当前模块的 src 中定义的java类中方法的注释生成 api 文档.

 

  ├config - 当前模块使用的配置文件(也可在其他模块调用)

    ├LearnEntityUiLabels.xml - 实体表字段描述国际化配置文件(默认没有, 可手动创建)

    ├LearnUiLabels.properties - 国际化配置的 属性型 文件(默认没有, 可手动创建)

    └LearnUiLabels.xml - 国际化配置文件(当前模块所有中英描述的配置文件; 命名: xxxUiLabels.xml)

    

  ├data - 当前模块的表中一些初始化种子/演示数据(在初始化时 DemoData 可不导入数据库; 其他为必须)

    ├LearnDemoData.xml - 临时的表测试数据配置(命名: xxxDemoData.xml)

    ├LearnSecurityData.xml - 当前模块涉及到的访问与操作权限配置(命名: xxxSecurityData.xml)

        --上述文档在 12.04 版本已经拆分为两个文件了, 信息如下

            LearnSecurityGroupDemoData.xml

                      - 当前模块涉及到的权限组配置(命名: xxxSecurityGroupDemoData.xml)

            LearnSecurityPermissionSeedData.xml

                      - 当前模块涉及到的详细权限配置(命名: xxxSecurityPermissionSeedData.xml)
    ├LearnUintData.xml - 模块中涉及到得单元测试使用的测试数据配置文件(命名: xxxUintData.xml)

    └LearnTypeData.xml - 当前模块涉及到的常量表种子数据配置(命名: xxxTypeData.xml)

    

  ├documents - 帮助文档配置

    └Learn.xml - 当前模块的帮助文件配置

  

  ├dtd - 文档类型声明的配置文件存放目录

    

  ├entitydef - 实体表, 视图, 实体触发器 配置文件目录, 是应用程序的数据模型定义。

    ├eecas.xml - 实体触发器(配置某个表发生操作时触发的事件)(命名: eecas.xml)

    ├entitymodel_view.xml - 表的视图配置(可与下行文件合并)

    ├entitymodel.xml - 实体表配置(命名: entitymodel.xml)

    ├entitygroup.xml - 实体分组配置(命名: entitygroup.xml)

    └entityengine.xml - 实体引擎配置(命名: entityengine.xml)

    

  ├lib - 当前模块引用到的一些 jar 包

    

  ├patches - 在不修改原模块文件时, 升级模块的 补丁 文件

    

  ├script - mililanguage 的脚本配置文件(可用于后续程序升级), 业务逻辑的脚本文件。

    ├xpp/com/learn/permissions/PermissionServices.xml - 权限校验的mililanguage配置

    

  ├servicedef - 服务, 服务触发器 配置文件目录

    ├secas.xml - 服务触发器(配置某个服务发生操作时触发的事件)(命名: secas.xml)

    └services.xml - 服务配置文件(命名: services.xml)

    

  ├testdef - 单元测试配置文件目录

    ├LearnTests.xml - 单元测试配置文件

    

  ├webapp - 模块核心代码(有: 请求控制器, 模块应用配置); 是web接口,

           应用程序的最前端,一个ofbiz应用程序能有多个webapp应用程序。

 

    ├learn - 模块的 应用程序节点(可有多个, 内部结构类似)

 

      ├error - 错误响应目录

        ├error.jsp - 错误响应文件

 

      ├learn - 程序 成员文件目录

 

      ├WEB-INF - 请求核心目录配置目录

        ├actions - 弱类型语言, 数据处理文件(如: test.bsh; test.groovy)

 

        ├controller.xml - 请求控制器配置文件(可有多个, 区分)

        ├web.xml - 模块应用核心配置文件(唯一网站ID定义; 控制器定义; 请求过滤器定义...)

 

    └index.jsp - 应用默认首页(内部只有一句重定向语句)

    

  ├widget - 装饰器文件目录

    ├CommonScreens.xml - 模块通用装饰器配置

    ├LearnForms.xml - 装饰器中引入的 Form 表单配置

    ├LearnMenus.xml - 装饰器中引入的 Menu 菜单配置

    ├LearnScreens.xml - 一般 Screens 装饰器配置

    

  ├build.xml - 模块加载与语言文件编译配置(引入模块结构中所有目录; 引入当前模块需要的所有 jar 文件; 编译java文件,生成jar文件;)

    └文件是ant配置文件,用于测试和构建这个应用程序。 

    

  ├ofbiz-component.xml - 模块加载的资源文件配置(引入模块内各种资源的配置; 应用程序 服务器 节点配置)

 

 

 

 

==================================关于本文===================================

 

        作者: mf1389004071

        ......上海_香飘飘

        博客: http://ofbizer.iteye.com/

        邮箱: mf1389004071@163.com

        有此标记, 均为原创, 禁止盗用, 转载请注明来源

        技术无上限, 能力有上限, 欢迎参与交流讨论和提出建议

        本文永久地址: http://ofbizer.iteye.com/blog/2028166