前言

最近在做的項(xiàng)目中有一個(gè)需求是要讓某個(gè)字段值根據(jù)記錄產(chǎn)生的日期和一定的組合規(guī)則按順序生成一個(gè)序列號(hào)，這個(gè)序列號(hào)不可重復(fù)，這原本是一個(gè)很常見(jiàn)的需求，沒(méi)有多想就寫(xiě)好了。由于沒(méi)有考慮到并發(fā)的情況，到后面測(cè)試的時(shí)候才發(fā)現(xiàn)一個(gè)比較嚴(yán)重的問(wèn)題，如果用戶同時(shí)操作產(chǎn)生的記錄，生成的序列號(hào)會(huì)出現(xiàn)重復(fù)。

經(jīng)過(guò)討論和思考后有幾種解決方案，一是在數(shù)據(jù)庫(kù)表層加鎖，一是采用類似 redis 的消息隊(duì)列，還有就是通過(guò)文件鎖達(dá)到數(shù)據(jù)庫(kù)排他鎖的目的，鑒于時(shí)間和項(xiàng)目當(dāng)前的情況，最后采用了通過(guò)文件鎖實(shí)現(xiàn)這個(gè)需求。

其實(shí)除了以上幾種方式，Odoo 本身就有一個(gè)模型（ir.sequence）是用于生成序列的，可以很方便地實(shí)現(xiàn)這個(gè)需求，因?yàn)橹耙恢睕](méi)有接觸過(guò)這個(gè)模塊，還是在項(xiàng)目之后的階段同事使用到了并且告訴我之后才知道原來(lái)有這么個(gè)好東西的存在。在這里我將會(huì)把我原本通過(guò)文件鎖實(shí)現(xiàn)的方式和通過(guò) Odoo 自帶的ir.sequence實(shí)現(xiàn)的方式都記錄下來(lái)。

給文件加鎖 - fcntl

fcntl是 Python 標(biāo)準(zhǔn)庫(kù)里的一個(gè)模塊，用來(lái)對(duì)文件進(jìn)行加鎖的操作。在實(shí)現(xiàn)中主要用到的是下面這個(gè)函數(shù)：

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 - 解鎖

關(guān)于fcntl的其他具體內(nèi)容請(qǐng)查看 官方標(biāo)準(zhǔn)庫(kù)文檔 。

下面來(lái)看一下具體的實(shí)現(xiàn)，在給出代碼之前，先描述一下需求，假設(shè)模型中有一個(gè)字段sn用于存儲(chǔ)按一定規(guī)則生成的序列號(hào)，序列號(hào)的組成規(guī)則如下：

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

需求很簡(jiǎn)單，也很清楚了，下面就上代碼開(kāi)始具體的實(shí)現(xiàn)。首先創(chuàng)建一個(gè)模塊demo_sequence：

./odoo-bin scaffold demo_sequence

然后在模塊的目錄下創(chuàng)建數(shù)據(jù)文件目錄data/，在目錄下創(chuàng)建一個(gè)data.xml文件，在后面會(huì)用到；繼續(xù)在模塊目錄下創(chuàng)建靜態(tài)文件目錄static/，在目錄下創(chuàng)建一個(gè)空文件SN.LOCK用作加鎖的文件對(duì)象。完成之后的目錄結(jié)構(gòu)如下：

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

模型的創(chuàng)建和視圖的編寫(xiě)，這里將跳過(guò)不說(shuō)，具體的代碼將在后面給出。先創(chuàng)建一個(gè)給文件加鎖的函數(shù)：

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

然后重寫(xiě)模型的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')
 # 今天已經(jīng)有序列號(hào)，在最新的序列號(hào)上遞增
 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) # 補(bǔ)0
 else:
 vals['sn'] = sn_prefix + '001'
 res = super(DemoSequence, self).create(vals)
 # 關(guān)閉文件將自動(dòng)解鎖
 file.close()
 return res

利用fcntl給文件加鎖后再生成序列號(hào)寫(xiě)入數(shù)據(jù)庫(kù)，以達(dá)到序列號(hào)不重復(fù)的目的，就這么點(diǎn)代碼就搞定了，不過(guò)還有更簡(jiǎn)單的方式，就是利用 Odoo 自帶的ir.sequence模型產(chǎn)生序列號(hào)。

生成唯一標(biāo)識(shí) - 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.

我們可以利用它生成唯一的標(biāo)識(shí)，下面就看一下怎么用ir.sequence實(shí)現(xiàn)前面所說(shuō)的需求。

打開(kāi)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>

這里的參數(shù)實(shí)際上不止這幾個(gè)，在實(shí)現(xiàn)需求的前提下這幾個(gè)就夠用了，分別說(shuō)明一下各個(gè)參數(shù)的作用：

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

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

接下來(lái)就是調(diào)用得到按規(guī)則生成的序列號(hào)，同樣重寫(xiě)模型的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)

可以看到只需要一行代碼就可以得到一個(gè)唯一的序列號(hào)，比前面用fcntl給文件加鎖的方式簡(jiǎn)單了幾個(gè)級(jí)別。這里的調(diào)用就用到了前面定義中所寫(xiě)的code。

在實(shí)際項(xiàng)目中所使用到的兩種方式都已經(jīng)在這里記錄下來(lái)了，官方的東西確實(shí)是個(gè)好東西，回頭看看自己寫(xiě)的東西，畢竟 too young，可惜官方的文檔好像并沒(méi)有相關(guān)的記錄（抑或是我沒(méi)找到？），多翻翻官方實(shí)現(xiàn)的功能模塊源碼，才是精進(jìn) Odoo 之道。

源碼下載

以上出現(xiàn)的所有代碼均可在倉(cāng)庫(kù) ruter/TNK-Odoo-Demo 中 查看并下載 (大家也可以通過(guò)本地下載)。

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

最新評(píng)論