Express服務(wù)器端代碼熱加載的實(shí)現(xiàn)代碼

更新時(shí)間：2024年01月29日 08:27:35 作者：forhot2000

這篇文章主要介紹了Express服務(wù)器端代碼熱加載的實(shí)現(xiàn)，文中通過(guò)代碼示例給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下

創(chuàng)建項(xiàng)目

首先，創(chuàng)建一個(gè) express 的創(chuàng)建項(xiàng)目

mkdir your-project
cd your-project
npm init -y
npm install --save express

添加 src/main.js

// ./src/main.js
const express = require('express');

function bootstrap() {
  const app = express();

  app.all('*', (req, res) => {
    res.send(`hello, world!\n`);
  });

  app.listen(3000, function () {
    console.log('listen on http://localhost:3000');
  });
}

bootstrap();

修改 package.json，增加 start 命令

{
  ...
  "scripts": {
    "start": "node src/main.js"
  },
  ...
}

啟動(dòng)服務(wù)

npm run start

OK，這就啟動(dòng)了一個(gè)基本的 express app 了。

但是，每次修改代碼后，都需要手動(dòng)重新啟動(dòng)服務(wù)，對(duì)于開(kāi)發(fā)來(lái)說(shuō)，這是個(gè)非常煩人的工作，下面讓我們一步一步來(lái)優(yōu)化它。

使用 nodemon 自動(dòng)重啟

使用 nodemon 檢測(cè)文件變動(dòng)，重啟服務(wù)，這種方式很簡(jiǎn)單，不需要修改現(xiàn)有代碼。

安裝 nodemon

npm install --save-dev nodemon

修改 package.json，增加 dev 命令，使用 nodemon 啟動(dòng)，其它都不用改

{
  ...
  "scripts": {
    "dev": "nodemon src/main.js",
    "start": "node src/main.js"
  }
  ...
}

配置好后，使用 npm run dev 啟動(dòng)服務(wù)，nodemon 會(huì)檢測(cè)文件改動(dòng)自動(dòng)重啟服務(wù)器，這樣你不用再頻繁的重啟服務(wù)，歡快地去寫(xiě)代碼了。

如果你需要排除一些文件的監(jiān)控，比如僅檢測(cè) src 目錄下的 js 文件，并忽略測(cè)試代碼，可以添加 nodemon 的配置文件 nodemon.json

{
  "watch": ["src/"],
  "ext": "js",
  "ignore": ["*.test.js", "*.spec.js"]
}

如上所示，nodemon 的使用非常簡(jiǎn)單，配合 ts-node 它還能支持 typescript，已經(jīng)能滿(mǎn)足大多數(shù)用戶(hù)的使用場(chǎng)景了。

不過(guò)，當(dāng)項(xiàng)目變的越來(lái)越大，每次改動(dòng)一個(gè)地方就重新啟動(dòng)服務(wù)就變得有點(diǎn)麻煩了。

使用 webpack HMR 實(shí)現(xiàn)模塊熱加載

webpack 的 HMR 功能會(huì)通知到哪些文件發(fā)生了變化需要重新加載，這個(gè)功能被廣泛用在前端開(kāi)發(fā)框架中，修改代碼后立即刷新頁(yè)面，其實(shí)它也還可以被用在服務(wù)器端代碼的加載過(guò)程中，讓我們來(lái)看看如何實(shí)現(xiàn)。

首先，添加依賴(lài)包

npm install --save-dev webpack webpack-cli webpack-node-externals run-script-webpack-plugin rimraf

添加兩個(gè)新文件，用來(lái)測(cè)試熱加載

// ./src/count.js
let n = 0;

export function inc() {
  n++;
  return n;
}

// ./src/hello.js
export function greet(name = 'World') {
  return `Hello, ${name}!`;
}

修改 src/main.js，引入上面的文件，并添加響應(yīng)熱加載的代碼，由于使用了 webpack，現(xiàn)在可以在代碼中使用 ES6 的 import 了，改動(dòng)后的 main.js 代碼如下：

// ./src/main.js
import express from 'express';
import { createServer } from 'http';
import { inc } from './count';
import { greet } from './hello';

