nodejs http request timeout

Node.js is an open source JavaScript runtime that enables building efficient web applications on the server side. It provides a lightweight and efficient way to handle HTTP requests and responses. But sometimes we find that a "request timeout" error message appears when making an HTTP request. This may occur in an environment where the network connection is not stable enough, or the server response is too slow. This article will discuss how to solve the problem of HTTP request timeout in Node.js.

1. HTTP requests in Node.js
To make HTTP requests in Node.js, you need to use the built-in HTTP module. The HTTP module provides a number of methods and properties that can be used to handle HTTP requests and responses. Below is an example of a simple HTTP GET request.

const http = require('http');

const options = {
  host: 'www.example.com',
  path: '/resource',
  port: 80,
  method: 'GET'
};

const req = http.request(options, (res) => {
  console.log(`statusCode: ${res.statusCode}`);
    
  res.on('data', (d) => {
    process.stdout.write(d);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.end();

In the above example, we used the http.request() method to create an HTTP request. This method accepts an options object as a parameter, containing information such as host name, port, path and request method. The options object can also set a timeout attribute, which is used to specify the maximum timeout for the request (in milliseconds).

2. HTTP request timeout processing
When using Node.js to make HTTP requests, a common problem is request timeout. The request did not complete after more than the specified time, possibly due to an unstable network connection or a slow server response. If request timeouts are not handled, it can cause the application to clog, resulting in a poor user experience.

To address the problem of request timeout, Node.js provides a timeout event, which can be used to set the time limit for request timeout. You can add a timeout event handler to detect if the request times out. If it times out, you can terminate the request and perform appropriate actions. Below is an example of HTTP request timeout handling.

const http = require('http');

const options = {
  host: 'www.example.com',
  path: '/resource',
  port: 80,
  method: 'GET',
  timeout: 5000 // 设置超时时间为5秒钟
};

const req = http.request(options, (res) => {
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    process.stdout.write(d);
  });
});

req.on('timeout', () => {
  req.abort();
});

req.on('error', (error) => {
  console.error(error);
});

req.end();

In the above example, we added a property named timeout to the options object, which is used to set the request timeout to 5 seconds. When the request times out, the timeout event of req will be triggered, and the abort() method will be called to terminate the request. Here, we simply print the error message of the request timeout, and you can handle the error message according to your needs.

3. How timeout works
Through the code in the above example, you can see that we set the timeout event, but it will not necessarily be triggered after 5 seconds, because the timeout event is after the request is completed. Triggered after 5 seconds. The HTTP request timeout time is determined by the sum of the TCP connection timeout time and the read timeout time.

TCP connection timeout refers to how long it takes the server to accept a request and send a response. If necessary, the length of the timeout can be set in the socket attribute in the options object, for example, set to 3000:

const options = {
  host: 'www.example.com',
  path: '/resource',
  port: 80,
  method: 'GET',
  timeout: 5000,
  socket: {
    connectTimeout: 3000
  }
};

The read timeout refers to how long it takes for response data to be transmitted. If necessary, the length of the read timeout can also be set in the options object, for example, set to 2000:

const options = {
  host: 'www.example.com',
  path: '/resource',
  port: 80,
  method: 'GET',
  timeout: 5000,
  timeout: 5000,
  socket: {
    connectTimeout: 3000
  },
  headers: {
    'Keep-Alive': true,
    'Connection': 'keep-alive'
  },
  agent: new http.Agent({ keepAlive: true })
};

In actual applications, TCP needs to be set according to the response time of the server and the stability of the network connection. Connection timeout and read timeout to avoid errors caused by request timeout.

4. Conclusion
When making HTTP requests in Node.js, you may encounter the problem of request timeout. To solve such problems, we can use Node.js's built-in HTTP module to set a timeout event for the request, terminate the request and handle the error message. The length of the TCP connection timeout and read timeout depends on the server response time and the stability of the network connection. Therefore, we need to set a reasonable timeout for server response time and network connection stability.

The above is the detailed content of nodejs http request timeout. For more information, please follow other related articles on the PHP Chinese website!