Laravel 5.5 HTTP 请求

末蓝、 2022-05-19 05:36 217阅读 0赞

## 访问请求实例 ##

在控制器中，获取当前 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');
    
            //
        }
    }

如果还期望在控制器方法中获取路由参数，只需要将路由参数置于其它依赖之后即可。

<?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://www.adm.devp/user/1][http_www.adm.devp_user_1] ，则 path 方法将会返回 user/1：

$path = $request->path();

is 方法允许你验证请求路径是否与给定模式匹配。该方法参数支持 \* 通配符：

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

如果请求URL是 [http://www.adm.devp/user/1][http_www.adm.devp_user_1] ，该方法会返回 true。

### 获取请求 URL ###

想要获取完整的 URL，而不仅仅是路径信息，可以使用请求实例提供的 url 或 fullUrl 方法， url 方法返回不带查询字符串的 URL，而 fullUrl 方法则包含查询字符串。

// 不包含查询字符串
    $url = $request->url();
    
    // 包含查询字符串
    $url_with_query = $request->fullUrl();

### 获取请求方式 ###

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) {
        //
    });

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

### 请求字符串处理 ###

默认情况下，Laravel 在 App\\Http\\Kernel.php 的全局中间件中引入了 TrimStrings 和 ConvertEmptyStringsToNull 中间件。这些中间件会自动对请求中的字符串字段进行处理，前者将字符串两端的空格清除，后者将空字符串转化为 null。

这样，在路由和控制器中我们就不必对字符串字段做额外的处理。

如果你想要禁止该行为，可以从 App\\Http\\Kernel.php 的全局中间件属性 $middleware 中移除这两个中间件。

### 获取请求输入 ###

你可以使用 all 方法以数组格式获取所有输入值：

$input = $request->all();

input 方法，可用于获取单个输入。

你不需要关心请求所使用的 HTTP 请求方式，因为对所有请求方式都是通过 input 方法获取用户输入：

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

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

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

处理表单数组输入时，可以使用 **.** 来访问数组输入。

$input = $request->input('user.0.name');
    
    $names = $request->input('user.*.name');

