请求(Request)对象封装了当前 HTTP 请求的全部信息。官方手册《请求》一章下设多个子类:获取请求对象、请求信息、获取请求参数、请求类型、HTTP 头信息、可输入参数过滤、上传文件、请求缓存。本文逐一整理,结尾附综合小实例。参考:ThinkPHP 8 请求。
一、获取请求对象
三种常用方式拿到同一个 Request 对象:
// 1. 助手函数(最常用)
$request = request();
// 2. 方法注入(推荐在控制器方法里)
use thinkRequest;
public function index(Request $request) { }
// 3. 静态调用
use thinkfacadeRequest;
Request::param('id');
二、请求信息
| 方法 | 获取内容 |
|---|---|
url() | 完整请求地址(含查询串) |
baseUrl() | 不含查询串的地址 |
pathinfo() | 当前 PATH_INFO |
method() | 请求类型(GET/POST/PUT…) |
ip() | 客户端 IP(自动识别代理头) |
host()、domain() | 域名信息 |
isSsl() | 是否 HTTPS 访问 |
三、获取请求参数
$request = request();
$request->param(); // 所有参数(含路由参数)
$request->param('id'); // 单个参数
$request->param('id', 0); // 带默认值
$request->get('name'); // 只取 GET 参数
$request->post('name'); // 只取 POST 参数
$request->route('id'); // 只取路由变量
$request->only(['id', 'name']); // 只取指定参数
$request->except(['_token']); // 排除指定参数后取全部
REST 场景可以用 put()、delete() 获取对应请求类型的参数。
四、请求类型
$request->isGet();
$request->isPost();
$request->isPut();
$request->isDelete();
$request->isAjax();
$request->isPjax();
$request->isSsl();
$request->method(true); // 获取原始请求类型(绕过表单伪装)
表单可以用 _method 伪装 PUT/DELETE,method() 返回伪装后的类型,method(true) 返回真实类型。
五、HTTP 头信息
$request->header(); // 所有头信息(数组)
$request->header('user-agent'); // 单个头,键名不区分大小写
六、可输入参数过滤
// 对本次请求的输入统一过滤
$request->filter('htmlspecialchars');
// 过滤器也可以在 config 里配置默认过滤
// 'default_filter' => 'trim,htmlspecialchars'
过滤器让每个进入的参数先过一遍处理函数,是防 XSS 的常用手段;也支持数组形式配置多个过滤器。
七、上传文件
$file = $request->file('avatar'); // 获取上传文件
if ($file) {
$file->validate(['size' => 2097152, 'ext' => 'jpg,png']);
$info = $file->move('uploads'); // 移动到 uploads 目录
echo $info->getPathname(); // 保存后的路径
}
validate()校验大小、后缀、图片规则等move()自动按日期生成子目录和随机文件名,也可自定义保存名- 多文件上传用
$request->file('image.0')形式逐个获取
八、请求缓存
对变化不频繁的接口,可以开启请求缓存:相同的请求在缓存有效期内直接返回上次的结果,不再执行控制器,显著减轻数据库压力。按需在配置里开启并设置有效期,数据更新时注意及时清缓存。
九、综合小实例:用户注册接口
把本章知识点串起来写一个注册方法:
public function register()
{
$request = request();
// 请求类型判断
if (!$request->isPost()) {
return json(['code' => 0, 'msg' => '请求方式错误'], 405);
}
// 参数获取:只取需要的字段
$data = $request->only(['username', 'email']);
if (empty($data['username'])) {
return json(['code' => 0, 'msg' => '用户名不能为空']);
}
// 请求信息:记录注册 IP
$data['reg_ip'] = $request->ip();
// 文件上传:头像(校验后保存)
if ($file = $request->file('avatar')) {
$file->validate(['size' => 2097152, 'ext' => 'jpg,png']);
$data['avatar'] = $file->move('uploads')->getPathname();
}
return json(['code' => 1, 'msg' => '注册成功', 'data' => $data]);
}
一个方法用到了请求对象、请求类型判断、参数获取(only)、请求信息(ip)和文件上传校验 —— 本章的知识点全在里边了。
十、总结
request() 拿对象,param/get/post/route 取参数、only/except 收窄范围;isGet/isPost/isAjax 判类型,method(true) 看真实类型;header() 取头信息,filter() 做输入过滤;file()+validate()+move() 三步完成上传;请求缓存给高频读接口提速。