前言
最近在写 koa 的时候想到, 如果我部分代码提供 api, 部分代码支持 ssr, 那我应该如何写呢?(不想拆成 2 个服务的情况下)
而且最近写的项目里面也用过一些服务端渲染, 如 nuxt, 自己也搭过 next 的项目, 确实开发体验都非常友好, 但是友好归友好, 具体又是如何实现的呢, 诸位有没有考虑过?
本着求真务实的折腾态度, 选了 react 作为研究对象 (主要是 vue 写的有点多, 恶心了), 那下面就简单就以最小成本写一个 react 的服务端渲染 demo
用到的技术栈
react 16 + webpack3 + koa2
看看它是如何实现服务端渲染的, here we go!
为什么要用服务端渲染
优点
无非就是两点
SEO 友好
加快首屏渲染, 减少白屏时间
那么问题来了什么是 SEO
直接放文章不做赘述, 前端后端分离, 怎么解决 SEO 优化的问题呢? - 知乎 , 一句话介绍就是, 现在我们做的大多是 SPA 网站, 所有页面啊数据啊都是 ajax 来的, 搜索引擎的 spider 来收录网页的时候, 发现全空? 那么你觉得你的网站收录的权重跟效果是好还是不好?
而我们对 SEO 优化, 也是下面内容所描述的核心就是:
下面是重点!
让服务器把有内容的 html 返回给我们, 事件的话浏览器再渲染一次来进行挂载
搭建 koa 环境
新建一个 ssr 项目, 并在项目中初始化 npm
mkdir ssr && cd ssr
npm init
下面的代码我们用到了 import jsx 等语法, node 环境是不支持的, 所以需要配置 babel
在当前项目中新建文件 app.js 跟 index.js, 然后
babel 的入口, index.js 代码如下
require('babel-core/register')()
require('babel-polyfill')
require('./app')
我们项目的入口, app.js 代码如下
import Koa from 'koa'
const app = new Koa()
// response
app.use((ctx) => {
ctx.body = 'Hello Koa'
})
app.listen(3000)
console.log("系统启动, 端口: 3000")
根目录下新建一个. babelrc 文件 内容是:
{
"presets": ["react", "env"]
}
安装上面所需要的依赖
npm install babel-core babel-polyfill babel-preset-env babel-preset-react nodemon --save-dev
npm i koa --save
配置启动脚本
package.json
"scripts": {
"dev": "nodemon index.js",
}
到这里你运行 npm run dev 打开 localhost:3000
你就会看到 hello Koa 了
是不是很简单就起了一个服务
安装 React
cnpm install react react-dom --save
在根目录下新建一个 app 文件夹, 并在文件夹中个新建一个 main.js
main.js 代码如下
import React from 'react'export
default class Home extends React.Component {
render() {
return < div > hello world < /div>
}
}/
修改之前 server.js
import Koa from 'koa'
import React from 'react'
import { renderToString } from 'react-dom/server'
import App from './app/main'
const app = new Koa()
// response
app.use(ctx => {
let str = renderToString(<App />)
ctx.body = str
})
app.listen(3000)
console.log('系统启动, 端口: 8080')
这个时候再 npm run dev 你就会看到屏幕上出现 hello world
再打开 chrome 开发者工具查看我们的请求:
我们的最简单的 react 组件变成 str 传了进来
这里我们用到了一个方法: renderToString - 其实就是将组件渲染成字符串
目前为止, 我们都还没有给组件加上事件等交互行为, 下面那让我们来试一下
修改 main.js 的代码
import React from 'react'
export default class Home extends React.Component {
render () {
return <div onClick={() => window.alert(123)}>hello world</div>
}
}
再刷新一下我们的页面,, 咦, 是不是没有什么卵用
那是因为后端只能讲组件渲染成一串 html 的字符串, 事件绑定等事情都是需要在浏览器端执行的
那事件我们改怎么绑定上去呢?
那你肯定就会猜到, 既然服务器渲染出来的是一串 html, 挂载事件的方式是不是在浏览器重新渲染一次就好了呢
说干就干
配制 webpack
在根目录下面新建一个 webpack.config.js 下面是 webpack.config.js 的内容:
var path = require('path')
var webpack = require('webpack')
module.exports = {
entry: {
main: './app/index.js'
},
output: {
filename: '[name].js',
path: path.join(__dirname, 'public'),
publicPath: '/'
},
resolve: {
extensions: ['.js', '.jsx']
},
module: {
loaders: [
{test: /\.jsx?$/,
loaders: ['babel-loader'],
}
]
}
}
上面的配置将 entry 设置成了 app/index.js 文件
那我们就创建一个
下面是 app/index.js 的代码:
import Demo from './main'
import ReactDOM from 'react-dom'
import React from 'react'
ReactDOM.render(<Demo />, document.getElementById('root'))
因为浏览器渲染需要将根组件挂载到某个 dom 节点上, 所以给我们的 react 代码设置一个入口
这个时候就有一个问题, 就是, document 对象 node 环境下并不存在, 那怎么解决的呢?
不存在? 不存在那我就不用就好了, SSR 核心就是让请求的 url 里面返回具体 HTML 内容, 事件什么的并不 care, 那么我就把根组件直接 renderToString 返回出来就好了呗
下面修改我们的服务代码, 让代码支持服务器渲染
新增一点依赖
cnpm i --save koa-static koa-views ejs
koa-static: 处理静态文件的中间件
koa-views: 配置模板的中间件
ejs: 一个模板引擎
修改 server.js 的代码
import Koa from 'koa'import React from 'react'import {
renderToString
}
from 'react-dom/server'import views from 'koa-views'import path from 'path'import Demo from './app/main'const app = new Koa()
// 将 / public 文件夹设置为静态路径
app.use(require('koa-static')(__dirname + '/public'))
// 将 ejs 设置为我们的模板引擎
app.use(views(path.resolve(__dirname, './views'), {
map: {
html: 'ejs'
}
}))
// response
app.use(async ctx = >{
let str = renderToString( < Demo / >) await ctx.render('index', {
root: str
})
}) app.listen(3000) console.log('系统启动, 端口: 8080')
下面新建我们的渲染模板 新建一个 views 文件夹
里面新建一个 index.html:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
<base href="/client">
</head>
<body>
<div id="root"><%- root %></div>
<script src="/main.js"></script>
</body>
</html>
这个 html 里面可以放一些变量, 比如这个 <%- root %>, 就是等下要放 renderToString 结果的地方 /main.js 则是 react 构建出来的代码
下面直接来测试一下我们的代码
1. 在 package.json 里面
新增:
"scripts": {
"dev": "nodemon index.js",
"build": "webpack"
},
2. 运行 npm run build, 构建出我们的 react 代码
3. npm run dev
点击一下代码, 是不是会 alert(123)
:tada: 撒花, 恭喜你, 一个最简单服务器渲染就已经完成
到这里核心的思想就都已经讲完了, 总结来说就下面三点:
起一个 node 服务
把 react 根组件 renderToString 渲染成字符串一起返回前端
前端再重新 render 一次
原理就是这么简单
但是具体开发的时候还会有各种各样的需求, 比如:
不可能我每次改完代码都重新构建看效果吧 => 需要 实时构建
create-react-app 都是热更新, 你还要刷新是不是太蠢了 =>
需要支持热更新
其他一些配套的周边, 如: react-router, redux 或者 mobx 怎么支持呢 =>
需要完善的生态
.etc
这些的原理以及配置都不太难, 单就是需要花点时间, 所以你可以直接参考以下 (大部分都是最新的配置)
更多配置
更多的配置可以参考下面的 repo(是一个工具链完善的最小实现, 欢迎提 PR,star)
GitHub - ws456999/koa-react-ssr-starter: to understand && to explain how react ssr works
你可以在里面找到
react + react-router + mobx-state-tree + postCSS + 热更新
的配置, 除了 react-router 的配置有些差别, 其他都跟 client 端差别不大
That's all.
参考链接
3-17 通过 Node.js API 启动 Webpack . 深入浅出 Webpack
Koa2 + React + Webpack 热加载部署方案 | Neko の喵窝
webpack - koa 服务端热更新问题 - SegmentFault
转 nodemon 基本配置与使用 - {前端开发} - 博客园
React 服务端渲染缓慢原因浅析 - 某熊的全栈之路 - SegmentFault
ReactDOMServer - React
来源: https://juejin.im/post/5a6a801051882573432d5fa7