function bootstrap() {
  const app = express();

  // 默認(rèn)情況下 express 會(huì)自動(dòng)創(chuàng)建 server，這里手動(dòng)創(chuàng)建 server 
  // 是為了在后面調(diào)用 server.close() 關(guān)閉舊的服務(wù)
  const server = createServer(app);

  app.all('*', (req, res) => {
    const n = inc();
    res.send(`${n}: ${greet('bob')}\n`);
  });

  server.listen(3000, function () {
    console.log('listen on http://localhost:3000');
  });

  if (module.hot) {
    module.hot.accept();
    module.hot.dispose(() => server.close());
  }
}

bootstrap();

修改 package.json

{
  ...
  "scripts": {
    "dev": "rimraf dist && webpack --config webpack-hmr.config.js --watch",
    "build": "rimraf dist && webpack --config webpack.config.js",
    "start": "node dist/server.js"
  },
  ...
}

添加 build 的 webpack 配置文件 webpack.config.js

// ./webpack.config.js
const path = require('path');
const nodeExternals = require('webpack-node-externals');

module.exports = {
  mode: 'production',
  entry: ['./src/main.js'],
  target: 'node',
  externals: [nodeExternals()],
  resolve: {
    extensions: ['.js'],
  },
  output: {
    path: path.join(__dirname, 'dist'),
    filename: 'server.js',
  },
};

添加 dev 的 webpack 配置文件 webpack-hmr.config.js

// ./webpack-hmr.config.js
const webpack = require('webpack');
const path = require('path');
const nodeExternals = require('webpack-node-externals');
const { RunScriptWebpackPlugin } = require('run-script-webpack-plugin');

module.exports = {
  mode: 'development',
  entry: ['webpack/hot/poll?100', './src/main.js'],
  target: 'node',
  externals: [
    nodeExternals({
      allowlist: ['webpack/hot/poll?100'],
    }),
  ],
  resolve: {
    extensions: ['.js'],
  },
  plugins: [
    new webpack.HotModuleReplacementPlugin(),
    new RunScriptWebpackPlugin({ name: 'server.js', autoRestart: false }),
  ],
  output: {
    path: path.join(__dirname, 'dist'),
    filename: 'server.js',
  },
};

開(kāi)發(fā)模式下，我們使用 npm run dev 啟動(dòng)服務(wù)，啟用熱加載功能。

接下來(lái)，我們來(lái)測(cè)試一下熱加載

curl http://localhost:3000/

輸出

1: Hello, boy!

當(dāng)我們修改 main.js 后，服務(wù)器端僅需要重新編譯并加載 main.js 一個(gè)文件

...
asset server.js 46.1 KiB [emitted] (name: main)
asset main.44ac5c7bc9372be2efa5.hot-update.js 2.58 KiB [emitted] [immutable] [hmr] (name: main)
asset main.44ac5c7bc9372be2efa5.hot-update.json 28 bytes [emitted] [immutable] [hmr]
Entrypoint main 48.7 KiB = server.js 46.1 KiB main.44ac5c7bc9372be2efa5.hot-update.js 2.58 KiB
runtime modules 23.5 KiB 9 modules
cached modules 4.69 KiB [cached] 7 modules
./src/main.js 677 bytes [built] [code generated]
webpack 5.89.0 compiled successfully in 32 ms
[HMR] Updated modules:
[HMR]  - ./src/main.js
[HMR] Update applied.
listen on http://localhost:3000/

再次訪問(wèn)服務(wù)

curl http://localhost:3000/

輸出

2: Hello, boy!

我們可以看到，count.js 中的計(jì)數(shù)并沒(méi)有重置

再試下修改 hello.js，webpack 會(huì)重新編譯并加載 hello.js，因?yàn)?nbsp;main.js 引用了 hello.js，所以雖然不會(huì)重新編譯 main.js，但是它也會(huì)被重新加載。

...
asset server.js 46.1 KiB [emitted] (name: main)
asset main.56dcdc90891aac75fe1c.hot-update.js 1.37 KiB [emitted] [immutable] [hmr] (name: main)
asset main.56dcdc90891aac75fe1c.hot-update.json 28 bytes [emitted] [immutable] [hmr]
Entrypoint main 47.5 KiB = server.js 46.1 KiB main.56dcdc90891aac75fe1c.hot-update.js 1.37 KiB
runtime modules 23.5 KiB 9 modules
cached modules 5.28 KiB [cached] 7 modules
./src/hello.js 72 bytes [built] [code generated]
webpack 5.89.0 compiled successfully in 65 ms
[HMR] Updated modules:
[HMR]  - ./src/hello.js
[HMR]  - ./src/main.js
[HMR] Update applied.
listen on http://localhost:3000/

