之前ID都是用自增實現的，那現在想用Snowflake算法生成主鍵，要做什麼改動呢？
目錄
背景介紹
目前工程框架如下
- Django
- django.db.backends.postgresql_psycopg2
目前models聲明和save()方法如下
# models.py
# 使用的是默認主鍵
class User(models.Model):
name = models.CharField(max_length=100, verbose_name="名字")
# user的新增操作，默認主鍵
user = User()
user.name = "123"
user.save()
在user.save()時執行的SQL語句是
INSERT INTO "polls_user" ("name") VALUES ('xiaoming') RETURNING "polls_user"."id"; args=('xiaoming',)
很明顯，並未在語句中設置ID主鍵
查看錶結構，發現id自動是使用序列自增來實現的
CREATE TABLE "public"."polls_user" (
"id" int4 NOT NULL DEFAULT nextval('polls_user_id_seq'::regclass),
"name" varchar(100) COLLATE "pg_catalog"."default" NOT NULL,
CONSTRAINT "polls_user_pkey" PRIMARY KEY ("id")
)
那麼基於目前的情況，如何改寫使用snowflake算法生成ID，而不是自動生成主鍵呢？
實現方案
方案1 - 手動添加主鍵
實現方式如下
-
（1）首先需要聲明id，聲明爲非
AutoField類型如果不聲明，在使用postgresql的情況下，會默認爲主鍵設置爲
serial類型，使用序列生成主鍵
# models.py
class User(models.Model):
id = models.BigIntegerField(primary_key=True)
name = models.CharField(max_length=100, verbose_name="名字")
- （2）其次是save( )的時候，需要手動設置主鍵
# user的新增操作
user = User()
user.id = snowflake.next_id()
user.name = "123"
# 可以不指定force_insert=True，如果不指定，默認會先update看是否有記錄，如果沒有，再執行insert
user.save(force_insert=True)
改動：（1）所有model增加id設置
（2）所有save()之前設置id=snowflake.next_id()
方案2 - 重寫save()方法
實現方式如下
- 單獨改寫某一個model的save( )方法
# models.py
class User(models.Model):
id = models.BigIntegerField(primary_key=True)
name = models.CharField(max_length=100, verbose_name="名字")
def save(self, *args, **kwargs):
if not self.id:
self.id = snowflake.next_id()
super(User, self).save(*args, **kwargs)
return self.id
- 調用的地方不用修改，不需要設置
user.id = snowflake.next_id()
按照上面的方法的話，每個新的model都是需要重寫save( )方法的，顯然工作量仍然比較多。
改動：（1）所有model增加id設置
（2）所有model重寫save()方法
方案3 - 使用 Django Signals 中的pre_save()
官方文檔地址：https://docs.djangoproject.com/en/3.0/topics/signals/
實現方式如下
- 修改models.py文件
使用pre_save( )方法，在調用models.save( )之後立即執行
注意
（1）如
auth_開頭的表的save()以及 其他django_開頭的表都會走此邏輯，需要排除這些model的save（2）save() 包括update和insert，過濾執行update的model
from django.db.models.signals import pre_save
from django.dispatch import receiver
import logging
@receiver(pre_save)
def pre_save_set_snowflake_id(sender, instance, *args, **kwargs):
"""
Django Signals, pre_save
適用所有的model
If we dont include the sender argument in the decorator,
like @receiver(pre_save, sender=MyModel), the callback will be called for all models.
"""
# print(__name__) # = polls.models
# print(type(instance)) # = <class 'polls.models.Question'>
if __name__ in str(type(instance)) and not instance.id:
# 滿足條件（1）在本models.py中聲明的model （2）id不爲空的model 纔會使用snowflake生成id
# 原因是如果不加條件（1）會有如auth_開頭的表以及django_開頭的表也會用snowflake生成的id，但是其id長度不夠
instance.id = snowflake.next_id()
class User(models.Model):
id = models.BigIntegerField(primary_key=True)
name = models.CharField(max_length=100, verbose_name="名字")
如上，修改好models.py之後，就可以安心使用save()了，原先的業務邏輯也不用有其他修改
改動（1）所有model增加id設置，統一設置 id = models.BigIntegerField(primary_key=True)
（2）增加pre_save( ) 方法，統一設置 id = snowflake.next_id()
方案4 - 仿照models.UUIDField，寫一個models.SnowflakeIDField
嘗試中，但是還沒有寫出來。
思路就是新寫一個field，比如類似models.UUIDField，能否寫一個models.SnowflakeIDField
如下是UUIDField寫法
# models.py
import uuid
class TestUUID(models.Model):
# 一定要設置default=uuid.uuid4
id = models.UUIDField(primary_key=True, default=uuid.uuid4)
name = models.CharField(max_length=100, verbose_name="名字")
# 新增操作
test_uuid = TestUUID()
test_uuid.name = '123123'
test_uuid.save()
-- 執行SQL
(0.005) INSERT INTO "polls_testuuid" ("id", "name") VALUES ('74f8e76c-b80a-4197-a469-81992c46e3c4'::uuid, '123123'); args=(UUID('74f8e76c-b80a-4197-a469-81992c46e3c4'), '123123')
TODO… 那麼，SnowflakeIDField如何實現呢？
最終了解下來，發現完全沒有必要自己寫models.SnowflakeIDField
如下，即可完成…
# models.py
# 添加 default=snowflake_util.next_id 即可
id = models.BigIntegerField(primary_key=True, default=snowflake_util.next_id)
總結
- 選擇上面的方案3，使用 Django Signals 中的pre_save()，可以增加對於參數的校驗，不過本次不需要
- 選擇上面的方案4，最簡單