ODOO学习笔记（5）：ODOO开发规范

一、代码结构与布局

1. 模块结构：
   • 每个ODOO模块应具有清晰的结构，通常包含以下目录和文件：
     • models：存放业务逻辑相关的模型类定义，如定义数据库表结构、业务规则等。
     • views：用于放置各种视图文件，包括表单视图、树状视图、看板视图等，以定义数据在前端的展示方式。
     • controllers：若涉及到与外部系统交互或自定义Web路由等情况，相关的控制器类放在此目录。
     • security：存放安全相关的文件，如访问控制列表（ACL），用于定义不同用户角色对数据和操作的访问权限。
     • data：可放置初始化数据文件，如创建模块初始时需要插入到数据库中的默认数据。
     • static：用于存储静态资源，如CSS样式文件、JavaScript脚本文件、图片等，以便在前端页面中使用。
     • __init__.py：初始化文件，用于将模块内的各个部分（如模型、视图等）正确导入，使模块能够被ODOO系统识别和加载。
2. 文件命名：
   • 模型文件：通常以models.py为文件名，如果模块内有多个不同功能的模型类，也可以按照功能细分，如product_models.py、customer_models.py等，以清晰表明文件内容。
   • 视图文件：根据视图类型命名，例如表单视图文件可命名为view_form.xml，树状视图文件命名为view_tree.xml，看板视图文件命名为view_kanban.xml等。
   • 控制器文件：可命名为controllers.py，若有针对特定功能的控制器，可进一步细化命名，如webshop_controllers.py。

二、命名规范

1. 模型命名：
   • 模型类名应采用驼峰命名法（CamelCase），首字母大写，且能清晰反映模型所代表的业务实体或功能。例如，代表产品的模型可命名为ProductModel，代表客户订单的模型可命名为CustomerOrderModel。
   • 模型对应的数据库表名通常采用小写字母加下划线的形式，且与模型名有一定关联。比如上述ProductModel对应的数据库表名可为product_model。
2. 视图命名：
   • 视图名称同样采用驼峰命名法，能准确描述视图的类型和用途。例如，用于展示产品列表的树状视图可命名为ProductListView，用于编辑产品信息的表单视图可命名为ProductFormView。
3. 字段命名：
   • 字段名采用小写字母加下划线的形式，且要具有描述性。例如，在产品模型中，描述产品价格的字段可命名为product_price，描述产品名称的字段可命名为product_name。

三、代码编写规范

1. 继承与扩展：
   • 当需要对现有ODOO模块进行扩展或修改时，优先考虑通过继承的方式实现。例如，要对原生的产品模块进行功能扩展，可创建新的模型类继承自原有的产品模型类，在继承类中添加新的业务逻辑、字段等。
   • 在继承过程中，要清晰标注所继承的类，如：

from odoo import fields, models

class ExtendedProductModel(models.Model):
    _inherit = "product.model"

    new_field = fields.Char("New Field Name")

2. 业务逻辑编写：
   • 在模型类中编写业务逻辑时，要遵循清晰、简洁的原则。对于复杂的业务逻辑，可以分解成多个较小的方法来实现，以便于理解和维护。
   • 例如，在计算产品总价的业务逻辑中：

class ProductModel(models.Model):
    _name = "product.model"

    price = fields.Float("Price")
    quantity = fields.Float("Quantity")

    def calculate_total_price(self):
        return self.price * self.quantity

3. 视图编写：
   • 在编写视图文件时，要按照ODOO视图的规范格式进行。例如，在编写表单视图时，要明确指定视图类型、模型、字段等信息，如下：

<?xml version="1.0" encoding="UTF-8"?>
<record id="view_product_form" name="Product Form View">
    <field name="name">Product Form View</field>
    <field name="model">product.model</field>
    <field name="arch">
        <form>
            <field name="product_name"/>
            <field name="product_price"/>
            <field name="quantity"/>
        </form>
    </field>
</record>

四、注释与文档字符串

1. 模块级注释：
   • 在模块的__init__.py文件或模块的主文件开头，应该有对整个模块功能、用途、主要特点等的总体注释说明，以便其他开发人员快速了解模块的大致情况。
2. 模型和视图注释：
   • 对于重要的模型类和视图文件，应该有相应的注释来解释其功能、业务逻辑、关键设计思路等。
   • 例如，在模型类上方可添加注释：

"""
This model represents the product in the system.
It contains fields such as price, quantity, etc.
and methods like calculate_total_price to compute the total price of the product.
"""
class ProductModel(models.Model):
    _name = "product.model"
   ...

- 在视图文件开头也可添加类似注释：

<?xml version="1.0" encoding="UTF-8"?>
<!-- This view is used to display and edit the product information in the form. -->
<record id="view_product_form" name="Product Form View">
   ...

3. 文档字符串（Docstrings）：
   • 模型类中的方法应该有文档字符串，详细描述方法的功能、输入参数、输出结果等信息。
   • 例如：

class ProductModel(models.Model):
    _name = "product.model"

    def calculate_total_price(self):
        """
        Calculate the total price of the product.

        Inputs:
            None

        Outputs:
            Float: The total price of the product calculated as price * quantity.
        """
        return self.price * self.quantity

五、版本控制与协作规范

1. 使用版本控制系统：
   • 推荐使用Git等版本控制系统来管理ODOO项目的开发过程。开发人员应该定期将代码提交到版本控制系统中，记录代码的变化情况。
   • 在每次提交时，要在提交信息中清晰描述提交的内容、目的等，以便其他开发人员能够快速了解此次提交的意义。
2. 分支管理：
   • 合理设置分支结构，如设置主分支（Master）用于部署生产环境，开发分支（Develop）用于日常开发。当开发完成一定阶段，通过合并操作将开发分支的成果合并到主分支。
   • 还可以根据项目需要设置特性分支（Feature Branch），用于开发特定的功能特性，开发完成后再将特性分支合并到开发分支。
3. 代码审查：
   • 建立代码审查制度，在代码提交到主分支或生产环境之前，由其他开发人员对代码进行审查。审查内容包括代码是否符合开发规范、业务逻辑是否正确、是否存在安全隐患等。
   • 通过代码审查可以提高代码质量，减少错误，促进开发人员之间的交流与协作。

遵循这些ODOO开发规范，可以提高ODOO项目的开发效率、代码质量和可维护性，便于开发人员之间的协作与交流。