技术分享
🗒️Apache OFBiz 学习
00 分钟
2023-11-29
2023-11-29
type
status
date
slug
summary
tags
category
icon
password
Language

1.准备

1.1环境及工具

  • Intellij IDEA 2020.1
  • JDK1.8
  • MySQL5
  • OFBIZ版本 (当前发布最新版17.12.04-发布于2020-07-13) 这里使用16.11.05 下载链接

2.下载 Apache OfBiz 框架

下载链接
  • 下载之后解压
notion image
  • Apache OFBiz 自带的数据库为 Derby 后续可以配置成MySQL数据库

3.运行 Apache OFBiz

以上命令将加载演示数据，（示例数据运行应用程序）
notion image
  • 浏览器上打开
    • 用户名 : admin
    • 密码 : ofbiz

4.创建一个应用程序

OFBiz 组件是一个文件夹，其中包含一个名为"ofbiz-组件.xml"的特殊 xml 文件，用于描述组件要加载和所需的资源。
OFBiz 本身就是一组组件。
  • 框架组件：这些是为应用程序组件提供技术层和工具的较低级别的组件;这些组件提供的功能通常是任何其他开发框架（数据层、业务逻辑层、事务处理、数据源池等）提供的功能。
  • 应用程序组件：这些是 ERP 应用程序所需的通用业务组件，可以扩展/定制（产品、订单、一方、制造、会计等）;应用程序组件可以访问框架组件提供的服务和工具以及其他应用程序组件发布的服务。
  • 特殊用途组件：这些组件类似于应用程序组件，但用于特殊用途的应用程序，如电子商务，谷歌基础集成，eBay

4.1创建插件/组件

使用命令行设置新的自定义组件
notion image

4.2运行应用程序

  • 在运行第一个组件之前，显示“Hello World”
  1. 打开 $OFBIZ_HOME/specialpurpose/ofbizDemo/widget/OfbizDemoScreens.xml
  • 只添加了 <label text =“ Hello World !! :)” /></label>
  1. 现在将需要通过重新加载数据 ./gradlew loadDefault ofbiz来重新启动OFBiz。 这是必需的，因为您已经为组件创建了一些带有一些安全性数据的组件（默认情况下，在组件数据目录中将其设置为OfbizDemoSecurityGroupDemoData.xml），并且在重新启动它时，ofbizdemo组件也会被加载
  1. 当OFBiz重新启动时，将浏览器定向到此处的应用程序中 https://localhost:8443/ofbizDemo
  1. 您将被要求登录。 使用用户登录：admin 密码：ofbiz。
  1. 登录时，您将看到ofbizdemo应用程序，并在屏幕上显示了hello world消息，如下图所示。就是这样，祝贺您的第一个组件已安装并正在运行。
  • 我这里进去报错 应该是国际化的问题
        • notion image
  • 解决办法 将apache-ofbiz-16.11.05\specialpurpose\ofbizDemo\widget\CommonScreens.xml 中的OfbizDemoUiLabels这行删除
        • notion image
  • 进去再次报错 原因 "元素类型“label”必须以匹配的结束标签“</label>”结束。"
        • notion image
  • 最后加上 label标签 成功进入
        • notion image
        notion image

4.3创建第一个数据库实体（表）

定义实体
要在数据库中创建自定义实体/表，只需要在ofbizdemo应用程序的$ OFBIZ_HOME / specialpurpose / ofbizDemo / entitydef / entitymodel.xml文件中提供实体定义。 使用Gradle任务设置组件时，已经设置了此文件结构。 只需要进入并提供实体定义，如下所示。 在这里，我们将为ofbizdemo应用程序添加两个新实体。
notion image
现在看一下$ OFBIZ_HOME / specialpurpose / ofbizDemo / ofbiz-component.xml文件。 已经在其中进行了资源输入，以便在加载组件时将这些实体从其定义加载到数据库。 如下所示：
notion image
要检查，只需重新启动OFBiz（Ctrl + C后跟“ ./gradlew ofbiz”），然后将浏览器定向到https://localhost:8443/webtools/control/entitymaint 并搜索OfbizDemoType和OfbizDemo实体。 您将看到它，如下图所示
notion image

4.4为实体准备数据

