[Laravel 5.4] 新增 3 個全域性中介軟體

milkmeowo發表於2017-01-18
Laravel

概述

file

今天看到一條推，新增了3個全域性中介軟體

中介軟體 功能
ValidatePostSize 驗證 post 資料大小
TrimStrings 去除首尾空白字元
ConvertEmptyStringsToNull 轉換空字串為 null
一個基類
TransformsRequest 處理請求資料格式

詳情

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 的程式碼越讀會越有味道。為什麼要這樣做，好在哪裡，還能不能有更好的方式，最重要的是怎麼做才能優雅。

相關文章