DEV Community: Talan

Xử lý error trong rest api nodejs

Talan — Sun, 20 Oct 2019 00:39:11 +0000

Tạo ra 1 middleware error cho việc xử lý lỗi.

Xử lý middleware cho error

Tại nơi định nghĩa app cho express xử lý như sau:

Import error từ middlewares đã được định nghĩa const error = require('../api/middlewares/error')
Bind app middleware tới instance của express:

// if error is not an instanceOf APIError, convert it.
// APIError là class có chứa cấu trúc lỗi
app.use(error.converter);

// catch 404 and forward to error handler
app.use(error.notFound);

// error handler, send stacktrace only during development
app.use(error.handler);

Định nghĩa APIError class

Tạo file APIError.js chẳng hạn tại src/api/utils/APIError.js
Nội dung file như sau

/* eslint-disable max-classes-per-file */
const httpStatus = require('http-status');

/**
 * @extends Error
 */
class ExtendableError extends Error {
  constructor({
 message, errors, status, isPublic, stack 
}) {
    super(message);
    this.name = this.constructor.name;
    this.message = message;
    this.errors = errors;
    this.status = status;
    this.isPublic = isPublic;
    this.isOperational = true; // This is required since bluebird 4 doesn't append it anymore.
    this.stack = stack;
    // Error.captureStackTrace(this, this.constructor.name);
  }
}

/**
 * Class representing an API error.
 * @extends ExtendableError
 */
class APIError extends ExtendableError {
  /**
   * Creates an API error.
   * @param {string} message - Error message.
   * @param {number} status - HTTP status code of error.
   * @param {boolean} isPublic - Whether the message should be visible to user or not.
   */
  constructor({
    message,
    errors,
    stack,
    status = httpStatus.INTERNAL_SERVER_ERROR,
    isPublic = false,
  }) {
    super({
      message,
      errors,
      status,
      isPublic,
      stack,
    });
  }
}

module.exports = APIError;

Xử lý error trong middleware

Tạo file error.js, chẳng hạn như src/api/middlewares/error.js
Nội dung xử lý như sau:

const httpStatus = require('http-status');
const expressValidation = require('express-validation');
const APIError = require('../utils/APIError');

/**
 * Error handler. Send stacktrace only during development
 * @public
 */
const handler = (err, req, res, next) => {
  const response = {
    code: err.status,
    message: err.message || httpStatus[err.status],
    errors: err.errors,
    stack: err.stack,
  };

  if (process.env !== 'development') {
    delete response.stack;
  }

  res.status(err.status);
  res.json(response);
};
exports.handler = handler;

/**
 * If error is not an instanceOf APIError, convert it.
 * @public
 */
exports.converter = (err, req, res, next) => {
  let convertedError = err;

  if (err instanceof expressValidation.ValidationError) {
    convertedError = new APIError({
      message: 'Validation Error',
      errors: err.errors,
      status: err.status,
      stack: err.stack,
    });
  } else if (!(err instanceof APIError)) {
    convertedError = new APIError({
      message: err.message,
      status: err.status,
      stack: err.stack,
    });
  }

  return handler(convertedError, req, res);
};

/**
 * Catch 404 and forward to error handler
 * @public
 */
exports.notFound = (req, res, next) => {
  const err = new APIError({
    message: 'Not found',
    status: httpStatus.NOT_FOUND,
  });
  return handler(err, req, res);
};

Xử lý error trong rest api nodejs

Talan — Sat, 19 Oct 2019 23:40:05 +0000

Tạo ra 1 middleware error cho việc xử lý lỗi.

Xử lý middleware cho error

Tại nơi định nghĩa app cho express xử lý như sau:

Import error từ middlewares đã được định nghĩa const error = require('../api/middlewares/error')
Bind app middleware tới instance của express:

// if error is not an instanceOf APIError, convert it.
// APIError là class có chứa cấu trúc lỗi
app.use(error.converter);

// catch 404 and forward to error handler
app.use(error.notFound);

// error handler, send stacktrace only during development
app.use(error.handler);

Định nghĩa APIError class

Tạo file APIError.js chẳng hạn tại src/api/utils/APIError.js
Nội dung file như sau

