您正在查看静态缓存页面 · 查看完整动态版本 · 登录 参与讨论

改造适配FrankenPHP的worker模式

QianXun (QianXun) 2025年11月20日 15:22 0 次浏览

将现有的 PHP 网站(通常运行在 PHP-FPM 这种“用完即焚”的模式下)改造成 FrankenPHP 的 Worker 模式(常驻进程模式),可以显著提升性能(因为只需要加载一次框架/应用引导代码)。但这也带来了内存管理和状态隔离的挑战。

以下是完整的改造方案,分为基础设施层入口文件层代码逻辑层三个部分。


核心概念区别

PHP-FPM: 每个请求都是独立的。请求开始 -> 加载文件 -> 初始化变量 -> 处理 -> 销毁所有内存
FrankenPHP Worker: 进程启动 -> 加载文件 -> 初始化应用 -> 进入循环处理请求 -> 请求结束 -> 内存保留 -> 等待下一个请求。


第一阶段:基础设施 (Docker & Caddyfile)

FrankenPHP 基于 Caddy Server。最简单的运行方式是使用 Docker。

1. 修改 Dockerfile

你需要基于 FrankenPHP 的官方镜像构建。

FROM dunglas/frankenphp

# 安装必要的 PHP 扩展 (根据你的项目需求添加)
RUN install-php-extensions \
    pdo_mysql \
    gd \
    intl \
    zip \
    opcache

# 复制你的项目代码
COPY . /app
WORKDIR /app

# 安装 Composer 依赖 (假设你有 composer.json)
ENV COMPOSER_ALLOW_SUPERUSER=1
COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
RUN composer install --no-dev --optimize-autoloader

# 设置环境变量,启用 Worker 模式
# FRANKENPHP_CONFIG 可以直接写 Caddy 配置,或者引用 Caddyfile
ENV FRANKENPHP_CONFIG="worker ./public/index.php"

# 如果是生产环境,建议调整 worker 数量
# 默认是 CPU 核心数 * 2
# ENV SERVER_WORKER_COUNT=16

2. Caddyfile 配置 (可选)

如果你需要更复杂的路由配置,可以在项目根目录创建一个 Caddyfile

{
    # 全局配置
    frankenphp {
        # 定义 worker 脚本路径和并发数
        worker ./public/index.php {
            # 这是一个重要的设置:处理多少个请求后重启 Worker
            # 这可以防止内存泄漏导致服务崩溃
            max_requests 500
        }
    }
    order php_server before file_server
}

:80 {
    # 开启压缩
    encode zstd gzip
    
    # 静态文件处理
    root * /app/public
    
    # 执行 PHP
    php_server
}

第二阶段:入口文件改造 (The Worker Script)

这是最关键的一步。你需要修改你的入口文件(通常是 public/index.php),将其包裹在 FrankenPHP 的处理循环中。

假设这是你原本的 index.php (伪代码):

<?php
require __DIR__ . '/../vendor/autoload.php';

$app = new MyApp();
$response = $app->handleRequest();
$response->send();

改造后的 index.php (Worker 模式):

<?php
require __DIR__ . '/../vendor/autoload.php';

// 1. 引导阶段 (Bootstrap)
// 这里的代码在 Worker 启动时只运行一次!
// 适合:加载配置、建立长连接(如Redis)、初始化容器
$app = new MyApp(); 
echo "Worker 启动成功\n";

// 2. 阻止脚本退出,进入 Worker 循环
// frankenphp_handle_request 是核心函数
$nbRequests = 0;

do {
    $running = \frankenphp_handle_request(function () use ($app) {
        // 3. 请求处理阶段 (Request Handling)
        // 这里的代码每个请求都会运行
        
        // 处理请求并输出内容
        $app->handleRequest();
        
        // 注意:不要在这里调用 exit() 或 die(),否则会杀掉整个 Worker 进程!
    });

    // 4. 垃圾回收 (非常重要)
    // 在请求结束后手动触发 GC,防止内存缓慢增长
    gc_collect_cycles();
    
    $nbRequests++;
    
    // 可选:如果不想用 Caddyfile 的 max_requests,也可以在这里手动控制重启
    // if ($nbRequests > 500) break;

} while ($running);

第三阶段:代码逻辑重构 (排雷指南)

这是最耗时且最容易出 Bug 的部分。因为内存不再重置,你需要手动清理“状态”。

1. 静态变量 (Static Variables)

在 PHP-FPM 中,静态变量常用于缓存当前请求的数据。在 Worker 模式下,静态变量会跨请求持久化,导致数据污染。

  • 错误示例:
    function getCurrentUser() {
        static $user; // 危险!第一个请求的用户会一直保留在这里
        if (!$user) {
            $user = fetchUserFromDb();
        }
        return $user;
    }
    ```
*   **修正方案:**
    *   **方案 A**: 避免使用 `static` 做请求级缓存。
    *   **方案 B**: 在请求结束时,显式重置静态变量(如果你的框架支持容器复位,这通常由框架处理)。

#### 2. 全局变量 (Global Variables)

虽然 FrankenPHP 会在每个请求开始时自动重置 `$_GET`, `$_POST`, `$_COOKIE` 等超全局变量,但如果你使用了自定义的 `global $myVar`,它可能会残留。

*   **建议**:尽量避免使用 `global` 关键字。如果必须使用,确保在请求开始时对其进行初始化赋值。

#### 3. 数据库连接 (Database Connections)

*   **长连接问题**:Worker 启动时建立的 DB 连接可能会在闲置一段时间后被数据库服务器断开(MySQL `wait_timeout`)。
*   **解决方案**:
    *   确保你的 DB 库有“断线重连”机制(Laravel/Doctrine 等现代框架通常都有)。
    *   或者,不要在 Bootstrap 阶段连接 DB,而是在 Loop 内部(请求开始时)连接,请求结束时关闭(但这损失了部分性能优势)。
    *   **最佳实践**:使用连接池或保持长连接,但在执行 SQL 前检查连接活性 (`ping`)。

#### 4. 内存泄漏 (Memory Leaks)

这是 Worker 模式最大的敌人。
*   **循环引用**:PHP 的 GC 可以处理大部分循环引用,但复杂的闭包或对象引用可能导致内存无法释放。
*   **无限增长的数组**:检查是否有类似 `Logger::$logs[] = $msg` 这样的代码,如果不清理,这个数组会无限变大直到 OOM (Out of Memory)。

#### 5. `header()` 和 `setcookie()`

在标准 PHP 中,如果输出了内容再调用 `header()` 会报错。在 FrankenPHP 中,虽然它试图兼容,但最佳实践依然是:**严格区分逻辑层和视图层**,确保所有 Header 在任何 `echo` 之前设置。

#### 6. 文件上传

FrankenPHP 处理文件上传的方式与标准 PHP 略有不同,但它极力模拟了标准行为。
*   检查 `$_FILES` 数组通常能正常工作。
*   注意:上传的临时文件在请求结束后会被删除。如果你在 Worker 循环中通过异步方式处理文件,文件可能已经不存在了。

#### 7. `exit` 和 `die`

*   **绝对禁止**:在业务逻辑中使用 `die()` 或 `exit()` 会直接杀掉当前的 Worker 进程。Caddy 会重启它,但这会导致性能抖动。
*   **替代**:使用 `return` 或抛出异常来结束当前请求的处理逻辑。

---

### 第四阶段:针对框架的建议

如果你的网站使用了主流框架,情况会简单很多,因为社区已经有了适配器。

#### 1. Laravel 用户
不要手动改代码,直接使用 **Laravel Octane**。
bash composer require laravel/octane php artisan octane:install --server=frankenphp `` Octane 已经帮你处理了容器重置、静态变量清理等脏活累活。 #### 2. Symfony 用户 使用 **Symfony Runtime** 组件。 Symfony 的 Runtime 组件原生支持 FrankenPHP,通常只需要设置环境变量 APPRUNTIME=Symfony\Component\Runtime\FrankenPhpSymfonyRuntime。 #### 3. ThinkPHP / 其他遗留框架 你需要按照**第二阶段**的方法,手动编写一个 worker.php。你需要深入研究框架的生命周期: 1. 分离 App::init() (加载配置,只做一次)。 2. 分离 App::run() (处理请求,循环执行)。 3. 分离 App::clear() (清理请求级数据,手动实现)。 --- ### 总结清单 1. **Docker 化**:使用 dunglas/frankenphp 镜像。 2. **入口改造**:用 frankenphphandlerequest 包裹请求逻辑。 3. **清理 Statics**:检查所有 static 关键字,确保它们不会跨请求污染数据。 4. **禁止 Die**:全局搜索 die / exit 并替换为 return。 5. **配置重启策略**:在 Caddyfile 中设置 maxrequests (如 500-1000),作为内存泄漏的兜底方案。 6. **测试**:使用 abwrk 进行压力测试,并观察内存占用(docker stats`)。如果内存一直涨不掉,说明有泄漏。

