Node.js 学习 ｜ 青训营笔记

这是我参与「第五届青训营 」伴学笔记创作活动的第 1 天

Node.js 课程笔记

Node.js 的应用场景

前端工程化

• Bundle：webpack，vite，esbuild，parcel
• Uglify：uglifyjs
• Transpile：babeljs，typescript
• 其他语言加入竞争：esbuild，parcel，prisma
• 现状：难以替代

Web 服务端应用

• 学习曲线平缓，开发效率较高
• 运行效率接近常见的编译语言
• 社区生态丰富及工具链成熟（npm，V8 inspector）
• 与前端结合的场景会有优势（SSR）
• 现状：竞争激烈，Node.js 有自己独特的优势

Electron 跨端桌面应用

• 商业应用：vscode，lack，discord，zoom
• 大型公司内的效率工具
• 现状：大部分场景在选型时，都值得考虑

Node.js 在字节

• BFF 应用、SSR 应用，举例：Modern.js
• 服务端应用，举例：头条搜索，西瓜视频，懂车帝
• Electron 应用：飞连，飞书
• 每年新增 1000+ Node.js 应用，生态发展迅猛

Node.js 运行时结构

运行时结构

V8，libuv

• V8：JavaScript Runtime，诊断调试工具（inspector）
• libuv：eventloop（事件循环），syscall（系统调用）
• 举例：用 node-fetch 发起请求时...

特点

• 异步 I/O

  setTimeout(() => {
      console.log('B')
  })
  console. Log('A')
  

• 单线程

  function fibonacci(num: number): number {
      if (num === 1 || num === 2) (
          return 1;
      }
      return fibonacci(num - 1) + fibonacci(num - 2);
  }
  fibonacci(42)
  fibonacci(43)
  

• 跨平台

  const net = require('net' )
  const socket = new net.Socket('/tmp/scoket.sock')
  

异步 IO

当 Node.js 执行 IO 操作时，会在响应返回后恢复操作，而不是阻塞线程并占用额外内存等待

单线程

• JS 单线程

  实际：JS 线程 + uv 线程 + V8 任务线程池 + V8 Inspector 线程

• 优点：不用考虑多线程状态同步问题，也就不需要锁;同时还能比较高效地利用系统资源

• 缺点：阻塞会产生更多负面影响

  解决办法：多进程或多线程

跨平台

• 跨平台（大部分功能、api）

• Node.js 跨平台 + JS 无需编译环境（+ Web 跨平台 + 诊断工具跨平台）

  = 开发成本低（大部分场景无需担心跨平台问题），整体学习成本低

编写 Http Server

安装 Node.js

Mac，Linux 推荐使用 nvm 安装；Windows 推荐使用 nvm4w 或者官方安装包。

如果遇到安装失败或者安装慢的问题，可以设置安装源解决

NVM_NODEJS_ORG_MIRROR=https://npmmirror.com/mirrors/node nvm install 16

编写 Http Server

Hello World

const http = require('http')
​
const port = 3000
​
const server = http.createServer((req, res) => {
    res.end('hello')
})
​
server.listen(port, () => {
    console.log(`server listens on: $[port}`)
})

JSON

http_server_json.js

const http = require('http')
​
const port = 3000
​
const server = http.createServer((req, res) => {
    const bufs = []
    req.on('data', data => {
        bufs.push(data)
    })
    req.on('end', () => {
        let reqData = {}
        try{
            reqData = JSON.parse(Buffer.concat(bufs).toString())
        } catch (err) {
            // receive invalid json data
        }
        res.setHeader('Content-Type', 'application/json')
        res.end(JSON.stringify({
            echo: reqData.msg || 'Hello',
        }))
    })
})
​
server.listen(port, () => {
    console.log(`server listens on: $[port}`)
})

http_client.js

const http = require('http')
​
const body = JSON.stringify({
    msg: 'Hello from my own client',
})
​
const req = http.request('http://127.0.0.1:3000', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
    },
}, (res) => {
    const bufs = []
    res.on('data', data => {
        bufs.push(data)
    })
    res.on('end', () => {
        const receive = JSON.parse(Buffer.concat(bufs).toString())
        console.log('json.msg is：', receive)
    })
})
​
req.end(body)

同时运行 http_server_json.js 和 http_client.js，客户端即可接收到从服务端传回的 JSON 数据。

Promisify

用 Promise + async await 重写以上两个例子

技巧：将 callback 转换成 promise

function wait(t) {
    return new Promise((resolve, reject) => {
        setTimeout(() => {
            resolve()
        }, t)
    })
}
wait(1000).then(() => { console.log('get called') })

使用 Promise 改写 http_server_json.js ：

