JavaScript中更安全的URL读写


你能发现这段代码中的错误吗?你可能不知不觉地以不安全的方式编写URL了。

const url = `https://builder.io/api/v2/content
  ?model=${model}&locale=${locale}?query.text=${text}`

const res = await fetch(url)

常见问题#1:分隔符字符不正确

带有额外 ? 的URL字符串
哎呀!这显然是一个初学者的错误,但很容易被忽视,我在自己的代码中甚至在JS开发十年后也发现了这个错误。

在我看来,这种错误的常见原因是在编辑或移动代码之后。例如,你有一个结构正确的URL,然后从一个地方复制一部分到另一个地方,然后错过了参数分隔符被错误地排列的事实。

这也可能发生在连接时。例如:

url = url + '?foo=bar'

但等等,原始url可能已经有一个查询参数了。好的,这应该是:

url = url + '&foo=bar'

但是,等等,如果原始url没有查询参数,那么这样现在就是错的了。糟糕。

b常见问题#2:忘记编码

带有未编码参数的URL字符串
噢。模型和locale可能不需要编码,因为它们是URL安全值,但我没有停下来考虑文本可能是各种文本,包括空格和特殊字符,这会给我们带来问题。

所以也许我们会过度纠正并且更加谨慎地处理事情:

const url = `https://builder.io/api/v2/content
  ?model=${
    encodeURIComponent(model)
  }&locale=${
    encodeURIComponent(locale)
  }&query.text=${
    encodeURIComponent(text)
  }`

常见问题#3:意外的空白字符

带有意外空白字符的URL字符串
哎呀。为了将这个长URL分成多行,我们意外地包含了换行符和额外的空格进入URL,这将导致我们无法按预期工作。

现在我们可以正确地拆分字符串,但是我们变得更加混乱和难以阅读:

const url = `https://builder.io/api/v2/content`
  + `?model=${
    encodeURIComponent(model)
  }&locale=${
    encodeURIComponent(locale)
  }&query.text=${
    encodeURIComponent(text)
  }`

仅仅是为了正确地构造一个URL,我们就要做这么多。

URL构造函数来解救

解决上述挑战的更清晰和更安全的解决方案是使用URL构造函数:

const url = new URL('https://builder.io/api/v2/content')

url.searchParams.set('model', model)
url.searchParams.set('locale', locale)
url.searchParams.set('text', text)
  
const res = await fetch(url.toString())

这为我们解决了几个问题:

  • 分隔符字符始终正确(第一个参数使用?,之后使用&)。
  • 所有参数都会自动编码。
  • 在将长URL跨多行拆分时,不会有额外的空白字符。

修改URL

在我们需要修改URL但不知道当前状态的情况下,它也非常有帮助。

例如,不是遇到这个问题:

url += (url.includes('?') ? '&' : '?') + 'foo=bar'

我们可以直接这样做:

// 假设 `url` 是一个URL
url.searchParams.set('foo', 'bar')

// 或者如果URL是一个字符串
const structuredUrl = new URL(url)
structuredUrl.searchParams.set('foo', 'bar')
url = structuredUrl.toString()

同样,你也可以修改URL的其他部分:

const url = new URL('https://builder.io')

url.pathname = '/blog'      // 更新路径
url.hash = '#featured'      // 更新哈希
url.host = 'www.builder.io' // 更新主机

url.toString()              // https://www.builder.io/blog#featured

读取URL值

现在,“我只想从当前URL中读取查询参数而不使用库”这个古老的问题已经解决了。

const pageParam = new URL(location.href).searchParams.get('page')

或者例如使用以下方式更新当前URL:

const url = new URL(location.href)
const currentPage = Number(url.searchParams.get('page'))
url.searchParams.set('page', String(currentPage + 1))
location.href = url.toString()

但这不仅限于浏览器。它也可以在Node.js中使用:

const http = require('node:http');

const server = http.createServer((req, res) => {
  const url = new URL(req.url, `https://${req.headers.host}`)
  // 读取路径,查询等...
});

以及Deno:

import { serve } from "https://deno.land/std/http/mod.ts";
async function reqHandler(req: Request) {
  const url = new URL(req.url)
  // 读取路径,查询等...
  return new Response();
}
serve(reqHandler, { port: 8000 });

URL属性了解

URL实例支持浏览器中已经熟悉的所有属性,比如window.location或锚元素,你都可以读取和写入:

const url = new URL('https://builder.io/blog?page=1');

url.protocol // https:
url.host     // builder.io
url.pathname // /blog
url.search   // ?page=1
url.href     // https://builder.io/blog?page=1
url.origin   // https://builder.io
url.searchParams.get('page') // 1

一张URL的图表,并指出每个部分,比如“主机名”与“哈希”等。


URLSearchParams方法了解

URLSearchParams对象,在URL实例上作为url.searchParams可访问,支持一些方便的方法:

searchParams.has(name)

检查搜索参数是否包含给定名称:

url.searchParams.has('page') // true
searchParams.get(name)

获取给定参数的值:

url.searchParams.get('page') // '1'
searchParams.getAll(name)

获取为参数提供的所有值。如果您允许在相同名称下多次提供多个值,这很方便,比如&page=1&page=2

url.searchParams.getAll('page') // ['1']
searchParams.set(name, value)

设置参数的值:

url.searchParams.set('page', '1')
searchParams.append(name, value)

追加参数 - 如果您可能支持同一参数多次,比如&page=1&page=2,这很有用:

url.searchParams.append('page', '2')
searchParams.delete(name)

从URL中完全删除参数:

url.searchParams.delete('page')

陷阱

一个大陷阱是,传递给URL构造函数的所有URL都必须是绝对URL。

例如,这将抛出错误:

new URL('/blog') // ERROR!

你可以通过提供origin作为第二个参数来解决这个问题,就像这样:

new URL('/blog', 'https://builder.io')

或者,如果你真的只需要处理URL的部分,你也可以直接使用URLSearchParams,如果你只需要处理相对URL的查询参数:

const params = new URLSearchParams('page=1')
params.set('page=2')
params.toString()

URLSearchParams还有一个好处,就是它还可以接受一个键值对对象作为其输入:

const params = new URLSearchParams({
  page: 1,
  text: 'foobar',
})
params.set('page=2')
params.toString()

浏览器和运行时支持

新的URL支持所有现代浏览器,以及Node.js和Deno!


©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,525评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,203评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,862评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,728评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,743评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,590评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,330评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,244评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,693评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,885评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,001评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,723评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,343评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,919评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,042评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,191评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,955评论 2 355

推荐阅读更多精彩内容