【Python】轻量级分布式任务调度系统-RQ

一 前言   
   Redis Queue 一款轻量级的P分布式异步任务队列，基于Redis作为broker，将任务存到redis里面，然后在后台执行指定的Job。就目前而言有三套成熟的工具celery，huey ，rq 。按照功能和使用复杂度来排序的话也是 celery>huey>rq. 因为rq 简单，容易上手，所以自己做的系统也会使用RQ作为分布式任务调度系统。
二 安装 
   因为RQ 依赖于Redis 故需要安装版本>= 2.6.0.具体安装方法请参考《Redis初探》。*nix 系统环境下安装RQ:

1. pip install rq

无需其他配置即可以使用RQ。
三 原理
   RQ 主要由三部分构成 Job ，Queues，Worker 构成。job也就是开发定义的函数用来实现具体的功能。调用RQ 把job 放入队列Queues,Worker 负责从redis里面获取任务并执行，根据具体情况返回函数的结果。
3.1 关于job
   一个任务（job）就是一个Python对象，具体表现为在一个工作（后台）进程中异步调用一个函数。任何Python函数都可以异步调用，简单的将函数与参数追加到队列中，这叫做入队（enqueueing）。
3.2 关于Queue
   将任务加入到队列之前需要初始化一个连接到指定Redis的Queue

1. q=Queue(connection=redis_conn)
2. from rq_test import hello
3. result = q.enqueue(hello,'yangyi')

   queue有如下属性:
   timeout :指定任务最长执行时间，超过该值则被认为job丢失，对于备份任务 需要设置一个比较长的时间 比如24h。
   result_ttl :存储任务返回值的有效时间，超过该值则失效。
   ttl :specifies the maximum queued time of the job before it'll be cancelled
   depends_on :specifies another job (or job id) that must complete before this job will be queued
   job_id : allows you to manually specify this job's job_id
   at_front :will place the job at the front of the queue, instead of the back
   kwargs and args : lets you bypass the auto-pop of these arguments, ie: specify a timeout argument for the underlying job function.
  需要关注的是 depends_on ，通过该属性可以做级联任务A-->B ,只有当A 执行成功之后才能执行B .
  通过指定队列的名字，我们可以把任务加到一个指定的队列中：

1. q = Queue("low", connection = redis_conn)
2. q.enqueue(hello, "杨一"）

 对于例子中的Queue("low"),具体使用的时候可以替换"low"为任意的复合业务逻辑名字，这样就可以根据业务的需要灵活地归类的任务了。一般会根据优先级给队列命名（如：high, medium, low).
 如果想要给enqueue传递参数的情况,可以使用enqueue_call方法。在要传递超时参数的情况下：

1. q = Queue("low", connection = redis_conn)
2. q.enqueue_call(func=hello, args= ("杨一",),timeout = 30)

3.3 关于worker
   Workers将会从给定的队列中不停的循环读取任务，当所有任务都处理完毕就等待新的work到来。每一个worker在同一时间只处理一个任务。在worker中，是没有并发的。如果你需要并发处理任务，那就需要启动多个worker。
   目前的worker实际上是fork一个子进程来执行具体的任务，也就是说rq不适合windows系统。而且RQ的work是单进程的，如果想要并发执行队列中的任务提高执行效率需要使用threading针对每个任务进行fork线程。
   worker的生命周期有以下几个阶段组成：
   1 启动，载入Python环境
   2 注册，worker注册到系统上，让系统知晓它的存在。
   3 开始监听。从给定的redis队列中取出一个任务。如果所有的队列都是空的且是以突发模式运行的，立即退出。否则，等待新的任务入队。
   4 分配一个子进程。分配的这个子进程在故障安全的上下文中运行实际的任务（调用队列中的任务函数）
   5 处理任务。处理实际的任务。
   6 循环。重复执行步骤3。
四 如何使用
   简单的开发一个deamon 函数，用于后端异步调用，注意任意函数都可以加入队列，必须能够在入队的时候 被程序访问到。
 

1. #!/usr/bin/env python
2. #-*- coding:utf-8 -*-
3. def hello(name):
4.     print "hello ,%s"%name
5.     ip='192.168.0.1'
6.     num=1024
7.     return name,ip,num
8. def workat(name):
9.     print "hello %s ,you r workat youzan.com "%(name)

4.1 构建队列，将任务对象添加到队列里面

1. >>> from redis import Redis,ConnectionPool
2. >>> from rq import Queue
3. >>> pool = ConnectionPool(db=0, host='127.0.0.1', port=6379,
4. ... password='yangyi')
5. >>> redis_conn = Redis(connection_pool=pool)
6. >>> q=Queue(connection=redis_conn)
7. >>> from rq_test import hello
8. >>>
9. >>> result = q.enqueue(hello,'yangyi')
10. >>> result = q.enqueue(hello,'youzan.com')

