技术 · 思考 · 实践 · 成长

首页/ThinkPHP8/正文

ThinkPHP 8 响应完全指南:输出、JSON/JSONP/XML 与重定向下载

ThinkPHP88 次阅读

控制器的返回值会被自动封装成响应(Response)对象发给客户端。官方手册《响应》一章下设多个子类:响应输出、响应参数(状态码/响应头)、重定向、JSON 响应、JSONP 响应、XML 响应、文件下载。本文逐一整理,结尾附综合小实例。参考:ThinkPHP 8 响应。

一、响应输出

控制器里直接 return 就是响应输出,不需要手动 echo:

public function index()
{
    return 'hello,thinkphp';          // 字符串响应
}

public function data()
{
    return ['id' => 1, 'name' => 'tp']; // 数组自动转 JSON 响应
}

二、响应参数:状态码与响应头

需要精细控制时,创建响应对象并链式设置状态码、响应头:

use thinkfacadeResponse;

$response = Response::create($data, 'json');
$response->code(404);                        // 设置状态码
$response->header(['X-Api-Version' => '1.0']); // 设置响应头
return $response;

三、重定向

return redirect('blog/index');                      // 助手函数 302
return redirect(url('blog/read', ['id' => 1]), 301); // 配合路由生成地址

// 控制器继承 thinkController 时也可用
$this->redirect('blog/index', 302);

重定向属于响应的一种(302/301),浏览器收到后自动跳转;建议用 url() 生成目标地址,路由改动后自动跟随。

四、JSON 响应

return json(['code' => 1, 'data' => $data]);       // 助手函数
return json($data, 200);                            // 指定状态码

use think
esponseJson;
return Json::create($data)->code(201);              // 响应对象写法

JSON 响应自动带上 Content-Type: application/json,是 API 项目的标准输出。

五、JSONP 响应

return jsonp(['code' => 1, 'data' => $data]);

JSONP 用于跨域的 <script> 调用场景,自动读取回调参数包一层函数调用;现在更常见的跨域方案是 CORS。

六、XML 响应

return xml(['code' => 1, 'data' => $data]);

use think
esponseXml;
return Xml::create($data);

XML 响应把数组转成 XML 输出,适合对接老系统或需要 XML 接口的场景。

七、文件下载

use think
esponseFile;

return File::create(ROOT_PATH . 'public' . DIRECTORY_SEPARATOR . 'backup.zip')
           ->name('backup-2024.zip');   // name() 指定下载时的文件名

文件响应会设置正确的 Content-Type 与下载头;name() 指定对外的文件名,不暴露服务器真实路径。

八、综合小实例:API 响应三件套

把本章知识点串起来,写一组典型的接口响应:

use thinkfacadeResponse;

// 1. 详情接口:JSON + 自定义响应头 + 状态码
public function detail($id)
{
    $article = ['id' => $id, 'title' => 'ThinkPHP 响应'];  // 伪代码:查库
    if (!$article) {
        return json(['code' => 404, 'msg' => '文章不存在'], 404);
    }
    $response = json(['code' => 0, 'data' => $article]);
    $response->header(['X-Api-Version' => '1.0']);
    return $response;
}

// 2. 发布成功后跳转回列表页
public function create()
{
    // ...保存文章...
    return redirect(url('blog/index'));
}

// 3. 下载数据库备份
public function download()
{
    return 	hink
esponseFile::create(ROOT_PATH . 'backup.sql')
               ->name('db-backup.sql');
}

一个例子用齐了 JSON 响应、状态码、响应头、重定向和文件下载 —— 正好覆盖本章全部子类。

九、总结

return 即响应:字符串直出、数组自动 JSON;要精细控制就建响应对象链式设置 code/header;json/jsonp/xml 各管一种格式;redirect() 管跳转、File::create() 管下载;对外接口记得统一 JSON 结构和状态码。

凡人做一事,便须全副精神注在此一事,首尾不懈,不可见异思迁,做这样,想那样,坐这山,望那山。人而无恒,终身一无所成。——曾国藩《曾国藩家书》

评论交流

0 条评论 · 支持多级回复
验证码
暂无评论,来说说你的想法吧

相关文章

继续阅读