优化雪花算法和主键类型

Author: wu-clan

backend/app/admin/model/dept.py

@@ -4,7 +4,7 @@
 
 from typing import TYPE_CHECKING, Optional
 
-from sqlalchemy import Boolean, ForeignKey, String
+from sqlalchemy import BigInteger, Boolean, ForeignKey, String
 from sqlalchemy.dialects.postgresql import INTEGER
 from sqlalchemy.orm import Mapped, mapped_column, relationship
 
@@ -32,7 +32,7 @@ class Dept(Base):
 
     # 父级部门一对多
     parent_id: Mapped[int | None] = mapped_column(
-        ForeignKey('sys_dept.id', ondelete='SET NULL'), default=None, index=True, comment='父部门ID'
+        BigInteger, ForeignKey('sys_dept.id', ondelete='SET NULL'), default=None, index=True, comment='父部门ID'
     )
     parent: Mapped[Optional['Dept']] = relationship(init=False, back_populates='children', remote_side=[id])
     children: Mapped[Optional[list['Dept']]] = relationship(init=False, back_populates='parent')

backend/app/admin/model/login_log.py

@@ -7,7 +7,7 @@
 from sqlalchemy.dialects.postgresql import TEXT
 from sqlalchemy.orm import Mapped, mapped_column
 
-from backend.common.model import DataClassBase, id_key
+from backend.common.model import DataClassBase, snowflake_id_key
 from backend.utils.timezone import timezone
 
 
@@ -16,7 +16,7 @@ class LoginLog(DataClassBase):
 
     __tablename__ = 'sys_login_log'
 
-    id: Mapped[id_key] = mapped_column(init=False)
+    id: Mapped[snowflake_id_key] = mapped_column(init=False)
     user_uuid: Mapped[str] = mapped_column(String(50), comment='用户UUID')
     username: Mapped[str] = mapped_column(String(20), comment='用户名')
     status: Mapped[int] = mapped_column(insert_default=0, comment='登录状态(0失败 1成功)')

backend/app/admin/model/m2m.py