先实例化一个Queue类q,然后通过enqueue方法发布任务。第一个参数是执行的函数名，后面是函数执行所需的参数，可以是args也可以是kwargs，案例中是一个字符串。
然后会返回一个Job类的实例，后面会具体介绍Job类的实例具体的api。

4.2启动worker ，从日志上可以看到执行了utils.hello('yangyi') utils.hello('youzan.com') 。当然这个只是简单的调用介绍，生产环境还要写的更加健壮，针对函数执行的结果进行相应的业务逻辑处理。 

1. root@rac2:~# >python woker.py
2. 23:44:48 RQ worker u'rq:worker:rac2.3354' started, version 0.6.0
3. 23:44:48 Cleaning registries for queue: default
4. 23:44:48
5. 23:44:48 *** Listening on default...
6. 23:44:48 default: utils.hello('yangyi') (63879f7c-b453-4405-a262-b9a6b6568b68)
7. hello ,yangyi
8. 23:44:48 default: Job OK (63879f7c-b453-4405-a262-b9a6b6568b68)
9. 23:44:48 Result is kept for 500 seconds
10. 23:44:48
11. 23:44:48 *** Listening on default...
12. 23:45:12 default: utils.hello('youzan.com') (e4e9ed62-c476-45f2-b66a-4b641979e731)
13. hello ,youzan.com
14. 23:45:12 default: Job OK (e4e9ed62-c476-45f2-b66a-4b641979e731)
15. 23:45:12 Result is kept for 500 seconds

需要说明的是其实 worker的启动顺序应该在job放入队列之前，一直监听rq里面是否有具体的任务，当然如果worker晚于job 加入队列启动，job的状态会显示为 queued 状态。
4.3 查看作业执行的情况
当任务加入队列，queue.enqueue()方法返回一个job实例。其定义位于rq.job文件中，可以去查看一下它的API，主要用到的API有：

1. >>> from rq import job
2. >>> job = q.enqueue(hello,'youzan.com')
3. >>> job.get_id() ##获取任务的id ，如果没有指定 ，系统会自动分配一个随机的字符串。
4. u'17ad0b3a-195e-49d5-8d31-02837ccf5fa6'
5. >>> job = q.enqueue(hello,'youzan.com')
6. >>> print job.get_status() ##获取任务的处理状态
7. finished
8. >>> step1=q.enqueue(workat,) ##故意不传递参数，让函数执行失败，则获取的状态值是 failed
   >>> print step1.get_status()
   failed
9. >>> print job.result # 当任务没有执行的时候返回None，否则返回非空值,如果 函数 hello() 有return 的值，会赋值给result
10. None
11. 当我们把worker 监听进程停止，然后重新发布任务，查看此时任务的在队列的状态，会显示为 queued
12. >>> job = q.enqueue(hello,'youzan')
13. >>> print job.get_status()
14. queued
15. >>> print job.to_dict() #把job实例转化成一个字典，我们主要关注状态。
16. {u'origin': u'default', u'status': u'queued', u'description': u"rq_test.hello('youzan')", u'created_at': '2016-09-06T08:00:40Z', u'enqueued_at': '2016-09-06T08:00:40Z', u'timeout': 180, u'data': '\x80\x02(X\r\x00\x00\x00rq_test.helloq\x01NU\x06youzanq\x02\x85q\x03}q\x04tq\x05.'}
17. >>> job.cancel() # 取消作业，尽管作业已经被执行，也可以取消
18. >>> print job.to_dict()
19. {u'origin': u'default', u'status': u'queued', u'description': u"rq_test.hello('youzan')", u'created_at': '2016-09-06T08:00:40Z', u'enqueued_at': '2016-09-06T08:00:40Z', u'timeout': 180, u'data': '\x80\x02(X\r\x00\x00\x00rq_test.helloq\x01NU\x06youzanq\x02\x85q\x03}q\x04tq\x05.'}
20. >>> print job.get_status()
21. queued
22. >>>
23. >>> job.delete() # 从redis队列中删除该作业
24. >>> print job.get_status()
25. None
26. >>> print job.to_dict()
27. {u'origin': u'default', u'description': u"rq_test.hello('youzan')", u'created_at': '2016-09-06T08:00:40Z', u'enqueued_at': '2016-09-06T08:00:40Z', u'timeout': 180, u'data': '\x80\x02(X\r\x00\x00\x00rq_test.helloq\x01NU\x06youzanq\x02\x85q\x03}q\x04tq\x05.'}

五 参考文章
[1]官方文档  
[2] 翻译 - Python RQ Job 
[3] 翻译 - Python RQ Workers  
[4] 云峰就她了 这位博主写了很多rq相关的实践经验，值得参考。