Django自定义EncryptedField如何获取所属模型实例及关联字段值？

在from_db_value和get_prep_value方法里无法直接拿到模型实例——这两个方法的执行时机没有实例上下文：from_db_value是查询集返回数据时逐个转换字段值，此时实例还未组装；get_prep_value仅负责处理当前字段的值，没有传递实例参数。

推荐通过信号机制来实现，利用pre_save（保存前）和post_init（实例初始化后）信号获取完整的模型实例，进而拿到关联字段的值完成加解密。

代码实现 #

from django.db import models
from django.db.models.signals import pre_save, post_init
from django.dispatch import receiver

class EncryptedField(models.TextField):
    def __init__(self, other_field, *args, **kwargs):
        self.other_field = other_field
        super().__init__(*args, **kwargs)

    def contribute_to_class(self, cls, name, **kwargs):
        super().contribute_to_class(cls, name, **kwargs)
        # 为当前字段所属的模型注册信号
        pre_save.connect(self._handle_pre_save, sender=cls)
        post_init.connect(self._handle_post_init, sender=cls)

    def _handle_pre_save(self, sender, instance, **kwargs):
        raw_value = getattr(instance, self.attname)
        # 避免重复加密（根据你的加密规则调整判断逻辑）
        if self._is_encrypted(raw_value):
            return
        
        # 获取关联字段的当前值
        associated_data = getattr(instance, self.other_field)
        # 加密后重新赋值给字段
        encrypted_val = encrypt(raw_value, associated_data)
        setattr(instance, self.attname, encrypted_val)

    def _handle_post_init(self, sender, instance, **kwargs):
        encrypted_val = getattr(instance, self.attname)
        if not encrypted_val:
            return
        
        # 获取关联字段的值
        associated_data = getattr(instance, self.other_field)
        # 解密后赋值给字段，供业务使用
        decrypted_val = decrypt(encrypted_val, associated_data)
        setattr(instance, self.attname, decrypted_val)

    # 辅助方法：判断值是否已加密（需结合实际加密逻辑实现）
    def _is_encrypted(self, value):
        # 示例：判断是否有加密标识前缀
        return isinstance(value, str) and value.startswith("ENC:")

    # 重写这两个方法，只做值的透传，加解密逻辑交给信号处理
    def from_db_value(self, value, expression, connection):
        return value

    def get_prep_value(self, value):
        return value

工作流程 #

1. 加载实例时解密：当模型从数据库加载完成后，post_init信号触发，此时实例已拥有所有字段的数据，我们用关联字段的值解密当前字段，并把解密后的值赋值给实例属性，业务代码直接拿到明文。
2. 保存实例时加密：当调用save()方法时，pre_save信号触发，此时获取当前字段的明文值，用关联字段的最新值加密后重新赋值，最终存入数据库的是加密后的内容。

注意事项 #

• 确保_is_encrypted方法逻辑准确，避免对已加密的值重复加密。
• 处理空值场景，防止加解密函数报错。
• 如果关联字段的值在实例生命周期内被修改，保存时会自动用最新的关联字段值重新加密当前字段，无需额外处理。

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