Laravel 学习笔记:Command

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

一、crontab 了解

Cron 是Linux下的定时器工具,可以方便执行定时任务。其格式大致如:

Cron命令格式

注:简单的记成:分、时、日、月、周,通配符*配合位置表示任意值(如每分钟、每小时等)

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
  1. 命令执行成功后会生成 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}";
    }
}
  1. 打开 App\Console\Kernel.php
// ...
    protected $commands = [
        // 加入可用命令列表
        Commands\TestCommand::class,
    ];
// ...
    protected function schedule(Schedule $schedule)
    {
        // 批量执行时需要在这里定义,这里假设为每分钟执行
        $schedule->command('GroupName:cmd1')->everyMinute();
    }
// ...
  1. 测试
# 查看是否添加了命令
> php artisan list
# ...
 GroupName
  GroupName:cmd1             Tell me,im great!t! # 还不错,这里出现了即代表可用
# ...

# 单命令执行
> php artisan GroupName:cmd1 hello --param2=world
你的参数是:hello, world

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

  1. 其他事项

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

> artisan GroupName:cmd1

  Not enough arguments (missing: "param1").

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

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

只需要在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框架有一段时间了,这里记录下每一天的成长,希望与大家共勉。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,569评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,499评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,271评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,087评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,474评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,670评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,911评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,636评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,397评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,607评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,093评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,418评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,074评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,092评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,865评论 0 196
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,726评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,627评论 2 270

推荐阅读更多精彩内容

  • Ubuntu的发音 Ubuntu,源于非洲祖鲁人和科萨人的语言,发作 oo-boon-too 的音。了解发音是有意...
    萤火虫de梦阅读 98,518评论 9 468
  • .bat脚本基本命令语法 目录 批处理的常见命令(未列举的命令还比较多,请查阅帮助信息) 1、REM 和 :: 2...
    庆庆庆庆庆阅读 7,938评论 1 19
  • linux资料总章2.1 1.0写的不好抱歉 但是2.0已经改了很多 但是错误还是无法避免 以后资料会慢慢更新 大...
    数据革命阅读 12,019评论 2 34
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 引言 到今日开始,用简书APP有两三个月了,在我的手机里存活率蛮高的。所以决定考虑一下关于简书的用法。 我对简书的...
    joan_2阅读 199评论 0 0