Koa-React-SSR 服务端渲染,技术分享(koa2.0 + React16.x+webpack4.x)

demo地址:https://github.com/xwb007/Koa-React-SSR

本文为前端小白自学总结,有错误的地方恳请各位大佬指出!

一、为什么需要服务端渲染?

1、SEO不友好

2、首次请求时间较长,体验不好,等待白屏

二、客户端渲染和服务端渲染

1、客户端

客户端

2、服务端

服务端

三、开始构建项目(webpack-4.x)

webpack 本地环境和生产环境配置我就不多阐述了,直接开始我的思路

首先要用koa来启动服务,webpack来打包我们的react代码

sever/app.js-koa一些中间件

import Koa from 'koa';
import json from 'koa-json';
import bodyParser from 'koa-bodyparser';
import logger from 'koa-logger';
import session from 'koa-session';
import compress from 'koa-compress';
import convert from 'koa-convert';
import cors from 'koa2-cors';

const app = new Koa();
app.use(convert(session(app)));
app.use(compress());
app.use(bodyParser());
app.use(cors());
app.use(json());
app.use(logger());

export default app;

然后就是<font color=#c00>server/server.dev.js</font>-启动本地开发server文件


const app = require('./app.js'),
    convert = require('koa-convert'),
    webpack = require('webpack'),
    fs = require('fs'),
    path = require('path'),
    devMiddleware = require('koa-webpack-dev-middleware'),
    hotMiddleware = require('koa-webpack-hot-middleware'),
    views = require('koa-views'),
    router = require('./routes'),
    clientRoute = require('./middlewares/clientRoute'),
    config = require('../build/webpack.dev.config'),
    port = process.env.port || 3000,
    compiler = webpack(config);

compiler.plugin('emit', (compilation, callback) => {
    const assets = compilation.assets;
    let file, data;

    Object.keys(assets).forEach(key => {
        if (key.match(/\.html$/)) {
            file = path.resolve(__dirname, key);
            data = assets[key].source();
            fs.writeFileSync(file, data);
        }
    });
    callback();
});

app.use(views(path.resolve(__dirname, '../views'), { map: { html: 'ejs' } }));
app.use(router.routes());
app.use(router.allowedMethods());
app.use(clientRoute);

app.use(
    convert(
        devMiddleware(compiler, {
            noInfo: true,
            publicPath: config.output.publicPath
        })
    )
);

app.use(convert(hotMiddleware(compiler)));
//ejs模版渲染
app.use(views(path.resolve(__dirname, '../views'), { map: { html: 'ejs' } }));

在项目中我们会使用到rudux 、router路由完全有react前端来控制,在用户请求路由时传到前端路由来匹配进行渲染相对应的路由模块,<font color=#c00>react-router-dom</font> 的 StaticRouter很好的针对服务端,ctx.url为请求的路由,data为请求的参数,需要在你渲染前传递过去。

<font color=#c00>.clientRoute.js</font>

import React from 'react';
import { renderToStaticMarkup } from 'react-dom/server';
import { StaticRouter } from 'react-router-dom';
import { Provider } from 'react-redux';
import store from '../../client/redux/store';

import { RoutesIndex, routes } from '../../client/router/index';

import getData from '../../client/common/getData';

async function clientRoute(ctx, next) {
    for (let item of routes) {
        if (item.path == ctx.url) {
            const data = await getData(ctx.url);
            await ctx.render('index', {
                root: renderToStaticMarkup(
                    <Provider store={store}>
                        <StaticRouter location={ctx.url} context={data}>
                            <RoutesIndex />
                        </StaticRouter>
                    </Provider>
                )
            });
            break;
        }
    }
    await next();
}

export default clientRoute;

我们再来看看getData

<font color=#c00>client/common/getData.js</font>

import request from './request';

async function getData(path) {
    switch (path) {
        case '/':
            let data = {};
            await request.config({ url: '/api/user/getUserInfo' }).then(res => {
                data = res;
            });
            return data;
        default:
            break;
    }
}

export default getData;

