A brief analysis of creating a simple HTTP server using Node-JS Tutorial-php.cn

How to create an HTTP server using NodeJS? The following article will introduce to you how to use Node to create a simple HTTP server. I hope it will be helpful to you!

A brief analysis of creating a simple HTTP server using Node

1. Use Node.js to run JavaScript scripts directly

node.jsThe v8 engine based on Chrome runs js code, so we can get rid of the browser environment and run js# directly in the console ##Code, such as the following hello worldcode

console.log('hello world');

Copy after login

You can run it directly by using

node in the console

A brief analysis of creating a simple HTTP server using Node

2. Create a simple HTTP server

The built-in module of node.jshttp provides basic http Service capabilities, based on the CommonJS specification, we can use require to import the http module for use http There are A createServer function allows us to create a httpserver It receives a callback function as a parameter. This callback function receives two parameters --request and response. [Related tutorial recommendations: nodejs video tutorial]

request includes all client requested information, such as url, request headers header, request method and request body, etc.
response is mainly used to return information to the client and encapsulates some operations related to the response body, such as The response.writeHead method allows us to customize the header information and status code of the return body

After we have processed the response body, call

response.end() method can send the response body to the client Using thecreateServer function only creates a Server object for us, but does not enable it to listen. We also need to call the listen## of the server object. #The method can be used to listen, and it can actually start running as a server.

The first parameter of the method is the listening port number, and the second parameter is the binding Host ip, the third parameter is a callback function, which will be called asynchronously by the http module. When an error is encountered, it can be called in the first parameter of this callback function. After getting the thrown exception, we can choose to handle the exception to make our server more robust

http

module to create a simple server<div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">const { createServer } = require('http'); const HOST = 'localhost'; const PORT = '8080'; const server = createServer((req, resp) => { // the first param is status code it returns // and the second param is response header info resp.writeHead(200, { 'Content-Type': 'text/plain' }); console.log('server is working...'); // call end method to tell server that the request has been fulfilled resp.end('hello nodejs http server'); }); server.listen(PORT, HOST, (error) => { if (error) { console.log('Something wrong: ', error); return; } console.log(`server is listening on http://${HOST}:${PORT} ...`); });</pre><div class="contentsignin">Copy after login</div></div>You can directly try to run it with

node

and create a server that belongs to you! After the server is running, the browser can access the server by accessing http://localhost:8080

A brief analysis of creating a simple HTTP server using Node You can also use

nodemon

Run it so that when our code changes, we don’t need to manually terminate the program and re-run it <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">npm i -g nodemon</pre><div class="contentsignin">Copy after login</div></div> It is recommended to install it globally so that it can be used directly without going through

npx nodemon

To use It is also very simple to use, just change the node command to the nodemon command<div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">nodemon http-server.js</pre><div class="contentsignin">Copy after login</div></div>

A brief analysis of creating a simple HTTP server using Node

3 .Add type prompt

When we used the

createServer

and resp objects earlier, we could not see any syntax prompts, and we must follow ## at any time. #nodeIt’s a bit inconvenient to check the official documentation while using it. But it doesn’t matter, we can use the.d.ts file of ts to help us provide syntax prompts. Note that we are not using ts for development, just using it The syntax prompt function is only Initialize the project--

npm init -y