再次訪問(wèn)服務(wù)

curl http://localhost:3000/

輸出

3: Hello, boy!

可以看到，count.js 中的計(jì)數(shù)任然沒(méi)有被重置，說(shuō)明只要不修改 count.js 及其依賴(lài)項(xiàng)，count.js 就不會(huì)被重新加載。

發(fā)布到生產(chǎn)環(huán)境

生產(chǎn)環(huán)境下，我們不需要熱加載功能，那么我們可以運(yùn)行 npm run build 構(gòu)建代碼，然后再運(yùn)行 npm start，使用構(gòu)建后的代碼啟動(dòng)服務(wù)，這樣優(yōu)先保證線上環(huán)境的性能。

動(dòng)態(tài)加載目錄的問(wèn)題

另外還有一個(gè)常見(jiàn)的問(wèn)題，有時(shí)候我們需要?jiǎng)討B(tài)的加載某個(gè)目錄下的所有文件，這個(gè)可以用 await import 來(lái)加載模塊來(lái)完成。

讓我們來(lái)改一下 main.js，將 bootstrap 改成 async 方法，再增加一個(gè) loadControllers 方法

// ./src/main.js
// ...
import { readdir } from 'fs/promises';
import { resolve } from 'path';

async function bootstrap() {
  // ...
  const server = createServer(app);

  // 動(dòng)態(tài)加載 controllers 目錄下的所有文件
  await loadControllers(app);

  app.all('*', (req, res) => { /* ... */ });
  //...
}

async function loadControllers(app) {
  try {
    // 注意，這里應(yīng)該是掃描 src 目錄，而不是 dist 目錄
    const files = await readdir(resolve('./src/controllers'));
    for (let i = 0; i < files.length; i++) {
      const file = files[i];
      const name = file.substring(0, file.length - 3); // remove ext '.js'
      const module = await import('./controllers/' + name);
      app.use(`/${name}`, module.default);
    }
  } catch (err) {
    console.error(err);
  }
}

bootstrap();

提示

遍歷目錄文件的時(shí)候需要使用源文件的目錄，而不能使用文件的相對(duì)目錄

錯(cuò)誤的代碼

// 編譯后的代碼會(huì)提示找不到目錄 ./dist/controllers 
readdir(path.join(__dirname, 'controllers'));

正確的代碼

readdir(path.resolve('./src/controllers'));

再添加一個(gè) controller 文件 src/controllers/posts.js

// ./src/controllers/posts.js
import { Router } from 'express';

const router = Router();

router.get('/', (req, res) => {
  res.send([
    {
      id: 1,
      title: 'post 1',
      content: 'content of the post',
    },
  ]);
});

export default router;

測(cè)試下新加的 controller

curl http://localhost:3000/posts

輸出

[{"id":1,"title":"post 1","content":"content of the post"}]

這種方式存在一個(gè)問(wèn)題，每次都要去掃描 src 目錄，導(dǎo)致部署的時(shí)候還需要將 src 目錄復(fù)制到服務(wù)器，而這些 src 目錄下的文件除了提供一個(gè) filename 就沒(méi)有其它作用了，我認(rèn)為這不是一個(gè)好的代碼。

如果要避免這種隱式的動(dòng)態(tài)加載，可以將它改成如下代碼：

// 顯示聲明有哪些 controllers
const controllerNames = [
  'posts',
];

async function loadControllers(app) {
  const controllers = controllerNames.map((name) => ({ name }));
  for (let i = 0; i < controllers.length; i++) {
    const controller = controllers[i];
    try {
      const module = await import(`./controllers/${controller.name}`);
      controller.router = module.default;
    } catch (err) {
      // console.error(err);
    }
  }

  controllers.forEach(({ name, router }) => {
    if (router) {
      const path = `/${name}`;
      app.use(path, router);
      console.log(`mount controller '${name}' on '${path}'`);
    } else {
      console.error(`cannot find controller '${name}'`);
    }
  });
}

以上就是Express服務(wù)器端代碼熱加載的實(shí)現(xiàn)代碼的詳細(xì)內(nèi)容，更多關(guān)于Express代碼熱加載的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: