webpack3 + babel + vue2 后端渲染配置与实践

在前端开发中,使用Vue2框架进行开发已经成为了一种广泛的选择。而后端渲染技术则能够更好地支援SEO优化、更好地支援页面内容的爬取及搜索引擎收录。本文中,我们将讨论如何使用Webpack3 + Babel + Vue2进行后端渲染的配置及实践。

环境准备

在开始之前,需要先安装一些工具:

  1. Node.js:安装 Node.js 的过程根据操作系统的不同而有所不同,请查看官方文档以获得更多信息。

  2. Vue CLI:在 Node.js 安装完成之后,使用 npm 安装 Vue CLI:

    安装完成之后,使用以下的命令来检查是否安装成功:

  3. Vue Server Renderer:使用以下的命令进行安装,这将会安装用于 Vue 服务器端渲染的必要文件:

下一步,我们配置Webpack和Babel。

Webpack + Babel 配置

Webpack 和 Babel 是前端开发中的两个核心工具。在这篇文章中,我们将使用Webpack打包应用程序,并使用Babel支持ES6语法,并将Vue进行服务器端渲染。

首先,我们需要创建一个package.json文件。打开命令行,进入项目目录,然后执行以下命令:

为了使我们的项目能够使用Webpack和Babel,我们还需要安装以下插件:

  1. Babel-loader

    这个插件能够使我们的应用程序支持ES6语法。使用以下命令安装:

  2. Webpack

    webpack可以将我们的应用程序的代码打包成一个可执行的单一文件。使用以下命令进行安装:

  3. Vue Loader

    Vue Loader是用于将.vue文件编译为JavaScript模块的Webpack的插件。使用以下命令进行安装:

现在,我们需要在项目的根目录中创建一个名为 webpack.config.js 的配置文件。以下是一个基本的配置示例:

const path = require('path');

module.exports = {
  entry: './src/index.js', // 入口文件
  output: { // 输出文件
    path: path.resolve(__dirname, 'dist'),
    filename: 'bundle.js'
  },
  module: { // 模块
    rules: [ // 使用 babel-loader 进行转译
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      },
      // 使用 vue-loader 进行编译
      {
        test: /\.vue$/,
        use: {
          loader: 'vue-loader'
        }
      }
    ]
  }
};

这里,我们定义了一个入口文件,来告诉Webpack从哪里开始打包。我们规定打包的输出路径是 dist下的 bundle.js。此外,我们使用Babel来编译JavaScript模块,使用Vue Loader来编译Vue文件。

我们还需要在根目录下创建一个 .babelrc 文件,用于配置Babel。以下是一个基本的配置示例:

{
  "presets": [
    ["env", {
      "modules": false,
      "useBuiltIns": true,
      "targets": {
        "browsers": ["last 2 versions", "ie >= 9"]
      }
    }]
  ]
}

上述配置告诉Babel使用 env 预设,并将 useBuiltIns 设为 true。这样,Babel便可以自动根据你的代码中使用的特性进行编译。现在,让我们来处理用于服务端渲染的Vue配置。

Vue 服务器端渲染配置

Vue 服务器端渲染的关键就在于 vue-server-renderer 模块。这个模块会为我们生成一个用于渲染Vue模板的渲染器,并将Vue的应用程序渲染为字符串。在这个字符串上,你可以使用Node.js中的任何HTTP框架来提供一个完整的HTML响应。

我们可以使用以下代码初始化vue-server-renderer:

const Vue = require('vue');
const renderer = require('vue-server-renderer').createRenderer();

在初始化之后,我们便可以通过这个渲染器来直接处理Vue实例并生成HTML字符串。以下是一个示例,该示例创建一个Vue实例,然后通过渲染器来生成HTML字符串:

// 创建Vue实例
const app = new Vue({
  template: '<div>Hello World</div>'
});

// 使用渲染器生成HTML字符串
renderer.renderToString(app, (err, html) => {
  if (err) {
    console.log(err);
  } else {
    console.log(html);
  }
});

这将会输出一个HTML字符串:

<div><div>Hello World</div></div>

为了将Vue服务器端渲染与Webpack配置整合起来,我们需要创建一个名为 webpack.server.config.js 的配置文件。这个配置文件与我们之前的Webpack配置大体相似,但是我们在这里使用了一个名为 vue-server-renderer/server-plugin 的Webpack插件。这个插件可用于生成一个仅包含服务端渲染代码的单独JavaScript模块。

以下是一个基本的配置示例:

const path = require('path');
const VueSSRServerPlugin = require('vue-server-renderer/server-plugin');

module.exports = {
  target: 'node', // target 进行 node.js 的服务器端运行
  entry: './src/entry-server.js',
  output: {
    filename: 'server-bundle.js',
    libraryTarget: 'commonjs2' // 使用commonjs2, 使exports的内容为 module.exports.default
  },
  externals: Object.keys(require('./package.json').dependencies),
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      },
      {
        test: /\.vue$/,
        use: {
          loader: 'vue-loader'
        }
      }
    ]
  },
  plugins: [
    new VueSSRServerPlugin() // 使用 vue-server-renderer/server-plugin 插件
  ]
};

我们稍后会在 entry-server.js 文件中实现这个入口文件。在这个文件中,我们创建一个Vue应用程序实例,并将其导出为一个函数,该函数将在服务器端进行调用以进行渲染。

以下是一个示例实现,这个Vue应用程序包含了一个简单的计数器:

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

// 导出 Vue 应用程序实例函数
export default function createApp() {
  const app = new Vue({
    render: h => h(App)
  });

  return { app };
}

现在,我们可以在 server.js 文件中使用 server-bundle.js 模块,如下:

const fs = require('fs'); 
const path = require('path'); 
const express = require('express'); 
const serverBundle = require('./dist/server-bundle.js').default; 
const renderer = require('vue-server-renderer').createRenderer({ 
     template: fs.readFileSync(path.join(__dirname, 'index.html'), 'utf-8') 
}); 

const app = express(); // 创建 express 应用 

app.use(express.static('dist')); // express.static 用于提供静态文件。这里我们提供 dist 目录下的文件 

// 监听所有请求 
app.get('*', (req, res) => { 
     serverBundle().then(({ app }) => { 
          renderer.renderToString(app, (err, html) => { 
               if (err) { 
                    console.error(err); 
                    res.status(500).send('Internal server error'); 
               } else { 
                    res.send(html); 
               } 
          }); 
     }, err => { 
          console.error(err); 
          res.status(500).send('Internal server error'); 
     }); 
});

app.listen(4000, () => { 
     console.log('Server started at http://localhost:4000/'); 
});

在这个 server.js 文件中,我们使用了 express 应用程序。这个应用程序首先提供静态文件服务。当有请求发生时,它会加载 server-bundle.js 模块,并调用其导出的函数来生成Vue应用程序实例。我们然后使用 vue-server-renderer 来生成HTML字符串,该字符串将发送给客户端。

对于初学者来说,理解Vue服务器端渲染可能有些困难。本文希望通过提供一个基本的配置示例来帮助读者更好地理解这项技术。在实践中,你需要更深入地了解Webpack和Vue,才能配置出更完备的服务器端渲染方案。

总结

本文介绍了如何使用Webpack3 + Babel + Vue2进行服务器端渲染的配置与实践。从创建package.json文件开始,我们逐步介绍了Webpack和Babel的配置,然后演示了使用Vue服务器端渲染的方法。这些知识和技术对于构建高性能、可维护、易于SEO的Web应用程序都是至关重要的。本文希望能为许多开发者提供一些帮助和指导。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/6593b99beb4cecbf2d85ea45


纠错反馈