如何确保Symfony应用健康运行？使用HealthCheckBundle轻松搞定！

<code class="bash">composer require macpaw/symfony-health-check-bundle</code>

<code class="php">// config/bundles.php
<?php

return [
    // ...
    SymfonyHealthCheckBundle\SymfonyHealthCheckBundle::class => ['all' => true],
    // ...
];</code>

<code class="yaml"># config/packages/symfony_health_check.yaml
symfony_health_check:
    # 定义健康检查项，这些检查会返回详细的状态信息
    health_checks:
        - id: symfony_health_check.doctrine_orm_check # 检查Doctrine ORM连接
        # - id: symfony_health_check.redis_check        # 检查Redis连接 (如果使用)
        # - id: your_project.custom_check              # 你自定义的检查项 (稍后介绍)

    # 定义“Ping”检查项，通常只返回一个简单的“UP”或“DOWN”状态
    ping_checks:
        - id: symfony_health_check.status_up_check

    # 如果你使用了Redis检查，需要提供DSN
    # redis_dsn: 'redis://localhost:6379'

    # 可以自定义失败时的HTTP响应码
    ping_error_response_code: 500 # Ping检查失败时返回500
    health_error_response_code: 404 # Health检查失败时返回404</code>

<code class="yaml"># config/routes/symfony_health_check.yaml
health_check:
    resource: '@SymfonyHealthCheckBundle/Resources/config/routes.xml'</code>

<code class="yaml"># config/packages/security.yaml
security:
    firewalls:
        healthcheck:
            pattern: ^/health # 匹配 /health 路径
            security: false   # 允许匿名访问
        ping:
            pattern: ^/ping   # 匹配 /ping 路径
            security: false   # 允许匿名访问
        # ... 其他防火墙规则</code>

<code class="php"><?php

declare(strict_types=1);

namespace App\Check; // 你的项目命名空间

use SymfonyHealthCheckBundle\Dto\Response;
use SymfonyHealthCheckBundle\Check\CheckInterface;

class CustomApiCheck implements CheckInterface
{
    // 假设你需要检查一个外部API的可达性
    private $httpClient;

    public function __construct(\Symfony\Contracts\HttpClient\HttpClientInterface $httpClient)
    {
        $this->httpClient = $httpClient;
    }

    public function check(): Response
    {
        try {
            $response = $this->httpClient->request('GET', 'https://api.example.com/status');
            if ($response->getStatusCode() === 200) {
                return new Response('External API Status', true, 'API is reachable and healthy.');
            } else {
                return new Response('External API Status', false, 'API returned status code: ' . $response->getStatusCode());
            }
        } catch (\Exception $e) {
            return new Response('External API Status', false, 'Failed to connect to API: ' . $e->getMessage());
        }
    }
}</code>

<code class="yaml"># config/services.yaml
services:
    App\Check\CustomApiCheck:
        arguments: ['@http_client'] # 注入HTTP客户端服务
        tags: ['container.service_subscriber'] # 如果需要其他服务，可能需要此tag

# config/packages/symfony_health_check.yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_orm_check
        - id: App\Check\CustomApiCheck # 引用你的自定义服务ID</code>

<code class="dockerfile">HEALTHCHECK --start-period=15s --interval=5s --timeout=3s --retries=3 CMD curl -sS http://localhost/health || exit 1</code>