10

业务需求

最近公司要求开发web版的app,由于app是偏向内容方面,而且带了一个聊天模块,所以一般的多页开发不是很适合,而且主要是手机浏览,对加载速度或者用户体验来说都比较苛刻。调研了很多框架和模式,最后自己东拼西凑搞出来了这么一个玩意。

UI框架 :淘宝SUI

服务端

毫无疑问使用node,使用typescript可以有效的在编码同时查错,强类型语言写服务端毫无压力。


#app.ts 只贴重要代码

var webpack = require('webpack')
var webpackDevMiddleware = require('webpack-dev-middleware')
var WebpackConfig = require('./webpack.config')

import * as index from "./server/routes/index";
import * as cookbook from "./server/routes/cookbook";
import * as cookbookDetail from './server/routes/cookbookDetail'


var app = express();

//启动服务的时候 打包并监听客户端用到的文件,webpackDevMiddleware是开发模式,他会打包js在内存里面,你改了文件,它也会重新打包
app.use(webpackDevMiddleware(webpack(WebpackConfig), {
    publicPath: '/__build__/',
    stats: {
        colors: true
    }
}));

//一般的配置项
app.set('views', __dirname + '/views');
app.set('view engine', 'ejs');
app.set('view options', { layout: false });
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
app.use(methodOverride());
app.use(express.static(__dirname + '/public'));

var env = process.env.NODE_ENV || 'development';
if (env === 'development') {
    app.use(errorHandler());
}

//路由配置
app.get('/cookbook', index.index);
app.get('/cookbook/:id', cookbook.index);
app.get('/cookbookDetail/:id', cookbookDetail.index);


app.listen(3000, function(){
    console.log("Demo Express server listening on port %d in %s mode", 3000, app.settings.env);
});

export var App = app;

服务端渲染页面

#index.ts
import express = require("express")
import vueServer = require("vue-server") //服务端渲染vue的插件
import request = require('request'); //第3方http请求的插件
import queryString = require('querystring'); //转换get参数的插件


var Vue = new vueServer.renderer(); //创建一个服务端的vue

export function index(req: express.Request, res: express.Response) {

    let vm:vueServer,
    b:Object,
    options:Object;

    options = {
        method: 'GET',
        //随便用了一个免费的API,是查询菜谱的
        url: 'http://apis.baidu.com/tngou/cook/classify?'+queryString.stringify({
            id : 0,
        }),
        headers: {
            //百度API的开放接口凭证
            'apikey': 'a369f43a6392605426433831e10765ec'
        }
    };
    request(options,function(err,resp,body){

        if (!err && resp.statusCode == 200) {
            b = JSON.parse(body);
            vm = new Vue({
                replace : false,
                template : `
                <div>
                    <!-- 标题栏 -->
                    <header class="bar bar-nav">
                        <a class="icon icon-me pull-left open-panel"></a>
                        <h1 class="title">{{title}}</h1>
                    </header>

                    <!-- 这里是页面内容区 -->
                    <div class="content">
                      <div class="list-block">
                        <ul>
                          <li class="item-content" v-for="item in cookbookClasses">
                            <div class="item-media"><i class="icon icon-f7"></i></div>
                            <div class="item-inner">
                              <div class="item-title">{{item.title}}</div>
                            </div>
                          </li>
                        </ul>
                      </div>
                    </div>
                </div>
                `,
                data : {
                    title : '菜谱首页',
                    cookbookClasses: b.tngou,
                }
            });
        }
        //等待html渲染完成,再返回给浏览器 vueServer.htmlReady是vue-server的自带事件
        vm.$on('vueServer.htmlReady', function(html:string) {
            //这里用的是ejs模板 可以把需要用到的数据设置成window下的全局变量,方便客户端的js访问。
            res.render('layout',{
                server_html:html,
                server_data:`
                    window.cm_cookbookClasses = {
                        title : '菜谱首页',
                        cookbookClasses: ${JSON.stringify(b.tngou)}
                    }`
            })
        });

    });
}
#layout.ejs  访问这个SPA的所有url返回的都是这个页面 <meta>标签都可以动态设置,只要传参数进来就可以
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,minimum-scale=1.0,maximum-scale=1.0,initial-scale=1.0,user-scalable=no">
    <title>Vue Router Example</title>
    <link rel="stylesheet" href="//g.alicdn.com/msui/sm/0.6.2/css/??sm.min.css,sm-extend.min.css">
    <style type="text/css">
        
        //注释掉的是vue-router切换的动画, 通过transition,transition-mode设置
        /*.test-transition {*/
            /*transition: all .5s ease;*/
        /*}*/

        /*.test-enter, .test-leave {*/
            /*opacity: 0;*/
            /*transform: translate3d(10px, 0, 0);*/
        /*}*/
        h2{
            font-size: 1rem;
        }
        p{
            font-size: .8rem;
        }
        img{
            max-width: 100%;
        }
    </style>
    <script>
        //定义一些前端需要用到的全局属性,文章ID或用户信息什么的
        //index.ts中传过来的是 window.cm_data = {name:"张三"}
        //前端就能访问到了
        <%-server_data%>
    </script>
