PHP插件开发中的一个错误：JSON直接输出导致网站首页异常

2025 年 07 月 22 日

15 次浏览

2221字数

AI摘要

文章讨论了PHP插件开发中的一个错误，即JSON数据直接输出导致网站首页异常的问题。问题出现在WeFootStep插件的`Widget.php`文件中的`getStepDataJson()`函数，该函数直接设置了响应头为`application/json`并输出JSON编码后的数据，导致页面只输出JSON数据。解决方案是修改该函数，使其只在确认是AJAX请求时才直接输出JSON并退出。文章还强调了在开发PHP插件时应注意代码的健壮性和兼容性，遵循关注点分离、条件性输出、防御性编程和明确文档等原则。

问题描述

最近在使用步数统计插件（WeFootStep）时，发现网站首页完全变成了一段JSON数据，而不是正常的HTML页面。具体表现为首页显示如下内容：

{"results":"<li><a href=\"https:\/\/blog.ybyq.wang\/archives\/186.html\">\u770b\u770b\u4f60\u662f\u4e0d\u662f\u201c\u8d5e\u535a\u6587\u76f2\u201d<p class=\"text-muted\">dobe\u3001IDEA\u3001<mark class='text_match'>pycharm<\/mark>\u7b49\r\n<\/p><\/a><\/li>..."}

这完全破坏了网站的正常浏览体验。

原因分析

经过几天的艰苦排查，发现问题出在WeFootStep插件的Widget.php文件中的getStepDataJson()函数：

/**
 * 获取步数JSON数据，用于AJAX请求
 */
public function getStepDataJson()
{
    $history = $this->getStepHistory();
    $stats = $this->getStepStats();
    
    $data = [
        'history' => $history,
        'stats' => $stats
    ];
    
    header('Content-Type: application/json');
    echo json_encode($data);
    exit;
}

这个函数存在的问题是：

函数直接设置了响应头为application/json
输出JSON编码后的数据
调用exit终止了PHP的执行流程

这种实现方式本来是为AJAX请求设计的，但如果在普通页面加载过程中被误调用，就会导致整个页面只输出JSON数据。

解决方案

解决方案很简单：修改getStepDataJson()函数，让它只在确认是AJAX请求时才直接输出JSON并退出：

/**
 * 获取步数JSON数据，用于AJAX请求
 */
public function getStepDataJson()
{
    $history = $this->getStepHistory();
    $stats = $this->getStepStats();
    
    $data = [
        'history' => $history,
        'stats' => $stats
    ];
    
    // 只在AJAX请求时才直接输出JSON并退出
    if (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest') {
        header('Content-Type: application/json');
        echo json_encode($data);
        exit;
    }
    
    // 如果不是AJAX请求，返回数据而不直接输出
    return $data;
}

这个改进添加了一个检查机制，通过判断$_SERVER['HTTP_X_REQUESTED_WITH']是否为xmlhttprequest来确定当前是否是一个AJAX请求。如果是，才执行原来的行为；如果不是，则只返回数据而不直接输出。