MongoDB 连接 URI 简介

简介

连接到数据库服务器通常是设计和配置由数据库支持的应用程序时需要完成的首要任务之一。虽然有许多方法可以向应用程序提供地址、监听端口、凭据和其他详细信息，但连接 URI（有时称为连接字符串或连接 URL）是指定紧凑格式复杂配置的最强大和灵活的方法之一。

在本指南中，我们将讨论如何使用您的 MongoDB 数据库信息和身份验证详细信息格式化连接 URI。连接 URI 分为多个部分，因此我们将逐步介绍每个部分。

百分比编码值

在我们开始之前，我们应该提到 MongoDB 连接 URI 期望百分比编码值。这意味着任何在 URL 中具有特殊含义的字符都必须转换为其百分比编码的对应字符，以确保库和应用程序能够正确解释它们。

您应该进行百分比编码的字符包括

• :: %3A
• /: %2F
• ?: %3F
• #: %23
• [: %5B
• ]: %5D
• @: %40

这些在连接 URI 中具有特殊含义。

因此，如果您的密码是...

pe@ce&lo\/3

...您需要在连接 URI 中指定为

pe%40ce&lo\%2F3

如果您不确定某个字符是否应该进行百分比编码，通常最好还是编码它。例如，如果您不确定\字符是否是保留字符，您可以使用它的百分比编码等效字符%5C以确保安全

pe%40ce%26lo%5C%2F3

在构建连接 URI 时请记住这一点。

快速概览

在深入细节之前，我们可以查看 MongoDB 连接 URI 的规范

mongodb://[username:password@]host[:port][,...hostN[:port]][/[database][?parameter_list]]

\________/\__________________/\___________________________/\__________/\________________/
     |             |                        |                    |             |
     |- schema     |- auth credentials      |                    |             |- parameter list
                                            |                    |
                                            |                    |- default authentication database
                                            |
                                            |- host specifier

方括号中的部分表示可选部分。您可能已经注意到 URI 的大部分部分都是可选的。可能也很明显，您可以在 URI 中编码许多信息。

各个组件的快速描述

• mongodb://: 用于将字符串标识为 MongoDB 连接 URI 的方案标识符。
• auth credentials: URI 的一个可选组件，可用于指定连接的用户和密码。
  • username: 可选用户名。如果包含，它应该在第二个斜杠 (/) 之后开始，并持续到冒号 (:)。如果包含，必须伴随一个password。
  • password: 可选密码。如果包含，它在冒号 (:) 之后开始，并持续到 at 符号 (@)。如果包含，必须伴随一个username。
• host specifier: 一个必需的组件，用于指定一个或多个要连接的主机名和端口。
  • host: 要连接的服务器的 IP 地址、DNS 名称或本地可解析名称。主机持续到冒号 (:)（如果包含端口），持续到逗号 (,)（如果指定了多个主机），否则持续到斜杠 (/)。必须提供至少一个主机。
  • port: 一个可选的端口规范，指示 MongoDB 在主机上监听哪个端口。端口以冒号 (:) 开始，并持续到逗号 (,)（如果提供了另一个主机）或持续到斜杠 (/)（如果不是）。
• default authentication database: 如果参数列表中未提供更具体的authSource，则用于进行身份验证的数据库名称。如果此处或使用authSource未指定数据库，MongoDB 将尝试对标准admin数据库进行身份验证。
• parameter list: 一个可选的附加参数列表，可以影响连接行为。参数列表以问号 (?) 开始。如果未提供默认身份验证数据库，则必须在最后一个主机定义之后以斜杠和问号 (/?) 开始参数列表。
  • parameter pairs: 参数列表由键值对组成。每对中的键和值由等号 (=) 分隔，每对与下一对之间由与号 (&) 分隔。

这是结合所有这些组件的 MongoDB 连接 URI 示例

mongodb://sally:sallyspassword@dbserver.example:5555/userdata?tls=true&connectionTimeout=5000
 ^          ^         ^               ^           ^     ^          ^
 |- schema  |         |- password     |- host     |     |          |- parameter list
            |                                     |     |
            |- username                           |     |- default authentication database
                                                  |
                                                  |- port

指定 URI 类型

