最近在公司的項(xiàng)目開發(fā)中使用到了 laravel 框架，采用的是前后端開發(fā)的模式。接觸過前后端開發(fā)模式的小伙伴應(yīng)該都知道，后端返回的數(shù)據(jù)格式需要盡可能搞得保證一致性，這樣前端在處理時(shí)也方便處理。我們先通過觀看下面的兩張接口返回的效果圖吧，這樣或許會更加的直觀一些。

laravel默認(rèn)的輸出格式(圖一)

修改后的輸出格式(圖二)

或許通過上面兩張圖，你還是未看出有什么區(qū)別的話。這里我用文字描述一下吧。 這種情況是發(fā)生在laravel做表單驗(yàn)證的情況下發(fā)生的。前端向我后端接口發(fā)送一個(gè)POST請求時(shí)，發(fā)送了一個(gè)title和body的字段。我后端需要對兩個(gè)字段做一些非空驗(yàn)證。按照框架手冊來進(jìn)行的話，輸出的格式就是圖一的格式。然后后端統(tǒng)一的輸出格式是圖二中的格式，如果按照圖一的格式輸出肯定是不行，這樣就需要我們做一個(gè)特殊處理。

問題排查

首先我們可以通過文檔參看到如下信息。下面劃線的部分，提到的返回信息是將所有未驗(yàn)證通過的數(shù)據(jù)都返回給前端，就如圖一中的數(shù)據(jù)格式。

laravel默認(rèn)的輸出格式(圖三)

預(yù)期效果

通過圖三我們知道了 laravel 默認(rèn)的是返回一個(gè)帶 422 的 http 狀態(tài)碼并且將所有的驗(yàn)證錯(cuò)誤信息都返回。

然而我們需要的只是如圖二的格式，單個(gè)的輸出錯(cuò)誤信息。大致的解決思路就是在輸出的時(shí)候，我們?nèi)ツJ(rèn)顯示第一個(gè)未通過的驗(yàn)證信息，當(dāng)通過之后，之前第二個(gè)未嚴(yán)重通過的就變成了第一個(gè)，這樣依次循環(huán)下去，我們的每個(gè)數(shù)據(jù)就得到了驗(yàn)證。驗(yàn)證的地方我們選擇框架異常統(tǒng)一處理的地方，這樣每次驗(yàn)證都自動的進(jìn)行處理。

解決方案

該框架是 laravel5.8 的情況下進(jìn)行編寫,如果版本不同,或許還需要特殊的處理,不過處理的思路可以參考下面的。

1.創(chuàng)建一個(gè)表單驗(yàn)證器。執(zhí)行下面的命令之后，我們在php app/Http/Requests目錄下面就可以看到該類文件了。

php artisan make:request ProjectValidate

2.定義驗(yàn)證規(guī)則。rules 方法是定義驗(yàn)證規(guī)則,而 messages 方法則是定義返回的錯(cuò)誤信息，該方法也可以省略掉，這樣提示的信息就是英文而不是圖一或圖二看到的中文了。

namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class ProjectValidate extends FormRequest
{
  /**
   * Determine if the user is authorized to make this request.
   *
   * @return bool
   */
  public function authorize()
  {
    return true;
  }
  /**
   * Get the validation rules that apply to the request.
   *
   * @return array
   */
  public function rules()
  {
    return [
      'title' => 'bail|required',
      'body' => 'required',
    ];
  }
  /**
   * define the validation message
   *
   * @return array
   */
  public function messages()
  {
    return [
      'title.required' => '文章標(biāo)題必填',
      'body.required' => '文章內(nèi)容必填',
    ];
  }
}

3.使用驗(yàn)證器。這里我定義了一個(gè)控制器，在 addData 方法中，使用依賴注入的方式去實(shí)現(xiàn)數(shù)據(jù)的驗(yàn)證。記住，該方法體在未通過數(shù)據(jù)驗(yàn)證的情況下是不會去執(zhí)行的。

namespace App\Http\Controllers\Backend\Project;

use App\Http\Requests\ProjectValidate;
use App\Http\Controllers\Backend\UCenter;

class Index extends UCenter
{
  public function index()
  {
    return success();
  }
  public function addData(ProjectValidate $request)
  {
    $validated = $request->validated();
    return success($validated);
  }
}

4.統(tǒng)一處理數(shù)據(jù)格式。找到php App\Exceptions\Handler.php文件，找到下面的方法，修改為如下內(nèi)容。這時(shí)候在做表單驗(yàn)證就會顯示圖二的格式信息了。

public function render($request, Exception $exception)
  {
    if ($exception instanceof ValidationException) {
      // 只讀取錯(cuò)誤中的第一個(gè)錯(cuò)誤信息
      $errors = $exception->errors();
      $message = '';
      // 框架返回的是二維數(shù)組，因此需要去循環(huán)讀取第一個(gè)數(shù)據(jù)
      foreach ($errors as $key => $val) {
        $keys  = array_key_first($val);
        $message = $val[$keys];
        break;
      }
      return response()->json(['code' => 1001, 'message' => $message, 'data' => []], 422);
    }
    return parent::render($request, $exception);
  }

總結(jié)

1.優(yōu)勢

輸出固定的格式，前端在處理數(shù)據(jù)的時(shí)候，不需要做特別的格式上面調(diào)整。

2.劣勢

這樣的方式驗(yàn)證，每驗(yàn)證一次，就會向后端發(fā)送一個(gè) http 請求。

以上所述是小編給大家介紹的Laravel框架表單驗(yàn)證格式化輸出的方法,希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時(shí)回復(fù)大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持！
如果你覺得本文對你有幫助，歡迎轉(zhuǎn)載，煩請注明出處，謝謝！

最新評論