Install@types/node
pnpm i @types/node -DCreate the jsconfig.json
node_modules, there is no need to check it<div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">{ "compilerOptions": { "checkJs": true }, "exclude": ["node_modules", "**/node_modules/*"] }</pre><div class="contentsignin">Copy after login</div></div> I wonder if you have found that there is actually an error in the above code?

can help us check for type errors. You can choose whether to enable it according to your needs. As you can see, after turning on the check, we were immediately prompted with the parameter type mismatch problem

这时候将鼠标悬浮在listen方法上，就能够看到该方法的签名

A brief analysis of creating a simple HTTP server using Node

可以看到，原来port参数需要是number类型，但是我们定义的时候是string类型，所以没匹配上，将其修改为number的8080即可而且可以直接查看到相关api的文档，不需要打开node官方的文档找半天去查看了

4. 返回多个字符串的响应体

前面我们的简单http server中只返回了一句话，那么是否能够返回多句话呢？这就要用到resp对象的write方法了，end只能够返回一次内容，而是用write方法，我们可以多次写入内容到响应体中，最后只用调用一次end，并且不传递任何参数，只让他完成发送响应体的功能

const { createServer } = require("http");
const HOST = "localhost";
const PORT = 8080;

const server = createServer((req, resp) => {
  resp.writeHead(200, { "Content-Type": "text/plain" });  
  console.log("server is working...");  
  
  // write some lorem sentences
  resp.write("Lorem ipsum dolor sit amet consectetur adipisicing elit.\n");
  resp.write("Omnis eligendi aperiam delectus?\n");
  resp.write("Aut, quam quo!\n");

  resp.end();
});

server.listen(PORT, HOST, (error) => {
  if (error) {    
  console.log("Something wrong: ", error);    
  return;
  }  
  console.log(`server is listening on http://${HOST}:${PORT} ...`);
});

Copy after login

这次我们写入了三句话，现在的效果就变成这样啦

A brief analysis of creating a simple HTTP server using Node

5. 返回html

我们不仅可以返回字符串给浏览器，还可以直接读取html文件的内容并将其作为结果返回给浏览器这就需要用到另一个Node.js的内置模块 -- fs，该模块提供了文件操作的功能使用fs.readFile可以异步进行读取文件的操作，但是它不会返回promise对象，因此我们需要传入回调去处理读取到文件后的操作还可以使用fs.readFileSync进行同步阻塞读取文件，这里我们选择异步读取

const { createServer } = require("http");
const fs = require("fs");
const HOST = "localhost";

const PORT = 8080;const server = createServer((req, resp) => {
  // change the MIME type from text/plain to text/html
  resp.writeHead(200, { "Content-Type": "text/html" });  
  
  // read the html file content
  fs.readFile("index.html", (err, data) => { 
     if (err) {  
      console.error(      
        "an error occurred while reading the html file content: ",
        err
      );      throw err;
    }    
    console.log("operation success!");

    resp.write(data);
    resp.end();
  });
});

server.listen(PORT, HOST, (error) => {
  if (error) {    
  console.log("Something wrong: ", error);    
  return;
  }  
  console.log(`server is listening on http://${HOST}:${PORT} ...`);
});

Copy after login

现在的结果就像下面这样：

A brief analysis of creating a simple HTTP server using Node

成功将html返回注意：这里需要将响应头的**Content-Type**改为**text/html**，告知浏览器我们返回的是**html**文件的内容，如果仍然以**text/plain**返回的话，浏览器不会对返回的内容进行解析，即便它是符合**html**语法的也不会解析，就像下面这样：

6. 返回JSON

当我们需要编写一个后端服务器，只负责返回接口数据的时候，就需要返回json格式的内容了，相信聪明的你也知道该怎么处理了：

将MIME类型设置为application/json
resp.write的时候传入的是json字符串，可以使用JSON.stringify处理对象后返回

const { createServer } = require("http");
const HOST = "localhost";
const PORT = 8080;

const server = createServer((req, resp) => { 
 // change the MIME type to application/json
  resp.writeHead(200, { "Content-Type": "application/json" });  
  
  // create a json data by using an object  
  const jsonDataObj = {
      code: 0,    
      message: "success",    
      data: {  
          name: "plasticine",      
          age: 20,      
          hobby: "coding",
    },
  };

  resp.write(JSON.stringify(jsonDataObj));
  resp.end();
});

server.listen(PORT, HOST, (error) => {
  if (error) { 
     console.log("Something wrong: ", error);    
     return;
  }  
  console.log(`server is listening on http://${HOST}:${PORT} ...`);
});

Copy after login

结果如下：

A brief analysis of creating a simple HTTP server using Node

7. 返回pdf文件

和之前返回html文件的思路类似，都是一个设置响应头MIME类型，读取文件，返回文件内容的过程但是这次我们搞点不一样的我们的思路是在服务器运行的时候生成一个pdf文件，并将它返回还需要将MIME的类型改为application/pdf生成pdf文件需要用到一个库 -- pdfkit

pnpm i pdfkit

Copy after login

首先我们编写一个创建pdf文件的函数，因为创建pdf文件还需要进行一些写入操作，不确定什么时候会完成，但是我们的请求必须等到pdf文件创建完成后才能得到响应所以我们需要将它变成异步进行的，返回一个promise

/**
 * @description 创建 pdf 文件
 */const createPdf = () => {
   return new Promise((resolve, reject) => {
       if (!fs.existsSync("example.pdf")) {      
       // create a PDFDocument object      
       const doc = new PDFDocument();
       
       // create write stream by piping the pdf content.
       doc.pipe(fs.createWriteStream("example.pdf"));   
        
      // add some contents to pdf document
      doc.fontSize(16).text("Hello PDF", 100, 100);   
         
      // complete the operation of generating PDF file.
      doc.end();
    }

    resolve("success");
  });
};

