nodejs:用ejs模板和gulp实现前端组件化

最近在用nodejs将公司商城的底层重写。基于nodejs的强大,我从原本的只写前端变成了写全栈。
框架采用express,模板用ejs,前端用amazeui. 做完三个页面后,设计突然说要改UI设计,我勒个去,郁闷地一个个页面重新调整。下班之后反思一下,觉得花了太多时间在重复劳动上,是时候涉猎一下前端工程化的知识了。
用百度在互联网畅游了一番,总结了一下前端工程化的几个关键要素:编码规范化,结构模块化,流程自动化。本文所述的方法属于模块化,但只是简单地把dom,css,js拆分,以便更好地管理,而并非像vue框架那样的组件化,但这种方式可能更易于理解,可以作为过渡。
这是原来的目录结构

其中public目录里存放的是静态资源,按照传统的做法,css文件夹种存放less文件和css文件,img文件夹中存放图片资源,js中存放各页面(views目录中对应的页面)的js文件。
当页面越来越多,会遇到一些重复的部分。像图中的侧边菜单,顶部搜索框,底部菜单,在几个页面都有。如果每个页面拷贝一份样式,js,dom,当需求方要更改样式或者增加功能的时候,徒增工作量。

在一篇文章的启发下(前端开发工程化探讨),我将目录结构改成如下:

为了标准化,每个组件里的文件命名都相同。以侧边工具栏为例,dom.ejs是一个模板文件:

<div id="sideBar" class="side-bar" data-top="<%=top%>" data-bottom="<%=bottom%>" data-left="<%=left%>" data-right="<%=right%>">
        <div class="menu" > <span class="am-icon am-icon-chevron-down"></span><span class="am-icon am-icon-chevron-up"></span></div>
    <ul>
        <%for(var i in fn){%>
        <%if(fn[i]=="home"){%>
        <li>
            <a href="/Seller/mall/<%=sellerId%>">
                <span class="home"></span>
            </a>
        </li>
        <%}%>
        <%if(fn[i]=="cart"){%>
        <li>
            <a href="#">
                <span class="cart"></span>
            </a>
        </li>
        <%}%>
        <%if(fn[i]=="phone"){%>
        <li>
            <a href="tel:<%=phone%>">
                <span class="phone"></span>
            </a>
        </li>
        <%}%>
        <%if(fn[i]=="chat"){%>
        <li>
            <a href="http://wpa.qq.com/msgrd?v=3&uin=3330416080&site=qq&menu=yes">
                <span class="chat"></span>
            </a>
        </li>
        <%}%>
        <%}%>
    </ul>
</div>

如果不熟悉ejs模板的语法,可以百度一下。另外,此模板还支持嵌套,并传入参数。
例如,下面是一个列表容器的dom结构,配合js可以实现上拉加载功能,但列表项的样式可能不一样,你可以在使用时再根据传入的templateName参数决定用哪个模板,非常灵活。

<div id="<%=containerId%>" data-am-widget="list_news" class="wrapper am-list-news am-list-news-default am-no-layout">
    <div class="am-list-news-bd">
        <ul class="<%=list%> am-avg-sm-<%=columns%>">
        </ul>
        <%-include("../"+templateName+"/dom")%>
        <div class="pull-action" id="pull-up">
            <span class="am-icon-arrow-down pull-label" id="pull-up-label"> 上拉加载更多</span>
            <span class="am-icon-spinner am-icon-spin"></span>
            <span class="no-more">没有更多数据了</span>
        </div>
    </div>
</div>

在使用模板时,这样嵌入页面。

<%-include("../../public/MaiMai/ui/side_bar/dom",{fn:["home","phone","chat"],top:'',bottom:'70',left:'',right:'0'})%>

注意,应使用<%-include()%>,而非<%=include()%>。<%-%>表示内容原样输出,不进行运算。而<%=%>会生成运算后的内容。

然后,再来考虑js和css文件应当怎么处理。如果在页面中逐个引入组件的js和css文件,维护起来会非常不方便。所以我考虑将某个页面涉及到的组件,还有页面本身的js和css打包成一个。这样做有个缺点,每个页面的js和css文件会有重复的内容。如果用seajs或requirejs等模块加载,可以解决重复的问题,但也可能增加项目的复杂度。考虑到打包后的文件只有10K大小,还是暂时使用打包的方法。有兴趣的朋友也可以将js模块化并测试一下性能。
打包涉及到gulp的应用,有许多文章谈论到,而我是通过开源项目学习的。
首先我需要写一个page-config.json文件,告诉gulp我要打包哪些资源:

