README

DoBee 是基于 FastD 组件生态构建的高性能 PHP API 框架骨架，完全支持 Swoole 协程运行，提供简洁优雅的开发体验。

✨ 特性

🚀 高性能 - 基于 Swoole 协程，性能远超传统 PHP-FPM
📦 组件化 - 完全采用 FastD 8.0 组件，松耦合设计
🎯 PSR 标准 - 遵循 PSR-7/11/15/17/18 标准
🔧 简洁配置 - 清晰的配置文件结构，易于理解和扩展
🌐 HTTP 服务 - 支持 Swoole HTTP 服务器和传统 FastCGI
💾 缓存支持 - 集成文件系统、Redis 等多种缓存后端
🗄️ 数据库 - 基于 Medoo 的轻量级数据库操作，支持连接池
🎭 中间件 - PSR-15 中间件支持，灵活扩展
📡 事件驱动 - 完整的事件监听器机制

📋 环境要求

PHP: >= 8.2
Swoole: >= 4.5 (可选，用于协程模式)
扩展:
- ext-swoole (可选)
- ext-pdo
- ext-json
- ext-curl

📦 安装

方式一：使用 Composer 创建项目（推荐）

composer create-project fastd/dobee myapp
cd myapp

方式二：克隆仓库后安装

git clone https://github.com/fastdlabs/dobee.git
cd dobee
composer install

方式三：手动添加到现有项目

composer require fastd/dobee

🚀 快速开始

1. 项目结构

myapp/
├── config/              # 配置文件
│   ├── cache.php       # 缓存配置
│   ├── command.php     # 命令配置
│   ├── database.php    # 数据库配置
│   ├── listener.php    # 监听器配置
│   ├── process.php     # 进程配置
│   ├── route.php       # 路由配置
│   ├── service.php     # 服务配置
│   └── swoole.php      # Swoole 配置
├── src/                # 应用代码
│   ├── bootstrap.php   # 引导文件
│   ├── command/        # 控制台命令
│   ├── http/           # HTTP 处理器
│   ├── listener/       # 事件监听器
│   ├── process/        # 自定义进程
│   └── server/         # 服务器监听器
├── tests/              # 测试文件
└── web/                # Web 入口
    └── index.php

2. 配置数据库

编辑 config/database.php:

return [
    'default' => [
        'type' => 'mysql',
        'host' => '127.0.0.1',
        'database' => 'dobee',
        'username' => 'root',
        'password' => '',
        'charset' => 'utf8mb4',
        'port' => 3306,
    ],
];

3. 配置缓存

编辑 config/cache.php:

return [
    'file' => [
        'adapter' => [
            'class' => \Symfony\Component\Cache\Adapter\FilesystemAdapter::class,
            'dsn' => null,
        ],
        'namespace' => 'dobee',
        'lifetime' => 3600,
        'directory' => __DIR__ . '/../runtime/cache',
    ],
];

4. 定义路由

编辑 config/route.php:

return [
    ['GET', '/', \http\Welcome::class],
    ['GET', '/users', \http\UserController::class . '@index'],
    ['POST', '/users', \http\UserController::class . '@store'],
];

5. 创建 HTTP 处理器

创建 src/http/UserController.php:

<?php

declare(strict_types=1);

namespace http;

use FastD\Http\Response\Json;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;

class UserController implements MiddlewareInterface
{
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        $db = container()->get('medoodb')->getDatabase('default');
        $users = $db->select('users', '*');
        
        return new Json(200, [
            'status' => 'success',
            'data' => $users,
        ]);
    }
}

🛠️ 运行方式

开发环境 (FastCGI)

# 使用 PHP 内置服务器
php -S localhost:8080 -t web/

生产环境 (Swoole)

# 启动 Swoole 服务器
php bin/server start

# 查看状态
php bin/server status

# 停止服务器
php bin/server stop

# 重启服务器
php bin/server restart

📝 使用示例

HTTP 健康检查示例

所有示例统一输出服务状态：

FastD Health Check

Cache: ✓ Connected
Database: ✓ Connected

查看 src/http/Welcome.php 了解完整实现。

使用缓存

$cachePool = container()->get('cache');
$fileCache = $cachePool->getCache('file');

// 写入缓存
$cacheItem = $fileCache->getItem('user_1');
$cacheItem->set(['name' => 'John']);
$cacheItem->expiresAfter(3600);
$fileCache->save($cacheItem);

// 读取缓存
$item = $fileCache->getItem('user_1');
if ($item->isHit()) {
    $user = $item->get();
}

使用数据库

$dbPool = container()->get('medoodb');
$db = $dbPool->getDatabase('default');

// 查询
$users = $db->select('users', '*', ['status' => 1]);

// 插入
$db->insert('users', [
    'name' => 'John',
    'email' => 'john@example.com',
]);

// 更新
$db->update('users', ['status' => 0], ['id' => 1]);

// 删除
$db->delete('users', ['id' => 1]);

命令行命令

创建 src/command/GreetCommand.php:

<?php

declare(strict_types=1);

namespace command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class GreetCommand extends Command
{
    protected function configure(): void
    {
        $this->setName('greet');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $output->writeln('Hello from DoBee!');
        return 0;
    }
}

运行命令：

php bin/console greet

🧪 测试

composer install
vendor/bin/phpunit

📚 依赖组件

DoBee 基于 FastD 8.0 组件生态：

{
    "require": {
        "fastd/cache": "^8.0",
        "fastd/container": "^8.0",
        "fastd/config": "^8.0",
        "fastd/http": "^8.0",
        "fastd/event": "^8.0",
        "fastd/routing": "^8.0",
        "fastd/medoodb": "^8.0",
        "fastd/swoole": "^8.0",
        "fastd/fastd": "^8.0"
    }
}

所有组件均遵循 PSR 标准，完全兼容 PHP 8.2+。

📖 文档

FastD 框架: https://github.com/fastdlabs/fastd
组件文档: 各组件仓库 README
Swoole 文档: https://www.swoole.com/

🤝 贡献

欢迎提交 Issue 和 Pull Request！

📄 License

MIT License

fastd / dobee

Maintainers

Package info

Statistics

Security