接受请求
要通过依赖注入获取当前 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 string $id
* @return Response
*/
public function update(Request $request, $id)
{
//
}
}
通过闭包路由获取参数
你也可以在路由闭包中使用 Illuminate\Http\Request
类, 服务容器会自动的将请求参数注入到路由闭包中:
use Illuminate\Http\Request;
Route::get('/', function (Request $request) {
//
});
请求路径 & 方法
Illuminate\Http\Request
实例提供了一系列方法来验证 HTTP 请求参数,并继承了 Symfony\Component\HttpFoundation\Request
类 。下面是该类的一些重要方法:
获取请求路径
path
方法返回请求的路径信息。所以,如果请求的路径是 http://domain.com/foo/bar
, path
方法将会返回 foo/bar
:
$uri = $request->path();
is
可以验证传入的请求路径是否与给定的模式匹配。 在这个方法中,你也可以使用 *
字符作为通配符:
if ($request->is('admin/*')) {
//
}
获取请求 URL
可以使用 url
或 fullUrl
方法获取完整的请求 URL。 url
方法返回不含有查询串的 URL, fullUrl
获取包含查询串的 URL:
// 不附带查询串...
$url = $request->url();
// 附带查询串...
$url = $request->fullUrl();
获取请求 Method
method
方法返回请求的 HTTP 动作。还可以使用 isMethod
方法校验 HTTP 动作是否与给定的客串上匹配:
$method = $request->method();
if ($request->isMethod('post')) {
//
}
PSR-7 请求
PSR-7 standard 定义了 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) {
//
});
{tip} 如果从路由或控制器返回 PSR-7 响应实例,框架会自动将其转换回 Laravel 响应实例并显示。
输入的裁剪和标准化
默认情况下,Laravel 在应用的全局中间件堆栈中包含了 TrimStrings
和 ConvertEmptyStringsToNull
中间件。这些中间件被放在 App\Http\Kernel
类的堆栈列表中。它们自动裁剪请求中的所有输入字符串域,同时将空字符串域转换为 null
。这样一来,你就不必担心路由和控制器中的标准化规约问题。
如果想要禁用这个行为,只需要通过从 App\Http\Kernel
类的 $middleware
属性中移除它(相当于从应用的中间件堆栈中移除)。
获取输入
获取所有的输入数据
可以使用 all
方法获取所有输入数据数组:
$input = $request->all();
获取单个输入值
使用一些简便方法,就可以通 实例过 Illuminate\Http\Request
实例获取用户的全部输入,不需要担心用户请求用的是哪种 HTTP 动作。无论哪种 HTTP 动作, 用户的请求都能被 input
方法获取:
$name = $request->input('name');
可以将默认值作为传递给 input
方法的第二个参数。这个值将在请求没有包含该参数时被返回:
$name = $request->input('name', 'Sally');
当与包含数组输入的表单协作时,使用 「点」 运算符访问数组元素:
$name = $request->input('products.0.name');
$names = $request->input('products.*.name');
不带参数调用 input
方法,能够获取全部输入值(关联数组形式):
$input = $request->input();
从查询串中获取输入
input
方法从整个请求载体中获取值(包括查询串), query
方法则仅从查询串中获取值:
$name = $request->query('name');
如果查询串值不存在,query
方法的第二个参数将被作为该参数的默认值被返回:
$name = $request->query('name', 'Helen');
不带参数调用 query
方法,能够获取查询串的所有值(关联数组形式):
$query = $request->query();
通过动态属性获取输入
可以通过 Illuminate\Http\Request
实例的动态属性访问用户输入。例如,如果应用表单包含 name
域,可以像下面这样访问该域的值:
$name = $request->name;
在使用动态属性时,Laravel 首先会在请求载体中查找参数的值。如果该值不存在,Lavarel 将在路由参数中搜索。
获取 JSON 输入
当向应用传递 JSON 请求时,可以通过 input
方法访问 JSON 数据,只要将请求的 Content-Type
头设置为 application/json
。 同样可以使用 「点」语法访问 JSON 数组:
$name = $request->input('user.name');
获取部分输入数据
如果需要获取输入数据的子集,可以使用 only
或 except
方法。它们接受单个 array
或者动态参数列表:
$input = $request->only(['username', 'password']);
$input = $request->only('username', 'password');
$input = $request->except(['credit_card']);
$input = $request->except('credit_card');
{tip}
only
方法返回请求中的全部键值对;但是它不返回请求中不存在的键值对。
判断输入值是否存在
has
方法用于判定请求中是否存在指定的值。如果请求中存在该值, has
方法返回 true
:
if ($request->has('name')) {
//
}
如果给出一个数组, has
方法将判断在请求中,指定的值是否全部存在:
if ($request->has(['name', 'email'])) {
//
}
如果想要判断一个值在请求中是否存在,并且不为空,需要使用 filled
方法:
if ($request->filled('name')) {
//
}
旧数据
Laravel 允许你在两次请求之间保持数据。这个特性在有效性校验出错后重新填充表单时非常有用。不过,如果你使用 Lavarel 自带 验证特性,不需要自己手动调用这些方法因为一些 Laravel 内置的验证功能会自动调用它们。
将输入数据传送到 Session
Illuminate\Http\Request
类的 flash
方法将把当前的输入传送到 session ,在用户向应用发出这一次请求时它们仍然可用:
$request->flash();
可以使用 flashOnly
或 flashExcept
方法将请求数据的子集传送给 session。这些方法常用于将密码之类的敏感数据排除在 session 保持之外:
$request->flashOnly(['username', 'email']);
$request->flashExcept('password');
传送数据并跳转
当你经常需要将输入传送至 session 并紧接着跳转至之前的页面,可以通过在跳转函数后链接调用 withInput
方法轻易地实现:
return redirect('form')->withInput();
return redirect('form')->withInput(
$request->except('password')
);
获取旧数据
要获取前一次请求传送的数据,可以使用 Request
实例的 old
方法。 old
方法将从 session 拉取之前传送的值:
$username = $request->old('username');
Laravel 还提供了全局的 old
助手。如果要在 Blade 模板中 显示旧数据, old
助手更易用。如果给定域的旧值不存在,它将返回 null
:
<input type="text" name="username" value="{{ old('username') }}">
Cookies
从请求中获取 Cookies
Lavarel 框架生成的全部 cookies 都是加密的,并且已经用授权码签名,这意味着如果它们被客户端改变就会失效。使用 Illuminate\Http\Request
实例的 cookie
方法可以从请求中获取 cookie 值:
$value = $request->cookie('name');
也可以使用 Cookie
facade 访问 cookie 值:
$value = Cookie::get('name');
将 Cookies 附加到响应中
可以使用 cookie
方法向输出的 Illuminate\Http\Response
实例附加 cookie。需要传递 名称、值、cookie 的过期时间(以分钟为单位)给该方法:
return response('Hello World')->cookie(
'name', 'value', $minutes
);
cookie
还可以接受另外几个不太常用的参数。通常这些参数和 PHP 内置的 setcookie 方法的参数有着相同的作用和意义:
return response('Hello World')->cookie(
'name', 'value', $minutes, $path, $domain, $secure, $httpOnly
);
同样,你可以使用 Cookie
facade 来 「排列」 用于从应用中附加到输出响应的 cookies。queue
方法接受一个 Cookie
实例或者用于创建 Cookie
所需的参数列表。这些 cookies 将在输出响应被发送至浏览器前被附加:
Cookie::queue(Cookie::make('name', 'value', $minutes));
Cookie::queue('name', 'value', $minutes);
生成 Cookie 实例
如果想要生成一个随后可以提供给响应实例的 Symfony\Component\HttpFoundation\Cookie
实例,可以使用全局的 cookie
助手。这个 cookie 在没有附加到响应实例前不会传回客户端:
$cookie = cookie('name', 'value', $minutes);
return response('Hello World')->cookie($cookie);
文件
获取上传的文件
可以使用 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 文档 可以获取这些方法的更多信息。
存储上传文件
要存储上传的文件,先配置好 文件系统。你可以使用 UploadedFile
的 store
方法把上传文件移动到你的某个磁盘上,该文件可能是本地文件系统中的一个位置,甚至像 Amazon S3 这样的云存储位置。
store
方法接受相对于文件系统配置的存储文件根目录的路径。这个路径不能包含文件名,因为系统会自动生成唯一的 ID 作为文件名。
store
方法还接受可选的第二个参数,用于存储文件的磁盘名称。这个方法会返回相对于磁盘根目录的文件路径:
$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');
配置可信代理
如果你的应用程序运行在失效的 TLS / SSL 证书的负载均衡器后,你可能会注意到你的应用程序有时不能生成 HTTPS 链接。通常这是因为你的应用程序正在从端口 80 上的负载均衡器转发流量,却不知道是否应该生成安全链接。
解决这个问题需要在 Laravel 应用程序中包含App\Http\Middleware\TrustProxies
中间件,这使得你可以快速自定义应用程序信任的负载均衡器或代理。你的可信代理应该作为这个中间件的 $proxies
属性的数组列出。除了配置受信任的代理之外,还可以配置应该信任的代理 $header
:
<?php
namespace App\Http\Middleware;
use Illuminate\Http\Request;
use Fideloper\Proxy\TrustProxies as Middleware;
class TrustProxies extends Middleware
{
/**
* 应用程序的可信代理列表
*
* @var array
*/
protected $proxies = [
'192.168.1.1',
'192.168.1.2',
];
/**
* 应该用来检测代理的头信息
*
* @var string
*/
protected $headers = Request::HEADER_X_FORWARDED_ALL;
}
{tip} 如果你使用 AWS 弹性负载平衡,你的
$header
值应该是Request::HEADER_X_FORWARDED_AWS_ELB
。常量的更多信息,可用于$headers
属性,看看 Symfony 的 文档 信任代理.
信任所有代理
如果你使用 Amazon AWS 或其他的「云」负载均衡器提供程序,你可能不知道负载均衡器的实际 IP 地址。在这种情况下,你可以使用 *
来信任所有代理:
/**
* 应用程序的可信代理列表
*
* @var array
*/
protected $proxies = '*';