就是一个根据路由来匹配你当前路由需要的参数,然后用axios进行异步请求 request是我封装的axios所以 es6 的async await超级好用呢,emmmmmm...这样就能在我们渲染返回html之前请求所需要的异步数据在服务端渲染,再来看看前端的配置,首先和react的cli基本一样

<font color=#c00>client/index.js</font>

import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter as Router } from 'react-router-dom';
import { RoutesIndex } from './router';

import { Provider } from 'react-redux';
import store from './redux/store';

ReactDOM.render(
    <Provider store={store}>
        <Router>
            <RoutesIndex />
        </Router>
    </Provider>,
    document.getElementById('root')
);

这儿要注意的问题就是Router必须放在这个地方,不能放在router/index.js里面,因为在node中引入BrowserRouter是要报错的

<font color=#c00>clinet/router/index.js</font>

/**
 * 返回一个基本的RoutesIndex
 */
import React from 'react';
import { Route } from 'react-router-dom';

import Home from '../page/Home';
import About from '../page/About';

const routes = [{ path: '/', component: Home }, { path: '/about', component: About }];

class RoutesIndex extends React.Component {
    render() {
        return (
            <div className="app-container">
                {routes.map((item, index) => (
                    <Route key={index} path={item.path} exact component={item.component} />
                ))}
            </div>
        );
    }
}

export default { RoutesIndex, routes };

我把routes放在一个数组中,新增的路由都在routes里面配,这样做的主要目的就是为了在服务端渲染的时候方便匹配路由,再不是请求的路由时直接await next();

    for (let item of routes) {
        if (item.path == ctx.url) {
            ...js
        }
    }
    await next();

redux我就不阐述了,我这里没有加入中间件redux-thunk,就是一个很简单的redux状态管理器

还有一点就是在我们页面中怎么处理服务端传递过来的参数和前端自己请求的参数?

<StaticRouter location={ctx.url} context={data}>
    <RoutesIndex />
</StaticRouter>

StaticRouter 传递的data在前端页面会传入props中的staticContext,在浏览器是看不见的,需要的服务端控制台打印查看。

<font color=#c00>./Home/index.jsx</font>

import React, { Component } from 'react';
import getData from '../../common/getData';
import styles from './index.scss';

class Home extends Component {
    constructor(props) {
        super(props);
        this.state = {
            user: props.staticContext
        };
    }

    async componentDidMount() {
        this.setState({ user: await getData(this.props.match.path) });
    }

    render() {
        const { user } = this.state;
        return (
            <div className={styles.box}>
                <h1>hello koa-react-template</h1>
                <p>{user && user.userId}</p>
                <p>{user && user.name}</p>
                <p>{user && user.gender}</p>
                <p>{user && user.age}</p>
            </div>
        );
    }
}

export default Home;

说到这里差不多就要结束了,就是还有一点问题,我就有个大胆的想法了,我这样做就是在后台请求的数据和前端请求的数据一致,这个时候就不应该在setState重新render页面了,所以可以把服务端请求的数据和html以前返回客户端,然后在前端请求了新的数据后进行比较,如果不一致就render,一直就不render,这样会不会更好呢??

注意问题

我在项目中使用了mysql,如果你没有安装mysql,没事,你可以直在<font color=#c00>server\controllers\user.js</font> 进行注释

// import query from './config';

// const findUserInfo = () => {
//     const _sql = 'select * from user';
//     return query(_sql, []);
// };

const getUserInfo = async ctx => {
    let data = {};

    // await findUserInfo().then(result => {
    //     data = result[0];
    // });

    data = {
        userId: 1001,
        name: 'xwb007',
        gender: '男',
        age: 24
    };

    ctx.body = data;
};

export default { getUserInfo };

作为一个前端小白,第一次分享技术,如果有大佬觉得有问题,可以指出来,感激不尽。你要是觉得还阔以,对你有帮助,欢迎stars。源码git

让我们一起愉快的掉头发吧!!!!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,185评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,652评论 3 393
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,524评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,339评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,387评论 6 391
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,287评论 1 301
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,130评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,985评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,420评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,617评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,779评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,477评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,088评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,716评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,857评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,876评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,700评论 2 354

推荐阅读更多精彩内容