0

0

在同一API端点处理多重请求的策略与实践

DDD

DDD

发布时间:2025-10-30 11:04:14

|

566人浏览过

|

来源于php中文网

原创

在同一API端点处理多重请求的策略与实践

本文探讨了如何在同一api端点有效处理多个不同请求的策略。通过在客户端使用查询字符串参数区分请求,并在服务器端基于这些参数动态分派业务逻辑,可以实现灵活且高效的api设计。这种方法避免了为每个细微操作创建独立端点的冗余,提升了代码的可维护性和api的清晰度,尤其适用于需要从同一资源获取不同类型或格式数据的场景。

引言:单端点多请求的挑战

在Web开发中,我们经常会遇到需要从同一个后端资源(例如 /specialties)获取不同类型或格式数据的情况。例如,可能需要获取所有专业列表,或者获取与特定专业相关的科目列表。如果为每个细微的数据获取操作都创建一个独立的API端点,可能会导致API结构冗余且难以管理。原始代码示例中,UI层试图通过两次独立的 fetch 调用访问同一URL,而BLL层则试图在接收到对 /specialties 的请求时,顺序执行 getSpecialties() 和 getSubjectsSpecial()。这种方法存在两个主要问题:

  1. 服务器响应单一性: HTTP请求通常预期服务器返回一个单一的、明确的响应。服务器端在处理一个请求时,如果先后调用两个函数并都尝试 echo json_encode(),最终客户端只能接收到最后一个 echo 的输出,或者由于响应头已发送而导致错误。
  2. 客户端请求的模糊性: 客户端发出的两个 fetch 请求都是 http://server-npk-web-core/specialties,服务器无法区分这两个请求的具体意图,从而无法准确地响应所需的数据。

为了解决这些问题,我们需要一种机制,允许客户端在请求同一端点时明确表达其意图,同时让服务器能够根据这些意图执行相应的业务逻辑。

解决方案:利用查询字符串参数进行请求分派

最直接且有效的解决方案是利用HTTP的查询字符串参数。客户端可以在发送请求时,通过URL中的查询参数来指定其具体的操作意图。服务器端则解析这些参数,并根据其值来分派到不同的处理函数。

1. 客户端(UI层)改造

在JavaScript的 fetch API中,可以通过在URL后面添加 ?key=value 的形式来传递查询参数。我们将为每个不同的请求指定一个 action 参数。

现在,客户端的每个 fetch 请求都清晰地表达了它希望服务器执行的“动作”。

Decktopus AI
Decktopus AI

AI在线生成高质量演示文稿

下载

2. 服务器端(BLL层)改造

在PHP后端,我们可以通过 $_GET 超全局变量来访问URL中的查询参数。然后,使用 switch 语句根据 action 参数的值来调用相应的业务逻辑函数。

setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);

    /**
     * 从数据库获取所有专业列表并以JSON格式输出
     * @param PDO $pdo 数据库连接对象
     */
    function getSpecialties($pdo){
      $specialties = 'SELECT * FROM `specialties`';
      $stmt = $pdo -> query($specialties);
      $specialtiesList = [];
      while ($special = $stmt->fetch(PDO::FETCH_ASSOC)){ // 使用PDO::FETCH_ASSOC获取关联数组
        $specialtiesList[] = $special;
      }
      header('Content-Type: application/json'); // 设置响应头为JSON
      echo json_encode($specialtiesList);
    }

    /**
     * 从数据库获取特定专业的科目列表并以JSON格式输出
     * @param PDO $pdo 数据库连接对象
     */
    function getSubjectsSpecial($pdo){
      // 注意:这里的 id_specialties = 2 是硬编码,实际应用中可能需要从请求中获取
      $subjectsSpecial = 'SELECT `subjects`.`title` FROM `subjects` WHERE `id_specialties` = 2';
      $stmt = $pdo -> query($subjectsSpecial);
      $subjectsSpecialList = [];
      while ($subjectSpecial = $stmt->fetch(PDO::FETCH_ASSOC)){
        $subjectsSpecialList[] = $subjectSpecial;
      }
      header('Content-Type: application/json'); // 设置响应头为JSON
      echo json_encode($subjectsSpecialList);
    }

    // 检查是否存在 'action' 查询参数
    if( !empty( $_GET['action'] ) ){

        switch( $_GET['action'] ){
            case 'specialties':
                getSpecialties($pdo);
                break; // 确保执行完后跳出
            case 'subjectsspecial':
                getSubjectsSpecial( $pdo );
                break; // 确保执行完后跳出
            default:
                // 如果 action 参数值不匹配任何已知操作,返回错误
                header('HTTP/1.1 400 Bad Request');
                header('Content-Type: application/json');
                echo json_encode(['error' => '未知操作类型']);
                break;
        }
        exit; // 确保在处理完请求后终止脚本执行,避免输出额外内容
    } else {
        // 如果没有提供 action 参数,可以返回一个默认响应或错误
        header('HTTP/1.1 400 Bad Request');
        header('Content-Type: application/json');
        echo json_encode(['error' => '缺少操作参数']);
        exit;
    }