</head>
//这里的id是前端需要用到的一个标识
<body id="app">
<div class="page-group">
    <div class="page page-current">
        //router-view是客户端vue-router需要解析的dom
        //server_html是根据访问url地址生成的html,是做SEO的重点,不加载下面的js也可以看到内容
        <router-view transition="test" transition-mode="out-in"><%-server_html%></router-view>
    </div>
</div>


//这里用到了淘宝团队的UI框架SUI,各种组件都有。它依赖zepto
<script type='text/javascript' src='//g.alicdn.com/sj/lib/zepto/zepto.min.js' charset='utf-8'></script>
<script type='text/javascript' src='//g.alicdn.com/msui/sm/0.6.2/js/??sm.min.js,sm-extend.min.js' charset='utf-8'></script>
 //webpack打包好的js,主要是路由配置
<script src="/__build__/app.js"></script>
</body>
</html>

客户端

#app.js 这个是/__build__/app.js,可以用es6编写,webpack会转换的

import Vue from './vue.min' //客户端的vue.js
import VueRouter from './vue-router.min' //vue的路由插件,配合webpack可以很简单实现懒加载
import VueResource from './lib/vue-resource.min'    //懒加载路由 只有访问这个路由才会加载js

import Index from 'bundle?lazy!./routes/index' //配合webpack的bundle-loader,轻松实现懒加载
import Cookbook from 'bundle?lazy!./routes/Cookbook'
import CookbookDetail from 'bundle?lazy!./routes/cookbookDetail'

var App = Vue.extend({})

Vue.use(VueResource)
Vue.use(VueRouter)

//百度API需要用到的参数
Vue.http.headers.common['apikey'] = 'a369f43a6392605426433831e10765ec';

var router = new VueRouter({
    //这里要好好说一下,一定要设置html5模式,不然前后端URL不统一会发生问题
    //比如访问 http://localhost:3000/ 服务端定义是访问index.ts这个路由文件
    //如果不是html5模式的话,经过客户端js运行之后会变成http://localhost:3000/#!/
    
    //在比如直接浏览器输入 http://localhost:3000/foo 服务端定义是访问.ts这个路由文件
    //如果不是html5模式的话,经过客户端js运行之后会变成 http://localhost:3000/foo/#!/
    
    //设置了html5模式后,加载完js后不会加上#!这2个类似锚点的字符,实现前后端路由统一如果用户刷新浏览器的话,服务端也能渲染出相应的页面。
    history: true, //html5模式 去掉锚点 
    saveScrollPosition: true //记住页面的滚动位置 html5模式适用,实际使用下来没用
})

//定义路由,要和服务端路由路径定义的一样
router.map({
    '/'   : {
        component: Index //前端路由定义,
    },
    '/cookbook/:id': {
        component: Cookbook
    },
    '/cookbookDetail/:id': {
        component: CookbookDetail
    }
})
router.redirect({
    '*': '/cookbook'
})
//启动APP
router.start(App, '#app')

客户端路由

#index.js  这里的模板和服务端的差不多,就增加了@click操作
'use strict';
import Vue from '../lib/vue.min'

let Index = Vue.extend({
    //replace : false, //必须注释掉 不然动画失效
    template : `
    <div>
        <!-- 标题栏 -->
        <header class="bar bar-nav">
            <a class="icon icon-me pull-left open-panel"></a>
            <h1 class="title">{{title}}</h1>
        </header>
    
        <!-- 这里是页面内容区 -->
        <div class="content">
          <div class="list-block">
            <ul>
              <li class="item-content" v-for="item in cookbookClasses" @click="goCookbook(item.id)">
                <div class="item-media"><i class="icon icon-f7"></i></div>
                <div class="item-inner">
                  <div class="item-title">{{item.title}}</div>
                </div>
              </li>
            </ul>
          </div>
        </div>
    </div>
    `,
    data : ()=>{
        return {
            title : '菜谱首页',
            cookbookClasses : []
        }
    },
    methods: {
        goCookbook(id){
            //vue-router 路由跳转
            this.$router.go('/cookbook/'+id);
        }
    },
    //vue-router的属性,可以设置路由的生命周期,具体请查文档
    route : {
        //应该是在渲染DOM之前获取数据
        data : function(transition) {
            //如果是服务端渲染的,应该设置全局变量,那么客户端就不用异步请求数据了
            if(window.cm_cookbookClasses){
                this.$data = window.cm_cookbookClasses;
                transition.next();
            }else{
                let qa_id = 0;
                //使用vue-resource来获取数据
                var resource = this.$resource('http://apis.baidu.com/tngou/cook/classify');
                $.showPreloader(); //这个是显示SUI的加载遮罩层
                resource.get({id: qa_id}).then((response)=>{
                    $.hidePreloader();
                    if(response.status == 200){
                        this.$data = {
                            title : '菜谱首页',
                            cookbookClasses : response.data.tngou
                        }
                        transition.next();
                    }else{
                        transition.abort();
                    }
                });
            }
        },
        canActivate: function(){

        },
        // 激活状态 把上一次记录的数据,获取出来,需要deactivate状态配合。
        activate: function (transition) {
            this.$data = window.cm_cookbookClasses;
            transition.next()
        },
        // 禁用状态 记录这一次的数据,方便以后再进入激活状态可以不用访问网络请求数据
        deactivate: function (transition) {
            window.cm_cookbookClasses = this.$data;
            transition.next()
        }
    }
})

