糯米PC端重构之实践

上一篇文章谈到了重构的原因和基本思路,在这片文章里我们将具体地阐述我们是如何做的。

技术选型

基本采用了原有的技术实现,以jslesshtml为基础,这没什么好说的。在服务端模板的选择中,我们选择了smarty模板,在糯米的wap端,我们采用了crox这个模板,两者我们都解决了同一份模板在前后端通用的小难题,大大地提高了开发效率。

目录结构

我们的目录结构参考了我们的团队规范,抛弃了原有的FIS的结构形式,变为以下形式:

.
├── bower.json
├── build
├── build.sh
├── dep // 第三方依赖
├── fis-conf.js
├── gulpfile.js
├── mock
├── node_modules
├── package.json
├── preview
├── src
├── static // 静态资源
├── template // 后端模板
├── test
├── tool
└── webpack.config.js

模块管理

我们的模块构建方式采用commonjs,因此我们可以利用npm上大量的优质模块,通过webpack可以跟我们前端开发常用的AMDCMD无缝的结合。

第三方依赖

开发过程中,必不可少将会用到社区里现有的优质模块,通过bower进行所有模块的管理,我们将统一放在dep文件夹下进行管理,并通过webpack的配置,可以在本地模块的应用。 如在webpackreslove配置项中配置相应的alias,就可以在实际开发中调用它,如requirejspath配置。

// webpack.config.js
alias = {
    'moye': depPath + '/moye/src/ui',
    'avalon': depPath + '/avalon/dist/avalon',
    'etpl': depPath + '/etpl/src/main'
};

// main.js
var moye = require('moye');
var avalon = require('avalon');

管理其他资源

开发过程中,一个组件通常包含多种资源(图片、less、swf、tpl等),如何才能方便的调用和管理呢?

对于以上问题,通过webpack的loader机制,我们将所有的资源都统一在JS中进行管理,而且我们可以通过编写自己的loader,来实现自己的所需的资源加载机制。举个栗子,

require('./main.less'); // 组件所需的less
var etpl = require('etpl');// 前端模板引擎
var search = require('./search/main'); // js
var suggestion = require('raw!./suggestion.html'); // html文本,前端模板引擎用
var smartyTpl = require('smarty4js!./smarty.tpl'); // smarty模板,转成js模板函数
var $ = require('jquery');

var exports = {
    init: function (options) {
        // do something
    },
    render: function () {
        // data是数据对象
        etpl.compile(suggestion).render(data);
        smartyTpl.render(data);
    }
};
module.exports = exports;

通过上面的代码实例,我们发现所有的资源都在一个main.js获得清晰的展现,而不是分散在整个项目中,因此便于更好地维护一个组件,组件在一定程度上变得内聚。通过webpack的loader,我们将一些需要通过手动或者命令行方式的工作,直接通过代码就能实现。

前端测试

测试采用了karma + jasmine 结合完成,因为我们的运行代码是通过webpack打包器生成的,所以测试过程中需要karmawebpack相结合。

上线部署

在上线部署中,我们保留原有的FIS的部署功能,利用FIS强大的工程化的功能,我们的将资源路径替换发布到测试机器压缩打包strong text资源统计追踪等繁琐的工作全部以工程化的形式完成,大大的节约了人力成本,有兴趣可以参考FIS官网的示例。

构建工具

将一系列工作我们通过gulp全部串联起来,整个过程所需要的命令为数不多。我们所用的gulp文件如下:

var gulp = require('gulp');
var config = require('./webpack.config');
var webpack = require('gulp-webpack-build');
var shelljs = require('shelljs');
var path = require('path');
var fs = require('fs');
var cwd = process.cwd();
var etpl = require('etpl');
var karma = require('karma').server;

// clean all files
gulp.task('clean', function () {
    shelljs.rm('-rf', path.join(cwd, 'static','common'));
    shelljs.rm('-rf', path.join(cwd, 'static','car'));
});



function printResult(stats) {
    stats = stats.toJson();
    (stats.errors || []).forEach(function (err) {
        console.error('error', err);
    });

    stats.assets.forEach(function (item) {
        var size = (item.size / 1024.0).toFixed(2) + 'kB';
        console.log('generated', item.name, size);
    });
}

var src = './src',
    webpackOptions = {
        debug: false,
        // devtool: '#source-map',
        watchDelay: 200
    },
    webpackConfig = {
        useMemoryFs: true,
        progress: true
    };
var CONFIG_FILENAME = './webpack.config.js';
var dest = './static';

gulp.task('webpack', [], function() {
    return gulp.src('./webpack.config.js', { base: path.resolve(src) })
        .pipe(webpack.init(webpackConfig))
        .pipe(webpack.props(webpackOptions))
        .pipe(webpack.run())
        .pipe(webpack.format({
            version: false,
            timings: true
        }))
        .pipe(webpack.failAfter({
            errors: true,
            warnings: true
        }))
        .pipe(gulp.dest(dest));
});


gulp.task('build', function () {
    gulp.src('./src/**/*.tpl')
        .pipe(gulp.dest('template/newpc'));
});

gulp.task('watch', function () {
    gulp.watch(['./src/**/*.js', './src/**/*.less']).on('change', function(event) {
        if (event.type === 'changed') {
            gulp.src(event.path, { base: path.resolve(src) })
                .pipe(webpack.closest(CONFIG_FILENAME))
                .pipe(webpack.init(config))
                .pipe(webpack.props(webpackOptions))
                .pipe(webpack.watch(function(err, stats) {
                    gulp.src(this.path, { base: this.base })
                        .pipe(webpack.proxy(err, stats))
                        .pipe(webpack.format({
                            verbose: true,
                            version: false
                        }))
                        .pipe(gulp.dest(dest));
                }));
        }
    });
});

gulp.task('test', function (done) {
    karma.start({
        configFile: __dirname + '/test/config.js'
    }, done);
});


gulp.task('debug', ['webpack'],  function(){
    var process = require('child_process');
    process.exec('fis release -d local');
});

后续规划

现如今糯米PC的技术框架还是采用以jquery为基础的模块化前端框架,这次通过commonjs的组织方式,也是为了后面代码能够在Node等后端进行处理,更好地达到前后端分层开发,完完全全去除后端模板的依赖。

在思考的过程中,实际是借鉴React,希望后续在浏览器兼容放开的基础和React更加成熟的基础上,糯米部分复杂的业务能采用React Component的方式进行开发,来实现同构开发。

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

推荐阅读更多精彩内容

  • GitChat技术杂谈 前言 本文较长,为了节省你的阅读时间,在文前列写作思路如下: 什么是 webpack,它要...
    萧玄辞阅读 12,613评论 7 110
  • 前端集成解决方案要求: 模块化开发。最好能像写nodejs一样写js,很舒服。css最好也能来个模块化管理! 性能...
    Www刘阅读 2,924评论 1 20
  • 糯米PC是一个典型的PC站点页面,包含一个团购网站所需要的全部功能,从网站开发角度来讲,是一个典型的website...
    沈礼阅读 1,350评论 1 3
  • 在现在的前端开发中,前后端分离、模块化开发、版本控制、文件合并与压缩、mock数据等等一些原本后端的思想开始...
    Charlot阅读 5,391评论 1 32
  • 我爱好摄影,但我觉得自己永远成不了摄影师,不过荷兰摄影师Haje Jan Kamps在他的博客上写的一篇文章给与了...
    无业遊民阅读 541评论 0 1