【odoo】Odoo 中的 Controllers 介绍与示例

在 Odoo 中，controllers 是一种用来处理 HTTP 请求的机制。它是 Odoo 中 Web 模块的重要组成部分，主要用于接收前端的 HTTP 请求、进行业务处理，然后返回响应。controllers 是 Odoo 和外部世界（如前端页面、API 客户端等）交互的桥梁。了解 Odoo 中的 controllers 对于开发 Web 应用或集成外部系统非常关键。

1. Odoo Controllers 的基本概念

Odoo 中的 controllers 是通过 Python 类实现的，并且继承自 http.Controller 类。Controller 类主要负责处理 HTTP 请求，它可以定义各种路由（URLs）来匹配不同的请求方式（如 GET、POST、PUT 等）。每个路由对应一个 Python 方法，方法中的逻辑负责处理具体的业务操作。

核心概念：

• 路由（Route）：在 Odoo 中，每个 URL 路径都会被映射到一个处理该路径的函数上。
• 请求（Request）：处理路由时，我们会接收到 HTTP 请求对象，包含了所有的请求信息，如请求方法、参数、表单数据等。
• 响应（Response）：处理完请求后，函数会返回一个响应，通常是一个 HTML 页面或 JSON 数据。

2. 如何创建一个 Odoo Controller

在 Odoo 中创建一个 controller 需要以下几个步骤：

1. 创建一个继承自 http.Controller 的 Python 类。
2. 使用装饰器 @http.route 为类中的方法定义路由。
3. 在方法中编写逻辑来处理请求。
   下面是一个简单的示例，展示如何在 Odoo 中定义一个 controller 来处理 HTTP 请求。

示例：创建一个简单的 Controller

1. 创建一个新的 Python 文件：controllers/main.py

from odoo import http
from odoo.http import request

class MyController(http.Controller):
    
    @http.route('/myapp/hello', type='http', auth="public", methods=['GET'], website=True)
    def hello_world(self, **kw):
        """
        这是一个简单的 GET 请求路由，返回一个 "Hello, World!" 的页面。
        """
        return "Hello, World!"
    
    @http.route('/myapp/user_info', type='json', auth="user", methods=['POST'])
    def user_info(self, **kw):
        """
        这是一个 POST 请求的路由，处理用户信息并返回 JSON 响应。
        """
        # 获取 POST 请求中的参数
        name = kw.get('name', '')
        email = kw.get('email', '')
        
        # 简单验证
        if not name or not email:
            return {'error': 'Name and Email are required!'}
        
        # 返回用户信息
        return {
            'status': 'success',
            'message': f'User {name} with email {email} has been saved successfully!'
        }
    
    @http.route('/myapp/greeting/<string:name>', type='http', auth="public", methods=['GET'])
    def greeting(self, name, **kw):
        """
        动态路由，根据 URL 参数 `name` 返回个性化的问候。
        """
        return f"Hello, {name}!"

2. 解释代码

• MyController 是我们自定义的控制器类，继承自 Odoo 的 http.Controller 类。
• 每个方法都通过 @http.route 装饰器来绑定一个路由。@http.route 装饰器接受多个参数：
  • route：定义路由路径。例如，/myapp/hello 是我们访问的 URL。type：请求的类型，通常可以是 http 或 json，分别代表返回 HTML 页面或 JSON 数据。
  • auth：定义路由的访问权限。auth=“public” 表示该路由对外部开放，auth=“user” 表示需要用户登录。
  • methods：定义允许的 HTTP 请求方法，如 GET、POST 等。

路由解析：

• myapp/hello：这是一个简单的 GET 请求路由，返回 “Hello, World!”。
• myapp/user_info：这个 POST 路由接收用户的 name 和 email 信息，并返回一个 JSON 格式的响应。
• myapp/greeting/string:name：这是一个动态路由，URL 中的 name 参数会传递到方法中，用来生成个性化的问候信息。

3. 测试与访问

启动 Odoo 后，访问以下路径可以测试这些路由：

• 访问 http://localhost:8069/myapp/hello，浏览器将显示 “Hello, World!”。
• 访问 http://localhost:8069/myapp/greeting/John，浏览器将显示 “Hello, John!”。
• 使用 POST 请求访问 http://localhost:8069/myapp/user_info，并传递 name 和 email 参数，可以获得 JSON 响应。

示例：创建一个返回模板的 Controller

Odoo 的 controllers 不仅支持返回文本和 JSON 数据，还可以返回 HTML 页面，通常这通过 Odoo 的模板引擎实现。下面是一个返回 HTML 页面模板的例子。

from odoo import http
from odoo.http import request

class MyController(http.Controller):
    
    @http.route('/myapp/home', type='http', auth="public", website=True)
    def home(self, **kw):
        """
        返回一个带有模板的页面。
        """
        # 获取模板并渲染
        return request.render('my_module.home_page', {})
        

在这个示例中，我们使用 request.render 方法来渲染一个模板文件。‘my_module.home_page’ 是一个 XML 模板的 ID，request.render 会返回渲染后的 HTML 页面。

在 Odoo 中，controllers 是连接前端与后端的桥梁，能够处理来自浏览器或 API 客户端的 HTTP 请求，并返回响应。我们可以使用 @http.route 装饰器来定义不同的路由，将其映射到具体的处理方法。通过使用 Odoo 的 request 对象，我们能够方便地获取请求参数、进行业务处理并返回各种格式的响应（如 HTML 页面、JSON 数据等）。

无论是开发内部管理系统、外部 API 接口，还是支持 Web 前端交互，Odoo 中的 controllers 都能帮助开发者实现灵活的路由和请求处理。