一次 Node.js 服务线上问题引出的 DNS 缓存方案研究与思考

以你之姓@ 2022-10-16 09:00 19阅读 0赞

点击上方 程序员成长指北，关注公众号

回复1，加入高级 Node 进阶交流群

作者：陈煮酒

原文地址：https://juejin.cn/post/6966944107314806821

问题背景

某天上午，运营同学突然在群里反馈很多用户来报登录问题。起初以为是内网接口服务异常了，但接口反馈没有产生异常的日志，也就是说异常请求还没打过去。于是我们登录服务器，筛选了下Node.js服务的日志：

![a703ed747999cc20ec83785018bffc09.png][] image.png

通过日志，我们可以很直观的看出问题所在：**DNS解析失败**

## 整理思路 ##

作为一个日均流量过千万的Node.js服务，每个请求都需要**解析N个内网接口域名**。

平时还好，如果`DNS服务出现了问题`，或者`网络抖动`，很容易在Node.js服务与内网接口服务都正常的情况下，导致**线上业务不可用**

针对这种情况，我们需要在Node.js服务端**对DNS解析做一层缓存**

首先我们需要明确一点：**！！！Node.js本身不做DNS查询结果的缓存！！！**

## 默认DNS查询方案 ##

我们先来了解一下默认的DNS查询方案：

Node.js**内置的http模块的`http.request()`请求**时，会**使用`dns.lookup()`进行查找**

*  方法调用链条是 **`http.request() -> net.createConnection() -> dns.lookup()`**

function lookupAndConnect(self, options) {
      // ...
      const lookup = options.lookup || dns.lookup;
      defaultTriggerAsyncIdScope(self[async_id_symbol], function() {
        lookup(host, dnsopts, function emitLookup(err, ip, addressType) {
          self.emit('lookup', err, ip, addressType, host);
          // ...
        });
      });
    }

通过这段代码我们可以看出，**`options.lookup`参数可以自行设置，可以传入`dns.resolve`或者自定义的符合要求的方法**

### getaddrinfo 函数 ###

`dns.lookup()`方法调用到最终，调用的是**底层的`getaddrinfo()`函数**（也就是上文报错点）

在C/C++代码中`getaddrinfo`函数是**同步调用**，所以**需要`libuv`通过线程池来实现Node.js的异步I/O**

注：查阅相关资料，我们可以看到**线程池默认大小是4**

可以通过`UV_THREADPOOL_SIZE`环境变量设置。**Node.js v14中最大为1024**

### 可能会出现的问题 ###

当请求在DNS查询阶段耗时过长时，由于默认线程池过小，服务处理请求的速度跟请求数量远远不匹配，**服务运行时间越长积压的请求数连接数就越多**

## 关于默认缓存 ##

*  **！！！Node.js本身不做DNS查询结果的缓存！！！**，Node.js**每次域名请求时都会请求`DNS Server`**
 *  使用DNS缓存**注意缓存的过期时间**

## 实现DNS缓存的相关依赖 ##

### lookup-dns-cache ###

lookup-dns-cache是很成熟的DNS缓存库，但比较古老

![e614b669719c37e5dc93895052b55941.png][] image.png

他的思路比较简单：

1.  底层查询使用了 **`dns.resolve()`来替换`dns.lookup`**
2.  **通过一个`Map`缓存已经解析出来的`hostname`信息**
3.  **避免并行的DNS请求**。同一时间只执行一个对相同hostname的查询请求，通过Map来实现

#### `dns.resolve` 与 `dns.lookup` 区别 ####

1.  **`dns.resolve`不使用`getaddrinfo()`**
2.  **`dns.resolve`是异步实现的**
3.  **`dns.resolve`不解析本地hosts文件**

const { resolve, lookup } = require('dns');
    
    lookup('preview4.xx.xx.com', (err, address, family) => {
        console.log('地址: %j 地址族: IPv%s', address, family); // 地址: "123.126.126.78" 地址族: IPv4
    });
    
    resolve('preview4.xx.xx.com', (err, records) => {
        console.log(records); // undefined
    });

