diff --git a/5-network/07-url/article.md b/5-network/07-url/article.md index f16779bf53..fa6b74af25 100644 --- a/5-network/07-url/article.md +++ b/5-network/07-url/article.md @@ -1,22 +1,28 @@ # URL 对象 -内置的 [URL](https://url.spec.whatwg.org/#api) 类为创建和解析 URL 提供了非常方便的接口。 +内建的 [URL](https://url.spec.whatwg.org/#api) 类提供了用于创建和解析 URL 的便捷接口。 -没有一个网络方法一定要使用 `URL` 对象，因为只使用字符串就已经足够了。因此从技术上来讲我们没有必要使用 `URL`。但是有些时候 `URL` 对象真的很有用。 +没有任何一个网络方法一定需要使用 `URL` 对象，字符串就足够了。所以从技术上讲，我们并不是必须使用 `URL`。但是有些时候 `URL` 对象真的很有用。 ## 创建 URL 对象 -创建新 URL 对象的语法： +创建一个新 `URL` 对象的语法： ```js new URL(url, [base]) ``` -- **`url`** —— URL 字符串（string）或者路径（path）（如果 base 被设置，我们会在下面介绍）。 -- **`base`** —— 可选的 base，如果设置了此参数并且 `url` 只有路径，那么就会根据这个 `base` 生成 URL。 +- **`url`** —— 完整的 URL，或者仅路径（如果设置了 base）， +- **`base`** —— 可选的 base URL：如果设置了此参数，且参数 `url` 只有路径，则会根据这个 `base` 生成 URL。 -例如，下面两个 URL 是相同的： +例如： + +```js +let url = new URL('https://javascript.info/profile/admin'); +``` + +下面这两个 URL 是一样的： ```js run let url1 = new URL('https://javascript.info/profile/admin'); @@ -26,17 +32,16 @@ alert(url1); // https://javascript.info/profile/admin alert(url2); // https://javascript.info/profile/admin ``` -转到相对于当前 URL 的路径： +我们可以根据相对于现有 URL 的路径轻松创建一个新的 URL： ```js run let url = new URL('https://javascript.info/profile/admin'); -let testerUrl = new URL('tester', url); +let newUrl = new URL('tester', url); -alert(testerUrl); // https://javascript.info/profile/tester +alert(newUrl); // https://javascript.info/profile/tester ``` - -`URL` 对象允许我们随时访问其组件，因此这是一个解析 URL 的好办法，例如： +`URL` 对象立即允许我们访问其组件，因此这是一个解析 url 的好方法，例如： ```js run let url = new URL('https://javascript.info/url'); @@ -46,61 +51,63 @@ alert(url.host); // javascript.info alert(url.pathname); // /url ``` -这是其组件列表： +这是 URL 组件的备忘单： ![](url-object.svg) - `href` 是完整的 URL，与 `url.toString()` 相同 - `protocol` 以冒号字符 `:` 结尾 -- `search` - 以问号 `?` 开始的一串参数 -- `hash` 以哈希字符 `#` 开始 -- 如果存在 HTTP 身份验证的话，还会有 `user` 和 `password` 属性：`http://login:password@site.com`（图片上没有，很少使用它）。 +- `search` —— 以问号 `?` 开头的一串参数 +- `hash` 以哈希字符 `#` 开头 +- 如果存在 HTTP 身份验证，则这里可能还会有 `user` 和 `password` 属性：`http://login:password@site.com`（图片上没有，很少被用到）。 -```smart header="我们可以在任意位置用 `URL` 代替字符串" -我们可以在 `fetch` 或者 `XMLHttpRequest` 中使用 `URL` 对象，几乎在任何能使用字符串 URL 的地方都能使用 `URL` 对象。 +```smart header="我们可以将 `URL` 对象传递给网络（和大多数其他）方法，而不是字符串" +我们可以在 `fetch` 或 `XMLHttpRequest` 中使用 `URL` 对象，几乎可以在任何需要 URL 字符串的地方都能使用 `URL` 对象。 -在绝大多数方法中，它会自动转换为字符串。 +通常，`URL` 对象可以替代字符串传递给任何方法，因为大多数方法都会执行字符串转换，这会将 `URL` 对象转换为具有完整 URL 的字符串。 ``` -## 搜索参数（SearchParams）“?...” +## SearchParams "?..." -假设我们想要创建一个具有给定搜索参数的 URL，例如：`https://google.com/search?query=JavaScript`。 +假设，我们想要创建一个具有给定搜索参数的 url，例如：`https://google.com/search?query=JavaScript`。 -我们可以在 URL 字符串中提供他们： +我们可以在 URL 字符串中提供它们： ```js new URL('https://google.com/search?query=JavaScript') ``` -……但是如果参数中包含空格，非拉丁字母等等（具体参见下面），参数中就要被编码。 +……但是，如果参数中包含空格，非拉丁字母等（具体参见下文），参数就需要被编码。 因此，有一个 URL 属性用于解决这个问题：`url.searchParams`，[URLSearchParams](https://url.spec.whatwg.org/#urlsearchparams) 类型的对象。 -它为搜索参数提供了简便的的方法： +它为搜索参数提供了简便的方法： -- **`append(name, value)`** —— 添加参数， -- **`delete(name)`** —— 移除参数， -- **`get(name)`** —— 获取参数， +- **`append(name, value)`** —— 按照 `name` 添加参数， +- **`delete(name)`** —— 按照 `name` 移除参数， +- **`get(name)`** —— 按照 `name` 获取参数， - **`getAll(name)`** —— 获取相同 `name` 的所有参数（这是可行的，例如 `?user=John&user=Pete`）， -- **`has(name)`** —— 检查参数是否存在， +- **`has(name)`** —— 按照 `name` 检查参数是否存在， - **`set(name, value)`** —— set/replace 参数， -- **`sort()`** —— 按 name 排序参数，很少使用， -- ……并且是可迭代的，类似于 `Map`。 +- **`sort()`** —— 按 name 对参数进行排序，很少使用， +- ……并且它是可迭代的，类似于 `Map`。 -例如： +包含空格和标点符号的参数的示例： ```js run let url = new URL('https://google.com/search'); -url.searchParams.set('q', 'test me!'); // 添加有空格和 ! 参数 + +url.searchParams.set('q', 'test me!'); // 添加带有一个空格和一个 ! 的参数 alert(url); // https://google.com/search?q=test+me%21 -url.searchParams.set('tbs', 'qdr:y'); // 这个参数指定 Google Search 的日期范围 +url.searchParams.set('tbs', 'qdr:y'); // 添加带有一个冒号 : 的参数 +// 参数会被自动编码 alert(url); // https://google.com/search?q=test+me%21&tbs=qdr%3Ay -// 遍历搜索参数（解码（decoded）） +// 遍历搜索参数（被解码） for(let [name, value] of url.searchParams) { alert(`${name}=${value}`); // q=test me!，然后是 tbs=qdr:y } @@ -109,57 +116,65 @@ for(let [name, value] of url.searchParams) { ## 编码（encoding） -[RFC3986](https://tools.ietf.org/html/rfc3986) 标准定义了哪些字符是允许的，哪些不是。 +[RFC3986](https://tools.ietf.org/html/rfc3986) 标准定义了 URL 中允许哪些字符，不允许哪些字符。 -下面这些是不允许的，必须要编码才可以，例如非拉丁字母，空格 —— 以它们的 UTF-8 代码代替，前缀为 `%`，例如 `%20`（基于历史原因，空格可以通过 `+` 编码，因此在 URL 中也可以这样做）。 +那些不被允许的字符必须被编码，例如非拉丁字母和空格 —— 用其 UTF-8 代码代替，前缀为 `%`，例如 `%20`（由于历史原因，空格可以用 `+` 编码，但这是一个例外）。 -好消息是 `URL` 对象能自动处理这些。我们仅需提供未编码的参数，然后将 URL 转换为字符串： +好消息是 `URL` 对象会自动处理这些。我们仅需提供未编码的参数，然后将 `URL` 转换为字符串： ```js run -// 在这个例子中使用一些 cyrillic 字符 +// 在此示例中使用一些西里尔字符 let url = new URL('https://ru.wikipedia.org/wiki/Тест'); url.searchParams.set('key', 'ъ'); alert(url); //https://ru.wikipedia.org/wiki/%D0%A2%D0%B5%D1%81%D1%82?key=%D1%8A ``` -正如所见，URL 路径中的 `Тест` 和 `ъ` 参数都被编码。 + +正如你所看到的，url 路径中的 `Тест` 和 `ъ` 参数都被编码了。 + +URL 变长了，因为每个西里尔字母用 UTF-8 编码的两个字节表示，因此这里有两个 `%..` 实体（entities）。 ### 编码字符串 -如果我们使用字符串而不是 URL 对象，此时我们可以使用内建函数手动编码： +在过去，在出现 `URL` 对象之前，人们使用字符串作为 URL。 -- [encodeURI](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI) - 编码整个 URL。 -- [decodeURI](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURI) - 解码为未编码前的状态。 -- [encodeURIComponent](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) - 编码 URL 组件，例如搜索参数，或者 hash 或者 pathname。 -- [decodeURIComponent](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent) - 解码为未编码前的状态。 +而现在，`URL` 对象通常更方便，但是仍然可以使用字符串。在很多情况下，使用字符串可以使代码更短。 -`encodeURIComponent` 和 `encodeURI` 之间有什么区别？ +如果使用字符串，则需要手动编码/解码特殊字符。 -如果我们看看 URL 就容易理解它们之间的差异，将它分隔为如上图中的组件形式： +下面是用于编码/解码 URL 的内建函数： + +- [encodeURI](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI) —— 编码整个 URL。 +- [decodeURI](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURI) —— 解码为编码前的状态。 +- [encodeURIComponent](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) —— 编码 URL 组件，例如搜索参数，或者 hash，或者 pathname。 +- [decodeURIComponent](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent) —— 解码为编码前的状态。 + +一个自然的问题：“`encodeURIComponent` 和 `encodeURI` 之间有什么区别？我们什么时候应该使用哪个？” + +如果我们看一个 URL，就容易理解了，它被分解为本文上面图中所示的组件形式： ``` -http://site.com:8080/path/page?p1=v1&p2=v2#hash +https://site.com:8080/path/page?p1=v1&p2=v2#hash ``` -正如所见，`:`，`?`，`=`，`&`，`#` 这类字符在 URL 中是允许的。而其他的，包括非拉丁字母和空格，则必须被编码。 +正如我们所看到的，在 URL 中 `:`，`?`，`=`，`&`，`#` 这类字符是被允许的。 -这就是 `encodeURI` 所作的事情： +……另一方面，对于 URL 的单个组件，例如一个搜索参数，则必须对这些字符进行编码，以免破坏 URL 的格式。 + +- `encodeURI` 仅编码 URL 中完全禁止的字符。 +- `encodeURIComponent` 也编码这类字符，此外，还编码 `#`，`$`，`&`，`+`，`,`，`/`，`:`，`;`，`=`，`?` 和 `@` 字符。 + +所以，对于一个 URL 整体，我们可以使用 `encodeURI`： ```js run -// 在 URL 路径中使用 cyrcillic 字符 +// 在 url 路径中使用西里尔字符 let url = encodeURI('http://site.com/привет'); -// 每个 cyrillic 都被以两个 %xx 的形式编码 -// 它们一起组成了字符的 UTF-8 代码 alert(url); // http://site.com/%D0%BF%D1%80%D0%B8%D0%B2%D0%B5%D1%82 ``` -……另一方面，我们看看单个的 URL 组件，比如搜索参数，我们应该编码更多的字符，即被用来格式化 URL 组件的 `?`，`=` 和 `&`。 - -这就是 `encodeURIComponent` 所做的事情。它编码与 `encodeURI` 相同的字符，以及许多其他字符，以使得结果值在任何 URL 组件中都可以安全使用。 - -例如： +……而对于 URL 参数，我们应该改用 `encodeURIComponent`： ```js run let music = encodeURIComponent('Rock&Roll'); @@ -168,7 +183,7 @@ let url = `https://google.com/search?q=${music}`; alert(url); // https://google.com/search?q=Rock%26Roll ``` -相较于 `encodeURI`： +将其与 `encodeURI` 进行比较： ```js run let music = encodeURI('Rock&Roll'); @@ -177,30 +192,26 @@ let url = `https://google.com/search?q=${music}`; alert(url); // https://google.com/search?q=Rock&Roll ``` -我们可以看到，`encodeURI` 不会编码 `&`，因为这是整个 URL 中合法的字符。 - -但是我们应该在搜索参数中编码 `&`，否则，我们得到的是 `q=Rock&Roll` —— 实际上是 `q=Rock` 加上一些模糊的参数 `Roll`。其结果和预期不同。 - -因此，对于每个搜索参数，我们应该使用 `encodeURIComponent` 将其准确的插入 URL 字符串。最安全的是编码 name 和 value，除非我们能完全保证参数中只有一个允许的字符。 - -### 为什么要用 URL？ +我们可以看到，`encodeURI` 没有对 `&` 进行编码，因为它对于整个 URL 来说是合法的字符。 -很多旧的代码使用这些函数，这些函数有时候很方便，不会导致错误。 +但是，我们应该编码在搜索参数中的 `&` 字符，否则，我们将得到 `q=Rock&Roll` —— 实际上是 `q=Rock` 加上一些晦涩的参数 `Roll`。不符合预期。 -但是在现代代码中，建议使用 [URL](https://url.spec.whatwg.org/#url-class) 和 [URLSearchParams](https://url.spec.whatwg.org/#interface-urlsearchparams) 类。 +因此，对于每个搜索参数，我们应该使用 `encodeURIComponent`，以将其正确地插入到 URL 字符串中。最安全的方式是对 name 和 value 都进行编码，除非我们能够绝对确保它只包含允许的字符。 -其中一个理由是：它们都是基于最新的 URI 标准：[RFC3986](https://tools.ietf.org/html/rfc3986)，而 `encode*` 函数是基于过时的 [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) 标准。 +````smart header="`encode*` 与 `URL` 之间的编码差异" +类 [URL](https://url.spec.whatwg.org/#url-class) 和 [URLSearchParams](https://url.spec.whatwg.org/#interface-urlsearchparams) 基于最新的 URL 规范：[RFC3986](https://tools.ietf.org/html/rfc3986)，而 `encode*` 函数是基于过时的 [RFC2396](https://www.ietf.org/rfc/rfc2396.txt)。 -例如，IPv6 地址以不同方式处理： +它们之间有一些区别，例如对 IPv6 地址的编码方式不同： ```js run -// IPv6 地址的合法 URL +// IPv6 地址的合法 url let url = 'http://[2607:f8b0:4005:802::1007]/'; alert(encodeURI(url)); // http://%5B2607:f8b0:4005:802::1007%5D/ alert(new URL(url)); // http://[2607:f8b0:4005:802::1007]/ ``` -正如所见，`encodeURI` 取代了方括号 `[...]`，这是不正确的，原因是：在 RFC2396 (August 1998) 时代 IPv6 URL 还不存在。 +正如我们所看到的，`encodeURI` 替换了方括号 `[...]`，这是不正确的，原因是：在 RFC2396 (August 1998) 时代，还不存在 IPv6 url。 -这种情况很少见，`encode*` 函数大部分时间都能正常使用，这只是偏好使用新 API 的其中一个原因。 +这种情况很少见，`encode*` 函数在大多数情况下都能正常工作。 +````