const http = require('http')
​
const port = 3000
​
const server = http.createServer(async (req, res) => {
    const msg = await new Promise((resolve, reject) => {
        const bufs = []
        req.on('data', data => {
            bufs.push(data)
        })
        req.on('error', (err) => {
            reject(err)
        })
        req.on('end', () => {
​
            reqData = JSON.parse(Buffer.concat(bufs).toString('utf8'))
            let msg = 'hello'
            try {
                const ret = JSON.parse(buf)
                msg = ret.msg
            } catch (err) {
                // receive invalid json data
            }
​
            resolve(msg)
        })
    })
​
    const responseJson = {
        msg: `receive: ${msg}`
    }
    res.setHeader('Content-Type', 'application/json')
    res.end(JSON.stringify(responseJson))
})
​
server.listen(port, () => {
    console.log(`server listens on: $[port}`)
})

静态文件

编写一个简单的静态文件服务：

static_server.js

const http = require('http')
const fs = require('fs')
const path = require('path')
const url = require('url')
​
const port = 3000
​
const server = http.createServer((req, res) => {
    // expected http://127.0.0.1:3000/index.html?abc=10
    const info = url.parse(req.url)
​
    // static/index.html
    const file = fs.createReadStream(path.resolve(__dirname, './static/' + info.path))
    file.pipe(res)
})
​
server.listen(port, () => {
    console.log(`server listens on: ${port}`)
})

运行 static_server.js 脚本，在浏览器访问 http://localhost:3000/index.html 即可收到 static 目录下的 index.html 文件。

React SSR

SSR（server side rendering）特点：

• 相比传统 HTML 模版引擎：避免重复编写代码
• 相比 SPA (single page application)：首屏渲染更快，SEO 友好

SSR 缺点：

• 通常 qps 较低，前端代码编写时需要考虑服务端染情况

HTML 例子：

const http = require('http')
​
const port = 3000
​
const server = http.createServer((req, res) => {
    res.setHeader('Content-Type', 'text/html')
    res.end(`
    <DOCTYPE html>
    <html>
        <head>
            <title>My App</title>
        </head>
        <body>
            <h1>My App</h1>
        </body>
    </html>
    `)
})
​
​
server.listen(port, () => {
    console.log('server listens on: ${port}')
})

替换为 React：

const http = require('http')
const React = require('react')
const ReactDOMServer = require('react-dom/server')
​
function App() {
    return React.createElement('h1', {
        children: 'Hello',
    })
}
​
const port = 3000
​
const server = http.createServer((req, res) => {
    res.setHeader('Content-Type', 'text/html')
    res.end(`
    <!DOCTYPE html>
    <html>
        <head>
            <title>My App</title>
        </head>
        <body>
            <div id="main">
            ${ReactDOMServer.renderToString(React.createElement(App))}
            </div>
        </body>
    </html>
    `)
})
server.listen(port, () => {
    console.log('server listens on: ${port}')
})

SSR 难点：

1. 需要处理打包代码
2. 需要思考前端代码在服务端运行时的逻辑
3. 移除对服务端无意义的副作用，或重置环境

Debug

• V8 Inspector: 开箱即用、特性丰富强大、与前端开发一致、跨平台

  • node --inspect
  • open http://localhost:9229/json

• 场景：

  • 查看 console.log 内容
  • breakpoint
  • 高 CPU、死循环：cpuprofile
  • 高内存占用：heapsnapshot
  • 性能分析

部署

• 部署要解决的问题

  • 守护进程：当进程退出时，重新拉起
  • 多进程：cluster 便捷地利用多进程
  • 记录进程状态，用于诊断

• 容器环境

  • 通常有健康检查的手段，只需考虑多核 cpu 利用率即可

延伸话题

Node.js 贡献代码

• 快速了解 Node.js 代码

  • Node.js Core 贡献入门

• 好处：

  • 从使用者的角色逐步理解底层细节，可以解决更复杂的问题；
  • 自我证明，有助于职业发展；
  • 解决社区问题，促进社区发展；

• 难点：

  • 费时间

编译 Node.js

• 为什么要学习编译 Node.js

  • 认知：黑盒到白盒，发生问题时能有迹可循
  • 贡献代码的第一步

• 如何编译

  • 参考: Maintaining the build files
  • ./configure && make install
  • 演示：给 net 模块添加自定义属性

诊断/追踪

• 诊断是一个低频、重要同时也相当有挑战的方向。是企业衡量自己能否依赖一门语言的重要参考

• 技术咨询行业中的热门角色

• 难点：

  • 需要了解 Node.js 底层，需要了解操作系统以及各种工具
  • 需要经验

WASM，NAPI

• Node.js (因为 V8) 是执行 WASM 代码的天然容器，和浏览器 WASM 是同一运行时，同时 Node.js 支持 WASI
• NAPI 执行 C 接口的代码（C/C++/Rust...），同时能保留原生代码的性能
• 不同编程语言间通信的一种方案