关于Plain PHP简易API的变量命名、实现及路由处理的技术问询

代码示例 #

<?php
include "./db_functions.php";

$method = $_SERVER["REQUEST_METHOD"];
$uri = parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH);
$uri = explode("/", $requestPath);
$Body = json_decode(file_get_contents("php://input"), true);

switch (end($uri)) {
    case 'topics':
        if ($method !== "GET") {
            http_response_code(405);
            exit;
        }

        $sql = "SELECT id, name FROM topic";
        $topics = getData($sql);

        echo json_encode($topics);
        break;
}
?>

技术问题解答 #

1. 上述代码中的变量命名是否简洁清晰？

整体命名偏简洁，但存在不规范和错误点：

• $Body 使用大驼峰命名，不符合PHP社区通用的小驼峰（如$body）或下划线命名风格，和其他变量的命名规则不统一。
• 未定义的$requestPath直接被使用，属于代码错误；从上下文看这个变量应该指代解析后的URI路径，命名本身没问题，但代码逻辑有漏洞。
• $method、$uri、$topics这类变量命名清晰，能直接看出用途，是合格的命名方式。

2. 采用Plain PHP构建该小型API的方式是否可接受？

完全可接受。对于功能单一、接口数量极少的小型API，Plain PHP的优势是轻量无依赖、部署成本低，不需要引入框架带来的额外复杂度。但要补全几个关键细节：

• 增加错误处理：比如数据库查询失败时，要返回500状态码和错误提示，而不是静默失败。
• 统一响应格式：不管成功还是失败，都返回标准化的JSON结构（如{"code":200,"data":[]}或{"code":405,"msg":"不允许的请求方法"}），而非直接输出数组。
• 后续扩展时要注意输入校验：如果新增带参数的接口，必须对输入数据做合法性校验，避免安全问题。

3. 小型项目中处理路由与HTTP方法的最佳实践是什么？

• 路由集中管理：用数组统一定义路由规则，比如$routes = [['method' => 'GET', 'path' => '/topics', 'handler' => 'getTopics']];，再通过循环匹配路由，比零散的switch更易维护。
• 严格绑定HTTP方法：每个路由明确指定允许的请求方法，不匹配时返回405状态码，同时通过Allow响应头告知客户端允许的方法。
• 路由与业务逻辑分离：路由只做匹配分发，业务逻辑（如数据库查询、数据处理）放在单独的函数或类中，避免把所有代码堆在路由判断里。
• 支持动态路由参数：如果需要/topics/{id}这类动态路径，用正则表达式匹配并提取参数，传递给业务处理函数。
• 统一错误响应：路由不存在、方法不允许、业务异常等场景，都返回格式一致的错误JSON，包含错误码和提示信息。
• 减少全局变量依赖：封装工具函数获取请求信息，比如getHttpMethod()、getRequestPath()，避免直接操作$_SERVER这类全局变量。

内容的提问来源于stack exchange，提问作者cheater Mr