级联承诺

Question

任何超出简单承诺的事情通常让我感到困惑。在这种情况下，我需要在N个对象上连续进行2次异步调用。首先，我需要从磁盘加载文件，然后将该文件上载到邮件服务器。我更愿意一起完成这两个动作，但是我已经通过先完成所有读操作然后再次上传所有内容来实现它。下面的代码有效，但我无法帮助，但认为可以做得更好。我不明白的一件事就是为什么when.all不会拒绝。我对文档的解释似乎暗示，如果其中一个承诺拒绝，那么.all将拒绝。我已经评论了较低的分辨率，以便测试错误。没有错误，事情似乎工作得很好并且有意义。

mail_sendOne({
  from: 'greg@', 
  to: 'wilma@', 
  subject: 'F&B data', 
  attachments: [
    {name: 'fred.html', path: '/fred.html'}, 
    {name: 'barney.html', path: '/barney.html'}
  ]
})
.done(
  function(res) {
    console.log(res)
  },
  function(err) {
    console.log('error ', err);
  }
)  

function mail_sendOne(kwargs) {
  var d = when.defer();
  var promises = [], uploadIDs = [], errs = [];

  // loop through each attachment
  for (var f=0,att; f < kwargs.attachments.length; f++) {
    att = kwargs.attachments[f];

    // read the attachment from disk  
    promises.push(readFile(att.path)
    .then(
      function(content) {
        // upload attachment to mail server
        return uploadAttachment({file: att.name, content: content})
        .then(
          function(id) {
            // get back file ID from mail server
            uploadIDs.push(id)
          },
          function(err) {
            errs.push(err)
          }
        )
      },
      function(err) {
        errs.push(err)
      }
    ))
  }

  // why doesn't this reject?
  when.all(promises)
  .then(
    function(res) {
      if (errs.length == 0) {
        kwargs.attachments = uploadIDs.join(';');
        sendEmail(kwargs)
        .done(
          function(res) {
            d.resolve(res);
          },
          function(err) {
            d.reject(err);
          }      
        )
      }
      else {
        d.reject(errs.join(','))
      }
    }
  )

  return d.promise;
}

function readFile(path) {
  var d = when.defer();
  var files = {
    '/fred.html': 'Fred Content',
    '/barney.html': 'Barney Content'
  }

  setTimeout(function() {
    d.reject('Read error');
    //d.resolve(files[path]);
  }, 10);

  return d.promise;
}

function uploadAttachment(obj) {
  var d = when.defer();

  setTimeout(function() {
    d.reject('Upload error');
    //d.resolve(new Date().valueOf());
  }, 10);

  return d.promise;
}

function sendEmail(kwargs) {
  var d = when.defer();

  setTimeout(function(){
    console.log('sending ', kwargs)
  }, 5);

  return d.promise;
}

Answer 1

那里有一些反模式使得代码比它需要的更加混乱。一个是在.then回调中使用.then时应该链接它们。另一个是deferred antipattern。

首先，让我们为阅读和上传创建一个函数，这两个函数都处理它们各自的错误，并在更多的上下文中抛出一个新的错误：

function readAndHandle(att) {
    return readFile(att.path)
        .catch(function (error) {
            throw new Error("Error encountered when reading " + att.path + error);
        });
}

function uploadAndHandle(att, content) {
    return uploadAttachment({file: att.name, content: content})
        .catch(function (error) {
            throw new Error("Error encountered when uploading " + att.path + error);
        });
}

然后，让我们将这两者组合成一个首先读取文件，然后上传它的函数。此函数返回一个承诺：

// returns a promise for an uploaded file ID
function readAndUpload(att) {
    return readAndHandle(att)
        .then(function (content) {
             return uploaAndHandle(att, content);
        });
}

现在，您可以使用.map()将附件数组映射到文件ID的承诺数组：

var uploadedIdsPromise = kwargs.attachments.map(readAndUploadAsync);

这就是你可以传递给when.all()的东西。这个.then处理程序会将一组ID传递给它的回调：

return when.all(uploadedIdsPromise)
    .then(function (ids) {
        kwargs.attachments = ids.join(";");
        return sendEmail(kwargs);
    })
    .catch(function (error) {
        // handle error
    });

这就是它的要点。

这里要注意的一件大事是，除了修改kwargs变量的地方之外，承诺不会修改承诺链之外的任何内容。这有助于保持逻辑清洁和模块化。

The Deferred Antipattern

请注意，上述代码中没有d.resolve或d.reject s。你应该使用deferred的唯一时间是你还没有可用的承诺（或者在其他一些特殊情况下）。即便如此，最近还有一些方法可以创造承诺。

when.js API文档说：

  

注意：不鼓励使用when.defer。在大多数情况下，使用when.promise，when.try或when.lift可以更好地分离关注点。

目前推荐的从某些非承诺异步API创建承诺的方法是使用revealing constructor pattern。以您的uploadAttachment()函数为例，它看起来像这样：

function uploadAttachment(obj) {
  return when.promise(function (resolve, reject) {
      setTimeout(function() {
          resolve(new Date().valueOf());
          // or reject("Upload error");
      }, 10);
  });
}

这是ES6 promise API的工作方式，它使您不必在deferred对象周围进行随机播放。