如何设计函数参数以支持 ID 或用户名的灵活组合传入

雨墨吖_3157

雨墨吖_3157

2026-07-24

791人浏览

原创

如何设计函数参数以支持 ID 或用户名的灵活组合传入

本文介绍两种专业、可扩展的方式,让函数能接受用户 id 或用户名中的任意一种(而非强制两者)来标识用户,避免冗余参数和运行时校验混乱。

本文介绍两种专业、可扩展的方式,让函数能接受用户 id 或用户名中的任意一种(而非强制两者)来标识用户,避免冗余参数和运行时校验混乱。

在实际开发中,常遇到类似场景:一个用户可通过唯一 ID(如 int)或用户名(如 str)识别,二者互为补充、无需同时提供。但若将 first_id, first_username, second_id, second_username 全部设为独立参数,不仅接口臃肿,还易引发调用歧义(如同时传 id 和 username 且不一致)或遗漏校验(如两者皆未传)。理想方案应保证:每个用户身份仅需提供 ID 或用户名之一,且类型安全、语义清晰、易于维护。

✅ 方案一:统一参数类型 + 运行时类型分发(轻量级推荐)

适用于逻辑简单、依赖少的场景。将每个用户抽象为单一参数,类型为 Union[int, str],内部根据类型自动解析:

from typing import Union

def get_chat(first_user: Union[int, str], second_user: Union[int, str]) -> dict:
    """
    获取两个用户之间的聊天会话。
    :param first_user: 用户1的ID(int)或用户名(str)
    :param second_user: 用户2的ID(int)或用户名(str)
    """
    def resolve_user(user: Union[int, str]) -> tuple[int, str]:
        if isinstance(user, int):
            user_id = user
            user_name = _fetch_username_by_id(user_id)  # 假设已实现
        elif isinstance(user, str):
            user_name = user
            user_id = _fetch_id_by_username(user_name)  # 假设已实现
        else:
            raise TypeError(f"Invalid user type: {type(user).__name__}. Expected int or str.")
        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]
    }

⚠️ 注意事项:

人声去除
人声去除

人声去除是一款通过 AI 分离歌曲人声、伴奏和乐器音轨的在线音频处理工具。

下载
  • 必须确保 _fetch_* 函数具备幂等性与容错能力(如用户名不存在时抛出明确异常);
  • 不建议在函数内硬编码 ID/username 映射逻辑,应封装为独立服务层方法;
  • 若 ID 与 username 类型可能重叠(如用户名为纯数字字符串),需额外校验避免歧义。

✅ 方案二:面向对象建模(工业级推荐)

当系统中“用户身份”概念频繁复用(如用于消息、权限、通知等多处),强烈推荐引入 User 实体类,实现构造器重载与单点数据源管理:

from typing import Union, TYPE_CHECKING

if TYPE_CHECKING:
    from typing import 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) -> 'User':
        username = _fetch_username_by_id(user_id)
        return cls(user_id, username)

    @classmethod
    def from_username(cls, username: str) -> 'User':
        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],
        "user_objects": [first_user, second_user]  # 可直接复用实例
    }

# 调用示例(清晰、安全、IDE 友好):
# chat = get_chat(User.from_id(123), User.from_username("alice"))
# chat = get_chat(User.from_username("bob"), User.from_id(456))

✅ 优势总结:

  • 类型安全:User 实例天然携带完整身份信息,杜绝参数缺失或冲突;
  • 职责分离:身份解析逻辑集中于 User 类,业务函数专注核心逻辑;
  • 可测试性强:User.from_id() 等方法可独立单元测试,get_chat 可用 mock User 实例快速验证;
  • 扩展友好:后续增加邮箱、UUID 等新标识方式,只需新增 from_email() 类方法,无需修改 get_chat 签名。

无论选择哪种方案,核心原则是:将“身份识别”这一领域概念显式建模,而非退化为松散的原始参数集合。这不仅能提升 API 的健壮性与可读性,更是迈向清晰领域驱动设计(DDD)的重要一步。

相关文章

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

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

下载

相关标签:

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

相关专题

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

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

2023.07.20

1591

4

python能做什么
python能做什么

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

2023.07.25

3824

7

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

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

2023.07.31

1589

3

python教程
python教程

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

2023.08.03

21997

23

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

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

2023.08.04

2707

5

python eval
python eval

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

2023.08.04

2747

5

scratch和python区别
scratch和python区别

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

2023.08.11

1103

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2123

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
FastAPI框架精讲课程
FastAPI框架精讲课程

共38课时 | 3.6万人学习