odoo的定时任务与异步任务

男娘i 2022-11-17 13:47 590阅读 0赞

## 定时任务与异步任务 ##

[点我下载完整odoo的demo][odoo_demo]

### 定时任务 ###

Odoo中内置了一个定时任务模型 ir.cron ，它定义了一套 定时、自动执行的规则。

可以通过创建 ir.cron 的模型记录来创建定时任务，一条记录就是一个定时任务。

1、先在业务模型中定义要定时执行的函数。

2、通过data文件，创建一条定时任务记录（往ir.cron模型插入一条记录）

<?xml version="1.0" encoding="UTF-8"?>
    <odoo>
        <data noupdate="1">
            <record model="ir.cron" id="ir_cron_course_update" forcecreate="True">
                <field name="name">课程更新</field>
                <field name="active" eval="True" />
                <field name="user_id" ref="base.user_root"/>
                <field name="interval_number">1</field>
                <field name="interval_type">hours</field>
                <field name="numbercall">-1</field>
                <field name="doall" eval="True" />
                <field name="model_id" ref="my_first_app.model_myproject_course"/>
                <field name="state">code</field>
                <field name="code">model.update_course()</field>
            </record>
        </data>
    </odoo>

字段详解：

1）name 定时任务名称.

2）user\_id

执行定时任务的用户，不同的用户是有不同权限的，为了保证能有足够权限执行定时任务，一般这里就是base.user\_root

3）interval\_number

任务执行的频次，和interval\_type字段一起决定了任务执行的间隔时间，比如interval\_number为2，interval\_type为minutes，就是任务每2分钟执行一次。

4）interval\_type

任务执行频次的单位，可选项有： minutes,hours,days,work\_days,weeks,months,意思很好理解，work\_days是星期几执行。

5）numbercall

**循环运行的次数，比如你填10，那么任务执行10次后将不再执行，这里-1代表一直执行下去。**

6）doall

如果在服务器重启期间错过了执行时机，**是否再次补充执行**。

7）model

任务方法所在模型。

8）function

任务方法，与model一起决定了任务时机到来时，具体调用哪个模型的哪个方法执行。

#### 异步定时任务 ####

***async:***

可以将方法标记为异步方法，作用是方法可以被挂起。

***await:***

用于标记异步方法内的耗时操作，挂起后可以跳出当前函数去执行其它异步函数，耗时操作结束了，再跳回来继续执行。一个函数内可以有多个await标记。如果不写await，就表示要方法执行完才会执行其它方法。

# -*- coding:utf-8 -*-
    
    from odoo import models, fields
    
    import asyncio
    
    
    class MySchedule(models.AbstractModel):
        _name = 'my.schedule'
        _description = '定时任务'
    
        def schedule(self):
            start_time = fields.datetime.now()
            asyncio.run(self.do_schedule_list())
            end_time = fields.datetime.now()
            print('cost time =>', end_time - start_time)
    
        # 任务列表,可能有多个定时任务需要执行,每个任务前加await
        async def do_schedule_list(self):
            await self.statistics_compute_sum_nums()
    
        # 具体的定时任务,这里是求和任务,1-100的和
        async def statistics_compute_sum_nums(self):
            # 定义异步方法列表,有三个异步任务
            tasks = [
                asyncio.create_task(self._compute_sum_nums(1, 30)),
                asyncio.create_task(self._compute_sum_nums(30, 60)),
                asyncio.create_task(self._compute_sum_nums(60, 101))
            ]
            # gather会异步执行任务,并返回所有任务完成后的结果
            result = await asyncio.gather(*tasks)
            print('result=>', result, 'sum=>', sum(result), 'time=>', fields.datetime.now())
    
        # 耗时方法
        async def _compute_sum_nums(self, start, end):
            await asyncio.sleep(2)
            return sum(range(start, end))

<?xml version="1.0" encoding="UTF-8" ?>
    <odoo>
    
        <record id="schedule_statistic_num_sum" model="ir.cron">
            <field name="name">数据统计任务</field>
            <field name="model_id" ref="model_my_schedule"/>
            <field name="state">code</field>
            <field name="code">model.schedule()</field>
            <field name="interval_number">1</field>
            <field name="interval_type">minutes</field>
            <field name="numbercall">-1</field>
            <field eval="True" name="doall"/>
            <field name="user_id" ref="base.user_root"/>
        </record>
    
    </odoo>

name: 定时任务的名称

model\_id: 引用模型的id，类似权限添加那块，带model\_前缀，后面是模型名，点用下划线代替

state：code，表示执行的动作

code: model.固定写法，后面跟模型要调用的方法

interval\_number: 这里表示每1分钟执行一次，如果是30，就表示每30分钟执行一次

interval\_type: 执行的周期，minutes, hours, days, weeks, months

numbercall: 表示总共要执行多少次，负数表示无限制，永远执行下去

doall: 为True时，表示服务器重启后，停机期间错过的任务，会被补充执行。

user\_id: 调度任务的用户，让odoo自己管理。

#### 例子：定时更新课程参与人数 ####

myproject/my\_first\_app/data/cron.xml：

