在 Laravel 中添加注释以将用户代码与 SQL 查询相关联

Laravel SQL Commenter 是一个 Spatie 为 Laravel 创建的，用于在 SQL 查询中添加注释的包。它使用了 sqlcommenter 来补充 SQL 语句:

/* 典型查询语句 */
select * from users
/* 被这个包补充了注释之后的查询语句 */
select * from "users"/*controller='UsersController',action='index'*/;

装完这个包，就有了 SQL 注释功能，然后你就能控制 注释里的内容 以及 注释功能的开关。

use Spatie\SqlCommenter\SqlCommenter;
 SqlCommenter::addComment('foo', 'bar');
 // select * from "users"/*foo='bar'*/;

这个包有个 “commenter(注释器)” 类的概念，意思是能往查询语句中加一些有用的信息，比如(查询来自哪个)控制器或者路由之类的。开箱即用，它包含了以下 commenter (注释器):

• ControllerCommenter
• RouteCommenter,
• JobCommenter
• FileCommenter
• CurrentUserCommenter

你还可以使用此包中提供的 commenter 界面添加自定义类。

在 GitHub 上了解此扩展包、获取完整的安装说明并查看 源代码。 如果你想深入了解这个包的背景，作者 Freek Van der Herten 写了一篇题为 Add comments to SQL queries made by Laravel 的帖子。

本文中的所有译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。

原文地址：https://laravel-news.com/laravel-sql-com...

译文地址：https://learnku.com/laravel/t/69694