介紹一個(gè)請(qǐng)求庫-Undici

前言

在瀏覽器中，如果想發(fā)起一個(gè)請(qǐng)求，我們以前會(huì)使用到 xhr，不過這種底層 api，往往調(diào)用方式比較簡陋。為了提高開發(fā)效率， jQuery 的 $.ajax 可能是最好的選擇，好在后來出現(xiàn)了更加現(xiàn)代化的 fetch api 。

但是考慮到 fetch 的兼容性，而且它也不支持一些全局性的配置，以及請(qǐng)求中斷，在實(shí)際的使用過程中，我們可能會(huì)用到 axios 請(qǐng)求庫，來進(jìn)行一些請(qǐng)求。到了 Node.js 中，幾乎都會(huì)通過 request 這個(gè)庫，來進(jìn)行請(qǐng)求。遺憾的是，request 在兩年前就停止維護(hù)了，在 Node.js 中需要找到一個(gè)能夠替代的庫還挺不容易的。

在 request 的 issues[1] 中，有一個(gè)表格推薦了一些在 Node.js 中常用的請(qǐng)求庫：

瀏覽器中使用比較多的 axios，在 Node.js 中并不好用，特別是要進(jìn)行文件上傳的時(shí)候，會(huì)有很多意想不到的問題。

最近我在網(wǎng)上????的時(shí)候，發(fā)現(xiàn) Node.js 官方是有一個(gè)請(qǐng)求庫的：undici，名字取得還挺復(fù)雜的。所以，今天的文章就來介紹一下 undici。順便提一句，undici 是意大利語 11 的意思，好像雙十一也快到了，利好茅臺(tái)??。

Undici means eleven in Italian. 1.1 -> 11 -> Eleven -> Undici. It is also a Stranger Things reference.

上手

我們可以直接通過 npm 來安裝 undici：

npm?install?undici?-S

undici 對(duì)外暴露一個(gè)對(duì)象，該對(duì)象下面提供了幾個(gè) API：

• undici.fetch：發(fā)起一個(gè)請(qǐng)求，和瀏覽器中的 fetch 方法一致；
• undici.request：發(fā)起一個(gè)請(qǐng)求，和 request 庫有點(diǎn)類似，該方法支持 Promise；
• undici.stream：處理文件流，可以用來進(jìn)行文件的下載；

undici.fetch

注意：該方法需要 node 版本 >= v16.5.0

在通過 undici.fetch 請(qǐng)求服務(wù)之前，需要先通過 koa 啟動(dòng)一個(gè)簡單登錄服務(wù)。

const?Koa?=?require('koa')
const?bodyParser?=?require('koa-bodyparser')

const?app?=?new?Koa()

app.use(bodyParser())
app.use(ctx?=>?{
??const?{?url,?method,?body?}?=?ctx.request
??if?(url?===?'/login')?{
????if?(method?===?'POST')?{
??????if?(body.account?===?'shenfq'?&&?body.password?===?'123456')?{
????????ctx.body?=?JSON.stringify({
??????????name:?'shenfq',
??????????mobile:?'130xxxxxx'
????????})
????????return
??????}
????}
??}
??ctx.status?=?404
??ctx.body?=?JSON.stringify({})
})

app.listen(3100)

上面代碼很簡單，只支持接受一個(gè) POST 方法到 /login 路由。下面使用 undici.fetch 發(fā)起一個(gè) POST 請(qǐng)求。

const?{?fetch?}?=?require('undici')

const?bootstrap?=?async?()?=>?{
??const?api?=?'http://localhost:3100/login'
??const?rsp?=?await?fetch(api,?{
????method:?'POST',
????headers:?{
??????'content-type':?'application/json'
????},
????body:?JSON.stringify({
??????account:?'shenfq',
??????password:?'123456'
????})
??})
??if?(rsp.status?!==?200)?{
????console.log(rsp.status,?'請(qǐng)求失敗')
????return
??}
??const?json?=?await?rsp.json()
??console.log(rsp.status,?json)
}

bootstrap()

如果將請(qǐng)求的方式改為 GET，就會(huì)返回 404。

const?rsp?=?await?fetch(api,?{
??method:?'GET'
})

undici.request

undici.request 的調(diào)用方式與 undici.fetch 類似，傳參形式也差不多。