Copy after login

这里使用到了管道操作，将PDFDocument对象的内容通过管道传到新创建的写入流中，当完成操作后我们就通过resovle告知外界已经创建好pdf文件了然后在服务端代码中调用

const server = createServer(async (req, resp) => {
  // change the MIME type to application/pdf
  resp.writeHead(200, { "Content-Type": "application/pdf" });  
  
  // create pdf file  
  await createPdf();  
  
  // read created pdf file
  fs.readFile("example.pdf", (err, data) => {
      if (err) { 
       console.error(        
        "an error occurred while reading the pdf file content: ",
        err
      );      
      throw err;
    }    
    console.log("operation success!");

    resp.end(data);
  });
});

server.listen(PORT, HOST, (error) => {
  if (error) {
      console.log("Something wrong: ", error);    
      return;
  }  
  console.log(`server is listening on http://${HOST}:${PORT} ...`);
});

Copy after login

现在浏览器就可以读取到创建的pdf文件了

A brief analysis of creating a simple HTTP server using Node

8. 返回音频文件

思路依然是一样的，读取一个音频文件，然后通过管道将它送到resp对象中再返回即可

const { createServer } = require("http");
const { stat, createReadStream } = require("fs");
const HOST = "localhost";
const PORT = 8080;

const server = createServer((req, resp) => {
  // change the MIME type to audio/mpe
  resp.writeHead(200, { "Content-Type": "audio/mp3" });  
  const mp3FileName = "audio.mp3";

  stat(mp3FileName, (err, stats) => {
    if (stats.isFile()) {      
      const rs = createReadStream(mp3FileName);      
      
      // pipe the read stream to resp
      rs.pipe(resp);
    } else {
      resp.end("mp3 file not exists");
    }
  });
});

server.listen(PORT, HOST, (error) => {
  if (error) {    
  console.log("Something wrong: ", error);    
  return;
  }  
  console.log(`server is listening on http://${HOST}:${PORT} ...`);
});

Copy after login

效果如下

1A brief analysis of creating a simple HTTP server using Node

打开后就是一个播放音频的界面，这是chrome提供的对音频文件的展示，并且打开控制台会发现有返回音频文件

11-A brief analysis of creating a simple HTTP server using Node

注意：将音频文件流通过管道传到**resp**后，不需要调用**resp.end()**方法，因为这会关闭整个响应，导致音频文件无法获取

1A brief analysis of creating a simple HTTP server using Node

9. 返回视频文件

视频文件和音频文件的处理是一样的，只是MIME的类型要改成video/mp4，其他都一样

const { createServer } = require("http");
const { stat, createReadStream } = require("fs");
const HOST = "localhost";
const PORT = 8080;
const server = createServer((req, resp) => {  
// change the MIME type to audio/mpe
  resp.writeHead(200, { "Content-Type": "audio/mp4" });  
  const mp4FileName = "video.mp4";

  stat(mp4FileName, (err, stats) => { 
     if (stats.isFile()) {      
     const rs = createReadStream(mp4FileName);      
     // pipe the read stream to resp
      rs.pipe(resp);
    } else {
      resp.end("mp4 file not exists");
    }
  });
});

server.listen(PORT, HOST, (error) => { 
 if (error) {    
 console.log("Something wrong: ", error);    
 return;
  }  
  console.log(`server is listening on http://${HOST}:${PORT} ...`);
});

Copy after login

A brief analysis of creating a simple HTTP server using Node

总结

我们学会了：

如何使用Node创建一个http服务器
给js加上类型提示
如何返回字符串响应体
如何返回html
如何返回JSON
如何生成并返回pdf文件
如何返回音频文件
如何返回视频文件

虽然内容简单，但还是希望你能跟着动手敲一敲，不要以为简单就看看就算了，看了不代表会了，真正动手实现过后才会找到自己的问题

更多node相关知识，请访问：nodejs 教程！

The above is the detailed content of A brief analysis of creating a simple HTTP server using Node. For more information, please follow other related articles on the PHP Chinese website!