欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

理解vue ssr原理并自己搭建简单的ssr框架

程序员文章站 2023-11-14 20:43:04
前言 大多数vue项目要支持ssr应该是为了seo考虑,毕竟对于web应用来说,搜索引擎是一个很大的流量入口。vue ssr现在已经比较成熟了,但是如果是把一个spa应用...

前言

大多数vue项目要支持ssr应该是为了seo考虑,毕竟对于web应用来说,搜索引擎是一个很大的流量入口。vue ssr现在已经比较成熟了,但是如果是把一个spa应用改造成ssr应用,成本还是有些高的,这工作量无异于重构前端。另外对前端的技术要求也是挺高的,需要对vue比较熟悉,还要有node.js 和 webpack 的应用经验。

引入

vue是一个构建客户端应用的框架,即vue组件是在浏览器中进行渲染的。所谓服务端渲染,指的是把vue组件在服务器端渲染为组装好的html字符串,然后将它们直接发送到浏览器,最后需要将这些静态标记"激活"为客户端上完全可交互的应用程序。

服务端渲染的优点

  • 更好的seo,搜索引擎爬虫可以抓取渲染好的页面
  • 更快的内容到达时间(首屏加载更快),因为服务端只需要返回渲染好的html,这部分代码量很小的,所以用户体验更好

服务端渲染的缺点

  • 首先就是开发成本比较高,比如某些声明周期钩子函数(如beforecreate、created)能同时运行在服务端和客户端,因此第三方库要做特殊处理,才能在服务器渲染应用程序中运行。
  • 由于服务端渲染要用nodejs做中间层,所以部署项目时,需要处于node.js server运行环境。在高流量环境下,还要做好服务器负载和缓存策略

原理解析

先附上demo地址:

第一步:编写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中完成,还要专门定义一个函数?虽然beforecreatecreated在服务端也会被执行(其他周期函数只会在客户端执行),但是我们都知道请求是异步的,这就导致请求发出后,数据还没返回,渲染就已经结束了,所以无法把 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:

理解vue ssr原理并自己搭建简单的ssr框架

结语

个人实践vue ssr已有一段时间,发现要想搭建一套完整的 ssr 服务框架还是很有挑战的,或许 nuxt 是一个不错的选择,对 nuxt 感兴趣的朋友可以参考我的一个开源小作品essay

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。