如何在Laravel中添加评论,将用户代码与SQL查询联系起来

172 阅读1分钟

Laravel[SQL Commenter]是一个由[Spatie]制作的软件包,用于为Laravel的SQL查询添加注释。它使用[sqlcommenter]来增加关于代码的SQL语句。

/* typical query */
select * from users
 
/* comments added by this package */
select * from "users"/*controller='UsersController',action='index'*/;

一旦这个包被安装,SQL注释就会被自动包含,你可以控制哪些东西被添加到注释中,并动态地禁用注释。

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

这个包有一个 "评论者 "类的概念,它为查询添加有用的信息,如控制器和路由信息。开箱即用,这个包包括以下评论器。

  • ControllerCommenter
  • RouteCommenter
  • 工作注释器
  • 文件注释器
  • CurrentUserCommenter

你也可以使用这个包中提供的Commenter 接口来添加自定义评论器类。