<?xml version="1.0" encoding="UTF-8"?>
    <odoo>
        <data>
            <record model="ir.cron" id="ir_cron_update_course_member" forcecreate="True">
                <field name="name">定时更新课程参与人数</field>
                <field name="active" eval="True" />
                <field name="user_id" ref="base.user_root"/>
                <field name="interval_number">1</field>
                <field name="interval_type">minutes</field>
                <field name="numbercall">-1</field>
                <field name="doall" eval="True"/>
                <field name="model_id" ref="my_first_app.model_myproject_course"/>
                <field name="state">code</field>
                <field name="code">model.update_course_member()</field>
            </record>
        </data>
    </odoo>

myproject/my\_first\_app/models/course.py:

# -*- coding: utf-8 -*-
    
    from odoo import models, fields, api
    
    class Course(models.Model):
        """ 课程 """
        _name = 'myproject.course'
        _inherit = ['mail.thread'] # 继承mail.thread保存字段值修改记录
    
        # track_visibility表示字段值修改时，消息日志中会自动追踪
        name = fields.Char(string='课程名称', reqired=True, placeholder='填写课程名称', track_visibility='onchange')
        description = fields.Text(string='Description', placeholder='填写课程描述', track_visibility='onchange')
        sex = fields.Boolean(string='性别', default=True)
        state = fields.Selection(
            [('draft', "草稿"), ('open', "开启"), ('full', "满人"), ('cancel', "取消")], string="状态",
            help="课程状态", default="draft"
        )
        responsible_id = fields.Many2one('res.users', ondelete='set null', string="负责人", index=True)
        session_ids = fields.One2many('myproject.session', 'course_id', string="讲座")
    
        def copy(self, default=None):
            default = dict(default or { })
            copied_count = self.search_count(
                [('name', '=like', u"Copy of {}%".format(self.name))])
            if not copied_count:
                new_name = u"Copy of {}".format(self.name)
            else:
                new_name = u"Copy of {} ({})".format(self.name, copied_count)
            default['name'] = new_name
            return super(Course, self).copy(default)
    
        _sql_constraints = [
            ('name_description_check',
             'CHECK(name != description)',
             "The title of the course should not be the description"),
            ('name_unique',
             'UNIQUE(name)',
             "The course title must be unique"),
        ]
    
        @api.model
        def js_test(self):
            # 课程tree视图中测试按钮点击事件
            print('dddddddddd')
    
        @api.model
        def update_course_member(self):
            # 定时任务，更新课程参与人数
            for course in self.env['myproject.course'].sudo().search([]):
                sessions = self.env['myproject.session'].sudo().search([('course_id', '=', course.id)])
                attendees_count = 0
                for s in sessions:
                    attendees_count += s.attendees_count
    
                course.description = '已参加人数有{}人'.format(attendees_count)

`myproject/my_first_app/__manifest__.py`加载cron.xml:

'data': [
            'security/myproject_security.xml',
            'security/ir.model.access.csv',
            'data/course_data.xml',
            'data/session_data.xml',
            'data/cron.xml',
            'views/menu_views.xml',
            'views/course_views.xml',
            'views/session_views.xml',
            'views/res_partner_views.xml',
            'wizard/myproject_wizard_view.xml',
            'wizard/actions_menu.xml',
            'report/myproject_report.xml',
            'report/myproject_report_templates.xml',
            'views/session_board.xml',
            'views/templates.xml',
        ],

在debug模式下，设置->技术->安排的动作->可以看到【定时更新课程参与人数】，也可以修改执行时间，手动执行等

### 异步任务 ###

当我们导入/导出一个很大的文件时，打印一个年度的财务明细报表时，或者执行一个需要长时间计算的任务时，我们的Odoo界面就被锁死的状态，一会儿让我们喝咖啡，一会儿请我们吃大餐，而且最后很可能超时跑飞，不了了之。  
这时，[queue\_job][queue_job]这个工具就派用场了。它可以将需要执行的代码作为延时任务放到队列里，从而不会阻断当前的操作。同时可以设定多个channel 和runner，在队列里的任务就可以被多个runner并发执行，大大提高了运行效率。

Github下载： **https://github.com/OCA/queue/tree/13.0/queue\_job**

而使用`queue_job`的语法非常简单，比如我们的模型`my.model`里有一个`heavy_method`需要异步执行，我们只要用`job`装饰器装饰这个方法：

from odoo import models, fields, api
    from odoo.addons.queue_job.job import job
    
    class MyModel(models.Model):
       _name = 'my.model'
    
       @job
       def heavy_method(self, a, k=None):
           _logger.info('executed with a: %s and k: %s', a, k)

然后在调用这个方法时先执行`with_delay`方法，比如：

def action_heavy_button(self):
            self.with_delay().heavy_method('a', 2)

注意：Odoo需要工作在workers > 1的状态

[options]
    (...)
    workers = 2
    server_wide_modules = web,queue_job
    
    (...)
    [queue_job]
    channels = root:2

[点我下载完整odoo的demo][odoo_demo]

## 后记 ##

【后记】为了让大家能够轻松学编程，我创建了一个公众号【轻松学编程】，里面有让你快速学会编程的文章，当然也有一些干货提高你的编程水平，也有一些编程项目适合做一些课程设计等课题。

也可加我微信【1257309054】，拉你进群，大家一起交流学习。  
如果文章对您有帮助，请我喝杯咖啡吧！

公众号

![公众号][20200317124808234.jpg]

关注我，我们一起成长~~

[odoo_demo]: https://download.csdn.net/download/lm_is_dc/16818292
[queue_job]: https://github.com/OCA/queue/tree/13.0/queue_job
[20200317124808234.jpg]: /images/20221022/13c588538c794987be93dc5542ba1ed1.png