如何设计函数以灵活接受用户标识参数(ID 或用户名)

聖光之護

聖光之護

2026-07-24

500人浏览

原创

如何设计函数以灵活接受用户标识参数(ID 或用户名)

本文介绍两种专业、类型安全的方式,让函数能灵活接受用户标识——只需提供 id 或用户名其中之一即可,无需冗余参数,同时避免运行时类型歧义和参数组合爆炸问题。

本文介绍两种专业、类型安全的方式,让函数能灵活接受用户标识——只需提供 id 或用户名其中之一即可,无需冗余参数,同时避免运行时类型歧义和参数组合爆炸问题。

在实际开发中,经常遇到类似场景:要查询两个用户之间的会话(如 get_chat),而每个用户既可通过唯一整型 ID 识别,也可通过字符串形式的 username 识别。但若将 first_id, first_username, second_id, second_username 全部设为独立参数,不仅破坏接口简洁性,还导致调用时需手动确保“ID 与 username 不同时为空、也不同时非空”,极易出错且难以维护。

以下是两种经过实践验证、兼顾可读性、类型安全与扩展性的解决方案:

✅ 方案一:利用类型区分 + 单一参数(推荐用于轻量级场景)

当 ID(int)与 username(str)天然类型不同时,可合并为一个参数,并在函数内部根据类型自动解析:

from typing import Union

def get_chat(first_user: Union[int, str], second_user: Union[int, str]) -> dict:
    # 假设已有辅助函数
    def resolve_user(user_id_or_name: Union[int, str]) -> tuple[int, str]:
        if isinstance(user_id_or_name, int):
            user_id = user_id_or_name
            user_name = get_username_by_id(user_id)  # 实际需实现
        elif isinstance(user_id_or_name, str):
            user_name = user_id_or_name
            user_id = get_id_by_username(user_name)   # 实际需实现
        else:
            raise TypeError(f"Expected int or str, got {type(user_id_or_name).__name__}")
        return user_id, user_name

    first_id, first_name = resolve_user(first_user)
    second_id, second_name = resolve_user(second_user)

    # 执行核心逻辑(如查数据库)
    return {
        "chat_id": f"{min(first_id, second_id)}_{max(first_id, second_id)}",
        "participants": [first_name, second_name]
    }

⚠️ 注意事项:此方案依赖 ID 与 username 类型严格区分(如 ID 必为 int,username 必为 str)。若系统支持数字型 username(如 "123"),则类型无法可靠判别,此时应优先选用方案二。

Python 3.14.2
Python 3.14.2

Python 3.14.2是Python编程语言在2025年12月5日发布的稳定版本,属于3.14系列的第二个维护更新。该版本包含了18项修复,重点解决了多进程、数据类及正则表达式等模块的回归问题,并修复了CVE-2025-12084等安全漏洞。此版本标志着自由线程模式(移除GIL)正式获得官方支持,是Python发展的重要里程碑。

下载

✅ 方案二:面向对象封装(推荐用于中大型项目)

定义 User 类,统一抽象用户标识,并提供多种构造方式,使调用方语义清晰、IDE 友好、类型检查完备:

from typing import Union, Self

class User:
    def __init__(self, user_id: int, username: str) -> None:
        self.id = user_id
        self.username = username

    @classmethod
    def from_id(cls, user_id: int) -> Self:
        # 实际中可在此触发远程/缓存查询
        username = fetch_username_by_id(user_id)
        return cls(user_id, username)

    @classmethod
    def from_username(cls, username: str) -> Self:
        user_id = fetch_id_by_username(username)
        return cls(user_id, username)

def get_chat(first_user: User, second_user: User) -> dict:
    return {
        "chat_id": f"{min(first_user.id, second_user.id)}_{max(first_user.id, second_user.id)}",
        "participants": [first_user.username, second_user.username],
        "first": {"id": first_user.id, "name": first_user.username},
        "second": {"id": second_user.id, "name": second_user.username}
    }

# ✅ 调用示例(语义明确、类型安全、IDE 可补全)
chat1 = get_chat(User.from_id(1001), User.from_username("alice"))
chat2 = get_chat(User.from_username("bob"), User.from_id(2002))

该设计优势显著:

  • 类型安全:mypy 等静态检查器可全程校验;
  • 可扩展性强:后续增加 from_email()、from_token() 等构造方法无需修改 get_chat;
  • 职责清晰:用户解析逻辑集中于 User 类,业务函数专注核心逻辑;
  • 测试友好:User 实例可轻松 mock,解耦外部依赖。

总结

避免将同一逻辑实体(用户)拆解为多个松散参数;应优先通过类型系统或领域模型表达约束。方案一适合快速迭代、类型边界明确的场景;方案二则是构建健壮、可维护 API 的工业级实践。二者均消除了“半必填参数”的反模式,让函数签名真正反映业务语义——get_chat 接收的是「两个用户」,而非「四段可能为空的字符串/数字」。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1104

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

2072

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1185

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

8819

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

1479

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

1551

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

881

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

531

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1111

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PyCharm官方快速入门指南
PyCharm官方快速入门指南

共0课时 | 0人学习

Python函数定义官方教程
Python函数定义官方教程

共0课时 | 0人学习

Python 3.14.6官方文档
Python 3.14.6官方文档

共0课时 | 0人学习