preview4.xx.xx.com 是**本地host配置的域名**。

由于**dns.resolve()不使用`getaddrinfo()`，所以此时解析出来的地址为undefined**

#### 避免并行请求实现 ####

**利用Map对正在查询的hostname做缓存。查询结束后从Map中删除**

let task = this._tasksManager.find(key);
    
    if (task) {
      task.addResolvedCallback(callback);
    } else {
      task = new ResolveTask(hostname, ipVersion);
      this._tasksManager.add(key, task);
      task.on('addresses', addresses => {
        this._addressCache.set(key, addresses);
      });
      task.on('done', () => {
        this._tasksManager.done(key);
      });
      task.addResolvedCallback(callback);
      task.run();
    }

#### 基于ttl的缓存 ####

1.  **通过`dns.reslove`方法设置`ttl:true`让DNS查询结果返回ttl值**
2.  **判断hostname还在缓存且未过期时直接返回缓存，否则进行查询**

/**
     * @param {string} key
     * @returns {Address[]|undefined}
     */
    find(key) {
        if (!this._cache.has(key)) {
            return;
        }
    
        const addresses = this._cache.get(key);
    
        if (this._isExpired(addresses)) {
            return;
        }
    
        return addresses;
    }

### cacheable-lookup ###

在实际使用中，发现了 **`dns.resolve()`无法解析本地`hosts`配置** 的域名，单纯使用`lookup-dns-cache`会导致本地开发环境出现报错。

经过调研，发现了cacheable-lookup这个库，作者是got的作者szmarczak。

![e1ef9ef9b14d4d73406501bf47e0e998.png][] image.png

通过提交记录我们可以看出，作者还在保持的对库的持续更新。

#### 对比 lookup-dns-cache ####

async queryAndCache(hostname) {
     if (this._hostnamesToFallback.has(hostname)) {
      return this._dnsLookup(hostname, all);
     }
    
     let query = await this._resolve(hostname);
    
     if (query.entries.length === 0 && this._dnsLookup) {
      query = await this._lookup(hostname);
    
      if (query.entries.length !== 0 && this.fallbackDuration > 0) {
       // Use `dns.lookup(...)` for that particular hostname
       this._hostnamesToFallback.add(hostname);
      }
     }
    
     const cacheTtl = query.entries.length === 0 ? this.errorTtl : query.cacheTtl;
     await this._set(hostname, query.entries, cacheTtl);
    
     return query.entries;
    }

通过源码我们可以看出，**当resolve方法没有解析成功时，会使用lookup方法进行兜底**，更符合我们**本地开发环境更改hosts文件**的场景

同时，这个库也提供了**基于ttl的缓存**、**阻止并行请求**等功能点

于是，我们可以解决我们的问题了！

## 解决方案 ##

在内网接口调用处统一增加`cacheable-lookup`进行DNS解析的缓存

## 最后 ##

**如果觉得这篇文章还不错**

**点击下面卡片关注我**

**来个【分享、点赞、在看】三连支持一下吧![959745d664b8f03a9811ab5c2f03eb9f.png][]**

![4db98db2791353ab7c02d0a9df7b52ba.png][]

**“分享、点赞、在看” 支持一波** ![48c52285749180be0c709d9064e19fd6.png][]

[a703ed747999cc20ec83785018bffc09.png]: /images/20221014/dc979f353b2742389ca25c8305a75c99.png
[e614b669719c37e5dc93895052b55941.png]: /images/20221014/34029c6d2f324fb9ad6e7c2918f60104.png
[e1ef9ef9b14d4d73406501bf47e0e998.png]: /images/20221014/ea038c035e8249e3b3db6055099aea20.png
[959745d664b8f03a9811ab5c2f03eb9f.png]: /images/20221014/3eba2dbaad094db6a5b89d8f963bc7ca.png
[4db98db2791353ab7c02d0a9df7b52ba.png]: /images/20221014/06315727bb894765b0479a5699133cab.png
[48c52285749180be0c709d9064e19fd6.png]: /images/20221014/db09e2ffe2eb4c62b89a5a6739a8ee59.png