Membina Sistem Pengendalian Ralat yang Mudah dan Berkesan dalam Node.js

Apabila membina aplikasi web, perkara tidak selalu berjalan seperti yang dirancang. Pengguna mungkin mencuba operasi yang tidak sah, data mungkin hilang, atau pepijat yang tidak dijangka mungkin timbul. Mengendalikan ralat ini dengan anggun adalah penting untuk mencipta aplikasi yang boleh dipercayai dan menyediakan pengalaman pengguna yang baik.

Dalam siaran ini, saya akan menunjukkan kepada anda cara melaksanakan sistem pengendalian ralat yang mudah dan berkesan dalam aplikasi Node.js anda. Mari selami! ?

Asas Pengendalian Ralat

Dalam JavaScript, ralat biasanya diwakili sebagai contoh kelas Ralat. Apabila berlaku kesilapan, anda boleh "membuang" ralat dan aplikasi anda boleh menangkapnya untuk bertindak balas dengan sewajarnya. Walau bagaimanapun, dalam aplikasi yang lebih besar, mengurus ralat dengan hanya kelas Ralat asas boleh menjadi kucar-kacir.

Di sinilah kelas ralat tersuai berguna!
Mencipta Kelas Ralat Tersuai

Berikut ialah kelas yang dipanggil AppError yang boleh kita gunakan untuk menentukan ralat berstruktur dan bermakna:

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
    }
}

Bagaimana Ia Berfungsi?

Nama
• : Menerangkan jenis ralat, seperti ValidationError atau NotFoundError.
• Kod http: Menetapkan kod status HTTP yang sesuai, seperti 400 untuk permintaan buruk atau 500 untuk ralat pelayan.
• perihalan: Menyediakan mesej mesra pengguna yang menerangkan ralat.
• isOperational: Bendera boolean untuk menunjukkan sama ada ralat telah dijangka (mis., isu input pengguna) atau tidak dijangka (cth., pepijat).
• ralat: Senarai pilihan untuk memasukkan butiran yang lebih khusus tentang ralat (berguna untuk ralat pengesahan).

Perisian Tengah Pengendalian Ralat Mudah

Sekarang kami mempunyai kelas ralat tersuai, kami memerlukan cara untuk mengendalikan ralat ini dalam apl kami. Masukkan perisian tengah:

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.',
        });
    }
};

Apa Fungsi Ini?
Menyemak jenis ralat:
Jika ralat adalah contoh AppError, ia dianggap sebagai ralat operasi. Ini ialah ralat yang anda jangkakan (cth., isu pengesahan atau sumber yang tiada).
Jika ia bukan AppError, ia dianggap sebagai ralat yang tidak dijangka. Ini mungkin pepijat dalam kod anda atau sesuatu yang anda tidak rancangkan.

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.

Menyatukan Semuanya

Bayangkan anda mempunyai laluan dalam apl Express anda yang membolehkan pengguna menyerahkan borang, tetapi beberapa medan tiada. Anda boleh menggunakan kelas AppError anda seperti ini:

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);

Apa Yang Berlaku Apabila Terdapat Ralat?
Jika nama atau e-mel tiada, contoh AppError dihantar ke fungsi seterusnya.
Perisian tengah errorHandler menangkapnya dan menghantar respons JSON berstruktur:

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

Kenapa Guna Corak Ini?

• Kejelasan: Kelas ralat tersuai menjadikan ralat anda lebih deskriptif dan lebih mudah untuk nyahpepijat.
• Ketekalan: Setiap ralat mengikut struktur yang boleh diramal, menjadikannya lebih mudah untuk dikendalikan oleh pembangun bahagian hadapan.
• Pemisahan Kebimbangan: Pengendali laluan anda menumpukan pada logik, manakala perisian tengah mengendalikan tindak balas ralat.

Kesimpulan
Pengendalian ralat tidak semestinya rumit! Dengan menggunakan kelas ralat tersuai dan perisian tengah, anda boleh membina sistem yang teguh dan mesra pemula yang memastikan apl anda boleh dipercayai dan pengguna anda gembira.

Apakah pendapat anda tentang pendekatan ini? Adakah anda mempunyai sebarang petua atau helah untuk mengendalikan ralat dalam Node.js? Beritahu saya dalam komen di bawah!

Atas ialah kandungan terperinci Membina Sistem Pengendalian Ralat yang Mudah dan Berkesan dalam Node.js. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!