连接 URI 中的项目通常是协议规范或应用程序类型。由于 URI 将用于连接到 MongoDB 数据库并进行身份验证，因此我们需要使用一个标识符来向我们正在使用的应用程序和库表明这一点。

MongoDB 项目仅接受mongodb作为有效的 URI 方案指定符。因此，您应该始终像这样开始您的连接 URI

mongodb://

方案指定符将确保后续信息在正确的上下文中被解释。

指定用户名和密码

URI 的下一部分是用户凭据。用户凭据是可选的，但如果您不想依赖应用程序或数据库配置的默认值，通常是必需的。

要包含用户凭据，请在方案标识符后提供用户名，然后是冒号 (:)、密码，最后是 at 符号 (@)

mongodb://username:password@

用户凭据是可选的，但如果包含，您必须同时提供用户名和密码组件。

指定服务器监听位置

在用户凭据之后是主机指定符，它定义了服务器监听的位置。可以在主机指定符中定义一个或多个主机，但由于主机指定符是**必需的**，因此必须至少提供一个主机。

每个主机定义都由一个host和一个可选的port组成。host可以是本地可解析的主机名、由外部名称系统（如 DNS）解析的名称，也可以是 IP 地址或其他直接地址。端口表示 MongoDB 在主机上监听的端口号。

要指定应用程序应尝试连接到本地计算机上默认的 MongoDB 端口 (27017)，您可以使用

mongodb://

如果您需要包含用户名和密码，该信息将首先出现，并由 at 符号分隔

mongodb://username:password@localhost

要指定在非标准端口上运行的远程服务器，请用冒号分隔这些详细信息。例如，要连接到198.51.100.22上的主机端口 3333，您可以使用

mongodb://username:password@198.51.100.22:3333

要定义多个主机和端口对，请用逗号 (,) 分隔这些集合，以告知应用程序如果无法连接到第一个服务器，则尝试连接后续服务器。例如，要将之前的示例扩展为包含一个在198.51.100.33上监听端口 5555 的备用服务器，您可以使用

mongodb://username:password@198.51.100.22:3333,198.51.100.33:5555

符合规范的客户端和应用程序将首先尝试连接到在198.51.100.22:3333监听的服务器。如果失败，它们将尝试连接到在198.51.100.33:5555监听的 MongoDB 数据库。

提供默认身份验证数据库

在主机指定符之后，下一个数据是默认身份验证数据库。虽然并非所有数据库管理系统都如此，但对于 MongoDB，您在建立连接时必须针对特定数据库进行身份验证。

数据库名称以正斜杠 (/) 开始，并持续到行尾或问号 (?)。如果参数列表中未提供authSource选项，将使用默认身份验证数据库。如果两者均未提供，客户端将针对admin数据库进行身份验证。

要连接到在198.51.100.22:3333监听的 MongoDB 服务器上托管的名为sales的数据库，您可以输入

mongodb://username:password@198.51.100.22:3333/sales

指定附加参数

连接 URI 的最后一部分用于提供连接的附加参数。参数列表由一个前导问号 (?) 引入，并持续到行尾。如果未提供默认身份验证数据库，则指示主机规范结束的尾随斜杠必须直接位于问号 (/?) 之前。

列出的每个参数都定义为由等号 (=) 连接的键值对。在第一个参数对之后，每个附加的键值对都由一个与号 (&) 分隔。

例如，要指定客户端应对我们之前定义的连接应用 10 秒超时，您可以使用

mongodb://username:password@198.51.100.22:3333/sales?connectTimeoutMS=10000

如果您想提供附加参数，您可以在其后添加，并在每对之间使用与号 (&)。例如，我们可以额外指定我们需要 SSL，并且指定的这些主机是我们想要连接的副本集的成员。

mongodb://username:password@198.51.100.22:3333,198.51.100.33:5555/sales?connectTimeoutMS=10000&tls=true&replicaSet=someReplicaSet

MongoDB 文档包含完整的参数列表，您可以阅读以了解更多信息。

结论

在本指南中，我们讨论了什么是 MongoDB 连接 URI，如何解释各个组件，以及如何在给定一组连接信息的情况下构建自己的 URI。连接 URI 将连接到给定数据库所需的所有信息编码在一个字符串中。由于这种灵活性和其广泛采用，了解如何解析和构建这些字符串会非常有帮助。