@@ -1,33 +1,33 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-from sqlalchemy import INT, Column, ForeignKey, Integer, Table
+from sqlalchemy import BigInteger, Column, ForeignKey, Table
 
 from backend.common.model import MappedBase
 
 sys_user_role = Table(
     'sys_user_role',
     MappedBase.metadata,
-    Column('id', INT, primary_key=True, unique=True, index=True, autoincrement=True, comment='主键ID'),
-    Column('user_id', Integer, ForeignKey('sys_user.id', ondelete='CASCADE'), primary_key=True, comment='用户ID'),
-    Column('role_id', Integer, ForeignKey('sys_role.id', ondelete='CASCADE'), primary_key=True, comment='角色ID'),
+    Column('id', BigInteger, primary_key=True, unique=True, index=True, autoincrement=True, comment='主键ID'),
+    Column('user_id', BigInteger, ForeignKey('sys_user.id', ondelete='CASCADE'), primary_key=True, comment='用户ID'),
+    Column('role_id', BigInteger, ForeignKey('sys_role.id', ondelete='CASCADE'), primary_key=True, comment='角色ID'),
 )
 
 sys_role_menu = Table(
     'sys_role_menu',
     MappedBase.metadata,
-    Column('id', INT, primary_key=True, unique=True, index=True, autoincrement=True, comment='主键ID'),
-    Column('role_id', Integer, ForeignKey('sys_role.id', ondelete='CASCADE'), primary_key=True, comment='角色ID'),
-    Column('menu_id', Integer, ForeignKey('sys_menu.id', ondelete='CASCADE'), primary_key=True, comment='菜单ID'),
+    Column('id', BigInteger, primary_key=True, unique=True, index=True, autoincrement=True, comment='主键ID'),
+    Column('role_id', BigInteger, ForeignKey('sys_role.id', ondelete='CASCADE'), primary_key=True, comment='角色ID'),
+    Column('menu_id', BigInteger, ForeignKey('sys_menu.id', ondelete='CASCADE'), primary_key=True, comment='菜单ID'),
 )
 
 sys_role_data_scope = Table(
     'sys_role_data_scope',
     MappedBase.metadata,
-    Column('id', INT, primary_key=True, unique=True, index=True, autoincrement=True, comment='主键 ID'),
-    Column('role_id', Integer, ForeignKey('sys_role.id', ondelete='CASCADE'), primary_key=True, comment='角色 ID'),
+    Column('id', BigInteger, primary_key=True, unique=True, index=True, autoincrement=True, comment='主键 ID'),
+    Column('role_id', BigInteger, ForeignKey('sys_role.id', ondelete='CASCADE'), primary_key=True, comment='角色 ID'),
     Column(
         'data_scope_id',
-        Integer,
+        BigInteger,
         ForeignKey('sys_data_scope.id', ondelete='CASCADE'),
         primary_key=True,
         comment='数据范围 ID',
@@ -37,17 +37,17 @@
 sys_data_scope_rule = Table(
     'sys_data_scope_rule',
     MappedBase.metadata,
-    Column('id', INT, primary_key=True, unique=True, index=True, autoincrement=True, comment='主键ID'),
+    Column('id', BigInteger, primary_key=True, unique=True, index=True, autoincrement=True, comment='主键ID'),
     Column(
         'data_scope_id',
-        Integer,
+        BigInteger,
         ForeignKey('sys_data_scope.id', ondelete='CASCADE'),
         primary_key=True,
         comment='数据范围 ID',
     ),
     Column(
         'data_rule_id',
-        Integer,
+        BigInteger,
         ForeignKey('sys_data_rule.id', ondelete='CASCADE'),
         primary_key=True,
         comment='数据规则 ID',

backend/app/admin/model/menu.py

@@ -4,7 +4,7 @@
 
 from typing import TYPE_CHECKING, Optional
 
-from sqlalchemy import ForeignKey, String
+from sqlalchemy import BigInteger, ForeignKey, String
 from sqlalchemy.dialects.mysql import LONGTEXT
 from sqlalchemy.dialects.postgresql import TEXT
 from sqlalchemy.orm import Mapped, mapped_column, relationship
@@ -42,7 +42,7 @@ class Menu(Base):
 
     # 父级菜单一对多
     parent_id: Mapped[int | None] = mapped_column(
-        ForeignKey('sys_menu.id', ondelete='SET NULL'), default=None, index=True, comment='父菜单ID'
+        BigInteger, ForeignKey('sys_menu.id', ondelete='SET NULL'), default=None, index=True, comment='父菜单ID'
     )
     parent: Mapped[Optional['Menu']] = relationship(init=False, back_populates='children', remote_side=[id])
     children: Mapped[Optional[list['Menu']]] = relationship(init=False, back_populates='parent')

backend/common/model.py

@@ -14,15 +14,30 @@
 # MappedBase -> id: Mapped[id_key]
 # DataClassBase && Base -> id: Mapped[id_key] = mapped_column(init=False)
 id_key = Annotated[
-    int, mapped_column(primary_key=True, index=True, autoincrement=True, sort_order=-999, comment='主键 ID')
+    int,
+    mapped_column(
+        BigInteger,
+        primary_key=True,
+        unique=True,
+        index=True,
+        autoincrement=True,
+        sort_order=-999,
+        comment='主键 ID',
+    ),
 ]
 
 
-# 雪花算法ID，使用方法同 id_key
+# 雪花算法 Mapped 类型主键，使用方法与 id_key 相同
 snowflake_id_key = Annotated[
     int,
     mapped_column(
-        BigInteger, primary_key=True, index=True, default=snowflake.generate, sort_order=-999, comment='雪花算法主键 ID'
+        BigInteger,
+        primary_key=True,
+        unique=True,
+        index=True,
+        default=snowflake.generate,
+        sort_order=-999,
+        comment='雪花算法主键 ID',
     ),
 ]
 

backend/plugin/code_generator/model/column.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 from typing import TYPE_CHECKING, Union
 
-from sqlalchemy import ForeignKey, String
+from sqlalchemy import BigInteger, ForeignKey, String
 from sqlalchemy.dialects.mysql import LONGTEXT
 from sqlalchemy.dialects.postgresql import TEXT
 from sqlalchemy.orm import Mapped, mapped_column, relationship
@@ -33,6 +33,6 @@ class GenColumn(DataClassBase):
 
     # 代码生成业务模型一对多
     gen_business_id: Mapped[int] = mapped_column(
-        ForeignKey('gen_business.id', ondelete='CASCADE'), default=0, comment='代码生成业务ID'
+        BigInteger, ForeignKey('gen_business.id', ondelete='CASCADE'), default=0, comment='代码生成业务ID'
     )
     gen_business: Mapped[Union['GenBusiness', None]] = relationship(init=False, back_populates='gen_column')

backend/plugin/oauth2/model/user_social.py

@@ -4,7 +4,7 @@
 
 from typing import TYPE_CHECKING
 
-from sqlalchemy import ForeignKey, String
+from sqlalchemy import BigInteger, ForeignKey, String
 from sqlalchemy.orm import Mapped, mapped_column, relationship
 
 from backend.common.model import Base, id_key
@@ -23,5 +23,7 @@ class UserSocial(Base):
     source: Mapped[str] = mapped_column(String(20), comment='第三方用户来源')
 
     # 用户社交信息一对多
-    user_id: Mapped[int] = mapped_column(ForeignKey('sys_user.id', ondelete='CASCADE'), comment='用户关联ID')
+    user_id: Mapped[int] = mapped_column(
+        BigInteger, ForeignKey('sys_user.id', ondelete='CASCADE'), comment='用户关联ID'
+    )
     user: Mapped[User | None] = relationship(init=False, backref='socials')