少掉配置SSR的烦恼，Koa-vuessr-middlware帮你忙

前言

最近在写一个新应用时，想用Koa 结合 Vue SSR，同时写Api 接口和页面，于是开始上手写，结果发现需要写的东西很多，参考的大多数例子都用的是十分类似的代码（好像大多都是基于尤大大的hackernews ），于是索性花了一个晚上把代码封装成一个Koa 的中间件，让后来者少造个轮子；

各位看官，走过路过，给个star 鼓励一下吧，谢谢！项目地址

示例

如果以下的文档不够清晰，可以参考我写的Demo 进行参考

安装

npm install koa-vuessr-middleware

文档

使用

首先需要在项目根目录下添加一个.ssrconfig 文件，内容如下：

{
  "template": "./src/index.template.html",
  "ouput": {
    "path": "./dist", 
    "publicPath": "/dist/"
  },
  "entry": {
    "client": "./src/entry-client.js",
    "server": "./src/entry-server.js"
  },
  "webpackConfig": {
    "client": "./build/webpack.client.conf.js",
    "server": "./build/webpack.server.conf.js"
  }
}

说明：

• template 默认网页模板，默认为空，即使用内置的网页模板
• entry 如果你想使用内置默认webpack 配置，则必须配置此项，包括一个client 和 server，client 为客户端入口js， server 则为服务端入口js
• output 如果你想使用内置默认webpack 配置，则需要配置一个path 和outputPath，可以参考 webpack 的output 配置

• webpackConfig 如果你想用自定义的webpack 配置，则需要配置以下两项：

  • client 客户端版本的webpack 配置文件
  • server 服务端版本的webpack 配置文件

注：可以在项目地址中参考相应的配置文件进行编写

基本用法如下：

const koa = require('koa');
const app = new koa();
const koaRouter = require('koa-router');
const ssr = require('koa-vuessrr-middleware');

router.get('/otherroute', otherloaders);
router.get('*', ssr(app, opts));

app.use(router.routes());
app.listen(8080);

• 开发环境

router.get('*', ssr(app, {
    title: '网页默认标题',
    isProd: false, // 此时将启用热更新功能，此为默认选项,
}));

• 生产环境

先执行以下命令生成生产代码

buildssr

然后使用以下代码

router.get('*', ssr(app, {
    title: '网页默认标题',
    isProd: true, // 此时将直接读取生产代码,
}));

文件目录建议如下例子：

├── src                      app directory
│   ├── router/              route directory
│   ├── views/               views directory
│   ├── components/          compoennts directory
│   ├── app.js               js file to export a createApp function
│   ├── App.vue              root Vue
│   ├── entry-server.js      server side entry point
│   └── entry-client.js      client side entry point
├── index.js                 server entry point
├── .ssrconfig               SSR configuration file
├── ...

app.js 示例

import Vue from 'vue'
import App from './App.vue'
import { createRouter } from './router'
import titleMixin from './util/title'

Vue.mixin(titleMixin)
export function createApp () {
  const router = createRouter()
  const app = new Vue({
    router,
    render: h => h(App)
  })
  return { app, router, }
}

entry-client.js 示例

import Vue from 'vue'
import 'es6-promise/auto'
import { createApp } from './app'

const { app, router } = createApp()

router.onReady(() => {
  app.$mount('#app')
})

entry-server.js 示例

import { createApp } from './app';
export default context => {
  return new Promise((resolve, reject) => {
    const { app, router } = createApp()
    const { url } = context
    const { fullPath } = router.resolve(url).route
    if (fullPath !== url) {
      return reject({ url: fullPath })
    }
    router.push(url)
    router.onReady(() => {
      const matchedComponents = router.getMatchedComponents()
      if (!matchedComponents.length) {
        return reject({ code: 404 })
      }
      Promise.all(matchedComponents.map(({ asyncData }) => asyncData)).then(() => {
        resolve(app)
      }).catch(reject)
    }, reject)
  })
}