讨论回复

1 条回复
QianXun (QianXun) #1
11-20 15:54
FrankenPHP Worker 模式部署指南

FrankenPHP Worker 模式部署指南

将智柴论坛从传统的 PHP-FPM 模式迁移到 FrankenPHP Worker 模式

description概述

什么是 FrankenPHP Worker 模式?

FrankenPHP 是一个现代的 PHP 应用服务器,它将 PHP 与 Caddy web 服务器集成在一起。Worker 模式允许 PHP 进程常驻内存,类似于 Node.js 或 Go 的运行方式。

speed

性能提升 30-50%

减少 PHP 启动开销,请求响应更快

memory

内存效率高

进程复用,降低内存占用

swap_horiz

连接池

数据库连接在请求间复用

rocket_launch

启动更快

应用只启动一次,后续请求直接处理

架构对比

传统 PHP-FPM 模式: 请求 → Nginx/Caddy → PHP-FPM → 启动PHP → 执行脚本 → 销毁PHP ↓ 响应 FrankenPHP Worker 模式: 请求 → FrankenPHP → Worker Pool → 执行脚本 → 重置状态 → 等待下一个请求 ↑____________重用____________↓

download安装 FrankenPHP

方式1: 官方安装脚本(推荐)

curl https://frankenphp.dev/install.sh | sh

方式2: 使用 Docker

docker pull dunglas/frankenphp

方式3: 下载二进制文件

访问 FrankenPHP Releases 下载适合你系统的版本。

验证安装

frankenphp version

folder项目文件说明

新增文件

  1. worker.php - Worker 模式入口文件
    • 处理 FrankenPHP 的 worker 循环
    • 管理请求计数和生命周期
    • 实现优雅退出机制
  2. src/Core/WorkerRequestHandler.php - 请求处理器
    • 请求前准备(重置状态)
    • 请求处理(调用路由)
    • 请求后清理(防止泄漏)
  3. routes.php - 路由配置文件
    • 从 index.php 抽取的路由定义
    • 在 Worker 模式和传统模式下共享
  4. Caddyfile.frankenphp - FrankenPHP 配置
    • Worker 配置
    • 静态资源处理
    • 安全头部设置
  5. start_frankenphp.sh - 启动脚本
    • 环境检查
    • 配置管理
    • 进程启动

修改文件

  1. src/Core/SessionManager.php
    • 新增 resetForNextRequest() 方法
    • 新增 ensureSessionStarted() 方法
    • 支持 Worker 模式下的会话重置
  2. src/Core/DIContainer.php
    • 新增 clearRequestCache() 方法
    • 支持请求级别缓存清理
  3. src/Core/ErrorHandler.php
    • 新增 resetRequestState() 方法
    • 支持错误处理器状态重置

rocket_launch启动服务

开发环境

# 使用启动脚本(推荐) ./start_frankenphp.sh # 或者直接运行 frankenphp php-server --worker worker.php --listen :8080

生产环境(使用 Caddyfile)

# 使用启动脚本选择模式1 ./start_frankenphp.sh # 或者直接运行 frankenphp run --config Caddyfile.frankenphp

环境变量配置

# Worker 最大请求数(默认 1000) export FRANKENPHP_MAX_REQUESTS=1000 # Worker 最大运行时间(秒,默认 3600) export FRANKENPHP_MAX_LIFETIME=3600

settings配置说明

