Lumen 使用 laravel-ide-helper

背景

前後端分離 Laravel 作為後端框架，對於未來只有無狀態的呼叫，存在一些比如載入的東西太多、太大、有些東西沒用到、臃腫…，框架老手可以通過配置使框架變得高效、輕量，但如果從框架層面本身做到輕量，使用 Lumen 將會是一個不錯的選擇。

安裝 laravel-ide-helper

使用 Lumen 版本的 Laravel 框架，想使用 laravel-ide-helper 來自動生成 Model 的相關自動註釋，提高開發效率，於是執行：

composer require barryvdh/laravel-ide-helper --dev 

手動註冊 laravel-ide-helper 服務提供者

Lumen 是超級輕量的，除了必要的外掛框架已經註冊，其它的一些需要手動註冊，所以安裝完後還需要在 bootstrap/app.php 手動註冊，於是開啟 app.php，在合適的位置新增：

// other code ...
if ($app->environment() == 'local') {
    $app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
}
// other code ...

生成 Model 註釋

這個時候就可以執行下 php artisan list 檢視 ide-helper 命令是否新增成功，這裡我就當成功了，直接執行：

# 為模型生成註釋
php artisan ide-helper:models

結果大概如下：

root@7b6c5c78829c:/var/www/ads# php artisan ide-helper:models

 Do you want to overwrite the existing model files? Choose no to write to _ide_helper_models.php instead (yes/no) [no]:
 > yes

Written new phpDocBlock to /var/www/ads/app/Models/CreditCardMaster.php
Written new phpDocBlock to /var/www/ads/app/Models/User.php
root@7b6c5c78829c:/var/www/ads# php artisan list

開啟對應的 Model 檔案，就會發現已經自動生成了相關的註釋欄位:

效果展示：

如此，在開發的時候，就能出現提示，效果如下：

能看詳細欄位描述：

參考資料

Laravel 超好用程式碼提示工具 Laravel IDE Helper
lumen可以使用laravel-ide-helper
GitHub:laravel-ide-helper

本作品採用《CC 協議》，轉載必須註明作者和本文連結