tacker源码分析(Pike版本)--定时任务

tacker-conductor进程启动时会创建一个service.Service实例，一方面用于监听消息队列中的RPC请求，另一方面启动一个定时任务。

class Service(n_rpc.Service):
    """Service object for binaries running on hosts.

    A service takes a manager and enables rpc by listening to queues based
    on topic. It also periodically runs tasks on the manager.
    Initialized by tacker-conductor
    """

Service 在init的时候动态import一个Conductor class并实例化

self.manager_class_name = manager     #manager是一个完整的类名字符串，'tacker.conductor.conductor_server.Conductor'
manager_class = importutils.import_class(self.manager_class_name)
self.manager = manager_class(host=host, *args, **kwargs)

查看manager_class的值

可见，在类Conductor已经import但还未实例化后已经包含一些类变量，如_periodic_tasks，后面会解释一下这个变量怎么来的。

Service实例在start时启动定时任务，调用self.periodic_tasks

periodic = loopingcall.FixedIntervalLoopingCall(self.periodic_tasks)

在定时任务整个流程中，其实FixedIntervalLoopingCall是触发器，它会固定时间地触发函数调用。调用间隔读取自配置文件中的periodic_interval，默认是40s。

这个periodic_tasks会调用self.manager的periodic_tasks，manager就是类Conductor的实例。

def periodic_tasks(self, raise_on_error=False):
    ctxt = context.get_admin_context()
    self.manager.periodic_tasks(ctxt, raise_on_error=raise_on_error)

manager的periodic_tasks最后调用的是其父类PeriodicTasks的run_periodic_tasks。

看一下Conductor类的继承关系

再看一下PeriodicTasks的定义，在oslo_service/periodic_task.py中。

@six.add_metaclass(_PeriodicTasksMeta)
class PeriodicTasks(object)

这个类有两个主要方法：run_periodic_tasks和add_periodic_task：

• run_periodic_task会循环检查self._periodic_tasks中的任务，并根据上次调用时间和定时任务自身配置的spacing确定是否调用task。
• add_periodic_task可以用于添加定时任务，但是在Tacker中没有用到。

那么Tacker中如何增加一个需要定时处理的task呢？

实际很简单，只要在manager.Manager或者其子类中增加一个方法，并用装饰器periodic_task装饰即可。比如，在Conductor类中增加方法：

@periodic_task.periodic_task
def test_periodical_task(self, context):
    print time.time()

test_periodical_task就成为一个定时执行的任务。注意，如果装饰器没有参数，默认间隔是60s。细心的同学会发现，如果配置文件和装饰器中的间隔都用默认值，定时任务的真正的调用间隔是不稳定的，一会儿40s，一会儿80s，请自己思考一下原因。

但装饰器是如何做到添加定时任务的呢？

由于使用了元类_PeriodicTasksMeta创建类PeriodicTasks，所以在importutils.import_class时会调用元类_PeriodicTasksMeta的__init__方法，这个方法中将有_periodic_task属性的方法添加为定时任务。

class _PeriodicTasksMeta(type):
    def _add_periodic_task(cls, task):
        """Add a periodic task to the list of periodic tasks.
            The task should already be decorated by @periodic_task.
        …
        cls._periodic_tasks.append((name, task))
        ...

def __init__(cls, names, bases, dict_):
    ...
    for value in cls.__dict__.values():
        if getattr(value, '_periodic_task', False):        # 如果类成员有_periodic_task属性且为True就添加到定时任务列表中
            cls._add_periodic_task(value)

在类import后，将cls.__dict__.values()中的test_periodical_task方法单挑出来，查看其属性。

可以发现装饰器给方法增添了一堆_periodic_开头的属性，这些属性将被用来判断这个方法是否是定时任务。

这也就是说，在导入类PeriodicTasks或子类时，其元类会添加类变量_periodic_tasks，并将类定义中有periodic_task装饰的方法认为是定时任务。