理解vue ssr原理，自己搭建簡單的ssr框架

wmui發表於2018-12-22
Vue框架

前言

大多數Vue專案要支援SSR應該是為了SEO考慮，畢竟對於WEB應用來說，搜尋引擎是一個很大的流量入口。Vue SSR現在已經比較成熟了，但是如果是把一個SPA應用改造成SSR應用，成本還是有些高的，這工作量無異於重構前端。另外對前端的技術要求也是挺高的，需要對Vue比較熟悉，還要有Node.js 和 webpack 的應用經驗。

引入

Vue是一個構建客戶端應用的框架，即vue元件是在瀏覽器中進行渲染的。所謂服務端渲染，指的是把vue元件在伺服器端渲染為組裝好的HTML字串，然後將它們直接傳送到瀏覽器，最後需要將這些靜態標記"啟用"為客戶端上完全可互動的應用程式。

服務端渲染的優點

  1. 更好的SEO，搜尋引擎爬蟲可以抓取渲染好的頁面

  2. 更快的內容到達時間（首屏載入更快），因為服務端只需要返回渲染好的HTML，這部分程式碼量很小的，所以使用者體驗更好

服務端渲染的缺點

  1. 首先就是開發成本比較高，比如某些宣告週期鉤子函式（如beforeCreate、created）能同時執行在服務端和客戶端，因此第三方庫要做特殊處理，才能在伺服器渲染應用程式中執行。

  2. 由於服務端渲染要用Nodejs做中間層，所以部署專案時，需要處於Node.js server執行環境。在高流量環境下，還要做好伺服器負載和快取策略

原理解析

先附上demo地址：github.com/wmui/vue-ss…

第一步：編寫entry-client.js和entry-server.js

entry-client.js只在瀏覽器環境下執行，所以需要顯示呼叫$mount方法，掛載DOM節點

import Vue from 'vue';
import App from './App.vue';
import createStore from './store/index.js';

function createApp() {
  const store = createStore();
  const app = new Vue({
      store,
      render: h => h(App)
  });
  return {app, store}
}

const { app, store } = createApp();

// 使用window.__INITIAL_STATE__中的資料替換整個state中的資料，這樣服務端渲染結束後，客戶端也可以自由操作state中的資料
if (window.__INITIAL_STATE__) {
  store.replaceState(window.__INITIAL_STATE__);
}

app.$mount('#app');

複製程式碼

entry-server.js需要匯出一個函式，在服務端渲染期間會被呼叫

import Vue from 'vue';
import App from './App.vue';
import createStore from './store/index.js';

export default function(context) {
  // context是上下文物件
  const store = createStore();
  let app = new Vue({
    store,
    render: h => h(App)
  });

  // 找到所有 asyncData 方法
  let components = App.components;
  let asyncDataArr = []; // promise集合
  for (let key in components) {
    if (!components.hasOwnProperty(key)) continue;
    let component = components[key];
    if (component.asyncData) {
      asyncDataArr.push(component.asyncData({store})) // 把store傳給asyncData
    }
  }
  // 所有請求並行執行
  return Promise.all(asyncDataArr).then(() => {
    // context.state 賦值成什麼，window.__INITIAL_STATE__ 就是什麼
    // 這下你應該明白entry-client.js中window.__INITIAL_STATE__是哪來的了，它是在服務端渲染期間被新增進上下文的
    context.state = store.state;
    return app;
  });
};
複製程式碼

上面的asyncData是幹嘛用的？其實，這個函式是專門請求資料用的，你可能會問請求資料為什麼不在beforeCreate或者created中完成，還要專門定義一個函式？雖然beforeCreate和created在服務端也會被執行（其他周期函式只會在客戶端執行），但是我們都知道請求是非同步的，這就導致請求發出後，資料還沒返回，渲染就已經結束了，所以無法把 Ajax 返回的資料也一併渲染出來。因此需要想個辦法，等到所有資料都返回後再渲染元件

asyncData需要返回一個promise，這樣就可以等到所有請求都完成後再渲染元件。下面是在foo組價中使用asyncData的示例，在這裡完成資料的請求

export default {
  asyncData: function({store}) {
    return store.dispatch('GET_ARTICLE') // 返回promise
  },
  computed: {
    article() {
      return this.$store.state.article
    }
  }
}
複製程式碼

第二步：配置webpack

webpack配置比較簡單，但是也需要針對client和server端單獨配置

webpack.client.conf.js顯然是用來打包客戶端應用的

module.exports = merge(base, {
  entry: {
    client: path.join(__dirname, '../entry-client.js')
  }
});
複製程式碼

webpack.server.conf.js用來打包服務端應用，這裡需要指定node環境

module.exports = merge(base, {
  target: 'node', // 指定是node環境
  entry: {
    server: path.join(__dirname, '../entry-server.js')
  },
  output: {
    filename: '[name].js', // server.js
    libraryTarget: 'commonjs2' // 必須按照 commonjs規範打包才能被伺服器呼叫。
  },
  plugins: [
    new HtmlWebpackPlugin({
      template: path.join(__dirname, '../index.ssr.html'),
      filename: 'index.ssr.html',
      files: {
        js: 'client.js'
      }, // client.js需要在html中引入
      excludeChunks: ['server'] // server.js只在服務端執行，所以不能打包到html中
    })
  ]
});
複製程式碼

第三步：啟動服務

打包完成後就可以啟動服務了，在start.js中我們需要把server.js載入進來，然後通過renderToString方法把渲染好的html返回給瀏覽器

const bundle = fs.readFileSync(path.resolve(__dirname, 'dist/server.js'), 'utf-8');
const renderer = require('vue-server-renderer').createBundleRenderer(bundle, {
  template: fs.readFileSync(path.resolve(__dirname, 'dist/index.ssr.html'), 'utf-8') // 服務端渲染資料
});


server.get('*', (req, res) => {
  renderer.renderToString((err, html) => {
    // console.log(html)
    if (err) {
      console.error(err);
      res.status(500).end('伺服器內部錯誤');
      return;
    }
    res.end(html);
  })
});

複製程式碼

效果圖

demo已經上傳到github： github.com/wmui/vue-ss…

理解vue ssr原理，自己搭建簡單的ssr框架

結語

個人實踐Vue SSR已有一段時間，發現要想搭建一套完整的 SSR 服務框架還是很有挑戰的，或許 Nuxt 是一個不錯的選擇，對 Nuxt 感興趣的朋友可以參考我的一個開源小作品Essay

以上，感謝閱讀！

相關文章