Node.js에서 간단하고 효과적인 오류 처리 시스템 구축-JS 튜토리얼-php.cn

Node.js에서 간단하고 효과적인 오류 처리 시스템 구축

DDD

풀어 주다： 2024-11-30 15:29:11

원래의

225명이 탐색했습니다.

Building a Simple and Effective Error-Handling System in Node.js

웹 애플리케이션을 구축할 때 항상 계획대로 진행되지는 않습니다. 사용자가 잘못된 작업을 시도하거나, 데이터가 누락되거나, 예상치 못한 버그가 발생할 수 있습니다. 안정적인 애플리케이션을 만들고 좋은 사용자 경험을 제공하려면 이러한 오류를 적절하게 처리하는 것이 필수적입니다.

이 게시물에서는 Node.js 애플리케이션에서 간단하고 효과적인 오류 처리 시스템을 구현하는 방법을 보여 드리겠습니다. 뛰어 들어보세요! ?

오류 처리의 기본

JavaScript에서 오류는 일반적으로 Error 클래스의 인스턴스로 표시됩니다. 문제가 발생하면 오류를 "발생"할 수 있으며, 애플리케이션은 이를 포착하여 그에 따라 응답할 수 있습니다. 그러나 대규모 애플리케이션에서는 기본 Error 클래스만으로 오류를 관리하면 지저분해질 수 있습니다.

여기서 사용자 정의 오류 클래스가 유용합니다!
사용자 정의 오류 클래스 생성

다음은 구조적이고 의미 있는 오류를 정의하는 데 사용할 수 있는 AppError라는 클래스입니다.

export class AppError extends Error {
    constructor(name, httpCode, description, isOperational, errors = []) {
        super(description); // Call the parent class (Error) constructor
        this.name = name; // Name of the error (e.g., ValidationError)
        this.httpCode = httpCode; // HTTP status code (e.g., 400, 404, 500)
        this.isOperational = isOperational; // Flag to distinguish between operational and system errors
        this.errors = errors; // Optional array of detailed error messages
    }
}

로그인 후 복사

어떻게 작동하나요?

이름: ValidationError 또는 NotFoundError와 같은 오류 유형을 설명합니다.
httpCode: 잘못된 요청의 경우 400, 서버 오류의 경우 500 등 적절한 HTTP 상태 코드를 설정합니다.
설명: 오류를 설명하는 사용자 친화적인 메시지를 제공합니다.
isOperational: 오류가 예상된 것인지(예: 사용자 입력 문제) 또는 예상치 못한 오류(예: 버그)를 나타내는 부울 플래그입니다.
오류: 오류에 대한 보다 구체적인 세부 정보를 포함하는 선택적 목록입니다(검증 오류에 유용함).

간단한 오류 처리 미들웨어

이제 사용자 정의 오류 클래스가 있으므로 앱에서 이러한 오류를 처리할 방법이 필요합니다. 미들웨어 입력:

export const errorHandler = (err, req, res, next) => {
    if (err instanceof AppError) {
        // Handle operational errors
        res.status(err.httpCode).json({
            success: false,
            error: err.name,
            message: err.message,
            errors: err.errors || [],
        });
    } else {
        // Handle unexpected errors
        console.error('Unexpected Error:', err.stack); // Log the stack trace for debugging
        res.status(500).json({
            success: false,
            error: 'InternalServerError',
            message: 'Something went wrong. Please try again later.',
        });
    }
};

로그인 후 복사

이것은 무엇을 합니까?
오류 유형을 확인합니다:
오류가 AppError의 인스턴스인 경우 운영 오류로 처리됩니다. 예상되는 오류는 다음과 같습니다(예: 유효성 검사 문제 또는 리소스 누락).
AppError가 아닌 경우 예상치 못한 오류로 처리됩니다. 이는 코드의 버그이거나 계획하지 않은 것일 수 있습니다.

Responds with the right status code and message:
    For AppError instances, it sends a structured JSON response containing the error details.
    For unexpected errors, it sends a generic 500 response to the user and logs the details for debugging.

로그인 후 복사

모두 합치기

Express 앱에 사용자가 양식을 제출하지만 일부 필드가 누락된 경로가 있다고 가정해 보세요. 다음과 같이 AppError 클래스를 사용할 수 있습니다.

app.post('/submit-form', (req, res, next) => {
    const { name, email } = req.body;

    if (!name || !email) {
        const errors = [];
        if (!name) errors.push({ field: 'name', message: 'Name is required.' });
        if (!email) errors.push({ field: 'email', message: 'Email is required.' });

        return next(new AppError('ValidationError', 400, 'Invalid input data.', true, errors));
    }

    res.json({ success: true, message: 'Form submitted successfully!' });
});

// Register the error-handling middleware
app.use(errorHandler);

로그인 후 복사

오류가 발생하면 어떻게 되나요?
이름이나 이메일이 누락된 경우 AppError 인스턴스가 다음 함수로 전달됩니다.
errorHandler 미들웨어가 이를 포착하고 구조화된 JSON 응답을 보냅니다.

{
    "success": false,
    "error": "ValidationError",
    "message": "Invalid input data.",
    "errors": [
        { "field": "name", "message": "Name is required." },
        { "field": "email", "message": "Email is required." }
    ]
}

로그인 후 복사

이 패턴을 사용하는 이유는 무엇인가요?