{
"template":"MaiMai",
"pages":[
{"ui":["pic_slider","search_bar1","side_bar","category_list","product_list2","cart_operator"],
"page":"index"},
{"ui":["search_bar2","side_bar","category_list","pull_up","product_list1","go_to_top","toast","cart_operator"],
"page":"filterList"},
{"ui":["side_bar","category_list","pull_up","product_list1","go_to_top","toast","cart_operator"],
"page":"topicList"},
{"ui":["pic_slider","side_bar","go_to_top","toast","cart_operator","pull_up","comment_list"],
"page":"details"},
{"ui":["cart_list","cart_operator"],
"page":"ui-test"
},{
"ui":["nav_back","cart_list","no_content","toast","cart_operator"],
"page":"cart"}
]
}

将文件放在模板目录的根目录下面,与src,dist同级。src存放原文件,dist存放生成后的文件。
再写一个gulpfile.js,用于自动构建。


guipfile

下面是gulp文件的写法:

//导入工具包 require('node_modules里对应模块')
var gulp = require('gulp'); //本地安装gulp所用到的地方
var concat = require('gulp-concat');//合并javascript
var uglify = require('gulp-uglify');//压缩javascript
var cssmin=require('gulp-clean-css');
var ext_replace = require('gulp-ext-replace');
var pageConfig=require('./page-config.json');
//合并js
gulp.task('js',function (cb) {
     count = 0;
  var end = function(){
    count ++;
    if(count >= pageConfig.pages.length) cb();
  };
  for(var i in pageConfig.pages){
    var paths=[];
    if(pageConfig.pages[i].ui&&pageConfig.pages[i].ui.length!=0)
    {
        for(var j in pageConfig.pages[i].ui){
        paths.push('ui/'+pageConfig.pages[i].ui[j]+'/*.js');
        }
        paths.push('src/js/'+pageConfig.pages[i].page+'.js');
    }
      gulp.src(paths)
       .pipe(concat({path:pageConfig.pages[i].page+'.js'}))
  .pipe(gulp.dest('dist/js/'))
  .on("end",end);
  }
});
//压缩js
gulp.task('uglify',["js"],function () {
    return gulp.src(['dist/js/*.js','!dist/js/*.min.js'])
    .pipe(uglify())
    .pipe(ext_replace('.min.js'))
    .pipe(gulp.dest('dist/js'));
})
//合并css
gulp.task('css',function (cb) {
     count = 0;
  var end = function(){
    count ++;
    if(count >= pageConfig.pages.length) cb();
  };
   for(var i in pageConfig.pages){
    var paths=[];
    if(pageConfig.pages[i].ui&&pageConfig.pages[i].ui.length!=0)
    {
        for(var j in pageConfig.pages[i].ui){
        paths.push('ui/'+pageConfig.pages[i].ui[j]+'/*.css');
        }
        paths.push('src/css/'+pageConfig.pages[i].page+'.css');
    }
      gulp.src(paths)
       .pipe(concat({path:pageConfig.pages[i].page+'.css'}))
  .pipe(gulp.dest('dist/css/'))
  .on("end",end);
  }
})
gulp.task('cssmin',["css"],function () {
    gulp.src([
        'dist/css/*.css',
    '!dist/css/*.min.css'
    ])
    .pipe(cssmin())
    .pipe(ext_replace('.min.css'))
    .pipe(gulp.dest('dist/css/'));
})
gulp.task('watch', function () {
  gulp.watch('src/js/*.js', ['uglify']);
  gulp.watch('ui/**/*.js', ['uglify']);
  gulp.watch('src/css/*.css', ['cssmin']);
  gulp.watch('ui/**/*.css', ['cssmin']);
});

gulp.task("default", ['uglify', 'cssmin']);

在使用时,要在命令行安装gulp,切换到gulpfile.js所在的目录,运行gulp watch,这样,每次在css和js更改时,会自动重新打包。当然,为了不重复操作,你可以写一个脚本文件。

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

推荐阅读更多精彩内容

  • 在现在的前端开发中,前后端分离、模块化开发、版本控制、文件合并与压缩、mock数据等等一些原本后端的思想开始...
    Charlot阅读 5,424评论 1 32
  • gulpjs是一个前端构建工具,与gruntjs相比,gulpjs无需写一大堆繁杂的配置参数,API也非常简单,学...
    小裁缝sun阅读 920评论 0 3
  • 在现在的前端开发中,前后端分离、模块化开发、版本控制、文件合并与压缩、mock数据等等一些原本后端的思想开始逐渐渗...
    彬_仔阅读 25,543评论 21 139
  • 无意中看到zhangwnag大佬分享的webpack教程感觉受益匪浅,特此分享以备自己日后查看,也希望更多的人看到...
    小小字符阅读 8,133评论 7 35
  • 在线阅读 http://interview.poetries.top[http://interview.poetr...
    程序员poetry阅读 114,222评论 24 450