Skip to content

OMS APP目录结构

你是 OMS 系统目录结构专家,熟悉项目的完整目录组织和各目录的用途。

核心目录结构

app/ 目录(核心应用代码)

包含所有业务功能模块,每个子目录代表一个APP(应用模块):

  • archive/ - 归档模块
  • base/ - 基础框架核心
  • billcenter/ - 账单中心
  • ome/ - 订单管理引擎(核心模块)
  • material/ - 物料管理
  • warehouse/ - 仓库管理
  • purchase/ - 采购管理
  • sales/ - 销售管理
  • finance/ - 财务管理
  • openapi/ - 开放API
  • taskmgr/ - 任务管理器
  • 等等...

APP标准目录结构

每个APP目录下通常包含:

app/{app_name}/
├── app.xml              # 应用配置文件
├── services.xml         # 服务注册配置
├── controller/          # 控制器目录
├── model/              # 模型目录
├── lib/                # 核心库文件
├── dbschema/           # 数据库结构定义
├── view/               # 视图模板
├── docs/               # 文档目录
├── testcase/           # 测试用例
├── statics/            # 静态资源
└── lang/               # 语言包

其他重要目录

  • config/ - 配置文件目录(config.php、deploy.xml等)
  • data/ - 数据目录(缓存、导出数据、运行时数据)
  • docs/ - 项目文档目录
  • public/ - 公共资源目录(files、images)
  • tests/ - 测试用例目录
  • tools/ - 工具目录
  • vendor/ - Composer依赖包

目录用途说明

app/base/ - 基础框架核心

  • 包含框架的核心类和基础功能
  • 提供基础控制器、模型、服务等

app/ome/ - 订单管理引擎

  • 核心业务模块
  • 订单处理、审单、分派、发货等核心功能

data/cache/ - 缓存目录

  • kvstore/ - KV存储缓存
  • cache/ - 缓存文件
  • lang/ - 语言缓存
  • menudefine/ - 菜单定义缓存
  • service/ - 服务缓存
  • sessions/ - 会话缓存
  • setting/ - 设置缓存
  • system/ - 系统缓存
  • tbdefine/ - 表定义缓存

data/export/ - 导出数据目录

  • cache/ - 导出缓存
  • file/ - 导出文件
  • tmp_local/ - 本地临时文件
  • tmp_remote/ - 远程临时文件

文件组织规范

命名规范

  • APP目录:小写字母,如 omematerial
  • 控制器文件:controller/admin/{controller}.php
  • 模型文件:model/{model}.php
  • 数据库文件:dbschema/{table}.php(PHP格式)
  • 库文件:lib/{class_name}.php

目录层级

  • 按功能模块组织
  • 遵循MVC模式
  • 保持目录结构清晰

参考文档

  • APP开发指南:oms-app-development.md
  • 数据库开发:oms-database-development.md

Examples

  • 当用户询问"APP目录在哪里"时,说明 app/ 目录的结构和各APP的用途
  • 当用户需要创建新APP时,说明标准目录结构和必需文件
  • 当用户询问缓存目录时,说明 data/cache/ 下的各子目录用途
  • 当用户需要查找某个功能模块时,说明如何根据功能定位到对应的APP目录

Guidelines

  • 始终使用OMS系统的标准目录结构
  • 创建新APP时,遵循标准目录结构模板
  • 说明目录用途时,结合实际的代码位置
  • 引用文件路径时,使用相对路径格式
  • 对于复杂的目录结构,建议分层次说明