ShortUUID 使用教程

ShortUUID 使用教程

shortuuidPHP 7.4+ library that generates concise, unambiguous, URL-safe UUIDs项目地址:https://gitcode.com/gh_mirrors/short/shortuuid

项目介绍

ShortUUID 是一个用于生成简洁、明确且 URL 安全的 UUID 的 Python 库。它基于 Python 内置的 uuid 模块，通过 base57 编码生成短 UUID，使用的字符集为数字、字母大小写，并去除了容易混淆的字符（如 l, 1, I, O 和 0）。

项目快速启动

安装

首先，确保你已经安装了 Python 3.6 或更高版本。然后使用 pip 安装 shortuuid：

pip install shortuuid

基本使用

在项目中导入 shortuuid 模块，并生成一个短 UUID：

import shortuuid

# 生成一个短 UUID
short_uuid = shortuuid.uuid()
print(short_uuid)  # 输出类似 'vytxeTZskVKR7C7WgdSP3d'

使用命名空间生成 UUID

你可以通过传递一个名称（DNS 或 URL）来生成一个版本 5 的 UUID：

# 使用 DNS 命名空间
short_uuid_dns = shortuuid.uuid(name="example.com")
print(short_uuid_dns)  # 输出类似 'exu3DTbj2ncsn9tLdLWspw'

# 使用 URL 命名空间
short_uuid_url = shortuuid.uuid(name="http://example.com")
print(short_uuid_url)  # 输出类似 '034636353306816784480643806546503818874456'

应用案例和最佳实践

在 Django 中使用 ShortUUID

ShortUUID 可以方便地集成到 Django 项目中，用于生成随机的短 UUID。以下是一个示例：

from shortuuid.django_fields import ShortUUIDField
from django.db import models

class MyModel(models.Model):
    # 一个长度为 16 的主键 ID，使用自定义字符集
    id = ShortUUIDField(
        length=16,
        max_length=40,
        prefix="id_",
        alphabet="abcdefg1234",
        primary_key=True
    )
    # 一个长度为 22 的短 UUID，使用默认字符集
    api_key = ShortUUIDField()

自定义字符集

你可以通过设置自定义字符集来生成特定格式的短 UUID：

import shortuuid

# 设置自定义字符集
shortuuid.set_alphabet("21345687654123456")

# 生成短 UUID
custom_short_uuid = shortuuid.uuid()
print(custom_short_uuid)  # 输出类似 '12345678'

典型生态项目

ShortUUID 可以与其他 Python 库和框架结合使用，例如：

• Django: 用于生成短 UUID 作为模型主键或 API 密钥。
• Flask: 在 Web 应用中生成短 UUID 作为会话 ID 或令牌。
• SQLAlchemy: 在数据库模型中使用短 UUID 作为唯一标识符。

通过这些集成，ShortUUID 可以帮助开发者生成简洁、明确的 UUID，提高应用的可读性和安全性。

shortuuidPHP 7.4+ library that generates concise, unambiguous, URL-safe UUIDs项目地址:https://gitcode.com/gh_mirrors/short/shortuuid