Django | model-字段-UUIDField

模型字段中 UUIDField 类型小记

进来在一个小应用中使用了 UUIDField 字段类型，在视图写完跑单元测试时，发现获取的结果和我期望的不一致....。

1 使用 UUIDField

class BaseBackBone(models.Model):
    """model docstring"""
    id = models.UUIDField(primary_key=True, default=UUIDTools.uuid1_hex, editable=False)

    class Meta:
        abstract = True

所使用的 UUIDTools.uuid1_hex 代码如下：

import uuid


class UUIDTools(object):
    """uuid function tools"""

    @staticmethod
    def uuid1_hex():
        """
        return uuid1 hex string

        eg: 23f87b528d0f11e696a7f45c89a84eed
        """
        return uuid.uuid1().hex

2 在终端中跑个测试

http http://127.0.0.1:8000/blog/category/

HTTP/1.0 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Date: Sat, 08 Oct 2016 10:00:01 GMT
Server: WSGIServer/0.2 CPython/3.5.2
Vary: Accept, Cookie
X-Frame-Options: SAMEORIGIN

[
    {
        "id": "e6e6ddca-8d2d-11e6-85b8-f45c89a84eed",
        "name": "Django"
    }
]

可以看到返回的 id 字段中有横岗，我查了数据库发现，数据库中是没有横杠

e6e6ddca8d2d11e685b8f45c89a84eed

很有意思，存到数据库中时，是不带横杠的，即自定义的函数返回的结果；但是显示时，带有小横杠，哈。

3 产生原因

翻了 Django 源代码

def to_python(self, value):
    if value and not isinstance(value, uuid.UUID):
        try:
            return uuid.UUID(value)
        except ValueError:
            raise exceptions.ValidationError(
                self.error_messages['invalid'],
                code='invalid',
                params={'value': value},
            )
    return value

重点是 return uuid.UUID(value) 这一句，原来如此。

4 解决方法

4.1 直接使用 CharField 字段

直接使用 CharField, 就不存在什么横杠的问题了。

4.2 重写 to_representation 方法

重写对应 serializers 中的 to_representation 方法即可。

4.3 自定义 UUIDField 字段

自定义继承 models.UUIDField 的字段，然后重写 to_python 方法