![最终产品图片](https://i-blog.csdnimg.cn/blog_migrate/2e30e1655ab2ff8607818a7ae313d394.png)
如果您问“ Yii是什么?” 查阅我之前的教程: Yii Framework简介 ,它回顾了Yii的优点,并概述了2014年10月发布的Yii 2.0的新功能。
在本使用Yii2编程系列中 ,我指导读者使用PHP的Yii2框架。 在今天的教程中,我将与您分享如何利用Yii的控制台功能来运行cron作业。
过去,我在cron作业中使用过wget-一个可通过Web访问的URL可以运行我的后台任务。 这引发了安全问题,并且存在一些性能问题。 我在启动系列安全性文章中介绍了一些减轻风险的方法时,我希望过渡到控制台驱动的命令。 而使用Yii2则非常简单。
对于今天的示例,我将在我的Twixxr网站上演示基于控制台的cron命令, 我在本Twitter API集中对此进行了介绍。 由于速率限制和性能管理问题,Twitter API非常依赖高效,可靠的cron任务。 因此,这是与您分享的一个很好的例子。
在开始之前,我先重申一下:我总是很感谢您的想法和反馈。 如果您有任何问题或建议,请在下面的评论中发表您的想法。 您也可以直接通过Twitter @reifman与我联系 。
什么是Cron?
Wikipedia 将cron描述为“类Unix计算机操作系统中的基于时间的作业调度程序”。 这很准确。 基本上,cron运行我们运行Web服务所需的所有后台任务,从日志管理和备份到API请求再到数据库清理。
要查看服务器上现有的cron作业,通常可以键入sudo crontab -l
并看到类似以下内容:
# Edit this file to introduce tasks to be run by cron.
#
# Each task to run has to be defined through a single line
# indicating with different fields when the task will be run
# and what command to run for the task
#
# To define the time you can provide concrete values for
# minute (m), hour (h), day of month (dom), month (mon),
# and day of week (dow) or use '*' in these fields (for 'any').#
# Notice that tasks will be started based on the cron's system
# daemon's notion of time and timezones.
#
# Output of the crontab jobs (including errors) is sent through
# email to the user the crontab file belongs to (unless redirected).
#
# For example, you can run a backup of all your user accounts
# at 5 a.m every week with:
# 0 5 * * 1 tar -zcf /var/backups/home.tgz /home/
#
# For more information see the manual pages of crontab(5) and cron(8)
#
# m h dom mon dow command
*/3 * * * * wget -O /dev/null http://meetingplanner.io/daemon/frequent
*/15 * * * * wget -O /dev/null http://meetingplanner.io/daemon/quarter
0 * * * * wget -O /dev/null http://meetingplanner.io/daemon/hourly
15 1 * * * wget -O /dev/null http://meetingplanner.io/daemon/overnight
40 2 * * * /usr/sbin/automysqlbackup
15 3 * * 5 wget -O /dev/null http://meetingplanner.io/daemon/weekly
30 2 * * 1 /opt/letsencrypt/letsencrypt-auto renew >> /var/log/le-renew.log
左侧指定每3或15分钟或每天午夜等激活这些任务,右侧是要运行的脚本。 另请参阅 使用Cron Jobs安排任务(Envato Tuts +) 。
请注意, “让我们加密”脚本如何是唯一的控制台命令。 它从我们服务器上的命令行运行。 但是,我上面的所有会议计划程序任务都是通过wget运行的。 就像机器人在特定时间在Web浏览器上一样,对执行后台任务的Web应用程序运行请求。
除了外部Web请求所需的开销以及服务器上脚本的超时限制外,您还必须保护这些访问点。 这是会议计划程序如何执行此操作的示例:
// only cron jobs and admins can run this controller's actions
public function beforeAction($action)
{
// your custom code here, if you want the code to run before action filters,
// which are triggered on the [[EVENT_BEFORE_ACTION]] event, e.g. PageCache or AccessControl
if (!parent::beforeAction($action)) {
return false;
}
// other custom code here
if (( $_SERVER['REMOTE_ADDR'] == $_SERVER['SERVER_ADDR'] ) ||
(!\Yii::$app->user->isGuest && \common\models\User::findOne(Yii::$app->user->getId())->isAdmin()))
{
return true;
}
return false; // or false to not run the action
}
它验证用户是以管理员身份登录还是以相同的Internet IP地址在服务器上本地运行。
实施基于控制台的Cron命令
Yii Framework开发背后的主要志愿者之一Alex Makarov在我定期撰写有关Envato Tuts +框架的问题时对我的回答很有帮助。 在阅读了我的安全事件后,他问为什么我不使用Yii2固有的控制台功能来执行cron作业。 基本上,我对此一无所知。
就像我有一个/frontend/controllers/DaemonController.php一样,我创建了一个/console/controllers/DaemonController.php。 在本教程中,我将针对更小,更简单的Twixxr Web服务执行此操作。
我习惯于使用控制台来运行数据库迁移 (例如./yii migrate/up 7
),仅此而已。 我很想尝试将其用于后台任务。
正如我在较早的教程中所写的那样 ,我的新生网站Twixxr需要大量的后台程序来定期轮换API调用,以响应所有用户请求,以与女性拥有的有影响力的Twitter帐户成为朋友。
这是主页的样子:
![如何使用Yii2编程-基于控制台的Cron-Twixxr主页示例网站](https://i-blog.csdnimg.cn/blog_migrate/55ec76e5b3d5d3d5237c78d685476bca.png)
因此,我认为Twixxr将成为运行基于控制台的cron控制器的绝佳测试平台。
新的DaemonController.php
这是我新的基于控制台的DaemonController.php的核心:
<?php
namespace console\controllers;
use Yii;
use yii\helpers\Url;
use yii\console\Controller;
use frontend\models\Twixxr;
/**
* Test controller
*/
class DaemonController extends Controller {
public function actionIndex() {
echo "Yes, cron service is running.";
}
public function actionFrequent() {
// called every two minutes
// */2 * * * * ~/sites/www/yii2/yii test
$time_start = microtime(true);
$x = new \frontend\models\Twixxr();
$x->process($time_start);
$time_end = microtime(true);
echo 'Processing for '.($time_end-$time_start).' seconds';
}
public function actionQuarter() {
// called every fifteen minutes
$x = new \frontend\models\Twixxr();
$x->loadProfiles();
}
public function actionHourly() {
// every hour
$current_hour = date('G');
if ($current_hour%4) {
// every four hours
}
if ($current_hour%6) {
// every six hours
}
}
请注意,它与基于前端的控制器的结构完全相同,但是由于它在/ console树中,因此无法安全访问Web。 没有配置Apache Web服务器站点来浏览该区域。
因此,在上面的示例中,将每两到三分钟调用一次actionFrequent()
。 它处理另一组Twixxr友谊请求。 另一方面, actionQuarter()
每15分钟调用一次,并更新配置文件信息以浏览account 。 让我们看一下cron文件中的调度工作方式。
新的Crontab文件
本质上,在我的crontab文件中,我将wget替换为直接的Linux脚本,如上所示,用于“让我们加密续订”。
键入sudo crontab -e
进行编辑,或键入-l
列出其内容。 这是我的Twixxr cron文件:
$ sudo crontab -l
# m h dom mon dow command
*/3 * * * * /var/www/twixxr/yii daemon/frequent
*/15 * * * * /var/www/twixxr/yii daemon/quarter
0 * * * * /var/www/twixxr/yii daemon/hourly
15 1 * * * /var/www/twixxr/yii daemon/overnight
15 3 * * 5 /var/www/twixxr/yii daemon/weekly
#40 2 * * * /usr/sbin/automysqlbackup
30 2 * * 1 /usr/bin/letsencrypt renew >> /var/log/le-renew.log
很简单 /var/www/twixxr/yii daemon/frequent
的左侧是/var/www/twixxr/yii daemon/frequent
解释器所在的路径,右侧是控制台控制器和调用方法。
切换一切正常。 我还没有切换会议计划程序,因为我想进行更多测试。 当后台任务中断时,很难知道和调试它们(尽管Sentry错误日志会有所帮助)。
要考虑的问题
我遇到的一个因素是控制台名称空间与前端名称空间是不同的,例如,我在本教程中设置的SiteHelper.php组件,该组件描述了从单个代码库运行多个站点 ,但在调用时失败它。 删除它是可行的,但是我需要运行测试以确保底层的后台代码仍然起作用。 但是,大多数切换都很顺利。
与其他任何代码更改一样,彻底测试和监视。
下一步是什么
展望未来,我将探索在Yii2框架内构建REST API,该框架巧合地依赖于创建一个独特的子树(如控制台树),但需要外部API。 当然,这会带来复杂的身份验证和安全性问题,因此与您一起探索这些问题将很有趣。 我将从多个角度看待API。 我实际上对此感到非常兴奋。
当我继续深入研究框架的不同方面时,请观看“ 使用Yii2编程”系列中即将发布的教程。 也请浏览“ 使用PHP构建启动”系列 ,该系列记录了构建Simple Planner和Meeting Planner的过程 。
如果您想知道下一个Yii2教程何时到达, 请在Twitter上关注我@reifman或查看我的讲师页面上的更新。
相关链接
- Yii2开发者交流 ,我的Yii2资源网站
- 通过Cron Jobs安排任务(Envato Tuts +)
- 如何在Yii2中实现cron(Yii文档)
- Twixxr ,其中提到的示例Web服务
翻译自: https://code.tutsplus.com/tutorials/how-to-program-with-yii2-running-cron-services--cms-27508