如果访问的是 [http://www.adm.devp/user/1?user\[\]\[name\]=jack&user\[\]\[name\]=rose][http_www.adm.devp_user_1_user_name_jack_user_name_rose] ，则 $input 的值是 jack ， 而 $names 的值是：

array(2) { [0]=> string(4) "jack" [1]=> string(4) "rose" }

### 从查询字符串中获取输入 ###

input 方法会从整个请求（包括查询字符串）中获取数据，而 query 方法只会从查询字符串中获取数据。

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

query 方法也支持默认值，你也可以调用一个不传任何参数的 query 方法以便以关联数组的方式获取整个查询字符串的数据，类似 all 方法所做的。

$query = $request->query();

query 方法就是从 query 属性对象中获取参数值，input 方法会从 query + request 属性对象中获取参数值，请求实例上还有个 post 方法。

query 方法只能用于获取 GET 请求查询字符串的数据，input 方法用于获取所有 HTTP 请求参数值，post 方法用于获取 POST 请求参数值。

### 通过动态属性获取输入 ###

此外，还可以通过使用 Illuminate\\Http\\Request 实例上的动态属性，来访问用户的输入。

例如，如果你的应用表单包含 name 字段，那么可以像这样访问提交的值：

$name = $request->name;

使用动态属性时，Laravel 首先会在请求参数中查找，如果不存在，还会到路由参数中查找。

### 获取 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');

### 判断请求参数是否存在 ###

判断参数在请求中是否存在，可以使用 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。

## Cookie ##

### 从请求中取出 Cookie ###

为了安全起见，Laravel 框架创建的所有 Cookie 都经过加密并使用一个认证码进行签名，这意味着如果客户端修改了它们则需要对其进行有效性验证。我们使用 Illuminate\\Http\\Request 实例的 cookie 方法从请求中获取 Cookie 的值。

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

### 添加 Cookie 到响应 ###

你可以使用 cookie 方法将一个 Cookie 添加到返回的 Illuminate\\Http\\Response 实例，你需要传递 Cookie 名称、值、以及有效期（分钟）到这个方法：

return response('test')->cookie(
        'name', 'jack', $minutes
    );

我们简单演示下该功能的使用，在 routes/web.php 中定义两个路由如下：

Route::get('cookie/add', function () {
        $minutes = 24 * 60;
        return response('test')->cookie('name', 'jack', $minutes);
    });
    
    Route::get('cookie/get', function(\Illuminate\Http\Request $request) {
        $cookie = $request->cookie('name');
        dd($cookie);
    });

在浏览器中，先访问 [http://www.adm.devp/cookie/add][http_www.adm.devp_cookie_add] 设置cookie，然后访问 [http://www.adm.devp/cookie/get][http_www.adm.devp_cookie_get] 获取 cookie。

### 生成 cookie 实例 ###

如果你想要生成一个 Symfony\\Component\\HttpFoundation\\Cookie 实例，以便后续添加到响应实例，可以使用全局辅助函数 cookie，该 Cookie 只有在添加到响应实例上才会发送到客户端。

$cookie = cookie('name', 'rose', $minutes);
    return response('test')->cookie($cookie);

改写下之前的 cookie/add 路由实现逻辑：

Route::get('cookie/add', function () {
        $minutes = 24 * 60;
        $cookie = cookie('name', 'rose', $minutes);
        return response('test')->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文档][API]来了解更多信息。

### 保存上传的文件 ###

要保存上传的文件，需要使用你所配置的某个文件系统，对应配置位于 config/filesystems.php。

'disks' => [
    
        'local' => [
            'driver' => 'local',
            'root' => storage_path('app'),
        ],
    
        'public' => [
            'driver' => 'local',
            'root' => storage_path('app/public'),
            'url' => env('APP_URL').'/storage',
            'visibility' => 'public',
        ],
    
        's3' => [
            'driver' => 's3',
            'key' => env('AWS_ACCESS_KEY_ID'),
            'secret' => env('AWS_SECRET_ACCESS_KEY'),
            'region' => env('AWS_DEFAULT_REGION'),
            'bucket' => env('AWS_BUCKET'),
        ],
    
    ],

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', 'public');

如果你不想自动生成文件名，可以使用 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('未获取到上传文件或上传过程出错');
    });

## 配置信任代理 ##

如果你的应用运行在一个会中断 TLS/SSL 证书的负载均衡器之后，你会注意到有的时候应用不会生成 HTTPS 链接，通常这是因为应用是从负载均衡器的80端口转发过来的流量，所以不知道应该生成安全加密链接。

要解决这个问题可以使用 Laravel 5.5 新增的 App\\Http\\Middleware\\TrustProxies 中间件，该中间件允许你快速自定义需要被应用信任的负载均衡器或代理。被信任的代理位于这个中间件的 $proxies 属性列表，除了配置信任代理之外，还可以配置代理发送的带有请求来源信息的消息头。

app/Http/Middleware/TrustProxies.php 中间件的默认内容如下：

<?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;
    
        /**
         * The current proxy header mappings.
         *
         * @var array
         */
        protected $headers = [
            Request::HEADER_FORWARDED => 'FORWARDED',
            Request::HEADER_X_FORWARDED_FOR => 'X_FORWARDED_FOR',
            Request::HEADER_X_FORWARDED_HOST => 'X_FORWARDED_HOST',
            Request::HEADER_X_FORWARDED_PORT => 'X_FORWARDED_PORT',
            Request::HEADER_X_FORWARDED_PROTO => 'X_FORWARDED_PROTO',
        ];
    }

### 信任所有代理 ###

如果你在使用 Amazon AWS 或者其他云服务提供的负载均衡，并不知道均衡器真实的 IP 地址，这种情况下，可以使用 \*\* 通配符信任所有代理。

protected $proxies = '**';

[http_www.adm.devp_user_1]: http://www.adm.devp/user/1
[http_www.adm.devp_user_1_user_name_jack_user_name_rose]: http://www.adm.devp/user/1?user%5B%5D%5Bname%5D=jack&user%5B%5D%5Bname%5D=rose
[http_www.adm.devp_cookie_add]: http://www.adm.devp/cookie/add
[http_www.adm.devp_cookie_get]: http://www.adm.devp/cookie/get
[API]: http://api.symfony.com/3.0/Symfony/Component/HttpFoundation/File/UploadedFile.html