摘要：單頁架構(gòu)方案當(dāng)下雖然很時(shí)髦，不過大多數(shù)的網(wǎng)站依舊選擇多頁或者單頁多頁的混合架構(gòu)。在正式環(huán)境中直接配置進(jìn)行轉(zhuǎn)發(fā)補(bǔ)充本文拋磚引玉簡單搭建了一個(gè)前后端分離框架，但還有很多不完善的地方。

SPA（單頁架構(gòu)）方案當(dāng)下雖然很時(shí)髦，不過大多數(shù)的網(wǎng)站依舊選擇多頁或者單頁+多頁的混合架構(gòu)。使用 express, webpack 本文低成本的實(shí)現(xiàn)了包含多頁架構(gòu)，自動(dòng)刷新，前后端分離 等概念

git repo
node-pages-webpack-hot

開發(fā)

 npm install
 npm install supervisor -g
 npm run start # 開發(fā)環(huán)境，配置 hot reload
 npm run prod # 生產(chǎn)環(huán)境
 npm run build # 編譯前端生產(chǎn)環(huán)境

DEMO

FE目錄：

SERVER目錄：

為了不浪費(fèi)你的時(shí)間，在閱讀以下內(nèi)容時(shí)需要有：

express 基礎(chǔ)知識(shí)，以及對(duì) node 簡單了解

webpack 中級(jí)了解，本文采用 webpack2 實(shí)現(xiàn)

前端配置需要實(shí)現(xiàn)的功能點(diǎn)：

多頁架構(gòu)自動(dòng)生成 entry，并通過 html-webpack-plugin 生成每個(gè)頁面的模板，且選擇任意模板引擎需要實(shí)現(xiàn) layout 模板功能（本文使用swig作為模板引擎）

配置各種文件后綴的 loader

使用 HotModuleReplacementPlugin 實(shí)現(xiàn)修改自刷新

規(guī)定每個(gè)頁面必須有一個(gè)同名的 js 文件作為此頁面的 entry ，目錄深度可變，如下圖，分解為兩個(gè) entry：

為實(shí)現(xiàn)自動(dòng)化獲取，使用了 glob 獲取所有 .js 文件，并判斷是否有同名的 .html ，如果有則生成一個(gè) entry，如果是 dev 環(huán)境則多增加 hotMiddlewareScript 模塊

  // get all js files
  let files = glob.sync(config.src + "/**/*.js");
  let srcLength = config.src.length;

  let entrys = {};

  files.forEach(function (_file) {
    let file = path.parse(_file);
    let htmlFile = path.resolve(file.dir, file.name + "." + config.ext);

    // if has same name template file, it is a entry
    if (fs.existsSync(htmlFile)) {
      let pathIndex = file.dir.indexOf(config.src);

      if (config.dev == "dev") {
        entrys[config.staticRoot + file.dir.slice(srcLength) + "/" + file.name] = [path.resolve(_file), hotMiddlewareScript];
      } else {
        entrys[config.staticRoot + file.dir.slice(srcLength) + "/" + file.name] = path.resolve(_file);
      }
    }
  });

  return entrys;

生成一系列 HtmlWebpackPlugin 的要點(diǎn)如下：

獲取到所有的 .html 后，判斷是否有對(duì)應(yīng)的 entry 文件，若有則創(chuàng)建 HtmlWebpackPlugin

如果頁面為 layout 模板，則需要多注入由 CommonsChunkPlugin 生成的 common 模塊

自動(dòng)生成 HtmlWebpackPlugin 代碼如下：

  let htmls = [];

  // get all templates
  let files = glob.sync(config.src + "/**/*." + config.ext);
  let srcLength = config.src.length;

  files.forEach(function (_file) {
    let file = path.parse(_file);

    let chunks = [];
    let chunkName = config.staticRoot + file.dir.slice(srcLength) + "/" + file.name;

    // if has same name entry, create a html plugin
    let c = entrys[chunkName];
    c && chunks.push(chunkName);

    // layout will contains common chunk
    if (file.name == config.serverLayoutName) {
      chunks.push(config.staticRoot + "/common");
    }

    let plugin = new HtmlWebpackPlugin({
      filename: config.templateRoot + file.dir.slice(srcLength) + "/" + file.base,
      template: path.resolve(file.dir, file.base),
      chunks: chunks,
      inject: false
    });

    htmls.push(plugin);
  });

  return htmls;

由于引入了模板 extends 支持，需設(shè)置 inject=false 便不會(huì)自動(dòng)注入 assets 文件

編寫 webpack 插件，將頁面的 js assets, css assets 分別注入到：


兩個(gè)替換文案處，例如頁面模板：

{% extends "../base/base.html" %}

{% block title %}My Page{% endblock %}

{% block style %}{%endblock%}

{% block head %}
  {% parent %}
{% endblock %}

{% block content %}
This is just an home page?。。?/p>


  clouds


link page2
{% endblock %}

{% block script %}{%endblock%}

編譯后替換后為：

{% extends "../base/base.html" %}

{% block title %}My Page{% endblock %}

{% block style %}{%endblock%}

{% block head %}
  {% parent %}
{% endblock %}

{% block content %}
This is just an home page?。?！


  clouds


link page2
{% endblock %}

{% block script %}{%endblock%}

在 dev 環(huán)境下由于配置了 webpack-hot-middleware 所以不能對(duì) css 進(jìn)行提取，否則無法熱更新

樣式相關(guān)的 loader 配置如下：

var extractInstance = new ExtractTextPlugin("[name].css");

