odoo框架源码研读一：前后端交互

曾经终败给现在 2023-10-03 11:09 1阅读 0赞

黄华信，神州数码云基地软件开发工程师，擅长odoo定制化开发。

### 1 源码文件结构 ###

odoo14.0源码结构如下：

doc文件夹下是项目的帮助文档。

odoo-bin文件是odoo的启动脚本，配合自定义的odoo.conf配置文件用来启动项目。

odoo是odoo的底层模块，包含项目的基础父类,以及项目启动需要的基础类。

addons中包含了odoo的基础业务模块，包括CRM、Sales等模块。

### 2 框架结构 ###

经历了六个月的odoo学习与实战，基于笔者对odoo前后端交互的理解。

![10bc2bf91fc334a16b79e9cb719a5010.png][]

### 2.1 前后端交互 ###

odoo的前端基础框架以及和后台基础模块交互的API都封装在了addons下的web模块。

#### **2.1.1 Controller控制器** ####

odoo是通过controller控制器来控制前后台的交互，然后又根据功能的不同划分成了多个控制器，从下图中每个controller的命名中了解各自对应的功能模块。

![04646b436c7f7ab54001c4f78bdf850f.png][]

这些controller继承了base模块中的Controller基类，并通过http.route装饰器的注解将controller中的方法标记为请求处理器，变成对外暴露的API接口，接收并处理http请求。关于http.route的详细介绍，源码中有详细的注释。此处以基础业务模块的controller控制器DataSet查询列表数据接口search\_read为例：

![76127d1e180237dfa2f3c03ec54904b0.png][]

http.route

<table> 
 <tbody> 
  <tr> 
   <th>type</th> 
   <th>enum</th> 
   <th>description</th> 
  </tr> 
  <tr> 
   <td>string/array</td> 
   <td></td> 
   <td>请求分发映射对应的方法</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>http/json</td> 
   <td>request类型</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>user/public/none</td> 
   <td>认证方法类型</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>GET/POST</td> 
   <td>请求类型</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td></td> 
   <td>The Access-Control-Allow-Origin cors directive value</td> 
  </tr> 
  <tr> 
   <td>bool</td> 
   <td></td> 
   <td>是否启用CSRF防御</td> 
  </tr> 
 </tbody> 
</table>

#### **2.1.2 Dispatcher分发模块** ####

通过调试代码，整理请求在到达controller之前的处理流程如下：

![2d366b9974686c40e26ffbc00a822f68.png][]

#### Root ####

Root是odoo的WSGI根应用，会在项目启动的时候创建。  
请求到达odoo后，会被Root接收，并调用dispatch方法。

![138f4e4395610270506b125728d8607a.png][]

root在dispatch方法处理流程：

1.  获取werkzeug中的原始request对象。
2.  然后设置上下文环境，包括将状态绑定线程、设置session、数据库、语言等

root在设置db的时候会根据db\_filter配置参数去获取匹配的数据库信息，如果唯一，那么进入系统登陆页面的时候session中会带有db,反之进入系统时session中不会带有db，并会进入数据库选择页面，选择之后才是登陆页面，登陆时会把选择的数据库信息设置到session中，以保证后面的请求都会通过IrHttp映射器分映射发请求到对应的方法。

1.  然后通过get\_request方法将request对象封装成HttpRequest或者JsonRequest
2.  通过判断session是否带有db数据库名称，调用不同的分发逻辑，如果db值为空就会跳转到选择数据库的界面，否则会调用IrHttp请求映射器进行dispatch。

#### IrHttp ####

源码中对IrHttp的描述是"HTTP Routing"或者是"Routing map"。

![be9c7c4fc1d5fd1c247fc6a051222b18.png][]

请求在到了IrHttp.\_dispatch()后，做了如下操作：

1.  根据请求中的path作为key去routeing\_map中匹配对应的路由信息（方法、参数等）。

![d618664347b93fd96c831639eb7c635a.png][]

![f760e3b58aa0f378dbecfb1a623af87b.png][]

1.  根据获取到的路由信息中的auth去进行权限校验
2.  根据获取的路由信息以及校验信息封装requestHandler

![c117de4db6d6eeeb7b9d2477663e1e25.png][]

1.  调用request的dispatch方法

