Laravel 5.1框架中如何创建自定义Artisan控制台命令

2024-08-25 11:38
文章标签 自定义 命令 创建 框架 控制台 artisan 5.1 laravel

本文主要是介绍Laravel 5.1框架中如何创建自定义Artisan控制台命令，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

对于laravel初学者来说，对laravel创建自定义Artisan控制台命令可能是不太了解，接下来的这篇文章给大家分享一下laravel框架中创建自定义Artisan控制台命令的实例。

 

1、入门

Laravel通过Artisan提供了强大的控制台命令来处理非浏览器业务逻辑。要查看Laravel中所有的Artisan命令，可以通过在项目根目录运行：

1

php artisan list

对应输出如下（部分截图）：

2015-10-19_211849.jpg

其中一些命名我们已经比较熟悉了，比如创建迁移make:migration以及执行迁移migrate，又比如创建模型make:model，创建控制器make:controller等。

如果要查看具体某个命令的使用方法，比如我们要查看创建Artisan命令make:console的具体用法，可以使用如下命令：

1

php artisan help make:console

对应输出如下：

2015-10-19_212233.jpg

2、创建命令

Artisan除了提供丰富的控制台命令之外，还允许我们通过make:console命令创建自己的控制台命令。上面我们已经使用help指令查看了make:console的用法，下面我们就沿着这条路走下去，一探究竟：创建命令并运行起来得到我们想要的各种结果。

首先我们创建一个最简单的命令，打印Hello LaravelAcademy，使用Artisan命令如下：

1

php artisan make:console HelloLaravelAcademy --command=laravel:academy

其中HelloLaravelAcademy是命令名，laravel:academy是控制台执行的命令，类似make:console。

执行完成后，会在app/Console/Commands目录下生成一个HelloLaravelAcademy.php文件：

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class HelloLaravelAcademy extends Command

{

    /**

     * The name and signature of the console command.

     *

     * @var string

     */

    protected $signature = 'laravel:academy';

    /**

     * The console command description.

     *

     * @var string

     */

    protected $description = 'Command description.';

    /**

     * Create a new command instance.

     *

     * @return void

     */

    public function __construct()

    {

        parent::__construct();

    }

    /**

     * Execute the console command.

     *

     * @return mixed

     */

    public function handle()

    {

        //

    }

}

其中$signature即为在控制台执行的命令名，$description为命令描述，handle方法为执行命令时调用的方法。

接下来我们简单编写handle方法如下：

1

2

3

4

public function handle()

{

    echo "Hello LaravelAcademy\n";

}

好了，一个最简单的命令已经编写好了，接下来要怎么执行并在控制台打印出“Hello LaravelAcademy”呢？

3、运行命令

在运行命令前需要将其注册到App\Console\Kernel的$commands属性中：

1

2

3

4

protected $commands = [

     ...  //其他命令类

     \App\Console\Commands\HelloLaravelAcademy::class

];

接下来我们就可以在控制台运行如下Artisan命令：

1

php artisan laravel:academy

终端就会打印出：

1

Hello LaravelAcademy

是不是很简单？

4、更多样的输入输出

当然，上面是最简单的情形，没有输入，写死的输出。实际环境中有更复杂的需求，有更多样的输入输出，下面我们来一一讨论。

定义输入

上面已经提到，我们可以通过修改$signature属性定义输入参数及选项，比如这里我们将上述Hello后面的字符串调整为通过输入参数来控制，可修改$signature如下：

1

protected $signature = 'laravel:academy {name}';

这样定义意味着name是必选参数，当然还支持更多自定义参数输入：

1

2

{name?} //可选参数

{name=LaravelAcademy} //默认name值为LaravelAcademy

为增强程序健壮性，我们将name修改为有默认值：

1

protected $signature = 'laravel:academy {name=LaravelAcademy}';

有时候我们还会在执行命令时传入一些选项，比如是否显示标点符号（虽然听上去很鸡肋，这里权当测试之用）， 那么我们可以修改$signature属性如下：

1

protected $signature = 'laravel:academy {name=LaravelAcademy} {--mark}';

如果调用命令时传递--mark则代表其值为true，否则为false，如果选项值在输入时通过用户设置，可定义$signature如下：

1

protected $signature = 'laravel:academy {name=LaravelAcademy} {--mark=}';

这样用户就可以在传入选项时通过=来为选项赋值，当然和参数一样，我们也可以为选项指定默认值：

1

protected $signature = 'laravel:academy {name=LaravelAcademy} {--mark=!}';

获取输入

定义好输入参数和选项后，又该如何获取其对应值呢？Laravel为我们提供了相应的方法。

获取参数值可以通过Illuminate\Console\Command的argument方法：

1

$name = $this->argument('name');

