在 Odoo 中生成唯一不重復的序列號

wujl596 發布于2019-07-30 15:41 / 3249人閱讀

摘要：最近在做的項目中有一個需求是要讓某個字段值根據記錄產生的日期和一定的組合規則按順序生成一個序列號，這個序列號不可重復，這原本是一個很常見的需求，沒有多想就寫好了。

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

經過討論和思考后有幾種解決方案，一是在數據庫表層加鎖，一是采用類似 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并添加以下代碼：



  
    
      Demo Sequence SN
      demo_sequence.sequence
      SN%(y)s%(month)s%(day)s
      3

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

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 中查看并下載。

注：本文轉自我的個人博客「TNK」，發布于 2017-12-08，通過原文地址可以訪問到我的博客原文。

GPU云服務器云服務器 cdn中生成鏈接 java中生成目錄在odoo服務器 odoo安裝在云vps

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/41401.html

「Odoo 基礎教程系列」第二篇——從 Todo 應用開始（1）

摘要：雖然這是個很簡單的應用，但是希望大家可以動手一起操作，從最簡單的開始上手學習如何使用這個框架。則是在和之間，負責響應用戶操作，從中獲取數據進行處理并返回到中。 showImg(https://segmentfault.com/img/bV66tE?w=728&h=410); 在第一篇教程發布之后差不多一個月的今天，終于完成了第二篇內容，這個發布周期拖得實在是有點太長了，我都覺得不好意思...

UCloud 2019-07-31 11:07 評論0 收藏0
「Odoo 基礎教程系列」第一篇——環境準備

摘要：安裝好后，在中執行查看版本信息，應該會看到輸出如下信息版本號可能會不同如果提示未找到，則需要手動將用戶基礎目錄下的添加到中。相關文章基礎教程系列第篇開天坑啦 showImg(https://segmentfault.com/img/bV4GZu?w=1262&h=911); 之前說好的「Odoo 基礎教程系列」終于來了（撒花）~剛過完年重新投入到工作中，一下子事情有點多都要忙不過來了...

szysky 2019-07-31 11:03 評論0 收藏0
odoo基礎數據加載

摘要：內部就是定義具體記錄的列名和值，可以有多個列，如下數據文件需在或字段里列出，才能在模塊安裝更新后正確的加載數據只在勾選演示數據后才會加載數據在系統啟動后會自動進行加載 odoo 基礎數據加載這里介紹的odoo基礎數據加載分兩種方式，一種是演示數據加載，一種是默認數據加載，下面就是詳細介紹首先，當然是創建一個date文件夾項目目錄，右鍵自定義一個文件夾 XML數據定義格式 ...

airborne007 2019-08-26 13:36 評論0 收藏0
odoo基礎數據加載

摘要：內部就是定義具體記錄的列名和值，可以有多個列，如下數據文件需在或字段里列出，才能在模塊安裝更新后正確的加載數據只在勾選演示數據后才會加載數據在系統啟動后會自動進行加載 odoo 基礎數據加載這里介紹的odoo基礎數據加載分兩種方式，一種是演示數據加載，一種是默認數據加載，下面就是詳細介紹首先，當然是創建一個date文件夾項目目錄，右鍵自定義一個文件夾 XML數據定義格式 ...

Labradors 2019-08-02 14:29 評論0 收藏0
odoo基礎數據加載

摘要：內部就是定義具體記錄的列名和值，可以有多個列，如下數據文件需在或字段里列出，才能在模塊安裝更新后正確的加載數據只在勾選演示數據后才會加載數據在系統啟動后會自動進行加載 odoo 基礎數據加載這里介紹的odoo基礎數據加載分兩種方式，一種是演示數據加載，一種是默認數據加載，下面就是詳細介紹首先，當然是創建一個date文件夾項目目錄，右鍵自定義一個文件夾 XML數據定義格式 ...

rollback 2019-08-27 10:58 評論0 收藏0