Laravel -Command

红太狼 2022-05-22 10:50 180阅读 0赞

> Laravel 开发console程序非常方便，其模式与其他框架，如yii类似。本文参考了 [Laravel 5.5 文档][Laravel 5.5] 详细信息请参考之。注：本文是基于Laravel 5.5的版本编写请注意。

## 一、crontab 了解 ##

Cron 是Linux下的定时器工具，可以方便执行定时任务。

简单的记成：分、时、日、月、周，通配符\*配合位置表示任意值（如每分钟、每小时等）

### 1.cron相关命令 ###

# 显示一个cron列表，其内容是由当前用户启动的任务
    crontab -l
    
    # 编辑自己的cron列表
    crontab -e

### 2. 简单的栗子 ###

* * * * * /path/php artisan myCommand             # 每分钟执行
    */1 * * * * /path/php artisan myCommand           # 每分钟执行，同上
    
    */5 * * * * /path/php artisan myCommand           # 每5分钟执行
    
    10,20 * * * * /path/php artisan myCommand         # 每小时10分、20分时执行
    
    1-31,35 * * * * /path/php artisan myCommand       # 每小时1至31分、35分执行
    
    0 */2 * * 0 /path/php artisan myCommand param1 param2 # 复杂点的例子，你能看懂吗？

生成环境下需要加上 &> /dev/null

* * * * * /path/php artisan myCommand &> /dev/null

> 这样做会直接丢弃cron任务的console输出，可以减少系统资源开销

### 3.复杂点的栗子 ###

有时候我们觉得每分钟执行一次间距太大了，我想改成每20秒中执行，那该怎么写？

# 请参考这个栗子
    * * * * * /path/php artisan myCommand    
    * * * * * sleep 20 ; /path/php artisan myCommand
    * * * * * sleep 40 ; /path/php artisan myCommand
    #看到这里你应该秒懂了，其实就是延时20秒启动一次即可

## 二、Laravel 控制台 ##

这里假装你已经熟悉（起码得了解）artisan的使用，比如：

# 列出可用的命令
    php artisan list

1.通过laravel提供的基础命令来生成一个Command，如：

php artisan make:command MyCommand

2.命令执行成功后会生成 app\\Console\\Commands\\MyCommand.php，打开后发现：

<?php
    
    namespace App\Console\Commands;
    
    use Illuminate\Console\Command;
    
    class TestCommand extends Command { 
        /** * The name and signature of the console command. * * @var string */
        protected $signature = 'GroupName:cmd1 {param1} {--param2=}';
    
        /** * The console command description. * * @var string */
        protected $description = 'Tell me，im great!';
    
        /** * Create a new command instance. * * @return void */
        public function __construct() { 
            parent::__construct();
        }
    
        /** * Execute the console command. * * @return mixed */
        public function handle() { 
            // 入口方法
            $param1 = $this->argument('param1'); // 不指定参数名的情况下用argument
            $param2 = $this->option('param2'); // 用--开头指定参数名
            echo "你的参数是：{$param1}, {$param2}";
        }
    }

3.打开 App\\Console\\Kernel.php

// ...
        protected $commands = [
            // 加入可用命令列表
            Commands\TestCommand::class, ]; // ... protected function schedule(Schedule $schedule) { 
            // 批量执行时需要在这里定义，这里假设为每分钟执行
            $schedule->command('GroupName:cmd1')->everyMinute();
        }
    // ...

4.测试

# 查看是否添加了命令
    > php artisan list
    # ...
     GroupName
      GroupName:cmd1             Tell me，im great!t! # 还不错，这里出现了即代表可用
    # ...
    
    # 单命令执行
    > php artisan GroupName:cmd1 hello --param2=world
    你的参数是：hello, world

> 这里你发现了，如果指定$signature时用了:即会给命令分组，如：分组名:命令名。但输入命令式仍然输入完整的名称。

5.其他事项

上文中如果你只输入了命令名而省略了参数的话会报错，如：

> artisan GroupName:cmd1
    
      Not enough arguments (missing: "param1").

由于我们定义的参数是必选的，因此会报这个错误。这时如果需要参数是可选的只需做如下调整。

protected $signature = 'GroupName:cmd1 {param1? } {--param2=}';

*  1

只需要在param1后增加?即可，option参数则不必。另外，我们可以通过相关方法来获取输入的参数表。

在handle中执行$this->arguments()获取参数表，如：

{
        "command":"GroupName:cmd1",
        "param1":"p1" }

执行$this->options()获取选项表，如：

{
        "param2":"p2",
        "help":false,
        "quiet":false,
        "verbose":false,
        "version":false,
        "ansi":false,
        "no-ansi":false,
        "no-interaction":false,
        "env":null }

通过以上的方法可以动态的判定传入的参数，方法内自行处理相应的逻辑。

[Laravel 5.5]: http://laravelacademy.org/post/8484.html