Artisan 命令行

[[toc]]

介绍

Artisan 是 Goravel 自带的命令行工具，该模块可以使用 facades.Cache 进行操作。它提供了许多有用的命令，这些命令可以在构建应用时为你提供帮助。其底层使用 urfave/cli 进行功能的实现。你可以通过命令查看所有可用的 Artisan 命令：

  1. go run . artisan list

每个命令都包含了「help」界面，它会显示和概述命令的可用参数及选项。只需要在命令前加上 help 即可查看命令帮助界面：

  1. go run . artisan help migrate

编写命令

除 Artisan 提供的命令外，你也可以编写自己的自定义命令。命令位于 app/console/commands 目录中。

生成命令

要创建新命令，可以使用 make:command Artisan 命令。该命令将在 app/console/commands 目录中创建一个新的命令类。如果你的应用程序中不存在此目录，请不要担心，它将在你第一次运行 make:command 命令时自动创建：

  1. go run . artisan make:command SendEmails

命令结构

生成命令后，应为该类的 signature 和 description 属性定义适当的值。当使用 list 命令显示命令列表时，将使用这些属性。执行命令时将调用handle方法。你可以将命令逻辑放在此方法中。

  1. package commands
  3. import (
  4.   "github.com/goravel/framework/contracts/console"
  5.   "github.com/urfave/cli/v2"
  6. )
  8. type SendEmails struct {
  9. }
  11. //Signature The name and signature of the console command.
  12. func (receiver *SendEmails) Signature() string {
  13.   return "emails"
  14. }
  16. //Description The console command description.
  17. func (receiver *SendEmails) Description() string {
  18.   return "Command description"
  19. }
  21. //Extend The console command extend.
  22. func (receiver *SendEmails) Extend() console.CommandExtend {
  23.   return console.CommandExtend{}
  24. }
  26. //Handle Execute the console command.
  27. func (receiver *SendEmails) Handle(c *cli.Context) error {
  28.   return nil
  29. }

定义输入

在编写控制台命令时，通常是通过参数和选项来收集用户输入的。 Goravel 让你可以非常方便的获取用户输入的内容。

参数

直接在命令后跟参数：

  1. go run . artisan emails NAME EMAIL

获取参数：

  1. func (receiver *ListCommand) Handle(c *cli.Context) error {
  2.   name := c.Args().Get(0)
  3.   email := c.Args().Get(1)
  5.   return nil
  6. }

选项

选项类似于参数，是用户输入的另一种形式。在命令行中指定选项的时候，它们以两个短横线 (–) 作为前缀。

定义：

  1. func (receiver *ListCommand) Extend() console.CommandExtend {
  2.   return console.CommandExtend{
  3.     Flags: []cli.Flag{
  4.       &cli.StringFlag{
  5.         Name:    "lang",
  6.         Value:   "english",// 默认值
  7.         Aliases: []string{"l"},// 选项简写
  8.         Usage:   "language for the greeting",// 选项说明
  9.       },
  10.     },
  11.   }
  12. }

获取：

  1. func (receiver *ListCommand) Handle(c *cli.Context) error {
  2.   lang := c.String("lang")
  4.   return nil
  5. }

使用：

  1. go run . artisan emails --lang chinese
  2. go run . artisan emails -l chinese // 缩写

具体使用方法请参考 urfave/cli 文档

分类

可以将一组命令设置为同一个分类，方便在 go run . artisan list 中查看：

  1. //Extend The console command extend.
  2. func (receiver *ConsoleMakeCommand) Extend() console.CommandExtend {
  3.   return console.CommandExtend{
  4.     Category: "make",
  5.   }
  6. }

子命令

可以为一个命令设置多个子命令：

  1. //Extend The console command extend.
  2. func (receiver *SendEmails) Extend() console.CommandExtend {
  3.   return console.CommandExtend{
  4.     Subcommands: []*cli.Command{
  5.       {
  6.         Name:  "add",
  7.         Usage: "add a new template",
  8.         Action: func(c *cli.Context) error {
  9.           fmt.Println("new task template: ", c.Args().First())
  10.           return nil
  11.         },
  12.       },
  13.       {
  14.         Name:  "remove",
  15.         Usage: "remove an existing template",
  16.         Action: func(c *cli.Context) error {
  17.           fmt.Println("removed task template: ", c.Args().First())
  18.           return nil
  19.         },
  20.       },
  21.     },
  22.   }
  23. }

使用：

  1. go run . artisan emails add
  2. go run . artisan emails remove

具体使用方法请参考 urfave/cli 文档

注册命令

你的所有控制台命令都在你的应用程序的 app\console\kernel.go 中注册，这是你的应用程序的「控制台内核」。在此文件的 Commands 方法中，加载所有可用的命令。

  1. func (kernel Kernel) Commands() []console.Command {
  2.   return []console.Command{
  3.     &commands.SendEmails{},
  4.   }
  5. }

以编程方式执行命令

有时你可能希望在 CLI 之外执行 Artisan 命令。例如，你可能希望从路由或控制器执行 Artisan 命令。可以使用 facades.Artisan 上的 Call 方法来完成此操作。

  1. facades.Route.GET("/", func(c *gin.Context) {
  2.   facades.Artisan.Call("emails")
  3.   facades.Artisan.Call("emails name --lang chinese") // 携带参数与选项
  4. })