如何在Django中将BinaryField设为主键？解决MySQL迁移报错

问题背景 #

使用Django 4.2.9连接MySQL时，定义了如下模型字段：

IDChuyenBien = models.BinaryField(primary_key=True, max_length=8)

执行makemigrations和migrate时触发错误：

_mysql.connection.query(self, query)
django.db.utils.OperationalError: (1170, "BLOB/TEXT column 'IDChuyenBien' used in key specification without a key length")

未设为主键时，该字段在MySQL中是LONGBLOB类型，但实际只需要存储8-10字节的二进制数据，对应MySQL的BINARY类型。

原因分析 #

Django默认的BinaryField在MySQL中会映射为LONGBLOB，即便设置了max_length参数，也不会自动转换为固定长度的BINARY(n)类型。而MySQL不允许将BLOB/TEXT类型直接作为主键，除非显式指定键长度——但LONGBLOB本身无法指定有效长度用于主键约束。

解决方案 #

自定义一个继承自BinaryField的字段，重写db_type方法，让它在MySQL环境下生成固定长度的BINARY(n)类型：

from django.db import models

class FixedBinaryField(models.BinaryField):
    def db_type(self, connection):
        if connection.vendor == 'mysql':
            # 取设置的max_length，默认8字节
            length = self.max_length or 8
            return f'BINARY({length})'
        # 其他数据库保持默认行为
        return super().db_type(connection)

然后在模型中替换原字段：

IDChuyenBien = FixedBinaryField(primary_key=True, max_length=8)

验证步骤 #

1. 重新执行makemigrations生成迁移文件
2. 执行migrate完成数据库变更
3. 查看MySQL表结构，该字段会被创建为BINARY(8)，可正常作为主键使用

内容的提问来源于stack exchange，提问作者couz2200