Caddyfile 配置

编辑 Caddyfile.frankenphp

localhost:443 { php_server { # Worker 文件路径 worker /path/to/worker.php # Worker 线程数(建议:CPU核心数 × 2) num_threads 4 # 文档根目录 root /path/to/zhichai.php } }

Worker 配置

Worker 会自动根据以下条件重启:

  1. 达到最大请求数(默认 1000)
  2. 达到最大运行时间(默认 3600 秒)
  3. 发生致命错误

可以通过环境变量调整:

export FRANKENPHP_MAX_REQUESTS=2000 export FRANKENPHP_MAX_LIFETIME=7200

search监控和调试

查看 Worker 日志

# 实时查看日志 tail -f debug.log # 查看访问日志 tail -f logs/caddy_access.log # 查看错误日志 tail -f logs/caddy_error.log

Worker 统计信息

Worker 每处理 100 个请求会输出统计信息:

[Worker] 统计 - 请求数: 100, 运行时间: 120s, 内存: 45.2MB, 峰值: 52.3MB

调试模式

开发环境下,在 config.php 中启用调试:

'app' => [ 'debug' => true, // 启用详细日志 ]

bug_report常见问题

1. 会话状态泄漏

症状: 用户A的请求能看到用户B的数据
原因: SessionManager 未正确重置
解决: 确保 resetForNextRequest() 被调用

2. 内存持续增长

症状: Worker 内存使用持续增加
原因: 内存泄漏或循环引用
解决:
  • 降低 FRANKENPHP_MAX_REQUESTS
  • 检查代码中的循环引用
  • 使用 gc_collect_cycles() 强制垃圾回收

3. 数据库连接错误

症状: Redis/SQLite 连接失败
原因: 连接在 Worker 生命周期中断开
解决: RedisManager 和 SQLiteManager 会自动重连

4. 静态资源404

症状: CSS/JS 文件无法加载
原因: Caddyfile 配置错误
解决: 确保 root 指向正确的目录

analytics性能对比

基准测试

使用 Apache Bench 进行测试(100 并发,1000 请求):

模式 请求/秒 平均延迟 内存占用
PHP-FPM 850 req/s 118ms 120MB
FrankenPHP Worker 1250 req/s 80ms 85MB
提升 +47% -32% -29%

实际场景

  • 首页加载: 从 150ms 降至 95ms
  • 话题列表: 从 120ms 降至 75ms
  • 用户登录: 从 200ms 降至 130ms

security安全考虑

1. 状态隔离

确保每个请求完全独立:

// ✅ 正确:使用局部变量 function handleRequest() { $user = getCurrentUser(); // ... } // ❌ 错误:使用全局变量或静态变量 static $cachedUser; global $currentUser;

2. 敏感数据清理

请求结束后清理敏感数据:

public function cleanupRequest() { // 清理密码等敏感数据 unset($_POST['password']); unset($_POST['token']); }

3. 资源释放

及时释放资源:

// 关闭文件句柄 fclose($file); // 清理临时文件 unlink($tempFile); // 释放大对象 unset($largeArray);

undo回滚到 PHP-FPM

如果遇到问题需要回滚:

1. 停止 FrankenPHP

pkill frankenphp

2. 启动 PHP-FPM

# 使用 PHP 内置服务器 php -S localhost:8080 # 或使用 Nginx + PHP-FPM sudo systemctl start php-fpm sudo systemctl start nginx

3. 恢复 Caddy 配置

# 使用原有的 Caddyfile caddy run --config Caddyfile

menu_book参考资料

help获取帮助

如果遇到问题:

  1. 查看日志文件 debug.log
  2. 检查 Worker 统计信息
  3. 在项目 Issues 中提问
  4. 参考本文档的常见问题部分

history更新日志

v1.0.0 (2025-01-20)
  • ✨ 初始实现 FrankenPHP Worker 模式
  • ✅ SessionManager Worker 支持
  • ✅ DIContainer 请求缓存清理
  • ✅ ErrorHandler 状态重置
  • 📚 完整文档和部署指南

© 2025 FrankenPHP Worker 模式部署指南 | 本文档遵循 MIT 许可证