首页
/ Tortoise-ORM中自定义主键生成策略的实现方法

Tortoise-ORM中自定义主键生成策略的实现方法

2025-06-09 09:07:44作者:蔡怀权

在使用Tortoise-ORM时,开发者可能会遇到需要自定义主键生成策略的情况。本文将以Snowflake算法为例,详细介绍如何在Tortoise-ORM中正确实现自定义主键生成。

问题背景

在数据库设计中,主键的生成策略有多种选择。Snowflake算法是一种分布式ID生成算法,它能够生成全局唯一的64位整数ID,非常适合分布式系统使用。该算法生成的ID包含时间戳、机器ID、进程ID和序列号等信息。

当开发者尝试在Tortoise-ORM中使用Snowflake算法作为主键生成策略时,可能会发现实际生成的ID与预期不符,数据库仍然使用了自增序列。

问题原因

Tortoise-ORM对于整数类型的主键字段有一个默认行为:当字段类型为整数且作为主键时,会自动设置generated=True。这个参数表示主键值将由数据库自动生成,而不是由应用程序提供。

这种设计对于简单的自增ID场景非常方便,但当我们需要使用自定义ID生成算法时,就会产生冲突。

解决方案

要解决这个问题,需要显式地设置generated=False参数。这会告诉Tortoise-ORM不要依赖数据库生成主键值,而是使用我们提供的默认值生成函数。

以下是正确的字段定义方式:

class User(Model):
    id = fields.BigIntField(primary_key=True, default=new_id, generated=False)
    username = fields.CharField(32, unique=True)

Snowflake算法实现示例

下面是一个完整的Snowflake算法实现示例,可以直接在项目中使用:

import time
import os

# 初始化参数
machine_counter = 0
machine_id = 0  # 可根据实际环境配置
epoch = 1609459200000  # 2021-01-01 00:00:00 UTC

def new_id():
    global machine_counter
    
    # 生成64位ID
    return (
        ((int(time.time() * 1000) - epoch) << 22) | 
        ((machine_id % 32) << 17) |
        ((os.getpid() % 32) << 12) |
        ((machine_counter := machine_counter + 1) % 1024)
    )

使用注意事项

  1. 分布式环境:在多机部署时,需要确保每台服务器的machine_id不同,通常可以通过环境变量或配置文件设置。

  2. 时钟回拨:Snowflake算法对系统时钟敏感,如果发生时钟回拨,可能导致ID重复。生产环境中需要增加时钟回拨检测和处理逻辑。

  3. 性能考虑:虽然Snowflake算法性能很高,但在极高并发场景下,可以考虑使用批量生成ID的策略。

  4. 迁移兼容性:如果从自增ID迁移到Snowflake ID,需要注意外键关系的处理和数据迁移策略。

总结

通过正确设置generated=False参数,我们可以在Tortoise-ORM中自由使用各种自定义主键生成策略。Snowflake算法只是其中一种选择,开发者可以根据项目需求选择UUID、ULID等其他分布式ID方案。

理解ORM框架的默认行为并根据实际需求进行调整,是高效使用ORM框架的重要技能。希望本文能帮助开发者更好地掌握Tortoise-ORM的主键生成机制。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511