最新文章專題視頻專題問答1問答10問答100問答1000問答2000關(guān)鍵字專題1關(guān)鍵字專題50關(guān)鍵字專題500關(guān)鍵字專題1500TAG最新視頻文章推薦1 推薦3 推薦5 推薦7 推薦9 推薦11 推薦13 推薦15 推薦17 推薦19 推薦21 推薦23 推薦25 推薦27 推薦29 推薦31 推薦33 推薦35 推薦37視頻文章20視頻文章30視頻文章40視頻文章50視頻文章60 視頻文章70視頻文章80視頻文章90視頻文章100視頻文章120視頻文章140 視頻2關(guān)鍵字專題關(guān)鍵字專題tag2tag3文章專題文章專題2文章索引1文章索引2文章索引3文章索引4文章索引5123456789101112131415文章專題3
問答文章1 問答文章501 問答文章1001 問答文章1501 問答文章2001 問答文章2501 問答文章3001 問答文章3501 問答文章4001 問答文章4501 問答文章5001 問答文章5501 問答文章6001 問答文章6501 問答文章7001 問答文章7501 問答文章8001 問答文章8501 問答文章9001 問答文章9501
當前位置: 首頁 - 科技 - 知識百科 - 正文

通過vue-cli3構(gòu)建一個SSR應用程序的方法

來源:懂視網(wǎng) 責編:小采 時間:2020-11-27 22:07:47
文檔

通過vue-cli3構(gòu)建一個SSR應用程序的方法

通過vue-cli3構(gòu)建一個SSR應用程序的方法:1、前沿 1.1、什么是SSR SSR(服務端渲染)顧名思義就是將頁面在服務端渲染完成后在客戶端直接展示。 1.2、客戶端渲染與服務端渲染的區(qū)別 傳統(tǒng)的SPA模式 即客戶端渲染的模式 Vue.js構(gòu)建的應用程序,默認情況下是有一個html模板頁,然后通過webpac
推薦度:
導讀通過vue-cli3構(gòu)建一個SSR應用程序的方法:1、前沿 1.1、什么是SSR SSR(服務端渲染)顧名思義就是將頁面在服務端渲染完成后在客戶端直接展示。 1.2、客戶端渲染與服務端渲染的區(qū)別 傳統(tǒng)的SPA模式 即客戶端渲染的模式 Vue.js構(gòu)建的應用程序,默認情況下是有一個html模板頁,然后通過webpac

1、前沿

1.1、什么是SSR

SSR(服務端渲染)顧名思義就是將頁面在服務端渲染完成后在客戶端直接展示。

1.2、客戶端渲染與服務端渲染的區(qū)別 傳統(tǒng)的SPA模式

即客戶端渲染的模式

  1. Vue.js構(gòu)建的應用程序,默認情況下是有一個html模板頁,然后通過webpack打包生成一堆js、css等等資源文件。然后塞到index.html中
  2. 用戶輸入url訪問頁面 -> 先得到一個html模板頁 -> 然后通過異步請求服務端數(shù)據(jù) -> 得到服務端的數(shù)據(jù) -> 渲染成局部頁面 -> 用戶

SSR模式

即服務端渲染模式

用戶輸入url訪問頁面 -> 服務端接收到請求 -> 將對應請求的數(shù)據(jù)渲染完一個網(wǎng)頁 -> 返回給用戶

 1.3、為什么要使用SSR呢?

ssr的好處官網(wǎng)已經(jīng)給出,最有意思的兩個優(yōu)點如下:

  1. 更有好的SEO。由于搜索引擎爬蟲抓取工具可以直接查看完全渲染的頁面。
  2. 更快的內(nèi)容到達時間(time-to-content)

1.4、SSR原理