设置自定义实体后，现在该为它准备一些样本数据了。 您可以在组件的数据目录下已设置的数据XML文件中执行此操作，即$ OFBIZ_HOME / specialpurpose / ofbizDemo / data / OfbizDemoTypeData.xml和$ OFBIZ_HOME / specialpurpose / ofbizDemo / data / OfbizDemoDemoData.xml。 如下所示进行设置
OfbizDemoTypeData.xml
OfbizDemoDemoData.xml
现在再来看看$ OFBIZ_HOME / specialpurpose / ofbizDemo / ofbiz-component.xml文件。 您已经在其中进行了资源输入，以加载以下文件中准备的数据：
在ofbiz-component.xml中可以看到
notion image

在实体中加载数据

方法一 : 此时要将样本数据加载到定义的实体/表中，您可以在控制台上运行gradlew loadDefault
方法二 : 可以直接在webtools中转到此处以加载实体xml https://localhost:8443/webtools/control/EntityImport 只需将xml数据放入“完整XML文档（根标签：entity-engine-xml）：”文本区域，然后单击“导入文本”，如下图所示
      notion image
      notion image
已经成功将数据导入数据库表中，非常简单
notion image

5.表单和服务

在上面，已经了解了如何创建实体（表），现在该创建一个表单，该表单将允许您在该实体中进行输入。

5.1创建服务

  • 在准备表单之前，先编写一个服务以在服务定义xml文件（$ OFBIZ_HOME / specialpurpose / ofbizDemo / servicedef / services.xml）中为OfbizDemo实体在数据库中创建记录
notion image
  • 此时这里的服务默认有一个
notion image
这个是虚拟服务，防止空文件和语法错误 - 在此处添加第一个实服务时删除
services.xml
现在再次查看$ OFBIZ_HOME / specialpurpose / ofbizDemo / ofbiz-component.xml文件。 已经在其中输入了用于加载此文件中定义的服务的资源条目：
notion image
要加载此服务定义，您将需要重新启动OFBiz。
gradlew ofbiz
要测试此服务，您可以直接在此处转到webtools-> Run Service选项：https://localhost:8443/webtools/control/runService
notion image
通过Web工具运行服务：框架提供的一种智能实用程序，用于运行您的服务。
提交上述表格后，您将展示一个表格，用于输入服务的IN参数。
  • 输入服务名称
        • notion image
  • 填写参数
        • notion image
  • 运行成功
        • notion image
  • 数据已经添加上去了
        • notion image

5.2UI国际化的使用（简介）

Apache OFBiz的国际化非常容易，用各种语言定义UI标签，并根据用户的语言环境显示相应的标签。
这是UI标签的示例（创建组件<component-name> UiLabels.xml是默认创建的，在我们的例子中是OfbizDemoUiLabels.xml）
OfbizdemouiLabels. xml

5.3创建添加(插入数据)表单

让我们为此服务创建我们的第一个表单，为此,让我们编辑现有文件的位置 $OFBIZ_HOME/specialpurpose/ofbizDemo/widget/OfbizDemoForms.xml，并添加为 OfbizDemo 创建窗体，如下所示：
OfbizDemoForms.xml
  • 在这里您可以注意到我们已经使用auto-fields-service根据服务定义IN / OUT属性自动生成表单
  • 转到Screens xml文件（OfbizDemoScreens.xml），将装饰器主体中的此表单位置添加到用于显示Hello World ...文本的屏幕。 如下所示
在主屏幕上添加表格位置
OfbizDemoScreens.xml

5.4表单的控制器输入

在转到表单并从添加表单开始创建OfbizDemo记录之前，您需要在$ OFBIZ_HOME / specialpurpose / ofbizDemo / webapp / ofbizDemo / WEB-INF / controller.xml文件中输入一个条目，以供目标服务调用 表格已提交。 您可以按照如下所示在Ofbizdemo应用程序控制器文件中的“请求映射”下进行操作：
一切都设置好了，让我们看一下我们最近创建的表单https://localhost:8443/ofbizDemo
notion image
主键（ofbizDemoId）不需要与表单一起发送，它将由OFBiz在数据库记录中自动排序。
  • 输入参数后添加
        • notion image
  • 可以看到数据已经添加进去了
        • notion image

5.5创建查找(查询数据)表单

让我们为OfbizDemo实体创建查找表单，以便搜索正在创建的OfbizDemos。
  1. 在OfbizDemoForms.xml中添加表单（FindOfbizDemo和ListOfbizDemo）