/* eslint-disable max-classes-per-file */
const httpStatus = require('http-status');

/**
 * @extends Error
 */
class ExtendableError extends Error {
  constructor({
 message, errors, status, isPublic, stack 
}) {
    super(message);
    this.name = this.constructor.name;
    this.message = message;
    this.errors = errors;
    this.status = status;
    this.isPublic = isPublic;
    this.isOperational = true; // This is required since bluebird 4 doesn't append it anymore.
    this.stack = stack;
    // Error.captureStackTrace(this, this.constructor.name);
  }
}

/**
 * Class representing an API error.
 * @extends ExtendableError
 */
class APIError extends ExtendableError {
  /**
   * Creates an API error.
   * @param {string} message - Error message.
   * @param {number} status - HTTP status code of error.
   * @param {boolean} isPublic - Whether the message should be visible to user or not.
   */
  constructor({
    message,
    errors,
    stack,
    status = httpStatus.INTERNAL_SERVER_ERROR,
    isPublic = false,
  }) {
    super({
      message,
      errors,
      status,
      isPublic,
      stack,
    });
  }
}

module.exports = APIError;

Xử lý error trong middleware

Tạo file error.js, chẳng hạn như src/api/middlewares/error.js
Nội dung xử lý như sau:

const httpStatus = require('http-status');
const expressValidation = require('express-validation');
const APIError = require('../utils/APIError');

/**
 * Error handler. Send stacktrace only during development
 * @public
 */
const handler = (err, req, res, next) => {
  const response = {
    code: err.status,
    message: err.message || httpStatus[err.status],
    errors: err.errors,
    stack: err.stack,
  };

  if (process.env !== 'development') {
    delete response.stack;
  }

  res.status(err.status);
  res.json(response);
};
exports.handler = handler;

/**
 * If error is not an instanceOf APIError, convert it.
 * @public
 */
exports.converter = (err, req, res, next) => {
  let convertedError = err;

  if (err instanceof expressValidation.ValidationError) {
    convertedError = new APIError({
      message: 'Validation Error',
      errors: err.errors,
      status: err.status,
      stack: err.stack,
    });
  } else if (!(err instanceof APIError)) {
    convertedError = new APIError({
      message: err.message,
      status: err.status,
      stack: err.stack,
    });
  }

  return handler(convertedError, req, res);
};

/**
 * Catch 404 and forward to error handler
 * @public
 */
exports.notFound = (req, res, next) => {
  const err = new APIError({
    message: 'Not found',
    status: httpStatus.NOT_FOUND,
  });
  return handler(err, req, res);
};

Middleware trong expressjs là gì? Tác dụng và cách sử dụng như thế nào?

Talan — Fri, 24 Aug 2018 01:44:52 +0000

Middleware trong ngành phần mềm nói chung là gì?
Middleware trong các ứng dụng website như thế nào?
Middleware trong expressjs

Problem

Khi mình tìm hiểu về express cụ thể là hàm cơ bản app.use() thì thấy có nhắc đến định nghĩa middleware function

Mounts the specified middleware function or functions at the specified path: the middleware function is executed when the base of the requested path matches path.

Suy ngẫm một lúc cũng chưa rõ và chưa nắm được bản chất nên đành tìm hiểu về thuật ngữ middleware vậy. Tuy mất công thật, tìm hiểu và viết thành blog nhưng lại cảm thấy sướng vl.

Middleware trong ngành phần mềm nói chung là gì?

Middleware là phần mềm máy tính với nhiệm vụ kết nối các thành phần phần mềm hoặc các ứng dụng với nhau. Phần mềm loại này bao gồm một tập các dịch vụ cho phép sự tương tác giữa các tiến trình chạy trên một hoặc nhiều máy khác nhau. Công nghệ middleware đã được phát triển để cung cấp khả năng hoạt động tương hỗ, phục vụ cho các kiến trúc phân tán thường được để hỗ trợ và đơn giản hóa các ứng dụng phân tán phức tạp.

Middleware là software nằm giữa hệ điều hành và các ứng dụng chạy trên OS đó. Nhằm mục đích quản lý data và sự giao tiếp của các distributed apps

