讓你的程式更美好 - 重構現有的程式碼 - iT 邦幫忙::一起幫忙解決難題，拯救 IT 人的一天

第 11 屆 iThome 鐵人賽

DAY 25

Modern Web

使用 Laravel 打造 RESTful API系列第 25 篇

讓你的程式更美好 - 重構現有的程式碼

11th鐵人賽 laravel php 重構

Victor

團隊IT成長團

2019-10-06 00:37:53

2931 瀏覽

分享至

本系列文章已集結成冊與鐵人賽文章差異內容，有以下幾點：

更新至Laravel 8、基礎的PHP重點筆記、加強製作API流程細節、加入程式設計模式，優化、重構程式碼的部分，並且於書籍前面的章節介紹Git。

讓您從製作第一個簡單的API到優化自己的程式碼，分享我的經驗給您，打造自己的最強大腦API，若有興趣的朋友可以參考看看

天瓏網路書局：
https://www.tenlong.com.tw/products/9789864345304

此篇文章同步發於個人部落格

開始重構程式碼，前幾天有提到 Controller 越來越肥大，程式碼越來越多，根本就已經超出人類想要看的範圍了！就像一篇好的文章，字數太多也是一件壞事，要有足夠的耐性才會想看。

這系列鐵人賽目前的 Controller 程式碼還不算太多，還算簡單拆開來相對容易，講解也比較清楚。

預計這樣拆開目前的 Controller

驗證會員等級權限 - 已由 Policy 負責
驗證使用者輸入資料 - 需再加入 Request
商業邏輯或外部資源 - 需再加入 Service
轉換資料結構 - 已由 Resource 負責

為了達到接近單一職責原則預計把Controller 拆成這個樣子！降低程式之間的耦合性！對目前的程式來說比較好！檔案不會拆太多太細，又可以讓程式可讀性增加， Policy、Resource 已經完成了！現在來拆解 Service、驗證資料

先來說說重構，重構程式碼並不是看心情去寫的，盡量減少打掉重來比較快的想法。現有的程式碼，經歷過不斷的除錯，才有現在穩定功能，想必有很多細節都有注意到。重構是希望可以讓程式碼更好維護，但功能要一樣，不然出問題了會覺得自己很野小！

這也是為什麼重購一開始要先寫一點測試的原因。先寫系統再來寫測試，我認為是目前業界比較常看到的模式屬於防禦類型，預防修改帶來的錯誤，另外一種現在蠻多新創公司的開發模式叫 TDD 先寫測試再來打造系統，讓輸入輸出固定好結構再全力衝刺！（離題了～）

驗證資料

先從驗證資料開始，我們以新建動物資源的API來拆分驗證資料Request 檔案！

請先開啟自動執行測試功能，如果忘記的可以參考昨天的文章開始拆分到 Service - 寫一點點測試

新建檔案

php artisan make:request StoreAnimalRequest

撰寫程式

app/Http/Requests/StoreAnimalRequest.php

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class StoreAnimalRequest extends FormRequest
{
    /**
     * 是否登入才能請求
     *
     * @return bool
     */
    public function authorize()
    {
        return true;
    }

    /**
     * 請求的資料欄位規則
     *
     * @return array
     */
    public function rules()
    {
        // 把 app/Http/Controllers/AnimalController.php 中 store 方法裡，之前寫的驗證表單規則複製過來 
        return [
            'type_id' => 'required',
            'name' => 'required|max:255',
            'birthday' => 'required|date',
            'area' => 'required|max:255',
            'fix' => 'required|boolean',
            'description' => 'nullable',
            'personality' => 'nullable'
        ];
    }
}

app/Http/Controllers/AnimalController.php

use App\Http\Requests\StoreAnimalRequest;

/**
 * Store a newly created resource in storage.
 *
 * @param  App\Http\Requests\StoreAnimalRequest  $request
 * @return \Illuminate\Http\Response
 */
public function store(StoreAnimalRequest $request)
{
    // 這裡原本寫的可以全部刪掉
    // $this->validate($request, [
    //     'type_id' => 'required',
    //     'name' => 'required|max:255',
    //     'birthday' => 'required|date',
    //     'area' => 'required|max:255',
    //     'fix' => 'required|boolean',
    //     'description' => 'nullable',
    //     'personality' => 'nullable'
    // ]);
    
    // 這個store方法只會剩下下面兩行
    $animal = Animal::create($request->all());
    return response($animal, Response::HTTP_CREATED);
}