export default Index

需要完善的地方

  1. 前后端统一模板,已经找到方法了把html分离出来,node端用fs.readFileSync方法获取,客户端用webpack的raw-loader获取html内容

  2. 安卓微信浏览器 vue-resource 设置了headers的apikey,但请求的时候没有带上,导致获取不到数据。

  3. IOS safari浏览器 渲染页面有问题,渲染20条数据,只显示10条左右,监听不到SUI无限滚动到底部的事件

不放源码都是瞎扯。

源码地址 最新的是分支V0.0.1 是个简单的菜谱DEMO

https://github.com/yjj5855/node-vue-server-webpack

你可能感兴趣的

19 条评论
yang_j_j 作者 · 2016年02月18日

这是保密的配置文件 所以没有公开,基本内容如下

var env = {
NODE_ENV : 'development',
SELF_HOST : '127.0.0.1:3000',
APIStore : {
    api_key   : 'a369f43a6392605426433831e10765ec',
    news_host : 'http://apis.baidu.com',
},
PATH_COOKBOOK : __dirname+'/client/com.chezhil.cookbook',
PATH_BUILD    : __dirname+'/__build__',

API_BASE_HOST : '你的API接口域名'
}

module.exports.config = env;

+1 回复

tg · 2016年01月27日

很不错!

回复

lemonStar · 2016年02月18日

你好,我想问下,按照你的讲解步骤执行了,npm install , tsd install ,但在执行 node server 的时候 提示 module.js:338 报错,提示没有在我的目录里找到 server ,这是什么原因呢,是ts文件没有编译成Js文件吗

回复

yang_j_j 作者 · 2016年02月18日

还要装 tsc 把ts文件编译成js文件 命令是 npm install -g tsc 装好之后运行一下 tsc 忽略警告

回复

lemonStar · 2016年02月18日

tsc是什么不是tsd吗? tsd 我安装了,server目录下已经有 typings文件夹,还有个疑惑,babel 的功能不也是可以将ts文件编译成js吗

回复

lemonStar · 2016年02月18日

按你说的安装了,也执行了, tsc报的错误是文件里缺少引用的模块 比如 http... 然后又执行 node server 提示找不到模块‘./env’

回复

lemonStar · 2016年02月18日

我新建了一个env.js的文件,把上面的代码复制进去了,api接口域名我写的局域网Ip,然后执行 又提示 缺少模块 request ,很抱歉,我真的是有很多不懂的,请指教下...

回复

lemonStar · 2016年02月18日

我在以前学习 express的文件夹里找到有一个request.js的文件

回复

yang_j_j 作者 · 2016年02月18日

package.json里面忘写了 你直接安装一下就可以了

回复

lemonStar · 2016年02月18日

终于调通了,谢谢~~~

回复

lemonStar · 2016年02月19日

请问下client 目录下的js文件也是用typescript 语言来写的,直接以js为文件后缀,没有经过编译直接使用,这是为什么

回复

yang_j_j 作者 · 2016年02月19日

client 是es6标准的语法

回复

jj8j · 2016年05月17日

大神啊!'bundle?lazy!./routes/index' ,能教导我下么?看过好多webpack的资料,就是觉得不懂! 大神 求个 QQ 或微信啊~我有偿求教~很急很关键~

回复

双叶 · 2016年11月02日

你好,我运行的时候出现下面这个报错,帮帮忙
C:Usersusernode-vue-server-webpackserverroutescookbook.js:11

    var classes = await, getCookbookClass_1 = ();
                                               ^

SyntaxError: Unexpected token )

at Module._compile (module.js:439:25)
at Object.Module._extensions..js (module.js:474:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:312:12)
at Module.require (module.js:364:17)
at require (module.js:380:17)
at Object.<anonymous> (C:\Users\user\node-vue-server-webpack\server.js:9:16)
at Module._compile (module.js:456:26)
at Object.Module._extensions..js (module.js:474:10)
at Module.load (module.js:356:32)

回复

0

你解决了吗?

李佳兴 · 2017年05月10日
Eysa · 2017年02月04日

楼楼,这哪里说SEO的事了?

回复

0

他是在服务端进行了页面渲染 而不来json数据到前端才进行字符串拼接页面

dodomonster · 2017年06月07日
征程ゎ · 2017年03月30日

对啊对啊,哪里说道seo了?

回复

小明子 · 4月15日

真神

回复

载入中...