VUE單頁應用骨架屏方案

常紅達發表於2019-01-16
Vue

什麼是骨架屏？

簡單的說，骨架屏就是在頁面未渲染完成的時候，先用一些簡單的圖形大致勾勒出頁面的基本輪廓，給使用者造成頁面正在載入的錯覺，待頁面渲染完成之後再用頁面替換掉骨架屏，從而減少頁面白屏的時間，給使用者帶來更好的體驗。

骨架屏效果

分析VUE渲染過程

使用vue-cli3.0建立專案：vue create project

第一步
第二步
第三步
第四步
第五步
第六步
第七步
第八步
在生成的專案資料夾下的public資料夾下的index.html檔案程式碼如下：

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width,initial-scale=1.0">
    <link rel="icon" href="<%= BASE_URL %>favicon.ico">
    <title>project</title>
  </head>
  <body>
    <noscript>
      <strong>We're sorry but project doesn't work properly without JavaScript enabled. Please enable it to continue.</strong>
    </noscript>
    <div id="app"></div>
    <!-- built files will be auto injected -->
  </body>
</html>
複製程式碼

可以看到，DOM裡面有一個div#app，當js被執行完成之後，此div#app會被整個替換掉，因此，如何在Vue頁面實現骨架屏，已經有了一個很清晰的思路——在div#app內直接插入骨架屏相關內容即可。

實現方案

手動在div#app裡面寫入骨架屏內容是不科學的，因此需要一個擴充套件性強且自動化的易維護方案。既然是在Vue專案裡，所以所謂的骨架屏也是一個.vue檔案，它能夠在構建時由工具自動注入到div#app裡面。 首先，我們在/src目錄下新建一個Skeleton.vue檔案，其內容如下：

<template>
  <div class="skeleton page">
    <div class="skeleton-nav"></div>
    <div class="skeleton-swiper">
        <div class="skeleton-swiper-item item-one"></div>
        <div class="skeleton-swiper-item item-two"></div>
    </div>
  </div>
</template>

<style>
html,body,div{
    margin:0;
    padding:0;
}
.skeleton {
  height: 100%;
  overflow: hidden;
  box-sizing: border-box;
  background: #fff;
}
.skeleton-nav {
  height: 54px;
  background: #eee;
  margin-bottom: 20px;
}
.skeleton-swiper {
    min-height:600px;
    max-width:1280px;
    margin:0 auto;
}
.skeleton-swiper-item{
    min-height: 600px;
    height:100%;
    background:#eee;
    border-radius:5px;
}
.item-one{
    width:20%;
    float:left;
}
.item-two{
    width:78%;
    float:right;
}
</style>
複製程式碼

接下來，在/src目錄再新建一個skeleton.entry.js入口檔案：

import Vue from 'vue';
import Skeleton from './Skeleton.vue';

export default new Vue({
    components: {
        Skeleton,
    },
    template: '<skeleton />',
});
複製程式碼

在完成了骨架屏的準備之後，我們需要一個關鍵外掛vue-server-renderer。該外掛本用於服務端渲染，但是在這裡，我們主要利用它能夠把.vue檔案處理成html和css字串的功能，來完成骨架屏的注入。

骨架屏注入

首先在public資料夾下新建一個template.html檔案，並且其程式碼和index.html檔案程式碼相同，但是需要在div#app中新增<!--vue-ssr-outlet-->佔位符：

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width,initial-scale=1.0">
    <link rel="icon" href="./favicon.ico">
    <title>醫生工作臺</title>
  </head>
  <body>
    <noscript>
      <strong>We're sorry but yz_doctors doesn't work properly without JavaScript enabled. Please enable it to continue.</strong>
    </noscript>
    <div id="app"><!--vue-ssr-outlet--></div>
    <!-- built files will be auto injected -->
  </body>
</html>
複製程式碼

然後，我們還需要在根目錄新建一個webpack.skeleton.conf.js檔案，以專門用來進行骨架屏的構建。

const path = require('path');
const webpack = require('webpack');
const nodeExternals = require('webpack-node-externals');
const VueSSRServerPlugin = require('vue-server-renderer/server-plugin');
const VueLoaderPlugin = require('vue-loader/lib/plugin');
module.exports = {
    target: 'node',
    entry: {
        skeleton: './src/skeleton.entry.js',
    },
    output: {
        path: path.resolve(__dirname, './dist'),
        publicPath: '/dist/',
        filename: '[name].js',
        libraryTarget: 'commonjs2',
    },
    module: {
        rules: [
            {
                test: /\.css$/,
                use: [
                    'vue-style-loader',
                    'css-loader',
                ],
            },
            {
                test: /\.vue$/,
                loader: 'vue-loader',
            },
        ],
    },
    externals: nodeExternals({
        whitelist: /\.css$/,
    }),
    resolve: {
        alias: {
            'vue$': 'vue/dist/vue.esm.js',
        },
        extensions: ['*', '.js', '.vue', '.json'],
    },
    plugins: [
        new VueLoaderPlugin(),
        new VueSSRServerPlugin({
            filename: 'skeleton.json',
        }),
    ],
};
複製程式碼

可以看到，該配置檔案和普通的配置檔案基本完全一致，主要的區別在於其target: 'node'，配置了externals，以及在plugins裡面加入了VueSSRServerPlugin。在VueSSRServerPlugin中，指定了其輸出的json檔名。然後通過執行下列指令，在/dist目錄下生成一個skeleton.json檔案： webpack --config ./webpack.skeleton.conf.js 接下來，在根目錄下新建一個skeleton.js，該檔案即將被用於往index.html內插入骨架屏:

const fs = require('fs');
const { resolve } = require('path');
const htmlMinifier = require('html-minifier');
const createBundleRenderer = require('vue-server-renderer').createBundleRenderer;

// 先把vue的模板檔案index.html置換成標準的模板，防止骨架屏汙染
let tempData = fs.readFileSync(resolve(__dirname, './public/template.html'), 'utf-8');
fs.writeFileSync('./public/index.html', tempData, 'utf-8');
console.log('模板注入完成');
// 讀取`skeleton.json`，以`index.html`為模板寫入內容
const renderer = createBundleRenderer(resolve(__dirname, './dist/skeleton.json'), {
    template: fs.readFileSync(resolve(__dirname, './public/index.html'), 'utf-8'),
});

// 把上一步模板完成的內容寫入（替換）`index.html`
renderer.renderToString({}, (err, html) => {
    if (err) {
        console.log(err);
        return;
    }
    html = htmlMinifier.minify(html, {
        collapseWhitespace: true,
        minifyCSS: true,
    });
    fs.writeFileSync('./public/index.html', html, 'utf-8');
});
console.log('骨架屏注入完成');

複製程式碼

接下來，只要執行node skeleton.js，就可以完成骨架屏的注入。 為了在npm run serve的時候自動完成骨架屏的注入，避免執行多次命令，需要在package.json中增加一條命令"preserve": "webpack --config ./webpack.skeleton.conf.js && node skeleton.js",放在"serve"命令之前。

總結

新建template.html檔案的目的是為了儲存模板檔案的乾淨，因為每次完成骨架屏的注入後index.html檔案中的<!--vue-ssr-outlet-->佔位符已經被骨架屏程式碼所替換，再次修改骨架屏後就無法完成骨架屏的注入啦，所以在注入骨架屏時先用template.html檔案中的內容替換index.html檔案，避免了每次修改骨架屏時還要手動修改index.html檔案，執行一條命令實現骨架屏的自動注入。

相關文章