Apache OFBiz Developer Manual

• 语言: 英语
• 格式: .pdf
• 来源: ofbizextra.org

摘要

《Apache OFBiz Developer Manual》介绍了Apache OFBiz系统的架构、核心组件、开发环境和安全配置。文档详细描述了OFBiz的各个 subsystem，如Web服务器、MVC框架、实体引擎、服务引擎和小部件系统。此外，文档还涵盖了开发环境的设置、部署方法以及安全性，特别是密码管理和JWT（JSON Web Token）的使用。文档还介绍了仿冒用户功能及其安全控制，强调了保护生产环境的重要性。

AI总结

# Apache OFBiz 开发手册总结

## 1. 系统简介
Apache OFBiz 是一个功能强大的企业级应用框架，由多个子系统组成，包括：
- **Web 服务器**：基于 Apache Tomcat。
- **MVC 框架**：用于处理请求和路由。
- **实体引擎**：定义、加载和操作数据。
- **服务引擎**：定义和控制业务逻辑。
- **小部件系统**：用于绘制和交互用户界面。

OFBiz 还提供：
- **数据模型**：跨业务共享，定义如订单、发票、总账、客户等。
- **服务库**：包含操作数据模型的预定义服务，如 `createBillingAccount`。
- **应用程序**：提供用户界面，操作数据模型和服务库，例如会计管理器和订单管理器。
- **插件**：可选功能扩展，是添加自定义逻辑的主要方式。

## 2. 组件结构
OFBiz 的基本单位是 **组件**，每个组件包含以下目录结构：

component-name-here/
- config/
- data/
- entitydef/
- grooveScripts/
- minilang/
- ofbiz-component.xml
- servicedef/
- src/
- webapp/
- widget/

每个组件都包含完整的应用程序功能，包括实体、数据、服务、用户界面和业务逻辑。核心应用和插件的主要区别在于位置：核心应用位于 `applications` 文件夹，插件位于 `plugins` 文件夹。

## 3. 开发环境
- **Java SE**：需要安装 Java SE。
- **IDE**：推荐使用 IntelliJ IDEA 进行热部署。
- **数据库**：需配置数据库环境。

## 4. 安全机制
### 4.1 密码和 JWT 使用
- **密码**：演示和初始密码存储在通过 `security.ofbiz-component.xml` 加载的文件中。
- **JWT**：用于：
1. 用户安全重置密码。
2. 支持单点登录（SSO）跨域跳转。

**存储秘密密钥**：
1. 使用 `security.properties` 文件。
2. 使用 `SystemProperty` 实体。

### 4.2 凭据转用（Impersonation）
- **定义**：允许授权用户以其他用户身份登录，访问其权限范围内的功能。
- **工作原理**：
1. 授权用户选择要 impersonate 的用户。
2. 系统生成 JWT，用户通过点击链接进行 impersonate。
3. 会话超时后自动退出 impersonate。
- **安全控制**：
- 默认禁用，需在 `security.properties` 中设置 `security.disable.impersonation = false`。
- 提供审计功能，记录 impersonate 操作。

## 5. 单点登录（SSO）
- **技术基础**：JWT、CORS 和 Ajax。
- **机制**：
1. 用户登录后，系统生成 `webappName.securedLoginId` cookie。
2. 用户点击链接，通过 `sendJWT()` 和 `loadJWT()` 方法传递 JWT。
3. 接收端通过 JWT 验证用户身份。

## 6. 示例工作流
- 用户访问 URL，系统执行一系列操作，包括路由、身份验证和业务逻辑处理。

## 7. 文档目标
- 提供用户文档、Wiki 和帮助资源。

## 8. 测试
- 包括单元测试、集成测试和 UI 测试。

## 9. 应用场景
### 9.1 党派管理（Party Management）
- **子应用**：
1. 人力资源：员工管理。
2. CRM B2C：客户（个人）管理。
3. 电子商务：用户配置文件页面。
4. 人力资源：组织/地点管理。
5. CRM B2B：客户（公司）管理。
6. 设施：员工管理。
- **组件**：
- Party：包括 Person、PartyGroup、Contact Mech.、Role、Party Identification 等。
- **屏幕**：
- 党派列表、添加/编辑、查看功能。

---

总结：Apache OFBiz 是一个功能强大的企业级框架，提供完整的开发环境、灵活的安全机制和丰富的应用场景。开发者可以通过组件化设计快速扩展功能，并通过插件实现定制化需求。