如果无参调用argument方法，则返回的是所有参数值数组。

获取选项值可以通过Illuminate\Console\Command的option方法：

1

$mark = $this->option('mark');

同理，无参调用option方法会返回所有选项值数组。

这样我们可以修改HelloLaravelAcademy的handle方法如下：

1

2

3

4

5

6

7

8

9

public function handle()

{

    $name = $this->argument('name');

    $mark = $this->option('mark');

    $string = 'Hello '.$name;

    if($mark)

        $string .= $mark;

    echo $string."\n";

}

这样我们在控制台输入如下Artisan命令：

1

php artisan laravel:academy

对应输出为：

1

Hello LaravelAcademy!

再运行如下Artisan命令：

1

php artisan laravel:academy Laravel --mark=?

对应输出为：

1

Hello Laravel?

输入提示

我们甚至还可以完全让用户通过在控制台输入name来获取输入参数，首先修改handle方法如下：

1

2

3

4

5

public function handle()

{

    $name = $this->ask('What do you want to say Hello?');

    echo "Hello ".$name."\n";

}

然后在终端输入php artisan laravel:academy，交互页面如下：
2015-10-19_224643.jpg

如果是输入密码一类的敏感信息可以用secret替代ask方法。
有时候我们会根据用户的意愿选择继续还是中止：

1

2

3

4

5

6

7

8

public function handle()

{

    if($this->confirm('Do you want to continue?[y|n]')){

        $this->info("Continue");

    }else{

        $this->error("Interrupt");

    }

}

对应输出为：

2015-10-19_232437.jpg

除了让用户手动输入外，还可以使用anticipate方法实现自动完成功能：

1

2

3

4

5

public function handle()

{

    $name = $this->anticipate('What is your name?', ['Laravel', 'Academy']);

    $this->info($name);

}

当然还可以使用choice方法为用户提供选择避免手动输入，用户只需选择对应索引即可：

1

2

3

4

5

public function handle()

{

    $name = $this->choice('What is your name?', ['Laravel', 'Academy']);

    $this->info($name);

}

对应交互页面如下：

2015-10-19_233106.jpg

编写输出

关于输出字符串，上面我们简单使用了echo语句，其实Laravel提供了更为强大和多样化的方法：

1

2

3

4

5

6

7

public function handle()

{

    $this->info("Successful!");

    $this->error("Something Error!");

    $this->question("What do you want to do?");

    $this->comment("Just Comment it!");

}

执行php artisan laravel:academy对应输出如下：

2015-10-19_225422.jpg

表格

Artisan甚至可以输出表格：

1

2

3

4

5

6

public function handle()

{

    $headers = ['Name', 'Email'];

    $users = \App\User::all(['name', 'email'])->toArray();

    $this->table($headers, $users);

}

执行php artisan laravel:academy对应输出为：

2015-10-19_225643.jpg

进度条

当然对于复杂耗时的命令，进度条是必不可少的，

1

2

3

4

5

6

7

8

9

public function handle()

{

    $this->output->progressStart(10);

    for ($i = 0; $i < 10; $i++) {

        sleep(1);

        $this->output->progressAdvance();

    }

    $this->output->progressFinish();

}

执行php artisan laravel:academy对应输出为：

2015-10-19_230505.jpg

5、从CLI之外调用Artisan

除了在控制台执行Artisan命令之外，还可以通过代码在别处调用Artisan命令，比如其它Artisan命令、控制器、路由或其他。

路由

在路由闭包中我们可以通过Artisan门面的call方法来调用本节创建的命令：

1

2

3

4

5

6

//在路由中调用Artisan命令

Route::get('testArtisan',function(){

    $exitCode = Artisan::call('laravel:academy', [

        'name' => 'Laravel学院', '--mark' => '！'

    ]);

});

其它Artisan命令

在一个Artisan命令中也可以调用另一个Artisan命令，还是通过call方法：

1

2

3

4

public function handle()

{

    $this->call('inspire');

}

如果想要调用一个Artisan命令并阻止其所有输出，可以使用callSilent方法：

1

2

3

4

public function handle()

{

    $this->callSilent('inspire');

}

除此之外，关于Artisan命令你还应该知道的是我们可以在创建的命令类的控制器或方法中注入任何依赖。这就意味着我们可以在命令类中使用注册到服务容器的所有类。

相关推荐：

laravel框架的启动过程分析

Laravel框架内置的Broadcast功能如何实现与客户端实时通信

以上就是Laravel 5.1框架中如何创建自定义Artisan控制台命令的详细内容，更多请关注php中文网其它相关文章！

这篇关于Laravel 5.1框架中如何创建自定义Artisan控制台命令的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1105452。

相关文章

