[Laravel 5.4] 新增 3 个全局中间件

概述

今天看到一条推，新增了3个全局中间件

详情

ValidatePostSize

验证 post 数据大小,避免大于php设定的post_max_size

    public function handle($request, Closure $next)
    {
        if ($request->server('CONTENT_LENGTH') > $this->getPostMaxSize()) {
            throw new PostTooLargeException;
        }
        return $next($request);
    }
    /**
     * Determine the server 'post_max_size' as bytes.
     *
     * @return int
     */
    protected function getPostMaxSize()
    {
        if (is_numeric($postMaxSize = ini_get('post_max_size'))) {
            return (int) $postMaxSize;
        }
        $metric = strtoupper(substr($postMaxSize, -1));
        switch ($metric) {
            case 'K':
                return (int) $postMaxSize * 1024;
            case 'M':
                return (int) $postMaxSize * 1048576;
            case 'G':
                return (int) $postMaxSize * 1073741824;
            default:
                return (int) $postMaxSize;
        }
    }

注意：如果超出php设定的post_max_size则会抛出Illuminate\Http\Exception\PostTooLargeException

TransformsRequest

TrimStrings 和 ConvertEmptyStringsToNull 中间件的基类

class TransformsRequest
{
    /**
     * The additional attributes passed to the middleware.
     *
     * @var array
     */
    protected $attributes = [];
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next, ...$attributes)
    {
        $this->attributes = $attributes;
        $this->clean($request);
        return $next($request);
    }
    /**
     * Clean the request's data.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return void
     */
    protected function clean($request)
    {
        $this->cleanParameterBag($request->query);
        $this->cleanParameterBag($request->request);
        if ($request->isJson()) {
            $this->cleanParameterBag($request->json());
        }
    }
    /**
     * Clean the data in the parameter bag.
     *
     * @param  \Symfony\Component\HttpFoundation\ParameterBag  $bag
     * @return void
     */
    protected function cleanParameterBag(ParameterBag $bag)
    {
        $bag->replace($this->cleanArray($bag->all()));
    }
    /**
     * Clean the data in the given array.
     *
     * @param  array  $data
     * @return array
     */
    protected function cleanArray(array $data)
    {
        return collect($data)->map(function ($value, $key) {
            return $this->cleanValue($key, $value);
        })->all();
    }
    /**
     * Clean the given value.
     *
     * @param  string  $key
     * @param  mixed  $value
     * @return mixed
     */
    protected function cleanValue($key, $value)
    {
        if (is_array($value)) {
            return $this->cleanArray($value);
        }
        return $this->transform($key, $value);
    }
    /**
     * Transform the given value.
     *
     * @param  string  $key
     * @param  mixed  $value
     * @return mixed
     */
    protected function transform($key, $value)
    {
        return $value;
    }
}

会分别对请求中的query request json 递归进每一个值都做处理，处理方法是transform

Laravel 5.4 拓展出来的有TrimStrings ConvertEmptyStringsToNull

TrimStrings

Illuminate/Foundation/Http/Middleware/TrimStrings.php 基类

<?php

namespace Illuminate\Foundation\Http\Middleware;

class TrimStrings extends TransformsRequest
{
    /**
     * The attributes that should not be trimmed.
     *
     * @var array
     */
    protected $except = [
        //
    ];
    /**
     * Transform the given value.
     *
     * @param  string  $key
     * @param  mixed  $value
     * @return mixed
     */
    protected function transform($key, $value)
    {
        if (in_array($key, $this->except)) {
            return $value;
        }
        return is_string($value) ? trim($value) : $value;
    }
}

Laravel 5.4项目文件app/Http/Middleware/TrimStrings.php

<?php
namespace App\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\TrimStrings as BaseTrimmer;
class TrimStrings extends BaseTrimmer
{
    /**
     * The names of the attributes that should not be trimmed.
     *
     * @var array
     */
    protected $except = [
        'password',
        'password_confirmation',
    ];
}

所以我们可以在 app/Http/Middleware/TrimStrings.php 这个文件中的 $except 里面定义我们不想去除首尾空白的字段

ConvertEmptyStringsToNull

<?php

namespace Illuminate\Foundation\Http\Middleware;

class ConvertEmptyStringsToNull extends TransformsRequest
{
    /**
     * Transform the given value.
     *
     * @param  string  $key
     * @param  mixed  $value
     * @return mixed
     */
    protected function transform($key, $value)
    {
        return is_string($value) && $value === '' ? null : $value;
    }
}

这下妈妈再也不用担心我存的数据因为空字符 '' 替代了 null 而引发的各种问题，可以少 array_filter 一次了

CustomYourTransformsRequest 拓展一个你的处理函数吧

所以相信各位看到这里也很清晰了，我们可以快速拓展我们自己的请求数据处理函数呀

只需要继承Illuminate\Foundation\Http\Middleware\TransformsRequest.php

然后写个transform($key, $value)方法就好啦

namespace App\Http\Middleware;

use Illuminate\Foundation\Http\Middleware\TransformsRequest;

class JustDoIt extends TransformsRequest
{
    /**
     * Transform the given value.
     *
     * @param  string  $key
     * @param  mixed  $value
     * @return mixed
     */
    protected function transform($key, $value)
    {
        // just do it
    }
}

总结

说实在这三个全局中间件，你说用途大嘛，其实不算太大，相信大家一直都会对请求数据做一些处理。你说用途小嘛，其实也不小，ConvertEmptyStringsToNull 其实挺实用的。而且学习 Laravel 最重要学习他的思想，我猜很多人也写过类似的中间件，但是可能并没有抽象出来一个 TransformsRequest ，显然这种处理方式非常值得学习，而且在 Laravel 中只能算冰山一角。所以 Laravel 的代码越读会越有味道。为什么要这样做，好在哪里，还能不能有更好的方式，最重要的是怎么做才能优雅。

本作品采用《CC 协议》，转载必须注明作者和本文链接