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 协议》，转载必须注明作者和本文链接