如何使用 PHP 的内置 Web 服务器快速测试网站

已发表: 2022-08-11

显示 PHP 徽标的插图

需要快速启动 Web 服务器来测试 PHP 应用程序? PHP 解释器有一个内置的! 您可以使用它来快速检查您的工作,而无需运行 Apache、NGINX 或容器化解决方案。

PHP 的集成服务器相对较少受到关注,但对于开发目的来说非常强大。 在本指南中,我们将展示如何使用它来替代其他微服务器,例如 Python 的 SimpleHTTPServer 或 http-server npm 包,它们都不能执行 PHP 脚本。

使用内置服务器

内置服务器是一种便利机制,可帮助您在缺乏成熟 HTTP 服务器的环境中测试 PHP 站点。 它在 PHP 5.4 和所有更高版本中可用。 您可以直接从工作目录运行它,而无需先设置虚拟主机。

在使用服务器之前,请注意它仅供开发使用。 PHP 文档明确警告不要在生产应用程序前部署此服务器。 在可公开访问的网络上公开它不够安全。

启动服务器

通过将-S标志传递给php可执行文件来启动服务器:

 $ php -S 本地主机:8080
[Fri Jun 10 16:00:00 2022] PHP 8.1.5 Development Server (http://localhost:8080) 启动

给命令的参数指定服务器的监听地址。 在上面的示例中,我们在localhost上使用了端口8080 。 现在您可以在 Web 浏览器中访问http://localhost:8080以访问工作目录中的内容。 当您请求它们时,任何 PHP 脚本都会自动执行。

您可以通过在启动服务器时设置-t标志来提供工作目录之外的路径:

 $ php -S localhost:8080 -t /home/$USER/public_docs

文档根目录现在将是您的主文件夹中的/public_docs

使用 Web 服务器时,请保持终端窗口打开。 完成网站测试后,按 Ctrl+C 终止该进程。 PHP 会将每个传入的请求记录到您的终端窗口中,包括 URI 和 HTTP 方法。 任何未捕获的 PHP 错误也会显示在日志中。

启用远程访问

localhost上侦听将不允许来自网络上其他设备的传入连接。 您可以通过绑定到0.0.0.0来允许远程访问:

 $ php -S 0.0.0.0:8080

请记住,服务器并未针对生产用途进行强化,也不应公开。 仅在绝对必要时才允许远程访问,例如在移动设备上测试特定功能时。 确保您使用的端口未对互联网开放。

请求回退匹配

当传入请求缺少 URI 组件时,PHP 将在活动文档根目录中查找index.phpindex.html文件。 如果这些文件都不存在,服务器将继续向上移动目录树,在您的文档根目录的父目录之一中查找索引。 这意味着您可能会无意中最终提供位于您指定目录之外的内容。 当到达树的顶部而没有找到索引文件时,将发出 404 Not Found 状态。

包含 URI(例如/file )的请求必须与文档根目录中的静态文件完全匹配。 否则将返回 404。 对于最流行的文件扩展名,PHP 自动将Content-Type响应标头设置为所服务文件的 MIME 类型。

使用路由器脚本

您可以选择将 Web 服务器配置为在每个请求上调用脚本。 这使您可以使用应用程序的前端控制器来执行高级动态路由。

启动服务器时,通过在命令行上提供 PHP 文件名来启用路由器功能:

 $ php -S localhost:8080 router.php

PHP 现在将使用router.php来处理每个传入的请求。 您可以通过检查请求 URI 将用户路由到应用程序中的适当点:

 if ( $_SERVER [ "REQUEST_URI" ] === "/dashboard" ) {
    需要一次dashboard.php   
}
否则if ( $_SERVER [ "REQUEST_URI" ] === "/profile" ) {
    要求一次profile.php   
}
否则{
    要求一次404.php   
}

路由器脚本产生的输出将成为发送回客户端的响应。 一个例外是脚本返回false :在这种情况下,PHP 将回退到返回与原始请求 URI 匹配的静态文件。

 if ( str_starts_with ( $_SERVER [ "REQUEST_URI" ] , "/api" ) ) {
    // 路由到正确的 API 端点
    // ...
}
否则{
    // 静态服务其他路由
    返回
}

从您的 PHP 代码中检测内置服务器

您的 PHP 代码可以通过检查活动接口名称来检测它是否被内置 Web 服务器调用。 php_sapi_name()函数提供了这个值。 当脚本被集成服务器组件调用时,它将被设置为cli-server

 if ( php_sapi_name ( ) === "cli-server" ) {
    enable_development_mode ( ) ;
}

同时处理多个请求

服务器默认运行在单进程同步模式下。 请求被单独处理并相互阻止执行,直到它们完成。 这也是服务器不适合生产使用的原因之一。

PHP 7.4 添加了对同时处理多个请求的支持。 它依赖于fork()可用性并且在 Windows 上不起作用。 启用此模式后,服务器将派生一个新的工作人员来服务每个传入的请求。 您可以通过将PHP_CLI_SERVER_WORKERS环境变量设置为您想要的工作人员数量来激活它:

 $ PHP_CLI_SERVER_WORKERS=8 php -S localhost:8080

此功能在 PHP 8.1 中仍被标记为实验性的。

概括

PHP 有一个内置的 Web 服务器,它是一种方便的方式来测试您的应用程序并在您的本地网络上快速公开本地文件系统内容。 它支持 PHP 脚本执行、包罗万象的路由和具有最常见 MIME 类型的静态文件。

尽管服务器现在支持可选的分叉模式,但不建议在生产中使用它。 它旨在作为开发辅助工具,缺少公共部署所需的自定义和安全功能。 它擅长的地方是作为传统开发平台(如 WAMP、XAMPP 和 Docker 容器)的轻量级和集成替代品。