PHP文件作为API端点与内部库调用的设计与实践

// api_helper.php
function getDatafromAPI($gstNo){
    // ... 获取API数据的逻辑 ...
    return $response;
}

$gstNo = $_GET['gstNo']; // 问题所在：在后端调用时，$_GET['gstNo'] 未定义
if (!empty($gstNo)) {
    echo getDatafromAPI($gstNo); // 问题所在：在后端调用时，此行会被执行并输出
}

<?php
// api_helper.php

/**
 * 从API获取数据。
 *
 * @param string $gstNo GST编号。
 * @return string 模拟的API响应数据。
 */
function getDatafromAPI($gstNo){
    // 实际应用中，这里会包含调用外部API或数据库的复杂逻辑
    // 为演示目的，返回一个简单的字符串
    return "成功获取GST编号 " . htmlspecialchars($gstNo) . " 的数据。";
}

// --- API 端点处理逻辑 ---
// 此代码块仅在脚本被直接通过HTTP请求访问时执行
// 并且确保请求方法为GET且包含'gstNo'参数
if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'GET' && isset($_GET['gstNo'])) {
    $gstNo = $_GET['gstNo'];

    // 基本的输入验证
    if (!empty($gstNo)) {
        $response_data = getDatafromAPI($gstNo);

        // 设置响应头，声明返回JSON格式
        header('Content-Type: application/json');
        // 将结果封装为JSON对象返回
        echo json_encode(['status' => 'success', 'data' => $response_data]);
    } else {
        // 参数缺失或无效时的错误响应
        header('Content-Type: application/json');
        // 设置HTTP状态码为400 Bad Request
        http_response_code(400);
        echo json_encode(['status' => 'error', 'message' => 'GST编号是必需的。']);
    }
    // 关键：在API请求处理完成后立即终止脚本执行
    exit();
}

// 如果脚本是被其他PHP文件包含，上述if条件不满足，
// 只有函数定义被加载，全局逻辑不会执行。
?>

// file.tpl (或您的JavaScript文件)
var gstNo = $('#gstNo').val(); // 假设页面中有ID为'gstNo'的输入框

jQuery.ajax({
    method: "GET",
    dataType: 'json', // 明确指定期望的返回数据类型为JSON
    url: "api_helper.php?gstNo=" + encodeURIComponent(gstNo), // 使用encodeURIComponent编码参数
    success: function(response) {
        if (response.status === 'success') {
            console.log("前端接收到数据:", response.data);
            // 在这里处理返回的数据，例如更新页面元素
            alert("数据获取成功: " + response.data);
        } else {
            console.error("API错误:", response.message);
            alert("数据获取失败: " + response.message);
        }
    },
    error: function(jqXHR, textStatus, errorThrown) {
        console.error("AJAX请求失败:", textStatus, errorThrown);
        alert("网络请求失败，请稍后再试。");
    }
});

<?php
// fileProcess.php

// 包含 api_helper.php，现在它只会加载函数定义
include_once 'api_helper.php'; // 使用 include_once 避免重复包含

$GSTIN = 'XYZ12345'; // 示例GSTIN
$response_from_backend = getDataFromAPI($GSTIN); // 直接调用函数

echo "后端处理完成。从API辅助函数获取的响应: " . $response_from_backend . "\n";

// 后续可以继续进行其他后端逻辑
// 例如，将数据存储到数据库，或进行进一步处理
?>

<?php
// api_functions.php

/**
 * 从API获取数据。
 *
 * @param string $gstNo GST编号。
 * @return string 模拟的API响应数据。
 */
function getDatafromAPI($gstNo){
    // 实际应用中，这里会包含调用外部API或数据库的复杂逻辑
    return "【函数库】成功获取GST编号 " . htmlspecialchars($gstNo) . " 的数据。";
}

// 可以在此文件中定义其他相关的辅助函数
// function anotherUtilityFunction(...) { ... }

?>

<?php
// api_endpoint.php

// 包含函数库文件
include_once 'api_functions.php';

// 确保是GET请求且包含'gstNo'参数
if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'GET' && isset($_GET['gstNo'])) {
    $gstNo = $_GET['gstNo'];

    if (!empty($gstNo)) {
        $response_data = getDatafromAPI($gstNo); // 调用函数库中的函数

        header('Content-Type: application/json');
        echo json_encode(['status' => 'success', 'data' => $response_data]);
    } else {
        header('Content-Type: application/json');
        http_response_code(400);
        echo json_encode(['status' => 'error', 'message' => 'GST编号是必需的。']);
    }
    exit();
} else {
    // 处理无效的API请求（例如，非GET请求或缺少参数的直接访问）
    header('Content-Type: application/json');
    http_response_code(400); // Bad Request
    echo json_encode(['status' => 'error', 'message' => '无效的API请求。']);
    exit();
}
?>

<?php
// fileProcess.php

// 包含纯函数库文件
include_once 'api_functions.php';

$GSTIN_backend = 'DEF67890'; // 示例GSTIN
$backend_result = getDataFromAPI($GSTIN_backend); // 直接调用函数

echo "后端处理完成。从函数库获取的响应: " . $backend_result . "\n";

// 后续其他后端逻辑
?>

// file.tpl (或您的JavaScript文件)
var gstNo = $('#gstNo').val();

jQuery.ajax({
    method: "GET",
    dataType: 'json',
    url: "api_endpoint.php?gstNo=" + encodeURIComponent(gstNo), // 指向新的API入口文件
    success: function(response) {
        if (response.status === 'success') {
            console.log("前端接收到数据:", response.data);
            alert("数据获取成功: " + response.data);
        } else {
            console.error("API错误:", response.message);
            alert("数据获取失败: " + response.message);
        }
    },
    error: function(jqXHR, textStatus, errorThrown) {
        console.error("AJAX请求失败:", textStatus, errorThrown);
        alert("网络请求失败，请稍后再试。");
    }
});