Odoo中如何生成唯一不重復的序列號詳解

前言

最近在做的項目中有一個需求是要讓某個字段值根據記錄產生的日期和一定的組合規則按順序生成一個序列號，這個序列號不可重復，這原本是一個很常見的需求，沒有多想就寫好了。由于沒有考慮到并發的情況，到后面測試的時候才發現一個比較嚴重的問題，如果用戶同時操作產生的記錄，生成的序列號會出現重復。

經過討論和思考后有幾種解決方案，一是在數據庫表層加鎖，一是采用類似 redis 的消息隊列，還有就是通過文件鎖達到數據庫排他鎖的目的，鑒于時間和項目當前的情況，最后采用了通過文件鎖實現這個需求。

其實除了以上幾種方式，Odoo 本身就有一個模型（ir.sequence）是用于生成序列的，可以很方便地實現這個需求，因為之前一直沒有接觸過這個模塊，還是在項目之后的階段同事使用到了并且告訴我之后才知道原來有這么個好東西的存在。在這里我將會把我原本通過文件鎖實現的方式和通過 Odoo 自帶的ir.sequence實現的方式都記錄下來。

給文件加鎖 - fcntl

fcntl是 Python 標準庫里的一個模塊，用來對文件進行加鎖的操作。在實現中主要用到的是下面這個函數：

def flock(fd, operation):
 """
 flock(fd, operation)

 Perform the lock operation op on file descriptor fd. See the Unix 
 manual page for flock(2) for details. (On some systems, this function is
 emulated using fcntl().)
 """
 pass

其中fd是文件描述符，operation為鎖的操作，總共有4種：

• fcntl.LOCK_EX - 排他鎖
• fcntl.LOCK_NB - 非阻塞鎖
• fcntl.LOCK_SH - 共享鎖
• fcntl.LOCK_UN - 解鎖

關于fcntl的其他具體內容請查看 官方標準庫文檔 。

下面來看一下具體的實現，在給出代碼之前，先描述一下需求，假設模型中有一個字段sn用于存儲按一定規則生成的序列號，序列號的組成規則如下：

• 固定的前綴SN
• 取記錄生成的日期組成的6位數字%y%m%d，如2017年12月8日取值為171208
• 最后是3位的流水號，從001開始遞增
• 生成的序列號不能有重復
• 最后的3位流水號每天自動重置，從001開始遞增（這個需求涉及到一些擴展，故此文將不實現這一需求）

需求很簡單，也很清楚了，下面就上代碼開始具體的實現。首先創建一個模塊demo_sequence：

./odoo-bin scaffold demo_sequence

然后在模塊的目錄下創建數據文件目錄data/，在目錄下創建一個data.xml文件，在后面會用到；繼續在模塊目錄下創建靜態文件目錄static/，在目錄下創建一個空文件SN.LOCK用作加鎖的文件對象。完成之后的目錄結構如下：

demo_sequence
├── __init__.py
├── __manifest__.py
├── controllers
│ ├── __init__.py
│ └── controllers.py
├── data
│ └── data.xml
├── demo
│ └── demo.xml
├── models
│ ├── __init__.py
│ └── models.py
├── security
│ └── ir.model.access.csv
├── static
│ └── SN.LOCK
└── views
├── templates.xml
└── views.xml

模型的創建和視圖的編寫，這里將跳過不說，具體的代碼將在后面給出。先創建一個給文件加鎖的函數：

def _file_lock(flag=fcntl.LOCK_EX):
 FILE_PATH = get_module_resource('demo_sequence', 'static/SN.LOCK')
 file = open(FILE_PATH)
 fcntl.flock(file.fileno(), flag)
 _logger.info('Acquire Lock')
 return file

然后重寫模型的create()方法：

@api.model
def create(self, vals):
 file = _file_lock()
 sn_prefix = 'SN' + datetime.date.today().strftime("%y%m%d")
 obj = self.env['demo_sequence.fcntl'].search_read([('sn', '=like', sn_prefix + '%')], limit=1, order='sn DESC')
 # 今天已經有序列號，在最新的序列號上遞增
 if obj and obj[0]['sn'].startswith(sn_prefix):
 sn_suffix = int(obj[0]['sn'][-3:]) + 1
 vals['sn'] = sn_prefix + str(sn_suffix).zfill(3) # 補0
 else:
 vals['sn'] = sn_prefix + '001'
 res = super(DemoSequence, self).create(vals)
 # 關閉文件將自動解鎖
 file.close()
 return res

利用fcntl給文件加鎖后再生成序列號寫入數據庫，以達到序列號不重復的目的，就這么點代碼就搞定了，不過還有更簡單的方式，就是利用 Odoo 自帶的ir.sequence模型產生序列號。

生成唯一標識 - ir.sequence

在模型ir.sequence中是這樣描述的：

The sequence model allows to define and use so-called sequence objects. Such objects are used to generate unique identifiers in a transaction-safeway.

我們可以利用它生成唯一的標識，下面就看一下怎么用ir.sequence實現前面所說的需求。

打開data/data.xml并添加以下代碼：

<?xml version="1.0" encoding="utf-8"?>
<odoo>
 <data noupdate="1">
 <record id="seq_demo_sequence_sn" model="ir.sequence">
  <field name="name">Demo Sequence SN</field>
  <field name="code">demo_sequence.sequence</field>
  <field name="prefix">SN%(y)s%(month)s%(day)s</field>
  <field name="padding">3</field>
 </record>
 </data>
</odoo>

這里的參數實際上不止這幾個，在實現需求的前提下這幾個就夠用了，分別說明一下各個參數的作用：

• name - 名字，隨便叫什么都行
• code - 調用生成編碼的 Key，需保證唯一性
• prefix - 前綴，可以是固定的字面量也可以是組合參數
• padding - 序列遞增的位數

注：記得將data/data.xml加入到__manifest__.py的data列表中

接下來就是調用得到按規則生成的序列號，同樣重寫模型的create()方法：

@api.model
def create(self, vals):
 vals['sn'] = self.env['ir.sequence'].next_by_code('demo_sequence.sequence')
 return super(DemoSequence2, self).create(vals)

可以看到只需要一行代碼就可以得到一個唯一的序列號，比前面用fcntl給文件加鎖的方式簡單了幾個級別。這里的調用就用到了前面定義中所寫的code。

在實際項目中所使用到的兩種方式都已經在這里記錄下來了，官方的東西確實是個好東西，回頭看看自己寫的東西，畢竟 too young，可惜官方的文檔好像并沒有相關的記錄（抑或是我沒找到？），多翻翻官方實現的功能模塊源碼，才是精進 Odoo 之道。

源碼下載

以上出現的所有代碼均可在倉庫 ruter/TNK-Odoo-Demo 中 查看并下載 (大家也可以通過本地下載)。

總結

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對億速云的支持。