首页 > 解决方案 > Node.JS 服务层设计

问题描述

我有一个非常简单的 express js 服务器,它接受来自客户端的请求,执行一些业务逻辑并响应客户端。请求-响应管道由控制器处理,业务逻辑在服务层内执行。该代码可以正常工作,但我不确定从服务层向控制器返回错误的方式是否正确。

控制器看起来像这样:

async createAnOrder(req, res, next) {
    try {

        // Input validations
        if (!req.body.name){
            throw new ClientFacingError(ERROR_CODES.BAD_REQUEST, "Name is missing")
        }

        let newOrder = new Order();
        let validationDictionary = new ValidationDictionary();

        if (!await orderService.createOrder(newOrder, validationDictionary)){
            return next(new ClientFacingError(ERROR_CODES.BAD_REQUEST, validationDictionary.getErrorMessage()));
        }

        res.json({
            orderId: newOrder.id
        })

    } catch (err) {
        if (err instanceof ClientFacingError) {
            res.status(err.code).json({ message: err.message })
        } else {
            res.status(500).json({ message: "Internal Error" })
        }
    }
}

orderService 看起来像这样:

async createOrder(newOrder, validationDictionary) {

    // Business logic validation
    if (await orderDb.hasOrder(newOrder)) {
        validationDictionary.addError("Invalid Order", "Order already exists");
        return false;
    }

    await orderDb.createOrder(newOrder);
    return true;
}

我试图将业务层与其他所有方面的关注点分离。我还想要服务层方法和控制器之间的智能合约。

我想我想做的是:

  1. 输入验证发生在控制器(基础设施)层,业务相关的验证只发生在服务层
  2. 如果操作成功,则服务层方法返回 true,如果存在业务验证错误,则返回 false。
  3. 服务层方法抛出的任何错误都是运行时错误,这些错误会被控制器捕获并作为内部错误返回给客户端。

另一种方法是遵守 CQS 原则。服务层方法不应返回值,而是抛出异常以指示失败。这种方法的问题是控制器没有关于是否可以将错误消息返回给客户端的上下文。我可能能够从服务层抛出 ClientFacingError 异常,控制器可以使用该异常来决定是否可以将错误消息返回给客户端,但这感觉就像我将服务层耦合到基础设施层一样。

标签: node.jserror-handlingarchitecturedomain-driven-designdesign-by-contract

解决方案


你有很好的顾虑和一个很好的方法,让我补充一些想法:

  • validation可以是服务的一部分,与主逻辑分开。因此,createOrder您还将拥有一个validateOrder(在您的服务中)。从您的控制器中,您可以像这样使用它:

控制器:

try {
    ...
    orderService.validateOrder(order);
    orderService.createOrder(order);
    ...
} catch (e) { 
    //handle e
}

解决此问题的方法是抛出异常(如我的示例中),返回布尔+错误代码的混合,消息...,或简单地将其嵌入到createOrder. 这取决于您的项目需求和您的品味。

  • 如果出现问题,我会用简洁的消息抛出异常并输入orderService。代码会更优雅。如果一切顺利,返回实际新创建的订单对象也很好,但一开始布尔值就足够了。(甚至无效,考虑到你抛出异常)。

  • 捕获控制器中的异常,记录它们,向客户端发送适当的响应。


推荐阅读