[ Lumen 5.1 文档 ] 基础 —— HTTP 请求

1、访问请求

通过依赖注入获取当前HTTP请求实例,应该在控制器的构造函数或方法中对Illuminate\Http\Request类进行类型提示,当前请求实例会被服务容器自动注入:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Routing\Controller;

class UserController extends Controller
{
    /**
     * 存储新用户
     *
     * @param  Request  $request
     * @return Response
     */
    public function store(Request $request)
    {
        $name=$request->input('name'); 
        
        //
    }
}

如果你的控制器方法还期望获取路由参数输入,只需要将路由参数置于其它依赖之后即可,例如,如果你的路由定义如下:

$app->put('user/{id}','UserController@update');

你仍然可以对Illuminate\Http\Request进行类型提示并通过如下方式定义控制器方法来访问路由参数:

<?php
    
namespace App\Http\Controllers;
    
use Illuminate\Http\Request;
use Illuminate\Routing\Controller;

classUser Controller extends Controller
{
    /**
     * 更新指定用户
     *
     * @param  Request  $request
     * @param  int  $id
     * @return Response
     */
     public function update(Request $request,$id)
    { 
        //
    }
}

1.1 基本请求信息

Illuminate\Http\Request实例提供了多个方法来检测应用的HTTP请求,LumenIlluminate\Http\Request继承自Symfony\Component\HttpFoundation\Request类,这里列出了一些该类中的有用方法:

获取请求URI

path方法将会返回请求的URI,因此,如果进入的请求路径是http://domain.com/foo/bar,则path方法将会返回foo/bar

$uri=$request->path();

is方法允许你验证进入的请求是否与给定模式匹配。使用该方法时可以使用*通配符:

if($request->is('admin/*')){ 
    //
}

想要获取完整的URL,而不仅仅是路径信息,可以使用请求实例中的url方法:

$url=$request->url();

 获取请求方法

method方法将会返回请求的HTTP请求方式。你还可以使用isMethod方法来验证HTTP请求方式是否匹配给定字符串:

$method=$request->method();
if($request->isMethod('post')){ 
    //
}

1.2 PSR-7 请求

PSR-7标准指定了HTTP消息接口,包括请求和响应。如果你想要获取PSR-7请求实例,首先需要安装一些库,Lumen使用Symfony HTTP Message Bridge组件将典型的Lumen请求和响应转化为PSR-7兼容的实现:

composer require symfony/psr-http-message-bridge
composer require zendframework/zend-diactoros

安装完这些库之后,你只需要在路由或控制器中通过对请求类型进行类型提示就可以获取PSR-7请求:

use Psr\Http\Message\ServerRequestInterface;

$app->get('/', function (ServerRequestInterface $request) {
    //
});

如果从路由或控制器返回的是PSR-7响应实例,则其将会自动转化为Lumen响应实例并显示出来。

2、获取输入

获取输入值

使用一些简单的方法,就可以从Illuminate\Http\Request实例中访问用户输入。你不需要担心请求所使用的HTTP请求方法,因为对所有请求方式的输入访问接口都是一致的:

$name = $request->input('name');

你还可以传递一个默认值作为第二个参数给input方法,如果请求输入值在当前请求未出现时该值将会被返回:

$name = $request->input('name', 'Sally');

处理表单数组输入时,可以使用”.”来访问数组:

$input = $request->input('products.0.name');

判断输入值是否出现

判断值是否在请求中出现,可以使用has方法,如果值出现过了且不为空,has方法返回true

if ($request->has('name')) {
    //
}

获取所有输入数据

你还可以通过all方法获取所有输入数据:

$input = $request->all();

获取输入的部分数据

如果你需要取出输入数据的子集,可以使用onlyexcept方法,这两个方法都接收一个数组作为唯一参数:

$input = $request->only('username', 'password');
$input = $request->except('credit_card');

2.1 老的输入

注意:在使用该特性前必须开启session。

Lumen允许你在两次请求之间保存输入数据,这个特性在检测校验数据失败后需要重新填充表单数据时很有用,但如果你使用的是Lumen内置的验证服务,则不需要手动使用这些方法,因为一些Lumen内置的校验设置会自动调用它们。

将输入存储到一次性Session

Illuminate\Http\Request实例的flash方法会将当前输入存放到一次性session中,这样在下一次请求时数据依然有效:

$request->flash();

你还可以使用flashOnlyflashExcept方法将输入数据子集存放到session中:

$request->flashOnly('username', 'email');
$request->flashExcept('password');

将输入存储到一次性Session然后重定向

如果你经常需要一次性存储输入并重定向到前一页,可以简单使用withInput方法来将输入数据链接到redirect后面:

return redirect('form')->withInput();
return redirect('form')->withInput($request->except('password'));

取出老数据

要从上次请求取出一次性存储的输入数据,可以使用Request实例的old方法。old方法提供了便利的方式从session中取出一次性数据:

$username = $request->old('username');

Lumen还提供了一个全局的帮助函数old,如果你是在Blade模板中显示老数据,使用帮助函数old更方便:

{{ old('username') }}

2.2 Cookies

要强制所有cookies被加密和签名,需要取消 bootstrap/app.php文件中EncryptCookies 中间件前面的注释。Lumen及Laravel框架创建的所有签名cookies通过一个认证码进行加密和签名,这样如果客户端试图篡改cookies则该cookies将会失效。

从请求中取出Cookies

我们使用Illuminate\Http\Request实例的cookie方法从请求中获取cookie的值:

$value = $request->cookie('name');

新增Cookie到响应

Lumen提供了一个全局的帮助函数cookie作为一个简单工厂来生成新的Symfony\Component\HttpFoundation\Cookie实例,新增的cookies通过withCookie方法被附加到Illuminate\Http\Response实例:

$response = new Illuminate\Http\Response('Hello World');
$response->withCookie(cookie('name', 'value', $minutes));
return $response;

想要创建一个长期有效的cookie,可以使用cookie工厂的forever方法:

$response->withCookie(cookie()->forever('name', 'value'));

2.3 文件上传

获取上传的文件

可以使用Illuminate\Http\Request实例的file方法来访问上传文件,该方法返回的对象是Symfony\Component\HttpFoundation\File\UploadedFile类的一个实例,该类继承自PHP标准库中提供与文件交互方法的SplFileInfo类:

$file = $request->file('photo');

验证文件是否存在

使用hasFile方法判断文件在请求中是否存在:

if ($request->hasFile('photo')) {
    //
}

验证文件是否上传成功

使用isValid方法判断文件在上传过程中是否出错:

if ($request->file('photo')->isValid()){
    //
}

保存上传的文件

使用move方法将上传文件保存到新的路径,该方法将上传文件从临时目录(在PHP配置文件中配置)移动到指定新目录:

$request->file('photo')->move($destinationPath);
$request->file('photo')->move($destinationPath, $fileName);

其它文件方法

UploadedFile实例中很有很多其它方法,查看该类的API了解更多相关方法。

学院君

学院君 has written 548 articles

资深PHP工程师,Laravel学院院长