CodeIgniter框架API接口怎么返回JSON_CodeIgniter框架RESTful响应格式封装

星夢妙者

星夢妙者

2026-05-07

866人浏览

原创

codeigniter 3 和 4 的 json 响应机制完全不同:ci3 必须用 $this->output->set_content_type()->set_output() 手动输出,ci4 必须用 service('response')->setjson();顺序、编码、空格、对象转换等细节均需严格遵循版本规范。

codeigniter框架api接口怎么返回json_codeigniter框架restful响应格式封装

CodeIgniter 3 和 CodeIgniter 4 的 JSON 响应机制完全不同,直接混用会导致空白页、500 错误或前端解析失败。别套用 Laravel 或 ThinkPHP 的写法,得按版本走。

CodeIgniter 3 中 set_output + set_content_type 是最稳的组合

CI3 没有原生 json() 方法,$this->output->set_output() 是唯一可控的输出入口。手动设头 + 手动编码是标准路径,任何绕过 Output 类的 echo / header() 都可能被后续钩子覆盖或触发缓存冲突。

  • set_content_type('application/json') 必须在 set_output() 前调用,顺序反了头信息就丢了
  • 务必用 json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES),否则中文变 \u4f60\u597d,斜杠被转义成 \/
  • 控制器方法末尾不能有额外 echoprint_r 或空行,否则 JSON 前会多出空白字符,前端 JSON.parse() 直接报 Unexpected token
  • 如果用了 MY_Controller 基类,确保基类没在构造函数里提前调用 $this->output->set_output()

示例:

public function get_user()
{
    $user = ['id' => 1, 'name' => '张三', 'email' => 'zhang@example.com'];
    $this->output
        ->set_content_type('application/json', 'utf-8')
        ->set_output(json_encode($user, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES));
}

CodeIgniter 4 必须用 service('response')->setJson()

CI4 彻底弃用 $this->output,所有响应必须走 Response 实例。直接 echo json_encode() 不仅不生效,还会破坏 PSR-7 响应生命周期,导致中间件失效或 CORS 头丢失。

php版微信js-sdk支付接口类
php版微信js-sdk支付接口类

php版微信js-sdk支付接口类

下载
  • 获取响应对象只能通过 service('response'),不能 new 实例
  • setJson() 会自动设置 Content-Type: application/jsoncharset=utf-8,无需手动设头
  • 若需自定义状态码,链式调用 setStatusCode(201),不要用 http_response_code()
  • 模型返回的对象数组(如 Result)需先用 getResultArray()getFirstRow('array') 转成 PHP 数组,否则 json_encode 会失败

示例:

public function show($id)
{
    $user = $this->userModel->find($id);
    if (!$user) {
        return service('response')->setStatusCode(404)->setJson(['error' => 'not found']);
    }
    return service('response')->setJson(['data' => $user]);
}

统一封装响应结构时,别在控制器里拼数组

常见错误是每个接口都写一遍 ['code' => 0, 'msg' => 'ok', 'data' => $xxx],既重复又难维护。CI3 可在基类加 api_response() 方法,CI4 则推荐用 ResponseTrait + 自定义服务。

  • CI3 基类中避免用 $this->load->view(),那会走模板引擎,和 JSON 冲突
  • CI4 中若继承了 BaseController 并 use ResponseTrait,优先用 $this->respond() 而非 service('response'),更简洁
  • 所有封装方法最终仍要落到 set_output()(CI3)或 setJson()(CI4),中间层只是语法糖,不是魔法
  • 时间戳字段(如 created_at)若来自数据库,CI4 的 Time 对象默认转 JSON 会出错,必须显式调用 toDateTimeString()getTimestamp()

最易忽略的是编码一致性:CI3 的 autoload.php 里没加载 url 辅助函数,base_url() 就会报错;CI4 的 .envapp.charset 若不是 UTF-8JSON_UNESCAPED_UNICODE 就无效。这些细节不检查,JSON 看似返回了,实际是乱码或截断。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

1373

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

1560

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

692

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

551

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

910

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1128

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

1684

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

5656

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

420

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 18.8万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.3万人学习