nodejs环境http请求

axios在nodejs环境使用http或者https模块发送请求。

'use strict';

var utils = require('./../utils');
var settle = require('./../core/settle');
var buildURL = require('./../helpers/buildURL');
var http = require('http');
var https = require('https');
var httpFollow = require('follow-redirects').http;
var httpsFollow = require('follow-redirects').https;
var url = require('url');
var zlib = require('zlib');
var pkg = require('./../../package.json');
var createError = require('../core/createError');
var enhanceError = require('../core/enhanceError');

var isHttps = /https:?/;

/*eslint consistent-return:0*/
module.exports = function httpAdapter(config) {
  return new Promise(function dispatchHttpRequest(resolvePromise, rejectPromise) {//返回一个promise
    var timer;//定时器
    var resolve = function resolve(value) {//resolve前先将定时器清除
      clearTimeout(timer);
      resolvePromise(value);
    };
    var reject = function reject(value) {//reject前先将定时器清除
      clearTimeout(timer);
      rejectPromise(value);
    };
    var data = config.data;//data参数
    var headers = config.headers;//header请求头对象

    // Set User-Agent (required by some servers)
    // Only set header if it hasn't been set in config
    // See https://github.com/axios/axios/issues/69
    //设置User-Agent请求头
    if (!headers['User-Agent'] && !headers['user-agent']) {
      headers['User-Agent'] = 'axios/' + pkg.version;
    }

    if (data && !utils.isStream(data)) {
      //如果data参数存在且data不是流
      if (Buffer.isBuffer(data)) {//如果是Buffer，不作操作
        // Nothing to do...
      } else if (utils.isArrayBuffer(data)) {//如果是ArrayBuffer
        data = Buffer.from(new Uint8Array(data));
      } else if (utils.isString(data)) {//如果是字符串
        data = Buffer.from(data, 'utf-8');
      } else {//其他情况，抛出错误
        return reject(createError(
          'Data after transformation must be a string, an ArrayBuffer, a Buffer, or a Stream',
          config
        ));
      }

      // Add Content-Length header if data exists
      //如果data存在，添加Content-Length请求头，data长度
      headers['Content-Length'] = data.length;
    }

    // HTTP basic authentication
    var auth = undefined;
    if (config.auth) {//如果传递了auth配置项，把用户名和密码拼起来
      var username = config.auth.username || '';
      var password = config.auth.password || '';
      auth = username + ':' + password;
    }

    // Parse url
    var parsed = url.parse(config.url);//将完整url解析成部分组成的对象
    var protocol = parsed.protocol || 'http:';//协议

    if (!auth && parsed.auth) {//如果url中带有auth且没有传递配置项auth，就使用url中的auth参数
      var urlAuth = parsed.auth.split(':');
      var urlUsername = urlAuth[0] || '';
      var urlPassword = urlAuth[1] || '';
      auth = urlUsername + ':' + urlPassword;
    }

    if (auth) {//有auth参数，从请求头中删除Authorization
      delete headers.Authorization;
    }

    var isHttpsRequest = isHttps.test(protocol);//判断是否是https协议
    var agent = isHttpsRequest ? config.httpsAgent : config.httpAgent;
    //根据判断是否https来获取到对应的httpAgent

    var options = {
      path: buildURL(parsed.path, config.params, config.paramsSerializer).replace(/^\?/, ''),
      method: config.method.toUpperCase(),
      headers: headers,
      agent: agent,
      auth: auth
    };
    //基础选项，path调用buildURL方法创建一个带有查询参数的url

    if (config.socketPath) {//添加socketPath配置到options中
      options.socketPath = config.socketPath;
    } else {//没有socketPath配置，就添加域名和端口号到options中
      options.hostname = parsed.hostname;
      options.port = parsed.port;
    }

    var proxy = config.proxy;//proxy定义代理服务器的域名和端口号
    if (!proxy && proxy !== false) {//没有传递proxy参数
      var proxyEnv = protocol.slice(0, -1) + '_proxy';//协议名加上_proxy的字符串，代理url的环境变量名字
      var proxyUrl = process.env[proxyEnv] || process.env[proxyEnv.toUpperCase()];
      //从环境变量中获取到代理url
      if (proxyUrl) {//如果存在代理url
        var parsedProxyUrl = url.parse(proxyUrl);//将代理url解析
        var noProxyEnv = process.env.no_proxy || process.env.NO_PROXY;//NO_PROXY环境变量
        var shouldProxy = true;

        if (noProxyEnv) {//如果有NO_PROXY环境变量
          var noProxy = noProxyEnv.split(',').map(function trim(s) {
            return s.trim();
          });//处理noProxyEnv，逗号分开变成一个数组，然后去除每一个元素的空格

          shouldProxy = !noProxy.some(function proxyMatch(proxyElement) {
            //循环noProxy，寻找是否有一个元素和请求url的域名相等
            if (!proxyElement) {//当前proxyElement为空，返回
              return false;
            }
            if (proxyElement === '*') {//如果proxyElement是通配符，返回true
              return true;
            }
            if (proxyElement[0] === '.' &&
                parsed.hostname.substr(parsed.hostname.length - proxyElement.length) === proxyElement &&
                proxyElement.match(/\./g).length === parsed.hostname.match(/\./g).length) {
              return true;
            }

            return parsed.hostname === proxyElement;//判断proxyElement与请求url的域名是否相等
          });
        }


        if (shouldProxy) {//如果需要代理
          proxy = {
            host: parsedProxyUrl.hostname,//代理域名
            port: parsedProxyUrl.port//代理端口号
          };

          if (parsedProxyUrl.auth) {//如果代理url拥有auth属性，就给proxy参数加上auth
            var proxyUrlAuth = parsedProxyUrl.auth.split(':');
            proxy.auth = {
              username: proxyUrlAuth[0],
              password: proxyUrlAuth[1]
            };
          }
        }
      }
    }

    if (proxy) {//如果设置了代理参数，根据代理改变options中的配置项
      options.hostname = proxy.host;//主机名
      options.host = proxy.host;//主机
      options.headers.host = parsed.hostname + (parsed.port ? ':' + parsed.port : '');//host请求头
      options.port = proxy.port;//端口号
      options.path = protocol + '//' + parsed.hostname + (parsed.port ? ':' + parsed.port : '') + options.path;//url路径

      // Basic proxy authorization
      if (proxy.auth) {//如果代理中含有auth参数
        var base64 = Buffer.from(proxy.auth.username + ':' + proxy.auth.password, 'utf8').toString('base64');//base64转码用户名和密码
        options.headers['Proxy-Authorization'] = 'Basic ' + base64;//添加对应请求头
      }
    }

    var transport;
    var isHttpsProxy = isHttpsRequest && (proxy ? isHttps.test(proxy.protocol) : true);
    //判断是https协议且含有代理
    if (config.transport) {//如果传递了transport，直接存下
      transport = config.transport;
    } else if (config.maxRedirects === 0) {//如果不允许重定向
      transport = isHttpsProxy ? https : http;//判断使用https模块还是http模块
    } else {//如果允许重定向，使用follow-redirects模块，请求时会自动重定向
      if (config.maxRedirects) {//maxRedirects加入options中
        options.maxRedirects = config.maxRedirects;
      }
      transport = isHttpsProxy ? httpsFollow : httpFollow;
    }

    if (config.maxContentLength && config.maxContentLength > -1) {
      //如果设置了最大正文长度，配置options对应选项
      options.maxBodyLength = config.maxContentLength;
    }

    // Create the request
    //创建请求
    //http.request(option, callback)方法发送http请求，它会返回http.ClientRequest对象
    //通过在http.ClientRequest对象上添加监听器即可获得响应对象
    var req = transport.request(options, function handleResponse(res) {
      //传递给http.request的callback是response事件的监听器，只会触发一次
      //res是http.IncomingMessage对象，可以用来获取响应状态码，响应头和响应数据
      if (req.aborted) return;//如果请求已经被中止，返回

      // uncompress the response body transparently if required
      var stream = res;
      switch (res.headers['content-encoding']) {
        //判断content-encoding响应头，此响应头指定了用什么编码来压缩响应主体
      /*eslint default-case:0*/
      case 'gzip':
      case 'compress':
      case 'deflate':
        // add the unzipper to the body stream processing pipeline
        stream = stream.pipe(zlib.createUnzip());//使用zlib压缩解压插件解压响应主体

        // remove the content-encoding in order to not confuse downstream operations
        //移除content-encoding响应头为了避免混淆后面的操作
        delete res.headers['content-encoding'];
        break;//跳出
      }

      // return the last request in case of redirects
      var lastRequest = res.req || req;//最后一次请求的请求对象，因为请求有可能发生了重定向

      var response = {//响应数据初始化
        status: res.statusCode,
        statusText: res.statusMessage,
        headers: res.headers,
        config: config,
        request: lastRequest
      };

      if (config.responseType === 'stream') {//如果请求配置中的responseType是stream格式
        response.data = stream;//response.data赋值为stream
        settle(resolve, reject, response);
        //调用settle来根据响应状态码来决定是否resolve或者reject当前promise
      } else {//如果配置要求的响应格式不是stream流格式
        var responseBuffer = [];
        stream.on('data', function handleStreamData(chunk) {
          //data事件，接收到数据块的时候触发
          responseBuffer.push(chunk);//将数据块插入responseBuffer数组

          // make sure the content length is not over the maxContentLength if specified
          //如果指定了最大响应正文长度，就判断是否响应数据长度超过了这个限制
          if (config.maxContentLength > -1 && Buffer.concat(responseBuffer).length > config.maxContentLength) {
            //如果响应数据长度超出限制长度，reject当前promise
            reject(createError('maxContentLength size of ' + config.maxContentLength + ' exceeded',
              config, null, lastRequest));
          }
        });

        stream.on('error', function handleStreamError(err) {
          //接收流数据块出错时触发error事件
          if (req.aborted) return;//如果请求对象已经中止，返回
          //否则reject当前promise
          reject(enhanceError(err, config, null, lastRequest));
        });

        stream.on('end', function handleStreamEnd() {
          //流数据传输完毕时触发end事件
          var responseData = Buffer.concat(responseBuffer);//将所有数据块连接成一个整体
          if (config.responseType !== 'arraybuffer') {//如果配置中的响应数据类型不是arrayBuffer
            //就调用toString方法转换格式，
            responseData = responseData.toString(config.responseEncodingresponseEncoding);
          }

          response.data = responseData;//响应数据赋值
          settle(resolve, reject, response);
          //调用settle来根据响应状态码来决定是否resolve或者reject当前promise
        });
      }
    });

    // Handle errors
    req.on('error', function handleRequestError(err) {
      //http.ClientRequest对象绑定error事件，发生错误的时候触发
      if (req.aborted) return;//如果请求对象已经中止，返回
      reject(enhanceError(err, config, null, req));//否则reject当前promise
    });

    // Handle request timeout
    if (config.timeout) {//如果配置项中有超时的配置
      timer = setTimeout(function handleRequestTimeout() {
        //新建一个定时器
        req.abort();//调用abort中止请求
        reject(createError('timeout of ' + config.timeout + 'ms exceeded', config, 'ECONNABORTED', req));//reject当前promise
      }, config.timeout);//超时时间过后执行
    }

    if (config.cancelToken) {//如果传递了cancelToken配置
      // Handle cancellation
      //设置了cancelToken的请求，只要用户调用了cancelToken对象的cancel方法，就会执行下面的then回调，中止请求
      config.cancelToken.promise.then(function onCanceled(cancel) {
        //对cancelToken对象上的promise指定resolve后的执行回调
        if (req.aborted) return;//如果请求已经中止，返回

        req.abort();//如果请求没有中止，就调用abort立即中止
        reject(cancel);//reject当前promise
      });
    }

    // Send the request
    if (utils.isStream(data)) {//如果config.data是流数据，就绑定error事件，读取数据出错就reject
      data.on('error', function handleStreamError(err) {
        reject(enhanceError(err, config, null, req));
      }).pipe(req);//将data读取完毕后用pipe传递给http.ClientRequest对象，可读流传递给可写流，用pipe方法
    } else {
      req.end(data);//否则关闭请求
    }
  });
};