Distributed apps là các ứng dụng hay phần mềm mà chạy trên multiple computers nhưng trong cùng 1 hệ thống network. Không giống như các apps truyền thống chỉ chạy trên 1 hệ thống đơn (single system), thì các distributed apps chạy trên multi systems 1 cách đồng thời 1 task hoặc 1 job nào đó.
Có thể tưởng tượng middleware giống như các ống nước vậy. Các ống nước này sẽ là nơi kết nối giữa các cáp lại với nhau, nhận đầu vào từ nơi này và chuyển nước đến đầu ra mong muốn.
Nói một cách development thì nó sẽ connect 2 ứng dụng lại với nhau vì thế data hoặc database có thể trao đổi dễ dàng qua các ống nước này.

Middleware trong các ứng dụng website như thế nào?

Nó là cầu nối giữa database và application
Xử lý request và quyết định các response trả về thế nào
Cũng có thể là cầu nối giữa các components
Cũng có thể control application sẽ như thế nào nếu có lỗi
Là software component được nhúng vào ứng dụng để xử lý request và response của các user actions

Middleware trong expressjs

Express is a routing and middleware web framework that has minimal functionality of its own: An Express application is essentially a series of middleware function calls

Vì bản chất nó thế nên khi làm việc với express chúng ta thường xuyên sử dụng một loạt của middleware functions.

Middleware trong expressjs là:

Một loạt các functions được gọi bởi router layer trước khi request cuối cùng được thực thi
Function nhận các request, response của 1 chu kỳ HTTP request/response
Function có thể chình sửa request, response trước khi gửi chúng đến next middleware function
Có thể update response hoặc chấm dứt nếu cần thiết
Function nhận vào ba tham số: đối tượng request, đối tượng response và next function Ví dụ:

function logger(req,res,next){
  console.log(new Date(), req.method, req.url);
  next();
}

Tác dụng

Middleware function được dùng để làm các việc sau:
- Thực thi bất kỳ đoạn code nào
- Update request, response
- Làm kết thúc chu kỳ request-response. Ví dụ có 1 vài exception xảy ra thì thay vì gọi hàm next thì mình có thể kết thúc nó luôn
Express application có thể sử dụng các loại middleware sau
- Application-level middleware Bind application-level middleware thành instance của app object thành việc có thể sử dụng bằng app.use() và app.METHOD()
- Router-level middleware Cách thức hoạt động giống như application-level-middleware, ngoại trừ nó bị ràng buộc bởi instance express.Router()
- Error-handling middleware Tên gọi nói lên tất cả
- Built-in middleware
- Third-party middleware

var express = require('express')
var app = express()
var cookieParser = require('cookie-parser') // lib bên thứ ba

// load the cookie-parsing middleware
app.use(cookieParser())

Ví dụ về cách sử dụng đơn giản

Bài toán: tạo ra middleware dùng để in current time và lưu 1 cuốn sách vào database và render message
Bài giải:

1/ Tạo method cho logging current time

    //create a method to
    var requestTime = function (req, res, next) {
      req.requestTime = Date.now();
      console.log("Current Time for Request"+req.requestTime );
      next()
    };

2/ Sử dụng middleware function trên như là application-level middleware

//use the middleware as an application-level middleware
app.use(requestTime);

3/ Tạo middleware để kết nối vào DB

// method to conenct to be

var conencttodb = function(req, res, next){
  try
  {
    var path= 'mongodb://localhost:27017/library';
    connect = mongoose.connect(path);
    console.log('conencted to db!!');
    //mongoose.set('debug', true);
  }
  catch(e)
  {
    console.log(e);
  }
};
app.use(conencttodb)

4/ Lưu thông tin cuốn sách bằng việc sử dụng next function

// create a new book
var book = new Book({
  title: 'Peter Quill',
  author: 'starlord55',
  yearpubished: 2011,
  id: 101,
  pages:56,
  ratings:1
});

// save the book in database
book.save(function(err, req, res) {
  console.log(req.body);
  if(err) {
    console.log(err);
    res.send({
      message :'something went wrong'
    });
  } else {
    // res.contentType('application/json');
    res.send({
      message:'the book has bees saved at'+req.requestTime
    });
  }
});

WHAT TO DO NEXT

Tiếp tục vọc node js =))