OfbizDemoForms.xml
窗体或屏幕的动作标签用于视图的数据准备逻辑
我们已经使用OOTB OFBiz通用服务performFind进行搜索操作，当您必须在一个实体或一个视图实体上执行搜索时，该操作简单而有效。
  1. 在下一步中，我们将这些表格包含在屏幕中，让我们将这些表格添加到OfbizDemoScreens.xml文件中。 为此，包括下面在OfbizDemoScreens.xml中定义的"FindOfbizDemo''屏幕
OfbizDemoScreens.xml
  1. 在controller.xml中添加用于访问此新的Find Ofbiz演示页面的请求映射
controller.xml
  1. 现在，让我们添加一个新菜单来显示查找选项。
      2. 在OFBiz中创建菜单确实非常简单，所有菜单定义为* menus.xml。
      当我们从Gra创建组件时，我们得到一个名为OfbizDemoMenus.xml的文件
      在OfbizDemoMenus.xml文件中输入以下内容。
OfbizDemoMenus.xml

5.6UI国际化的使用（完成）

如前所述，Apache OFBiz的国际化非常容易，我们以各种语言定义UI标签，并根据用户的语言环境显示相应的标签。
在这里我们完成了UI标签的示例（创建组件<component-name> UiLabels.xml是默认创建的，在我们的例子中是OfbizDemoUiLabels.xml）
OfbizDemoUiLabels.xml
现在只需重新启动服务器，在ofbizdemo应用程序（https://localhost:8443/ofbizDemo/control/main）下，您将看到“find”菜单选项。
notion image

5.7使用其他引擎的服务

每当需要构建业务逻辑时，您都应该更喜欢编写服务以利用其内置Service Engine中的功能。
您之前创建的服务“ createOfbizDemo”使用的是engine =“ entity-auto”，因此您无需提供其实现，OFBiz会负责创建操作。 当您需要在服务中进行复杂的操作时，涉及要构建的数据库和定制逻辑中的多个实体，您需要为服务提供定制实现。 在本节中，我们将重点讨论这一点。

5.7.1Java服务

您可以按照以下给定步骤按照Java指令实现服务：
  1. 定义您的服务，在这里我们将再次与自定义Ofbiz Demo应用程序的同一实体（OfbizDemo）一起运行。 打开服务定义文件$ OFBIZ_HOME / specialpurpose / ofbizDemo / servicedef / services.xml并添加新定义为：
services.xml
注意我们这次使用了engine =“ java”
  1. 在ofbizDemo组件src / main / java目录中创建“ com.companyname.ofbizdemo.services”包（如果src目录中不存在，则创建它们）。
例如：src / main / java / com / companyname / ofbizdemo / services。 可以在Java目录中放置必须用Java实现的应用程序服务。
  1. 在服务目录中的OfbizDemoServices.java文件中定义新的Java类，并实现方法，服务定义将调用该方法，如下所示：
OfbizDemoServices.java
  1. 停止服务器并使用“ ./gradlew ofbiz”重新启动，它将编译您的类，并在ofbiz重新启动更新的jar文件时使其可用。
  1. 测试使用webtools实现的服务->运行服务选项（https：// localhost：8443 / webtools / control / runService）或仅更新控制器请求调用的服务名称以使用此服务，并在应用程序中使用添加表单 您之前准备的。 这样，您的Add OfbizDemo表单将调用此Java服务。
controller.xml
  • 点击提交
        • notion image
  • 查看控制台
        • notion image
说明我们成功调用的是Java服务

5.7.2Groovy中的服务

不使用Groovy 则跳过
要利用即时编译和更少的代码行的功能，您可以使用Groovy DSL在OFBiz中实现用于构建业务逻辑的服务。
要使用Groovy实施服务，您可以按照以下给定步骤进行操作：
  1. 将新服务定义添加到services / services.xml文件，如下所示：
services.xml
  1. 在此处添加新的Groovy服务文件component://ofbizDemo/script/com/companyname/ofbizdemo/OfbizDemoServices.groovy
  1. 将服务实现添加到文件OfbizDemoServices.groovy
OfbizDemoServices.groovy
  1. 停止服务器并使用“ ./gradlew ofbiz”重新启动，这一次，我们只需要加载新的服务定义，就不需要显式编译，因为它是Groovy中的服务实现。
  1. 测试使用webtools实现的服务->运行服务选项（https：// localhost：8443 / webtools / control / runService）或仅更新控制器请求调用的服务名称以使用此服务，并在应用程序中使用添加表单 您之前为测试准备的。 这样，您的Add OfbizDemo表单将调用此groovy服务。
