萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP 運行環境偵測:php_sapi_name() 完整應用指南

核心函數

php_sapi_name() 回傳 PHP 與 Web 伺服器互動的介面類型(SAPI:Server API),是判斷執行環境的標準方式。

常見回傳值對照表

執行環境php_sapi_name() 回傳值備註
Apache 模組模式apache2handler最常見的生產環境
Nginx + PHP-FPMfpm-fcgi現代主流部署架構
CGI / FastCGIcgi-fcgi傳統共享主機環境
命令列模式 (CLI)cli腳本、排程任務、Artisan 等
內建開發伺服器cli-serverPHP 5.4+ php -S
Apache CGIcgi較少見
IIS (ISAPI/FastCGI)isapi / cgi-fcgiWindows 環境

實戰應用範例

1. 區分 Web 請求與 CLI 腳本

<?php
if (php_sapi_name() === 'cli') {
    // 命令列模式:啟用詳細日誌、關閉輸出緩衝
    ini_set('display_errors', 1);
    error_reporting(E_ALL);
} else {
    // Web 模式:正常錯誤處理、啟用 Session
    session_start();
}
?>

2. 環境專屬配置載入

<?php
$sapi = php_sapi_name();

$config = [
    'cli' => [
        'memory_limit' => '512M',
        'max_execution_time' => 0,
        'log_path' => '/var/log/cli/',
    ],
    'fpm-fcgi' => [
        'memory_limit' => '256M',
        'max_execution_time' => 30,
        'log_path' => '/var/log/fpm/',
    ],
    'apache2handler' => [
        'memory_limit' => '128M',
        'max_execution_time' => 30,
        'log_path' => '/var/log/apache/',
    ],
];

$envConfig = $config[$sapi] ?? $config['fpm-fcgi'];
foreach ($envConfig as $key => $value) {
    ini_set($key, $value);
}
?>

3. 安全性檢查:防止 CLI 腳本被 Web 訪問

<?php
// 僅允許 CLI 執行的維護腳本
if (php_sapi_name() !== 'cli') {
    http_response_code(403);
    die('Forbidden: CLI only script');
}

// 執行資料庫遷移、清理快取等敏感操作
?>

進階:結合 PHP_OS 常數判斷作業系統

<?php
echo "SAPI: " . php_sapi_name() . "\n";
echo "OS: " . PHP_OS . "\n"; // Linux, Darwin, WINNT 等
echo "PHP 版本: " . PHP_VERSION . "\n";

// 完整環境資訊
$info = [
    'sapi' => php_sapi_name(),
    'os' => PHP_OS,
    'php_version' => PHP_VERSION,
    'zend_version' => zend_version(),
    'is_cli' => (php_sapi_name() === 'cli'),
    'is_web' => (php_sapi_name() !== 'cli'),
];
print_r($info);
?>

注意事項

  • 不可靠的偽造:此函數回傳值由 PHP 核心決定,使用者無法輕易偽造
  • FastCGI 統一性:PHP-FPM、mod_fcgid、IIS FastCGI 皆回傳 cgi-fcgi 或 fpm-fcgi
  • 常數替代:PHP_SAPI 常數與 php_sapi_name() 回傳值相同,效能略優
copyright © 萬盛學電腦網 all rights reserved