OmBox2026 开发者文档OmBox2026 开发者文档
指南
API文档
示例
改进记录
GitHub
指南
API文档
示例
改进记录
GitHub
OmBox2026 开发者文档

OmBox2026 开发者文档

企业级业务管理平台开发文档

快速开始API文档

🚀 高性能

基于Yii2框架,配备Redis缓存系统,支持高并发访问

⚡ 实时通信

集成WebSocket实时通信,支持消息推送和数据实时更新

🔒 安全可靠

完善的权限系统,防穿透/击穿/雪崩缓存防护机制

📦 模块化设计

清晰的分层架构,支持Service层、DTO模式、Repository模式

🛠️ 易于扩展

良好的扩展性设计,支持自定义组件和行为

📚 完善文档

详细的开发文档、API文档和示例代码

🎯 核心功能

Redis缓存系统

完整的缓存管理系统,包含防护三件套:

  • 防穿透: 空值缓存,避免恶意查询
  • 防击穿: 互斥锁机制,防止缓存失效瞬间
  • 防雪崩: 随机过期时间,避免集中失效
// 基础使用
$cache = Yii::$app->cache;
$value = $cache->remember('key', function() {
    return heavyQuery();
});

// 使用辅助类
$user = CacheHelper::cacheUser(1, function() {
    return User::findOne(1);
});

WebSocket实时通信

基于Workerman的实时通信系统:

  • 实时消息推送: 点对点、频道广播、系统通知
  • 在线状态同步: 用户上线/下线、在线用户列表
  • 数据实时更新: Model自动触发、客户端监听
// Model自动更新
class User extends ActiveRecord
{
    public function behaviors() {
        return [
            'realtimeUpdate' => RealtimeUpdateBehavior::class,
        ];
    }
}

// 手动推送
Yii::$app->websocket->sendToUser(1, [
    'type' => 'notification',
    'content' => '您有新消息'
]);

📖 开始使用

安装

# 克隆项目
git clone https://github.com/ombox/ombox2026.git

# 安装依赖
composer install

# 配置数据库
cp common/config/db.php.example common/config/db.php

# 运行迁移
php yii migrate

配置

// common/config/main.php
return [
    'components' => [
        'cache' => [
            'class' => 'common\services\CacheService',
        ],
        'websocket' => [
            'class' => 'common\services\WebSocketService',
        ],
    ],
];

启动服务

# 启动WebSocket服务器
php websocket/server.php start -d

# 访问应用
http://your-domain/

🔗 快速链接

  • 快速开始指南
  • 项目结构说明
  • Service层开发
  • 缓存系统使用
  • WebSocket实时通信
  • API认证

📊 项目统计

  • 代码行数: 3,265+ 行新增功能代码
  • 测试覆盖: 81项测试,100%通过率
  • 核心方法: 75+ 个核心方法
  • 文档页面: 30+ 个文档页面

🤝 贡献

欢迎提交问题和拉取请求!

📄 许可证

MIT License

MIT Licensed | Copyright © 2026 OmBox2026