if (config.env == "dev") {
    var stylusLoader = [
      {
        loader: "style-loader"
      },
      {
        loader: "css-loader"
      },
      {
        loader: "stylus-loader"
      }
    ];

    var cssLoader = [
      {
        loader: "style-loader"
      },
      {
        loader: "css-loader"
      }
    ];
  } else {
    var stylusLoader = extractInstance.extract(["css-loader", "stylus-loader"]);
    var cssLoader = extractInstance.extract(["css-loader"]);
  }

并將所有的 loader 放到同一個(gè)文件進(jìn)行維護(hù)：

  var rules = [
    {
      test: /.styl$/,
      exclude: /node_modules/,
      use: stylusLoader
    },
    {
      test: /.css$/,
      exclude: /node_modules/,
      use: cssLoader
    },
    {
      test: /.html$/,
      use: {
        loader: "html-loader",
        options: {
          minimize: false
        }
      }
    },
    ......
    ......
  ]

對(duì)生成模板，靜態(tài)文件輸出目錄進(jìn)行統(tǒng)一控制，便于結(jié)合各種后端架構(gòu)

const port = process.env.PORT || 8080;
const env = process.env.NODE_ENV || "dev";

const CONFIG_BUILD = {
  env: env,
  ext: "html", // tempate ext
  src: path.resolve(__dirname, "../src"), // source code path
  path: env == "dev" ? "/" : path.resolve(__dirname, "../dist"), // base output path
  templateRoot: "templates", // tempate output path
  staticRoot: "static", // static output path
  serverLayoutName: "base", // swig layout name , only one file
  publicPath: env == "dev" ? ("http://localhost:" + port + "/") : "/"
}

server 端搭建了 express 服務(wù)，實(shí)現(xiàn)的功能點(diǎn)如下：

使用 webpack-dev-middleware 進(jìn)行 webpack 編譯

使用 webpack-hot-middleware 實(shí)現(xiàn) hot reload

使用 supervisor 服務(wù)監(jiān)聽 node 文件改動(dòng)并自動(dòng)重啟

render 模板時(shí)將內(nèi)存中的文件寫入硬盤，以進(jìn)行渲染

生成 webpack 的 compiler

  var webpack = require("webpack"),
    webpackDevConfig = require(path.resolve(config.root, "./fe/webpack.config.js"));

  var compiler = webpack(webpackDevConfig);

將 compiler 作為 express 的中間件

  // attach to the compiler & the server
  app.use(webpackDevMiddleware(compiler, {
    // public path should be the same with webpack config
    publicPath: webpackDevConfig.output.publicPath,
    noInfo: false,
    stats: {
      colors: true
    }
  }));

其中 publicPath 指明了 assets 請(qǐng)求的根路徑，這里配置的是：http://localhost:8080/

js、css 的自刷新通過配置 webpack-hot-middleware 實(shí)現(xiàn)（fe 也需進(jìn)行相應(yīng)的配置）

  // server
  const webpackHotMiddleware = require("webpack-hot-middleware");
  app.use(webpackHotMiddleware(compiler));
  // fe
  webpackPlugins.push(
    new webpack.HotModuleReplacementPlugin()
  );

node 文件修改通過配置 supervisor 服務(wù)實(shí)現(xiàn)自動(dòng)刷新

安裝服務(wù)：

npm install supervisor -g

配置啟動(dòng)參數(shù)：

// package.json
"scripts": {
  "start": "cross-env NODE_ENV=dev supervisor -w server -e fe server/server.js"
}

supervisor 監(jiān)聽了 server 文件夾下所有的改動(dòng)，改動(dòng)后重啟 express服務(wù)。
想要實(shí)現(xiàn)瀏覽器自動(dòng)刷新，需要在 layout 模板加入如下代碼：

  {% if env == "dev" %}
    
  {% endif %}

當(dāng) webpack 作為 express 中間件時(shí)，生成的所有文件都存在內(nèi)存中，當(dāng)然也包括由 html-webpack-plugin 生成的模板文件。
然而 express 的 render 函數(shù)只能指定一個(gè)存在于文件系統(tǒng)中的模板， 即dev 環(huán)境下 render 模板前需要將其從內(nèi)存中取得并存放到文件系統(tǒng)中。

module.exports = (res, template) => {
  if (config.env == "dev") {
    let filename = compiler.outputPath + template;
    // load template from 
    compiler.outputFileSystem.readFile(filename, function(err, result) {
      let fileInfo = path.parse(path.join(config.templateRoot, filename));


      mkdirp(fileInfo.dir, () => {
        fs.writeFileSync(path.join(config.templateRoot, filename), result);

        res.render(template);
      });
    });
  } else {
    res.render(template);
  }
}

layout 模板的存儲(chǔ)需要一個(gè)中間件：

  app.use((req, res, next) => {
    let layoutPath = path.join(config.templateRoot, config.layoutTemplate);
    let filename = compiler.outputPath + config.layoutTemplate;

    compiler.outputFileSystem.readFile(filename, function(err, result) {
      let fileInfoLayout = path.parse(layoutPath);

      mkdirp(fileInfoLayout.dir, () => {
        fs.writeFileSync(layoutPath, result);
        next();
      });
    });
  });

其余的均為 express 基礎(chǔ)使用，參閱文檔即可

在dev環(huán)境時(shí)使用 http-proxy-middleware 對(duì)后端接口進(jìn)行代理：

  // set proxy
  app.use("/api", proxy({target: config.proxy, changeOrigin: true}));

所有 /api 的請(qǐng)求都會(huì)代理到 config.proxy 配置的 ip 端口。

在正式環(huán)境中直接配置 nginx 進(jìn)行轉(zhuǎn)發(fā)

本文拋磚引玉簡單搭建了一個(gè)前后端分離框架，但還有很多不完善的地方。真實(shí)的線上應(yīng)用還需要考慮 nodejs 運(yùn)維成本，日志，監(jiān)控等等。