PHP怎么写接口_PHP接口开发中的日志记录与调试方法

<?php
// 假设你通过Composer安装了Monolog
require 'vendor/autoload.php';

use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use Monolog\Formatter\LineFormatter;

// 创建一个日志通道，通常代表你的应用或模块
$log = new Logger('api_service');

// 定义日志格式，包含时间、通道、级别、消息、上下文和额外信息
$dateFormat = "Y-m-d H:i:s";
$output = "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n";
$formatter = new LineFormatter($output, $dateFormat);

// 创建一个处理器，将日志写入按日期分割的文件
// 在开发环境，我们通常会设置DEBUG级别
$streamHandler = new StreamHandler(__DIR__ . '/logs/api_' . date('Y-m-d') . '.log', Logger::DEBUG);
$streamHandler->setFormatter($formatter);
$log->pushHandler($streamHandler);

// 模拟一个接口请求处理
try {
    $requestId = uniqid('req_');
    $log->info('Incoming API request.', [
        'requestId' => $requestId,
        'method' => $_SERVER['REQUEST_METHOD'] ?? 'CLI',
        'uri' => $_SERVER['REQUEST_URI'] ?? 'N/A',
        'ip' => $_SERVER['REMOTE_ADDR'] ?? 'N/A',
        'params' => $_GET // 记录请求参数
    ]);

    // 假设这里有一些业务逻辑，可能会出错
    if (!isset($_GET['user_id']) || !is_numeric($_GET['user_id'])) {
        throw new \InvalidArgumentException("Invalid or missing 'user_id' parameter.");
    }

    $userId = (int)$_GET['user_id'];
    // 模拟从数据库获取数据
    $userData = ['id' => $userId, 'name' => 'John Doe', 'email' => 'john.doe@example.com'];
    $log->debug('User data fetched successfully.', ['requestId' => $requestId, 'userId' => $userId, 'data' => $userData]);

    // 返回成功响应
    header('Content-Type: application/json');
    echo json_encode(['status' => 'success', 'data' => $userData]);
    $log->info('API response sent successfully.', ['requestId' => $requestId, 'userId' => $userId, 'http_status' => 200]);

} catch (\InvalidArgumentException $e) {
    // 处理业务逻辑中的参数错误
    $log->warning('API request failed due to invalid argument.', [
        'requestId' => $requestId ?? 'N/A',
        'error_message' => $e->getMessage(),
        'file' => $e->getFile(),
        'line' => $e->getLine(),
    ]);
    header('Content-Type: application/json');
    http_response_code(400); // Bad Request
    echo json_encode(['status' => 'error', 'message' => $e->getMessage()]);
    $log->info('API error response sent.', ['requestId' => $requestId ?? 'N/A', 'http_status' => 400]);

} catch (\Exception $e) {
    // 处理其他未预料的异常
    $log->error('An unexpected error occurred during API processing.', [
        'requestId' => $requestId ?? 'N/A',
        'error_message' => $e->getMessage(),
        'file' => $e->getFile(),
        'line' => $e->getLine(),
        'trace' => $e->getTraceAsString() // 记录完整的堆栈信息
    ]);
    header('Content-Type: application/json');
    http_response_code(500); // Internal Server Error
    echo json_encode(['status' => 'error', 'message' => 'An internal server error occurred. Please try again later.']);
    $log->info('API error response sent.', ['requestId' => $requestId ?? 'N/A', 'http_status' => 500]);
}

<?php
// 假设 $log 已经是一个配置好的 Monolog Logger 实例

// 注册一个全局异常处理器
set_exception_handler(function (Throwable $e) use ($log) {
    // 记录异常到日志，级别为 ERROR
    $log->error('An unhandled exception occurred.', [
        'type' => get_class($e),
        'message' => $e->getMessage(),
        'code' => $e->getCode(),
        'file' => $e->