?>

注意事项:

  • header('Content-Type: application/json');: 在 echo json_encode() 之前设置正确的 Content-Type 响应头至关重要,它告诉客户端响应体是JSON格式。
  • break;: 在 switch 语句的每个 case 块末尾使用 break 是标准做法,确保只执行匹配的逻辑。
  • exit;: 在服务器端处理完请求并发送响应后,立即使用 exit; 终止脚本执行是一个好习惯。这可以防止在特定条件下意外地输出额外的HTML或其他内容,从而破坏JSON响应的完整性。
  • 错误处理: default 分支用于处理未知的 action 参数,并返回一个HTTP 400 Bad Request 错误,告知客户端请求无效。同时,也应处理 action 参数缺失的情况。
  • 数据库连接 ($pdo): 示例代码假设 $pdo 数据库连接对象已经初始化。在实际应用中,您需要在脚本开始时建立数据库连接。
  • 参数化查询: 在 getSubjectsSpecial 函数中,id_specialties = 2 是硬编码的。在实际应用中,如果 id_specialties 是从客户端传递的,务必使用参数化查询来防止SQL注入攻击。例如:
    function getSubjectsSpecial($pdo, $specialtyId){
        $stmt = $pdo->prepare('SELECT `subjects`.`title` FROM `subjects` WHERE `id_specialties` = :id');
        $stmt->bindParam(':id', $specialtyId, PDO::PARAM_INT);
        $stmt->execute();
        // ...
    }
    // 在 switch 语句中调用:
    // case 'subjectsspecial':
    //     $specialtyId = isset($_GET['specialty_id']) ? (int)$_GET['specialty_id'] : null;
    //     if ($specialtyId) {
    //         getSubjectsSpecial($pdo, $specialtyId);
    //     } else {
    //         // 处理缺少 specialty_id 的错误
    //     }
    //     break;

总结

通过在客户端请求中引入查询字符串参数,并在服务器端基于这些参数进行逻辑分派,我们成功地在同一个API端点上实现了多个不同请求的处理。这种方法具有以下优点:

  • API设计清晰: 尽管是同一个端点,但通过 action 参数明确了每个请求的意图。
  • 代码可维护性: 将相关操作聚合在同一端点下,避免了端点数量的爆炸式增长,使得API结构更易于理解和维护。
  • 灵活性: 方便后续扩展新的操作,只需添加新的 action 值和对应的处理逻辑即可。
  • 资源复用: 可以在同一文件中管理与该资源相关的所有逻辑。

这种模式在构建RESTful API时非常常见,尤其适用于对同一资源进行不同“视图”或“操作”的获取请求。在设计API时,应始终考虑如何通过清晰的接口设计来提升其可用性和可维护性。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2827

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1695

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1553

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

1036

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1505

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1256

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1609

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1307

2023.11.13

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 1.9万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 807人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号