這是vue.js官方的SSR原理介紹圖,從這張圖片,我們可以知道:我們需要通過Webpack打包生成兩份bundle文件:

  • Client Bundle,給瀏覽器用。和純Vue前端項目Bundle類似
  • Server Bundle,供服務端SSR使用,一個json文件
  • 不管你項目先前是什么樣子,是否是使用vue-cli生成的。都會有這個構(gòu)建改造過程。在構(gòu)建改造這里會用到 vue-server-renderer 庫,這里要注意的是 vue-server-renderer 版本要與Vue版本一樣。

     

    2、開始構(gòu)建基于vue-cli3 的SSR應用程序

    了解ssr原理后,來開始step by step搭建一個自己的SSR應用程序

    安裝vue-cli3

    全局安裝vue-cli腳手架

    npm install @vue/cli -g --registry=https://registry.npm.taobao.org

    創(chuàng)建一個vue項目

    vue create ssr-example 

    會進入到一個交互bash界面,按自己需要選擇

    一步一步回車,根據(jù)自己需要選擇

    運行項目

    npm run serve

    看到這個提示,說明成功了一半了,接下來進行后一半的改造。

    3、進行SSR改造

    3.1 安裝需要的包

    1. 安裝 vue-server-renderer
    2. 安裝 lodash.merge
    3. 安裝 webpack-node-externals
    4. 安裝 cross-env
    npm install vue-server-renderer lodash.merge webpack-node-externals cross-env --registry=https://registry.npm.taobao.org --save-dev

    3.2 在服務器中集成

    在項目根目錄下新建一個server.js

    安裝koa2

    npm install koa koa-static --save --registry=https://registry.npm.taobao.org

    在koa2集成ssr

    // server.js
    // 第 1 步:創(chuàng)建一個 Vue 實例
    const Vue = require("vue");
    
    const Koa = require("koa");
    const app = new Koa();
    // 第 2 步:創(chuàng)建一個 renderer
    const renderer = require("vue-server-renderer").createRenderer();
    
    
    // 第 3 步:添加一個中間件來處理所有請求
    app.use(async (ctx, next) => {
     const vm = new Vue({
     data: {
     title: "ssr example",
     url: ctx.url
     },
     template: `<div>訪問的 URL 是: {{ url }}</div>`
     });
     // 將 Vue 實例渲染為 HTML
     renderer.renderToString(vm, (err, html) => {
     if(err){
     res.status(500).end('Internal Server Error')
     return
     }
     ctx.body = html
     });
    });
    
    const port = 3000;
    app.listen(port, function() {
     console.log(`server started at localhost:${port}`);
    });

    運行server.js

    node server.js

    看到這個說明一個簡單的ssr構(gòu)建成功了。

    不過到目前為止,我們并沒有將客戶端的.vue文件通過服務端進行渲染,那么如何將前端的.vue文件與后端node進行結(jié)合呢?

    3.3 改造前端配置,以支持SSR

    1、修改源碼結(jié)構(gòu)

  • 在src目錄下新建兩個文件,一個 entry-client.js 僅運行于瀏覽器 一個 entry-server.js 僅運行于服務器
  • 修改main.js
  • main.js 是我們應用程序的「通用 entry」。在純客戶端應用程序中,我們將在此文件中創(chuàng)建根 Vue 實例,并直接掛載到 DOM。但是,對于服務器端渲染(SSR),責任轉(zhuǎn)移到純客戶端 entry 文件。app.js 簡單地使用 export 導出一個 createApp 函數(shù):

    // main.js
    import Vue from 'vue'
    import App from './App.vue'
    import { createRouter } from "./router";
    
    // 導出一個工廠函數(shù),用于創(chuàng)建新的
    // 應用程序、router 和 store 實例
    export function createApp () {
     const router = createRouter();
     const app = new Vue({
     router,
     // 根實例簡單的渲染應用程序組件。
     render: h => h(App)
     })
     return { app }
    }

    修改entry-client.js

    客戶端 entry 只需創(chuàng)建應用程序,并且將其掛載到 DOM 中

    import { createApp } from './app'
    
    // 客戶端特定引導邏輯……
    const { app } = createApp()
    
    // 這里假定 App.vue 模板中根元素具有 `id="app"`
    app.$mount('#app')

    修改entry-server.js

    服務器 entry 使用 default export 導出函數(shù),并在每次渲染中重復調(diào)用此函數(shù)。

    import { createApp } from "./main";
    
    export default context => {
     // 因為有可能會是異步路由鉤子函數(shù)或組件,所以我們將返回一個 Promise,
     // 以便服務器能夠等待所有的內(nèi)容在渲染前,
     // 就已經(jīng)準備就緒。
     return new Promise((resolve, reject) => {
     const { app, router, store } = createApp();
    
     // 設置服務器端 router 的位置
     router.push(context.url);
    
     // 等到 router 將可能的異步組件和鉤子函數(shù)解析完
     router.onReady(() => {
     const matchedComponents = router.getMatchedComponents();
     // 匹配不到的路由,執(zhí)行 reject 函數(shù),并返回 404
     if (!matchedComponents.length) {
     return reject({
     code: 404
     });
     }
     // Promise 應該 resolve 應用程序?qū)嵗?,以便它可以渲? resolve(app);
     }, reject);
     });
    };

    修改router.js

    import Vue from 'vue'
    import Router from 'vue-router'
    import Home from './views/Home.vue'
    
    Vue.use(Router)
    
    export function createRouter(){
     return new Router({
     mode: 'history', //一定要是history模式
     routes: [
     {
     path: '/',
     name: 'home',
     component: Home
     },
     {
     path: '/about',
     name: 'about',
     component: () => import(/* webpackChunkName: "about" */ './views/About.vue')
     }
     ]
     })
    }

    2、修改webpack配置

    在vue-cli3創(chuàng)建的vue項目,已經(jīng)沒有了之前的webpack.base.conf.js、webpack.dev.conf.js、webpack.prod.conf.js。那么如何進行webpack的配置呢?

    在vue-cli官網(wǎng)上也說明了如何使用。 調(diào)整 webpack 配置最簡單的方式就是在 vue.config.js 中的 configureWebpack 選項提供一個對象,該對象將會被 webpack-merge 合并入最終的 webpack 配置。

    在項目根目錄下,新建一個vue.config.js

    // vue.config.js
    
    const VueSSRServerPlugin = require("vue-server-renderer/server-plugin");
    const VueSSRClientPlugin = require("vue-server-renderer/client-plugin");
    const nodeExternals = require("webpack-node-externals");
    const merge = require("lodash.merge");
    const TARGET_NODE = process.env.WEBPACK_TARGET === "node";
    const target = TARGET_NODE ? "server" : "client";
    
    
    module.exports = {
     configureWebpack: () => ({
     // 將 entry 指向應用程序的 server / client 文件
     entry: `./src/entry-${target}.js`,
     // 對 bundle renderer 提供 source map 支持
     devtool: 'source-map',
     target: TARGET_NODE ? "node" : "web",
     node: TARGET_NODE ? undefined : false,
     output: {
     libraryTarget: TARGET_NODE ? "commonjs2" : undefined
     },
     // https://webpack.js.org/configuration/externals/#function
     // https://github.com/liady/webpack-node-externals
     // 外置化應用程序依賴模塊??梢允狗掌鳂?gòu)建速度更快,
     // 并生成較小的 bundle 文件。
     externals: nodeExternals({
     // 不要外置化 webpack 需要處理的依賴模塊。
     // 你可以在這里添加更多的文件類型。例如,未處理 *.vue 原始文件,
     // 你還應該將修改 `global`(例如 polyfill)的依賴模塊列入白名單
     whitelist: [/\.css$/]
     }),
     optimization: {
     splitChunks: {
     chunks: "async",
     minSize: 30000,
     minChunks: 2,
     maxAsyncRequests: 5,
     maxInitialRequests: 3
     }
     },
     plugins: [TARGET_NODE ? new VueSSRServerPlugin() : new VueSSRClientPlugin()]
     }),
     chainWebpack: config => {
     config.module
     .rule("vue")
     .use("vue-loader")
     .tap(options => {
     merge(options, {
     optimizeSSR: false
     });
     });
     }
    };

    修改package,新增三個腳本來生成bundle.json

    "build:client": "vue-cli-service build",
    "build:server": "cross-env WEBPACK_TARGET=node vue-cli-service build",
    "build:win": "npm run build:server && move dist\\vue-ssr-server-bundle.json bundle && npm run build:client && move bundle dist\\vue-ssr-server-bundle.json",

     

    執(zhí)行命令

    npm run build:win

    在dist目錄下會生成兩個json文件

     

    3.4 改造server.js 代碼

    const fs = require("fs");
    const Koa = require("koa");
    const path = require("path");
    const koaStatic = require('koa-static')
    const app = new Koa();
    
    const resolve = file => path.resolve(__dirname, file);
    // 開放dist目錄
    app.use(koaStatic(resolve('./dist')))
    
    // 第 2 步:獲得一個createBundleRenderer
    const { createBundleRenderer } = require("vue-server-renderer");
    const bundle = require("./dist/vue-ssr-server-bundle.json");
    const clientManifest = require("./dist/vue-ssr-client-manifest.json");
    
    const renderer = createBundleRenderer(bundle, {
     runInNewContext: false,
     template: fs.readFileSync(resolve("./src/index.temp.html"), "utf-8"),
     clientManifest: clientManifest
    });
    
    function renderToString(context) {
     return new Promise((resolve, reject) => {
     renderer.renderToString(context, (err, html) => {
     err ? reject(err) : resolve(html);
     });
     });
    }
    // 第 3 步:添加一個中間件來處理所有請求
    app.use(async (ctx, next) => {
     const context = {
     title: "ssr test",
     url: ctx.url
     };
     // 將 context 數(shù)據(jù)渲染為 HTML
     const html = await renderToString(context);
     ctx.body = html;
    });
    
    const port = 3000;
    app.listen(port, function() {
     console.log(`server started at localhost:${port}`);
    });

    3.5 運行server.js

    node server.js

    訪問localhost:3000,可以看到頁面的數(shù)據(jù)都是又服務端渲染完成后返回的。到這一步已經(jīng)基本算完成了SSR的構(gòu)建了。

    如果有問題的話,可以把dist目錄下的index.html文件刪了。避免直接訪問到了該html文件。

     

    4、集成vuex

    修改store.js

    import Vue from 'vue'
    import Vuex from 'vuex'
    
    Vue.use(Vuex)
    
    export function createStore() {
     return new Vuex.Store({
     state: {
    
     },
     mutations: {
    
     },
     actions: {
    
     }
     });
    }

    修改main.js

    import Vue from "vue";
    import App from "./App.vue";
    import { createRouter } from "@/router";
    import { createStore } from "@/store";
    export function createApp() {
     const router = createRouter();
     const store = createStore() // +
     const app = new Vue({
     router,
     store, // +
     render: h => h(App)
     });
     return { app, router };
    }

    再次運行腳本構(gòu)建

    npm run build:win
    node server.js

    5、案例代碼

    附上案例源碼 https://github.com/lentoo/vue-cli-ssr-example歡迎star

    6、總結(jié)

    到目前為止,僅僅是完成了SSR的基礎部分,還有相關(guān)的 SSR熱更新之類的問題還需要繼續(xù)探索。如果有好的熱更新方法歡迎發(fā)出了參考參考。

    聲明:本網(wǎng)頁內(nèi)容旨在傳播知識,若有侵權(quán)等問題請及時與本網(wǎng)聯(lián)系,我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com

    文檔

    通過vue-cli3構(gòu)建一個SSR應用程序的方法

    通過vue-cli3構(gòu)建一個SSR應用程序的方法:1、前沿 1.1、什么是SSR SSR(服務端渲染)顧名思義就是將頁面在服務端渲染完成后在客戶端直接展示。 1.2、客戶端渲染與服務端渲染的區(qū)別 傳統(tǒng)的SPA模式 即客戶端渲染的模式 Vue.js構(gòu)建的應用程序,默認情況下是有一個html模板頁,然后通過webpac
    推薦度:
    • 熱門焦點

    最新推薦

    猜你喜歡

    熱門推薦

    專題
    Top