소개

Hashids는 제공된 salt , alphabet 및 min_length 를 사용하여 정수를 문자열에 매핑하는 라이브러리입니다. 예를 들어 정수1를 "r87f"로 변환하고 필요할 때 다시 변환할 수 있습니다.

이는 ID를 난독화하는 방법이며 모든 ID를 통해 데이터베이스의 모든 항목을 반복하는 것을 원하지 않을 때 특히 유용합니다.

Django에서 Hashid를 몇 번 사용했습니다. 그리고 id 필드를 노출해야 할 때마다 다음과 같이 호출하여 id 값을 hashids로 변환합니다.

from utils import hashids

def to_json(obj):
    exposed_id = hashids.encode(obj.id)
    ...
    return {
        'id': exposed_id,
        ...
    }

그리고 그 exposed_id가 사용되는 모든 곳에서 다시 변환해야 하므로 결국 다른 위치에 많은 코드가 생성됩니다.

이 접근 방식의 또 다른 문제는 다른 모델에 대해 소금 및 알파벳과 같은 다른 구성을 사용하기 어렵다는 것입니다. exposed_id 다른 모델에 대해 동일한 실제 id가 동일합니다.

이 둘을 통합하는 기존 프로젝트가 몇 가지 있지만 내가 원하는 것보다 더 방해가 됩니다. 난독화된 ID와 정수 ID 사이를 즉시 인코딩/디코딩하는 대신 일반적으로 실제로 데이터베이스에 씁니다.

이것은 django-hashids 이라는 100줄 미만의 코드로 만든 이 작은 라이브러리로 이어집니다.

장고 해시드

django-hashids Django 모델에 "가상"필드를 도입하여 Django를 Hashid와 통합합니다. 데이터베이스에 열이 없지만 사람들이 실제 데이터베이스 열이 있는 것처럼 쿼리할 수 있기 때문에 "가상"입니다.

다음은 간단한 예입니다.

class TestModel(Model):
    hashid = HashidsField(real_field_name="id")

instance = TestModel.objects.create()
instance2 = TestModel.objects.create()
instance.id  # 1
instance2.id  # 2

# Allows access to the field
instance.hashid  # '1Z'
instance2.hashid  # '4x'

# Allows querying by the field
TestModel.objects.get(hashid="1Z")
TestModel.objects.filter(hashid="1Z")
TestModel.objects.filter(hashid__in=["1Z", "4x"])
TestModel.objects.filter(hashid__gt="1Z")  # same as id__gt=1, would return instance 2

# Allows usage in queryset.values
TestModel.objects.values_list("hashid", flat=True) # ["1Z", "4x"]
TestModel.objects.filter(hashid__in=TestModel.objects.values("hashid"))

보시다시피 모든 합리적인 조회가 있는 실제 필드처럼 TestModel.hashid를 사용할 수 있지만 쿼리는 id 필드에 대한 프록시이며 인코딩/디코딩이 즉시 발생하여 원활한 경험을 제공합니다.

For more usage and configuration options please visit django-hashids on github