const?{?request?}?=?require('undici')

const?bootstrap?=?async?()?=>?{
??const?api?=?'http://localhost:3100/login'
??const?{?body,?statusCode?}?=?await?request(api,?{
????method:?'POST',
????headers:?{
??????'content-type':?'application/json'
????},
????body:?JSON.stringify({
??????account:?'shenfq',
??????password:?'123456'
????})
??})
??const?json?=?await?body.json()
??console.log(statusCode,?json)
}

bootstrap()

只是返回結(jié)果有點(diǎn)不一樣，request 方法返回的 http 響應(yīng)結(jié)果在 body 屬性中，而且該屬性也支持同 fetch 類似的 .json()/.text() 等方法。

中斷請(qǐng)求

安裝 abort-controller 庫，然后實(shí)例化 abort-controller，將中斷信號(hào)傳入 request 配置中。

npm?i?abort-controller

const?undici?=?require('undici')
const?AbortController?=?require('abort-controller')

//?實(shí)例化?abort-controller
const?abortController?=?new?AbortController()
undici.request('http://127.0.0.1:3100',?{
??method:?'GET',
??//?傳入中斷信號(hào)量
??signal:?abortController.signal,
}).then(({?statusCode,?body?})?=>?{
??body.on('data',?(data)?=>?{
????console.log(statusCode,?data.toString())
??})
})

我們運(yùn)行代碼，發(fā)現(xiàn)是可以請(qǐng)求成功的，是因?yàn)槲覀儧]有主動(dòng)調(diào)用中斷方法。

undici.request('http://127.0.0.1:3100',?{
??method:?'GET',
??signal:?abortController.signal,
}).then(({?statusCode,?body?})?=>?{
??console.log('請(qǐng)求成功')
??body.on('data',?(data)?=>?{
????console.log(statusCode,?data.toString())
??})
}).catch(error?=>?{
??//?捕獲由于中斷觸發(fā)的錯(cuò)誤
??console.log('error',?error.name)
})

//?調(diào)用中斷
abortController.abort()

現(xiàn)在運(yùn)行代碼會(huì)發(fā)現(xiàn)，并沒有輸出 請(qǐng)求成功 的日志，進(jìn)入了 catch 邏輯，成功的進(jìn)行了請(qǐng)求的中斷。

undici.steam

undici.steam 方法可以用來進(jìn)行文件下載，或者接口代理。

文件下載

const?fs?=?require('fs')
const?{?stream?}?=?require('undici')

const?out?=?fs.createWriteStream('./宋代-哥窯-金絲鐵線.jpg')
const?url?=?'https://img.dpm.org.cn/Uploads/Picture/dc/cegift/cegift6389.jpg'

stream(url,?{?opaque:?out?},?({?opaque?})?=>?opaque)

接口代理

const?http?=?require('http')
const?undici?=?require('undici')

//?將?3100?端口的請(qǐng)求，代理到?80?端口
const?client?=?new?undici.Client('http://localhost')
http.createServer((req,?res)?=>?{
??const?{?url,?method?}?=?req
??client.stream(
????{?method,?path:?url,opaque:?res?},
????({?opaque?})?=>?opaque
??)
}).listen(3100)

總結(jié)

本文只是介紹了 undici 幾個(gè) api 的使用方式，看起來 undici 上手難度還是比較低的。但是兼容性還不太行，比如，fetch 只支持 [email protected] 以上的版本。

對(duì)于這種比較新的庫，個(gè)人還是建議多觀望一段時(shí)間，雖然 request 已經(jīng)廢棄了，我們還是使用一些經(jīng)過較長時(shí)間考驗(yàn)過的庫，比如，egg 框架中使用的 urllib[7]，還有一個(gè) node-fetch[8]，上手難度也比較低，與瀏覽器中的 fetch api 使用方式一致。

參考資料

issues: https://github.com/request/request/issues/3143

node-fetch: https://www.npmjs.com/package/node-fetch

got: https://www.npmjs.com/package/got

axios: https://www.npmjs.com/package/axios

superagent: https://www.npmjs.com/package/superagent

urllib: https://www.npmjs.com/package/urllib

urllib: https://www.npmjs.com/package/urllib

node-fetch: https://www.npmjs.com/package/node-fetch