#### HttpRequest/JsonRequest ####

请求在到了HttpRequest/JsonRequest的dispatch方法后，都通过父类WebController的\_\_call\_function()方法根据在IrHttp时已经封装好的entpoint路由信息，路由到对应的controller中的接口方法。除此之外，HttpRequest在call\_function之前还校验了csrf\_token,而JsonHttp则是根据配置打印debug日志，以及返回结果封装json\_response。

![5e325bd49699928f1592a40c8a21a69b.png][]

![ff3773c8b805599021985ed11a090e1d.png][]

![f12140fd7b3b2ffc59a95e9b652973cc.png][]

至此，请求就顺利的到达了Controller控制器。  
关于HttpRequest和JsonRequest,两者都继承了同一个父类WebRequest,可以看出两者都具有处理异常、分发请求的功能，相比于JsonRequest,HttpRequest多了是否校验cors、渲染html和处理404请求的功能，而JsonRequest则多了封装json\_response的功能。具体对比如下：

<table> 
 <tbody> 
  <tr> 
   <th></th> 
   <th>_request_type</th> 
   <th>参数类型</th> 
   <th>返回值</th> 
  </tr> 
  <tr> 
   <td>HttpRequest</td> 
   <td>http</td> 
   <td>请求路径参数pathParam；请求参数queryParam;form表单；</td> 
   <td>空内容；werkzeug Response 对象;字符串或者编码；</td> 
  </tr> 
  <tr> 
   <td>JsonRequest</td> 
   <td>json</td> 
   <td>JSON object</td> 
   <td>JSON-RPC</td> 
  </tr> 
 </tbody> 
</table>

本篇就先讲到这里，下面一篇文章将会向大家介绍odoo的ORM。

**传送门：**

[TiKV源码略读-Server Start][TiKV_-Server Start]

[RPA实战之使用AA2019获取GDP数据][RPA_AA2019_GDP]

[10bc2bf91fc334a16b79e9cb719a5010.png]: https://img-blog.csdnimg.cn/img_convert/10bc2bf91fc334a16b79e9cb719a5010.png
[04646b436c7f7ab54001c4f78bdf850f.png]: https://img-blog.csdnimg.cn/img_convert/04646b436c7f7ab54001c4f78bdf850f.png
[76127d1e180237dfa2f3c03ec54904b0.png]: https://img-blog.csdnimg.cn/img_convert/76127d1e180237dfa2f3c03ec54904b0.png
[2d366b9974686c40e26ffbc00a822f68.png]: https://img-blog.csdnimg.cn/img_convert/2d366b9974686c40e26ffbc00a822f68.png
[138f4e4395610270506b125728d8607a.png]: https://img-blog.csdnimg.cn/img_convert/138f4e4395610270506b125728d8607a.png
[be9c7c4fc1d5fd1c247fc6a051222b18.png]: https://img-blog.csdnimg.cn/img_convert/be9c7c4fc1d5fd1c247fc6a051222b18.png
[d618664347b93fd96c831639eb7c635a.png]: https://img-blog.csdnimg.cn/img_convert/d618664347b93fd96c831639eb7c635a.png
[f760e3b58aa0f378dbecfb1a623af87b.png]: https://img-blog.csdnimg.cn/img_convert/f760e3b58aa0f378dbecfb1a623af87b.png
[c117de4db6d6eeeb7b9d2477663e1e25.png]: https://img-blog.csdnimg.cn/img_convert/c117de4db6d6eeeb7b9d2477663e1e25.png
[5e325bd49699928f1592a40c8a21a69b.png]: https://img-blog.csdnimg.cn/img_convert/5e325bd49699928f1592a40c8a21a69b.png
[ff3773c8b805599021985ed11a090e1d.png]: https://img-blog.csdnimg.cn/img_convert/ff3773c8b805599021985ed11a090e1d.png
[f12140fd7b3b2ffc59a95e9b652973cc.png]: https://img-blog.csdnimg.cn/img_convert/f12140fd7b3b2ffc59a95e9b652973cc.png
[TiKV_-Server Start]: https://zhuanlan.zhihu.com/p/356584875
[RPA_AA2019_GDP]: https://zhuanlan.zhihu.com/p/346837611