[TOC]
# 访问请求实例
在控制器中获取当前 HTTP 请求实例,需要在构造函数或方法中对 `Illuminate\Http\Request` 类进行依赖注入,这样当前请求实例会被`服务容器`自动注入:
~~~
<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
class UserController extends Controller
{
/**
* 存储新用户
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
$name = $request->input('name');
//
}
}
~~~
**依赖注入 & 路由参数**
如果还期望在控制器方法中获取路由参数,只需要将路由参数置于其它依赖之后即可,例如,如果你的路由定义如下:
~~~
Route::put('user/{id}','UserController@update');
~~~
你仍然可以对 `Illuminate\Http\Request` 进行依赖注入并通过如下方式定义控制器方法来访问路由参数 `id`:
~~~
<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
class UserController extends Controller
{
/**
* 更新指定用户
*
* @param Request $request
* @param int $id
* @return Response
*/
public function update(Request $request, $id)
{
//
}
}
~~~
**通过路由闭包访问请求**
还可以在路由闭包中注入 `Illuminate\Http\Request`,在执行闭包函数的时候服务容器会自动注入输入请求:
~~~
use Illuminate\Http\Request;
Route::get('/', function (Request $request) {
//
});
~~~
## 请求路径 & 方法
`Illuminate\Http\Request` 继承自 `Symfony\Component\HttpFoundation\Request` 类,提供了多个方法来检测应用的 HTTP 请求,下面我们来演示其提供的一些获取请求路径和请求方式的方法:
**获取请求路径**
`path` 方法将会返回请求的路径信息,因此,如果请求URL是 `http://domain.com/user/1`,则 `path` 方法将会返回 `user/1`:
~~~
$path = $request->path();
~~~
`is` 方法允许你验证请求路径是否与给定模式匹配。该方法参数支持 `*` 通配符:
~~~
if($request->is('user/*')){
//
}
~~~
如果请求URL是 `http://domain.com/user/1`,该方法会返回 `true`。
**获取请求 URL**
想要获取完整的 URL,而不仅仅是路径信息,可以使用请求实例提供的 `url` 或 `fullUrl` 方法, `url` 方法返回不带查询字符串的 URL,而 `fullUrl` 方法返回结果则包含查询字符串:
~~~
// 不包含查询字符串
$url = $request->url();
// 包含查询字符串
$url_with_query = $request->fullUrl();
~~~
例如,我们请求 `http://domain.com/user/1?token=laravelacademy.org`,则上述 `$url` 的值是 `http://domain.com/user/1`,`$url_with_query` 的值是 `http://blog.test/user/1?token=laravelacademy.org`。
**获取请求方法**
`method` 方法将会返回 HTTP 请求方式。你还可以使用 `isMethod` 方法来验证 HTTP 请求方式是否匹配给定字符串:
~~~
$method = $request->method(); // GET/POST
if($request->isMethod('post')){
// true or false
}
~~~
## PSR-7 请求
`PSR-7` 标准指定了 HTTP 消息接口,包括请求和响应。如果你想要获取遵循 PSR-7 标准的请求实例而不是 Laravel 请求实例,首先需要安装一些库。Laravel 可以使用 Symfony HTTP Message Bridge 组件将典型的 Laravel 请求和响应转化为兼容 PSR-7 接口的实现:
~~~
composer require symfony/psr-http-message-bridge
composer require zendframework/zend-diactoros
~~~
安装完这些库之后,只需要在路由或控制器中通过对请求示例进行类型提示就可以获取 PSR-7 请求:
~~~
use Psr\Http\Message\ServerRequestInterface;
Route::get('/', function (ServerRequestInterface $request) {
//
});
~~~
对比下 `Request` 实例和 `ServerRequestInterface` 实例的数据结构,可以看到 Laravel 的 Request 实例提供信息更丰富:
:-: ![](http://static.laravelacademy.org/wp-content/uploads/2018/03/15063951747233.jpg)
> 注:如果从路由或控制器返回的是 PSR-7 响应实例,则其将会自动转化为 Laravel 响应实例并显示出来。
# 请求字符串处理
默认情况下,Laravel 在 `App\Http\Kernel` 的全局中间件堆栈中引入了 `TrimStrings` 和 `ConvertEmptyStringsToNull` 中间件。这些中间件会自动对请求中的字符串字段进行处理,前者将字符串两端的空格清除,后者将空字符串转化为 `null`。这样,在路由和控制器中我们就不必对字符串字段做额外的处理:
:-: ![](http://static.laravelacademy.org/wp-content/uploads/2017/09/15063953875068.jpg)
如果你想要禁止该行为,可以从 `App\Http\Kernel` 的中间件堆栈属性 `$middleware` 中移除这两个中间件。
# 获取请求输入
**获取所有输入值**
你可以使用 `all` 方法以数组格式获取所有输入值:
~~~
$input = $request->all();
~~~
如果请求 URL 是 `http://blog.test/user/1?token=laravelacademy.org&name=学院君`,则对应 `$input` 返回值是:
:-: ![](http://static.laravelacademy.org/wp-content/uploads/2018/03/15063957252365.jpg)
**获取单个输入值**
通过一些很简单的方法,就可以从 `Illuminate\Http\Request` 实例中访问用户输入。你不需要关心请求所使用的 HTTP 请求方式,因为对所有请求方式都是通过 `input` 方法获取用户输入:
~~~
$name = $request->input('name');
~~~
还是以上面的请求 URL 为例,这里的 `$name` 值是 学院君。
你还可以传递一个默认值作为第二个参数给 `input` 方法,如果请求输入值在当前请求 URL 中未出现时该值将会被返回:
~~~
$name = $request->input('name', '学院君');
~~~
比如我们访问 `http://blog.test/user/1?token=laravelacademy.org`,仍然可以获取到 `$name` 的值为 学院君。
处理表单数组输入时,可以使用”.”来访问数组输入:
~~~
$input = $request->input('products.0.name');
$names = $request->input('products.*.name');
~~~
比如我们访问 `http://blog.test/user/1?products[][name]=学院君&products[][name]=学院君小号`,则上述 `$input` 的值是 `学院君`,而 `$names` 的值是:
:-: ![](http://static.laravelacademy.org/wp-content/uploads/2018/03/15063963904950.jpg)
**从查询字符串中获取输入**
`input` 方法会从整个请求负载(包括查询字符串)中获取数值,`query`则只会从查询字符串中获取数值:
~~~
$name = $request->query('name');
~~~
如果请求的查询字符串中没有提供给定的查询项,我们可以像 `input` 方法一样设置第二个参数为默认值:
~~~
$name = $request->query('name', '学院君');
~~~
你也可以调用一个不传任何参数的 `query` 方法以便以关联数组的方式获取整个查询字符串的值,类似 `all` 方法所做的:
~~~
$query = $request->query();
~~~
写到这里,估计有些人要蒙圈了,那 `input` 和 `query` 到底有什么区别,官方文档还是有些含混不清,那么这里学院君一杆子打到底,跟你聊聊两者的本质区别,回到上面打印 Request 实例那张图:
:-: ![](http://static.laravelacademy.org/wp-content/uploads/2018/03/15064003082756.jpg)
注意到标红圈的部分,`query` 方法就是从 `query` 属性对象中获取参数值,`input` 方法会从 `query + request` 属性对象中获取参数值,请求实例上还有个 `post` 方法用于从 `request` 属性对象中获取参数值,讲到这里我们应该有点眉目了,`query` 方法用于获取 `GET` 请求查询字符串参数值,`input` 方法用于获取所有 HTTP 请求参数值,`post` 方法用于获取 `POST` 请求参数值。感兴趣的同学可以去底层查看下源码:`vendor/laravel/framework/src/Illuminate/Http/Concerns/InteractsWithInput.php`。
**通过动态属性获取输入**
此外,你还可以通过使用 `Illuminate\Http\Request` 实例上的动态属性来访问用户输入。例如,如果你的应用表单包含 `name` 字段,那么可以像这样访问提交的值:
~~~
$name = $request->name;
~~~
使用动态属性的时候,Laravel 首先会在请求中查找参数的值,如果不存在,还会到路由参数中查找。该功能的实现原理自然是魔术函数 `__get` 了:
:-: ![](http://static.laravelacademy.org/wp-content/uploads/2017/09/15064007000489.jpg)
**获取JSON输入值**
发送 JSON 请求到应用的时候,只要 `Content-Type` 请求头被设置为 `application/json`,都可以通过 `input` 方法获取 JSON 数据,还可以通过“.”号解析数组:
~~~
$name = $request->input('user.name');
~~~
**获取输入的部分数据**
如果你需要取出输入数据的子集,可以使用 `only` 或 `except` 方法,这两个方法都接收一个数组或动态列表作为唯一参数,这和我们在上一篇控制器中提到的`控制器`中间件使用语法类似:
~~~
$input = $request->only(['username', 'password']);
$input = $request->only('username', 'password');
$input = $request->except(['credit_card']);
$input = $request->except('credit_card');
~~~
> 注:`only` 方法返回所有你想要获取的参数键值对,不过,如果你想要获取的参数不存在,则对应参数会被过滤掉。
**判断请求参数是否存在**
判断参数在请求中是否存在,可以使用 `has` 方法,如果参数存在则返回 `true`:
~~~
if ($request->has('name')) {
//
}
~~~
该方法支持以数组形式查询多个参数,这种情况下,只有当参数都存在时,才会返回 `true`:
~~~
if ($request->has(['name', 'email'])) {
//
}
~~~
如果你想要判断参数存在且参数值不为空,可以使用 `filled` 方法:
~~~
if ($request->filled('name')) {
//
}
~~~
## 上一次请求输入
Laravel 允许你在两次请求之间保存上一次输入数据,这个特性在检测校验数据失败后需要重新填充表单数据时很有用,不过如果你使用的是 Laravel 自带的验功能,则不需要手动使用这些方法,因为一些 Laravel 自带的校验设置会自动调用它们。
**将输入存储到 Session**
`Illuminate\Http\Request` 实例的 `flash` 方法会将当前输入存放到一次性 Session(所谓的一次性指的是从 Session 中取出数据后,对应数据会从 Session 中销毁)中,这样在下一次请求时上一次输入的数据依然有效:
~~~
$request->flash();
~~~
你还可以使用 `flashOnly` 和 `flashExcept` 方法将输入数据子集存放到 Session 中,这些方法在 Session 之外保存敏感信息时很有用,该功能适用于登录密码填写错误的场景:
~~~
$request->flashOnly('username', 'email');
$request->flashExcept('password');
~~~
**将输入存储到 Session 然后重定向**
如果你经常需要一次性存储输入请求输入并返回到表单填写页,可以在 `redirect` 之后调用 `withInput` 方法实现这样的功能:
~~~
return redirect('form')->withInput();
return redirect('form')->withInput($request->except('password'));
~~~
**取出上次请求数据**
要从 Session 中取出上次请求的输入数据,可以使用 Request 实例提供的 `old` 方法。`old` 方法可以很方便地从 `Session` 中取出一次性数据:
~~~
$username = $request->old('username');
~~~
Laravel 还提供了一个全局的辅助函数 `old()`,如果你是在 `Blade 模板`中显示上次输入数据,使用辅助函数 `old()` 更方便,如果给定参数没有对应输入,返回 `null`:
~~~
<input type="text" name="username" value="{{ old('username') }}">
~~~
## Cookie
**从请求中取出Cookie**
为了安全起见,Laravel 框架创建的所有 Cookie 都经过加密并使用一个认证码进行签名,这意味着如果客户端修改了它们则需要对其进行有效性验证。我们使用 `Illuminate\Http\Request` 实例的 cookie 方法从请求中获取 `Cookie` 的值:
~~~
$value = $request->cookie('name');
~~~
此外,还可以使用 `Cookie` 门面获取 Cookie 值:
~~~
$value = Cookie::get('name');
~~~
**添加 Cookie 到响应**
你可以使用 `cookie` 方法将一个 Cookie 添加到返回的 `Illuminate\Http\Response` 实例,你需要传递 Cookie 名称、值、以及有效期(分钟)到这个方法:
~~~
return response('欢迎来到 Laravel 学院')->cookie(
'name', '学院君', $minutes
);
~~~
`cookie` 方法可以接收一些使用频率较低的参数,一般来说,这些参数和 PHP 原生函数 `setcookie` 作用和意义一致:
~~~
return response('欢迎来到 Laravel 学院')->cookie(
'name', '学院君', $minutes, $path, $domain, $secure, $httpOnly
);
~~~
我们简单演示下该功能的使用,在 `routes/web.php` 定义两个路由如下:
~~~
Route::get('cookie/add', function () {
$minutes = 24 * 60;
return response('欢迎来到 Laravel 学院')->cookie('name', '学院君', $minutes);
});
Route::get('cookie/get', function(\Illuminate\Http\Request $request) {
$cookie = $request->cookie('name');
dd($cookie);
});
~~~
先访问 `http://blog.test/cookie/add` 设置 Cookie,然后再通过 `http://blog.test/cookie/get` 获取 Cookie 值,如果在页面看到输出 `学院君`,则表示 Cookie 设置成功。当然我们也可以通过 Chrome 浏览器的 F12 模式快速查看 Cookie 信息:
:-: ![](http://static.laravelacademy.org/wp-content/uploads/2017/09/15064055559978.jpg)
被加密过的 `name` 就是我们刚刚设置的 Cookie 了。
此外,你还可以使用 `Cookie` 门面将应用于附件的 Cookie 推送到输出响应队列。`queue` 方法接收一个 `Cookie` 实例或者创建一个 `Cookie` 实例的必要参数。这些 Cookie 会在响应发送到浏览器之前添加上:
~~~
Cookie::queue(Cookie::make('name', 'value', $minutes));
Cookie::queue('name', 'value', $minutes);
~~~
**生成 Cookie 实例**
如果你想要生成一个 `Symfony\Component\HttpFoundation\Cookie` 实例以便后续添加到响应实例,可以使用全局辅助函数 `cookie`,该 Cookie 只有在添加到响应实例上才会发送到客户端:
~~~
$cookie = cookie('name', '学院君', $minutes);
return response('欢迎来到 Laravel 学院')->cookie($cookie);
~~~
我们改写下之前的 `cookie/add` 路由实现逻辑:
~~~
Route::get('cookie/add', function () {
$minutes = 24 * 60;
//return response('欢迎来到 Laravel 学院')->cookie('name', '学院君', $minutes);
$cookie = cookie('name', '学院君X', $minutes);
return response('欢迎来到 Laravel 学院')->cookie($cookie);
});
~~~
效果和之前一致,这次访问 `cookie/get` 路由,页面打印结果是 `学院君X`。
# 文件上传
## 获取上传的文件
可以使用 `Illuminate\Http\Request` 实例提供的 `file` 方法或者动态属性来访问上传文件, `file` 方法返回 `Illuminate\Http\UploadedFile` 类的一个实例,该类继承自 PHP 标准库中提供与文件交互方法的 `SplFileInfo` 类:
~~~
$file = $request->file('photo');
$file = $request->photo;
~~~
你可以使用 `hasFile` 方法判断文件在请求中是否存在:
~~~
if ($request->hasFile('photo')) {
//
}
~~~
**验证文件是否上传成功**
使用 `isValid` 方法判断文件在上传过程中是否出错:
~~~
if ($request->file('photo')->isValid()){
//
}
~~~
**文件路径 & 扩展名**
`UploadedFile` 类还提供了访问上传文件绝对路径和扩展名的方法。 extension 方法可以基于文件内容判断文件扩展名,该扩展名可能会和客户端提供的扩展名不一致:
~~~
$path = $request->photo->path();
$extension = $request->photo->extension();
~~~
**其他文件方法**
`UploadedFile` 实例上还有很多其他可用方法,[查看该类的API文档](http://api.symfony.com/4.0/Symfony/Component/HttpFoundation/File/UploadedFile.html)了解更多信息。
## 保存上传的文件
要保存上传的文件,需要使用你所配置的某个`文件系统`,对应配置位于 `config/filesystems.php`:
:-: ![](http://static.laravelacademy.org/wp-content/uploads/2018/03/15064074232597.jpg)
Laravel 默认使用 `local` 配置存放上传文件,即本地文件系统,默认根目录是 `storage/app`,`public` 也是本地文件系统,只不过存放在这里的文件可以被公开访问,其对应的根目录是 `storage/app/public`,要让 Web 用户访问到该目录下存放文件的前提是在应用入口 `public` 目录下建一个软链 `storage` 链接到 `storage/app/public`。
`UploadedFile` 类有一个 `store` 方法,该方法会将上传文件移动到相应的磁盘路径上,该路径可以是本地文件系统的某个位置,也可以是云存储(如Amazon S3)上的路径。
`store` 方法接收一个文件保存的相对路径(相对于文件系统配置的根目录 ),该路径不需要包含文件名,因为系统会自动生成一个唯一ID作为文件名。
`store` 方法还接收一个可选的参数 —— 用于存储文件的磁盘名称作为第二个参数(对应文件系统配置 `disks` 的键名,默认值是 `local`),该方法会返回相对于根目录的文件路径:
~~~
$path = $request->photo->store('images');
$path = $request->photo->store('images', 's3');
~~~
如果你不想自动生成文件名,可以使用 `storeAs` 方法,该方法接收保存路径、文件名和磁盘名作为参数:
~~~
$path = $request->photo->storeAs('images', 'filename.jpg');
$path = $request->photo->storeAs('images', 'filename.jpg', 's3');
~~~
下面我们来简单演示下文件上传功能,在 `routes/api.php` 中定义如下文件上传路由:
~~~
Route::post('file/upload', function(\Illuminate\Http\Request $request) {
if ($request->hasFile('photo') && $request->file('photo')->isValid()) {
$photo = $request->file('photo');
$extension = $photo->extension();
//$store_result = $photo->store('photo');
$store_result = $photo->storeAs('photo', 'test.jpg');
$output = [
'extension' => $extension,
'store_result' => $store_result
];
print_r($output);exit();
}
exit('未获取到上传文件或上传过程出错');
});
~~~
我们还是使用 Advanced REST Client 工具来演示 POST 表单提交:
:-: ![](http://static.laravelacademy.org/wp-content/uploads/2017/09/15064080757437.jpg)
标记红圈的地方是需要重点关注的输入和输出。我分别测试了 `store` 方法和 `storeAs` 方法,上传文件成功后可以去 `storage/app` 目录下查看:
:-: ![](http://static.laravelacademy.org/wp-content/uploads/2018/03/15064081988612.jpg)
其他存储介质使用方式也差不多,无非是修改下 `store` 和 `storeAs` 对应的参数。在使用过程中遇到什么问题,欢迎在评论区反馈。
# 配置信任代理
如果你的应用运行在一个会中断 TLS/SSL 证书的负载均衡器之后,你会注意到有的时候应用不会生成 HTTPS 链接,通常这是因为应用是从负载均衡器从80端口转发过来的流量,所以不知道应该生成安全加密链接。
要解决这个问题可以使用 `App\Http\Middleware\TrustProxies` 中间件,该中间件允许你快速自定义需要被应用信任的负载均衡器或代理。被信任的代理位于这个中间件的 `$proxies` 属性列表,除了配置信任代理之外,还可以配置代理发送的带有请求来源信息的消息头:
~~~
<?php
namespace App\Http\Middleware;
use Illuminate\Http\Request;
use Fideloper\Proxy\TrustProxies as Middleware;
class TrustProxies extends Middleware
{
/**
* The trusted proxies for this application.
*
* @var array
*/
protected $proxies = [
'192.168.1.1',
'192.168.1.2',
];
/**
* The headers that should be used to detect proxies.
*
* @var string
*/
protected $headers = Request::HEADER_X_FORWARDED_ALL;
}
~~~
注:如果你在使用 AWS Elastic Load Balancing,`headers` 值应该修改为 `Request::HEADER_X_FORWARDED_AWS_ELB`,关于 `headers` 属性可用的更多常量,请查看 [Symfony 信任代理文档](http://symfony.com/doc/current/deployment/proxies.html)。
**信任所有代理**
如果你在使用 Amazon AWS 或者其他云服务提供的负载均衡,并不知道均衡器真实的 IP 地址,这种情况下,可以使用 `*` 通配符信任所有代理:
~~~
/**
* The trusted proxies for this application.
*
* @var array
*/
protected $proxies = '*';
~~~
- 序言
- 新版特性
- 快速入门
- 升级指南
- 贡献指南
- API文档
- 安装配置
- 目录结构
- Homestead
- Valet
- 部署
- 核心概念
- 请求生命周期
- 服务容器
- 服务提供者
- 门面(Facades)
- 契约(Contracts)
- 框架基础
- 路由
- 中间件
- CSRF 保护
- 控制器
- 请求
- 响应
- 视图
- 生成 URL
- Session
- 验证
- 错误处理
- 日志
- 前端开发
- Blade 模板
- 本地化
- 前端脚手架
- 编译前端资源(Laravel Mix)
- 安全系列
- 登录认证
- API 认证
- 授权
- 加密
- 哈希
- 重置密码
- 进阶系列
- Artisan 控制台
- 集合
- 广播
- 缓存
- 事件
- 文件存储
- 辅助函数
- 邮件
- 通知
- 扩展包开发
- 队列
- 任务调度
- 数据库操作
- 快速入门
- 查询构建器
- 分页
- 迁移
- 数据填充
- Redis
- Eloquent ORM
- 快速入门
- 关联关系
- 集合
- 访问器 & 修改器
- API 资源类
- 序列化
- 应用测试
- 快速入门
- HTTP 测试
- 浏览器测试
- 数据库测试
- 模拟
- 官方扩展包
- Cashier(订阅支付解决方案)
- Envoy(远程操作解决方案)
- Horizon(队列系统解决方案)
- Passport(API 认证解决方案)
- Scout(全文搜索解决方案)
- Socialite(第三方登录解决方案)
- 相关下载
- Laravel 5.6 中文文档离线版
- Laravel 5.6 一键安装包