本文档概述了 code-server 代码库中使用的通用实用函数和辅助模块。这些实用工具提供了可重用的功能，支持系统架构中的各种组件，从而提高了可维护性并减少了代码重复。
code-server 中的实用工具和助手充当基础构建块，可以简化复杂操作、标准化常见任务并提供系统不同组件的跨领域功能。这包括字符串操作、错误处理、路径规范化、UUID 生成和其他通用函数。
本文档仅关注通用实用工具，不涵盖特定组件的辅助函数。有关核心架构组件的信息，请参阅 架构，有关身份验证系统的信息，请参阅 身份验证系统。
代码库包含几个核心实用函数，这些函数在不同组件中使用。它们主要位于 src/common/util.ts 文件中。
plural 函数根据计数处理字符串的语法复数化
用法示例：${count} ${plural(count, "file")} processed 将生成“1 file processed”或“5 files processed”。
generateUuid 函数创建指定长度的随机唯一标识符
此函数用于创建唯一的会话标识符、临时令牌以及需要随机唯一字符串的其他情况。
normalize 函数删除 URL 中的冗余斜杠，并可选择保留尾部斜杠
这对于代理系统和路由处理的正常运行至关重要。
logError 函数对整个应用程序的错误日志记录进行标准化
下图说明了不同的实用函数如何在 code-server 的主要组件中使用
code-server 利用了几个外部库来提供附加的实用函数
| 库 | 目的 | 用途 |
|---|---|---|
@coder/logger | 日志记录 | 提供整个应用程序的结构化日志记录 |
safe-compare | 安全 | 用于身份验证的定时安全字符串比较 |
semver | 版本控制 | 用于更新和兼容性的语义版本比较 |
js-yaml | 配置 | 用于配置文件解析 YAML |
env-paths | 文件系统 | 应用程序数据的特定于平台的路径 |
xdg-basedir | 文件系统 | XDG Base Directory 规范支持 |
code-server 中的错误处理遵循使用 logError 实用函数的标准模式。这标准化了整个代码库的错误日志记录方法，确保错误包含适当的上下文和可用的堆栈跟踪。
错误处理模式区分了 Error 对象和其他类型的错误
路径规范化实用工具（normalize）在 code-server 的路由和代理系统中起着至关重要的作用。它通过以下方式确保一致的 URL 格式：
/a//b 变为 /a/b）这尤其重要，因为 code-server
在处理 code-server 中的实用工具时，会出现几种模式和最佳实践
错误日志记录：始终使用 logError 实用工具，而不是直接控制台日志记录，以确保一致的错误报告。
路径处理：在连接 URL 路径时，使用 normalize 函数，而不是手动字符串操作。
ID 生成：对于安全敏感的标识符，请使用 generateUuid 函数并指定适当的长度参数。
字符串格式化：对于需要语法正确的面向用户的消息，请使用 plural 实用工具。
这些实用工具为整个代码库的可维护和一致的代码提供了基础。
本文档中描述的实用工具支持 code-server 的更广泛架构。下图说明了这些实用工具如何与系统的主要组件相关联
来源：src/common/util.ts1-36 package.json70-90
code-server 中的实用工具和助手提供了支持整个应用程序的必要功能。虽然这些实用工具性质简单，但它们确保了代码库的一致性，减少了重复，并提高了可维护性。
在扩展 code-server 或添加新功能时，应优先使用现有实用工具，而不是实现新的、类似的功能。这确保了代码库中常见操作的一致性。