controller.xml
要确保正在执行此新服务实现，可以使用Debug.log（...）在控制台日志中检查您已在代码中放入的这一行。 要登录OFBiz，必须始终在Java类中使用Debug类方法。
要获得有关在Apache OFBiz中使用Groovy DSL进行服务和事件实现的更多详细信息，您可以在此处参考由Jacopo Cappellato创建的文档在OFBiz Wiki中。

6.Events(事件)

6.1示范

Apache OFBiz中的事件只是用于HttpServletRequest和HttpServletResponse对象的简单方法。 您无需像使用服务那样提供这些定义。 这些直接从控制器调用。 当您要将自定义服务器端验证添加到输入参数时，事件也很有用。 对于执行数据库操作，您仍然可以从事件中调用预建服务。
要在OFBiz中编写事件，请按照以下步骤操作：
  1. 添加新的事件目录到package和新的Events类文件，如下所示：
notion image
OfbizDemoEvents.java
  1. 将调用此事件的控制器请求添加为：
controller.xml
  1. 通过重建服务器来停止和启动服务器，因为我们需要编译在＃1中添加的Java事件类。
  1. 现在要测试该事件，您只需将AddOfbizDemo表单目标更改为读取“ createOfbizDemoEvent”，并且由于其提交，它将调用您的事件。

6.2服务与事件之间的区别

以下是服务和事件之间的一些区别，
  • 事件用于使用map processor进行验证和转换，而服务用于诸如CRUD操作之类的业务逻辑。
  • 服务返回Map。
  • 事件返回字符串。
  • 服务随服务器一起加载，定义的任何更改（如果在MiniLang中，则不是实现）都需要重新加载。
  • 我们可以在事件内部调用服务。 但是我们不能在服务内部调用事件
  • 事件是特定的本地片段功能，通常在一个地方用于一种目的，并从其位置调用。
  • 服务是一项功能，可以位于网络上的任何位置，大部分时间在几个不同的地方使用，并以其“name”来调用。
  • 如果发生事件，您可以访问HttpServletRequest和HttpServletResponse对象，并且可以读取/写入任何所需内容。 如果是服务，则只能访问服务参数。
参考资料
标准
服务
事件
用于编写业务逻辑
Yes
No
返回类型
Map
String
需要定义
Yes
No
可以进行作业调度
Yes
No
实施可能性
实体自动，Java，简单（XML）和Groovy
Simple (XML), Java & Groovy

7.自定义用户界面

使用FreeMarker模板和Groovy脚本
好的，我们在OFBiz教程的最后一部分中。 在这一部分中，我们将重点介绍为业务管理应用程序（即后端应用程序和esp）定制Apache OFBiz的UI层。 大多数时候，您会发现OFBiz窗口小部件已足够。 但是有时候重要的是根据用户的实际需求开发应用程序。
因此，首先要自定义应用程序的UI部分以使其变得容易，我们将使用Freemarker模板而不是内置的Form Widgets。 首先，我们将了解如何将Freemarker和Groovy脚本与Apache OFBiz一起使用，然后我们将了解如何通过定义自己的装饰器来对其进行自定义样式。 最初，我们将使用OFBiz默认装饰器。
从此处开始，请遵循给出的步骤：
  1. 在位置$ OFBIZ_HOME / specialpurpose / ofbizDemo / webapp / ofbizDemo / crud / AddOfbizDemo.ftl和ListOfbizDemo.ftl处添加两个Freemarker文件。
AddOfbizDemo.ftl
ListOfbizDemo.ftl
  1. 在位置$ OFBIZ_HOME / specialpurpose / ofbizDemo / webapp / ofbizDemo / WEB-INF / actions / crud / ListOfbizDemo.groovy中添加新的Groovy文件以用于数据提取逻辑，并添加如下所示的代码以列出OfbizDemo记录：
  1. 使用Ofbiz默认装饰器将新的屏幕文件添加到OfbizDemoScreens.xml，其中新添加的freemarker和groovy文件为
OfbizDemoScreens.xml
  1. 为OfbizDemo菜单添加新的控制器请求和新项，如下所示：
controller.xml
OfbizDemoMenus.xml
  1. 添加您的应用所使用的新UI标签。
  1. 运行您的Ofbiz演示应用程序，然后转到您刚刚添加的新标签。

7.1创建自定义装饰器