Window Server创建2台服务器的故障转移群集的图文教程

Window Server创建2台服务器的故障转移群集的图文教程

《WindowServer创建2台服务器的故障转移群集的图文教程》本文主要介绍了在WindowsServer系统上创建一个包含两台成员服务器的故障转移群集,文中通过图文示例介绍的非常详细,对大家的... 目录一、 准备条件二、在ServerB安装故障转移群集三、在ServerC安装故障转移群集，操作与Ser
阅读更多...
Window Server2016 AD域的创建的方法步骤

Window Server2016 AD域的创建的方法步骤

《WindowServer2016AD域的创建的方法步骤》本文主要介绍了WindowServer2016AD域的创建的方法步骤,文中通过图文介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录一、准备条件二、在ServerA服务器中常见AD域管理器：三、创建AD域，域地址为“test.ly”
阅读更多...
2.1/5.1和7.1声道系统有什么区别? 音频声道的专业知识科普

2.1/5.1和7.1声道系统有什么区别? 音频声道的专业知识科普

《2.1/5.1和7.1声道系统有什么区别?音频声道的专业知识科普》当设置环绕声系统时，会遇到2.1、5.1、7.1、7.1.2、9.1等数字，当一遍又一遍地看到它们时，可能想知道它们是什... 想要把智能电视自带的音响升级成专业级的家庭影院系统吗？那么你将面临一个重要的选择——使用 2.1、5.1 还是
阅读更多...
Linux使用dd命令来复制和转换数据的操作方法

Linux使用dd命令来复制和转换数据的操作方法

《Linux使用dd命令来复制和转换数据的操作方法》Linux中的dd命令是一个功能强大的数据复制和转换实用程序,它以较低级别运行,通常用于创建可启动的USB驱动器、克隆磁盘和生成随机数据等任务,本文... 目录简介功能和能力语法常用选项示例用法基础用法创建可启动www.chinasem.cn的 USB 驱动
阅读更多...
关于Maven生命周期相关命令演示

关于Maven生命周期相关命令演示

《关于Maven生命周期相关命令演示》Maven的生命周期分为Clean、Default和Site三个主要阶段,每个阶段包含多个关键步骤,如清理、编译、测试、打包等,通过执行相应的Maven命令,可以... 目录1. Maven 生命周期概述1.1 Clean Lifecycle1.2 Default Li
阅读更多...
Python如何使用seleniumwire接管Chrome查看控制台中参数

Python如何使用seleniumwire接管Chrome查看控制台中参数

《Python如何使用seleniumwire接管Chrome查看控制台中参数》文章介绍了如何使用Python的seleniumwire库来接管Chrome浏览器,并通过控制台查看接口参数,本文给大家... 1、cmd打开控制台，启动谷歌并制定端口号，找不到文件的加环境变量chrome.exe --rem
阅读更多...
windows系统下shutdown重启关机命令超详细教程

windows系统下shutdown重启关机命令超详细教程

《windows系统下shutdown重启关机命令超详细教程》shutdown命令是一个强大的工具,允许你通过命令行快速完成关机、重启或注销操作,本文将为你详细解析shutdown命令的使用方法,并提... 目录一、shutdown 命令简介二、shutdown 命令的基本用法三、远程关机与重启四、实际应用
阅读更多...
Python在固定文件夹批量创建固定后缀的文件(方法详解)

Python在固定文件夹批量创建固定后缀的文件(方法详解)

《Python在固定文件夹批量创建固定后缀的文件(方法详解)》文章讲述了如何使用Python批量创建后缀为.md的文件夹,生成100个,代码中需要修改的路径、前缀和后缀名,并提供了注意事项和代码示例,... 目录1. python需求的任务2. Python代码的实现3. 代码修改的位置4. 运行结果5.
阅读更多...
使用IntelliJ IDEA创建简单的Java Web项目完整步骤

使用IntelliJ IDEA创建简单的Java Web项目完整步骤

《使用IntelliJIDEA创建简单的JavaWeb项目完整步骤》：本文主要介绍如何使用IntelliJIDEA创建一个简单的JavaWeb项目,实现登录、注册和查看用户列表功能,使用Se... 目录前置准备项目功能实现步骤1. 创建项目2. 配置 Tomcat3. 项目文件结构4. 创建数据库和表5.
阅读更多...
使用SpringBoot创建一个RESTful API的详细步骤

使用SpringBoot创建一个RESTful API的详细步骤

《使用SpringBoot创建一个RESTfulAPI的详细步骤》使用Java的SpringBoot创建RESTfulAPI可以满足多种开发场景,它提供了快速开发、易于配置、可扩展、可维护的优点,尤... 目录一、创建 Spring Boot 项目二、创建控制器类（Controller Class）三、运行
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2