Куда выдавать ошибки в модели MVC: сервис или контроллер?

Это то, чему я уделил много времени. Я пробовал и экспериментировал с множеством разных подходов, и именно этот мне подходит лучше всего. Я делюсь примером регистрации арендатора по электронной почте, чтобы вы могли спланировать ее соответствующим образом для вашего варианта использования/API.

Поначалу это может показаться пугающим, поскольку для настройки требуется много шагов, но самое приятное то, что вам придется сделать это только один раз. После этого вы можете просто скопировать и вставить файлы кода в разные проекты, и они будут работать безупречно, поскольку эти файлы кода будут работать независимо.

1. Придумайте правильную/фиксированную структуру ответа, независимо от того, является ли это ответом об ошибке или успешным ответом. Для меня это было

{
    "success": true,
    "message": "",
    "data": {...}
}

success будет true или false в зависимости от операции, message будет правильным сообщением, объясняющим ответ/результат, и data будет содержать любые виды полезных данных, связанных с ответом, если это необходимо.

2. Создайте функцию промежуточного программного обеспечения, которая сможет обрабатывать любую ошибку или любой успешный объект, выданный/возвращенный из контроллера (и да, для меня контроллер — лучшее место, поскольку он содержит общую бизнес-логику) и сможет отправлять правильный ответ. после его обработки.

// put below code in a file named as response-handler.js

const { logError, logInfo } = require('../logger');
const { HttpError } = require('./error');

function sendSuccess(code, success, message, data) {
    return {
        code,
        success,
        message,
        data
    }
}

function sendError(code = 500, message = "something went wrong!") {
    throw new HttpError(code, false, message);
}

function handleResponse(result, req, res, next) {
    const { code, success, message, data } = result;
    
    if (code) {
        logInfo(`responded with ${code}: ${message}`)

        return res
        .status(code)
        .json({
            success,
            message,
            data
        })
    } else {
        logError(message);

        return res.status(500).json({
            success: false,
            message: 'something went wrong'
        })
    }
   
}

module.exports = {
    handleResponse,
    sendSuccess,
    sendError
};

Таким образом, во всей моей кодовой базе, внутри контроллеров, я буду использовать sendSuccess и sendError для возврата объекта успеха или ошибки, который в конечном итоге будет обработан handleResponse для отправки правильного ответа.

3. Создайте собственный класс ошибок, который будет использоваться для выдачи ошибок. Нативный Error может обрабатывать только сообщения. Но для правильной отправки ответа нам потребуется код ошибки/статуса, флаг успеха и сообщение. Таким образом

// put the below code in error.js

class HttpError extends Error {
    constructor(code, success, message) {
        super(message);
        this.code = code;
        this.success = success;
        this.name = this.constructor.name;
        Error.captureStackTrace(this, this.constructor);
    }
}

module.exports = {
    HttpError
}

sendError в пункте 2 в конечном итоге будет использовать HttpError для выдачи ошибок.

4. Подключите промежуточное ПО handleResponse в app.js.

const authRoutes = require('./auth/route/auth.route');
const tenantRoutes = require('./tenant/route/tenant.route');
const expenseRoutes = require('./expense/route/expense.route');
const categoryRoutes = require('./category/route/category.route');
const { handleResponse } = require('./core/http/response-handler');

app.get("/ping", (req, res) => {
    res.status(200).json({
        success: true,
        message: 'hello from euro!'
    });
})
app.use(authRoutes);
app.use(tenantRoutes);
app.use(expenseRoutes);
app.use(categoryRoutes);

app.use(handleResponse); // <- handleResponse must be the last middleware, this is important, so that it can handle all the routes defined above it

5. Настройте маршруты

// put below code in the route tenant.route.js

const router = require('express').Router();
const API_ENDPOINTS = require('../../support/request-mapper');
const { registerUserViaEmail } = require('../controller/tenant.controller');

router
    .post(
        API_ENDPOINTS.REGISTER_VIA_EMAIL,
        [],
        (req, res, next) => registerUserViaEmail(req,res).then(next).catch(next)
    )

module.exports = router;

registerUserViaEmail(req,res).then(next).catch(next) — суть этой установки. Проще говоря, что бы хорошее (then) или плохое (catch) ни происходило внутри registerUserViaEmail, позвольте handleResponse разобраться с этим. Вы поймете это, когда я покажу вам код контроллера.

6. Наконец вот код контроллера

//put the below code in tenant.controller.js

const { passwordEncoder } = require('../../core/crypto/password');
const { sendSuccess, sendError } = require('../../core/http/response-handler');
const { logError } = require('../../core/logger');
const Tenant = require('../model/tenant');

async function registerUserViaEmail(req, res) {
    const tenant = await Tenant.findOne({ email: req.body.email }).exec();

    if (tenant) {
        sendError(409, "user already exists!");
    }

    try {
        await Tenant.create({
            name: req.body.name,
            email: req.body.email,
            password: await passwordEncoder(req.body.password),
            provider: 'BASIC'
        })
    } catch (error) {
        logError(error.message, error);
        sendError();
    }

    return sendSuccess(201, true, "user registered successfully!");
}

module.exports = {
    registerUserViaEmail
}

Как вы можете видеть, я могу обрабатывать пользовательские/обработанные ошибки (401 повторяющаяся ошибка пользователя), необработанные ошибки (catch ошибка блока) и успешный ответ.

Итак, как только вы настроите базовые файлы, от проекта к проекту будут меняться только маршруты и контроллеры.

Надеюсь, это поможет вам подумать о структуре, которая подойдет вам лучше всего.

Ошибка throwed зависит от того, является ли это полным HTTP приложением или нет.

1 — Полный HTTP API/сервер.

Если это API, используемый только для HTTP запросов, вам следует throw Ошибки в Service Layer, как и в первом примере моего вопроса, потому что:

• Можно кинуть более конкретные status и messages

• Ваш Controller станет чище

• Controller не обязательно всегда иметь блок try/catch для устранения ошибки.

• Ошибки Service обрабатываются одинаково во всем вашем приложении.

• Пусть слой Controller просто обрабатывает requisition/response, потому что для этого он и создан!

2. Не полный HTTP API/сервер

Если он используется не только для HTTP запросов, лучший способ - это throw Ошибка на Service Layer только с конкретными Error Code и message, и позволить Controller обработать переданную ему ошибку и решить, что status дать и как это сделать. Отправь это.

В данном случае это лучший вариант, потому что Service можно использовать в других местах вашего приложения, а не только в HTTP Controllers.