将用户界面放置在Freemarker中使您可以自由地进行实验，进行CSS调整并使应用程序达到用户想要的方式。 在本节中，我们将看到如何做到这一点。
我们将通过为您的应用程序视图定义自定义装饰器来做到这一点。 OFBiz中的装饰器不过是一个屏幕，您可以通过在其他应用程序屏幕中包含该屏幕来定义和重用该屏幕。 您已经使用OFBiz随附的默认装饰器（主装饰器–> ApplicationDecorator）进行了此操作。 只需观察您到目前为止准备的屏幕，您会发现您正在使用此主装饰器，请参考OfbizDemoScreens.xml中的以下行。
OfbizDemoScreens.xml
web.xml
现在是时候使用自定义样式定义自己的装饰器了。
在下面给出的示例中，我们将使用Bootstrap设置在本教程最后一部分中开发的示例Freemarker屏幕的样式。 请按照以下给定的步骤构建您自己的装饰器。
  1. 下载Bootstrap v3.3.7目录，您可以从此处下载它并解压缩。
  1. 在位置$ OFBIZ_HOME / specialpurpose / ofbizDemo / webapp / ofbizDemo /下创建两个新目录，分别为“ css”和“ js”
  1. 将bootstrap-3.3.7 / dist / css / bootstrap.min.css复制到$ OFBIZ_HOME / specialpurpose / ofbizDemo / webapp / ofbizDemo / css
  1. 将bootstrap-3.3.7 / dist / js / bootstrap.min.js复制到$ OFBIZ_HOME / specialpurpose / ofbizDemo / webapp / ofbizDemo / js。
  1. 打开$ OFBIZ_HOME / specialpurpose / ofbizDemo / webapp / ofbizDemo / WEB-INF / web.xml，最后在allowedPaths中为css和js目录创建条目，如下所示：
web.xml
  1. 在$ OFBIZ_HOME / specialpurpose / ofbizDemo / webapp / ofbizDemo /位置添加名为“ includes”的新目录，并在您刚刚添加的名为PreBody.ftl和PostBody.ftl的新目录中创建两个新文件。 我们将在装饰器屏幕中使用（包括）这两个文件来构建完整的HTML页面。
PreBody.ftl
PostBody.ftl
  1. 打开组件的通用屏幕文件$ OFBIZ_HOME / specialpurpose / ofbizDemo / widget / CommonScreens.xml，这是我们将定义自定义装饰器的文件。
  1. 更新屏幕名为“ OfbizDemoCommonDecorator”（将用作您的应用程序的自定义装饰器），如下所示：
CommonScreens.xml
在上面的代码中，您可能已经注意到了layoutSettings.styleSheets []和layoutSettings.javaScripts [+0]表示法。 您可以使用layoutSettings。 文件的符号。
如果要带空方括号的styleSheets或javaScripts，只需将文件添加到layoutSettings.styleSheets或layoutSettings.javaScripts列表的末尾，并用[+0]将其添加到它的前面。
  1. 在上一部分创建的Freemarker屏幕中，将此装饰器用作：
OfbizDemoScreens.xml
  1. 更新您的FTL文件以遵循HTML Web标准并将CSS应用于以下文件：
AddOfbizDemo.ftl
ListOfbizDemo.ftl
  1. 现在，在web.xml中输入allowedPaths的条目后，重新启动OFBiz。 重新加载时，请访问https：// localhost：8443 / ofbizDemo / control / AddOfbizDemoFtl。您应该看到具有自定义样式的页面，而不是使用默认的OFBiz主题。
现在，您可以在这里随心所欲地玩它。 尝试更改页眉或使用新的页眉，添加页脚，进行验证等。因此，您可以使用Freemarker模板，CSS和JS自定义OFBiz的UI层。
您可能想要添加自己的CSS或JS文件，可以像对Bootstrap文件那样添加它们。
如果您已按照本教程进行了所有步骤并开发了实践应用程序，那么这将有助于您了解OFBiz中的其他实现。 这些都是在OFBiz中工作的基本基础。 现在您知道了如何在OFBiz中开始开发。 不要留下本教程中提供的额外链接，因为它们将帮助您大量了解此处详细介绍的内容。
这是常见问题解答技巧食谱手册中的另一本好书。
现在，接下来的事情是业务流程，为了真正理解OFBiz和OOTB数据模型中的OOTB流程，确实需要很好地理解它们，因此，可以在：OFBiz相关书中找到这些书。 充分了解OFBiz OOTB可用数据模型和业务流程将有助于在其顶部构建更好的业务解决方案。
现在您可以开始研究了。欢迎来到OFBiz世界。
上一篇
Olap4j 框架详解
下一篇
CDH6 集群搭建
评论