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

JavaScript029

nodejs:用ejs模板和gulp实现前端组件化,第1张

最近在用nodejs将公司商城的底层重写。基于nodejs的强大,我从原本的只写前端变成了写全栈。

框架采用express,模板用ejs,前端用amazeui. 做完三个页面后,设计突然说要改UI设计,我勒个去,郁闷地一个个页面重新调整。下班之后反思一下,觉得花了太多时间在重复劳动上,是时候涉猎一下前端工程化的知识了。

用百度在互联网畅游了一番,总结了一下前端工程化的几个关键要素:编码规范化,结构模块化,流程自动化。本文所述的方法属于模块化,但只是简单地把dom,css,js拆分,以便更好地管理,而并非像vue框架那样的组件化,但这种方式可能更易于理解,可以作为过渡。

这是原来的目录结构

其中public目录里存放的是静态资源,按照传统的做法,css文件夹种存放less文件和css文件,img文件夹中存放图片资源,js中存放各页面(views目录中对应的页面)的js文件。

当页面越来越多,会遇到一些重复的部分。像图中的侧边菜单,顶部搜索框,底部菜单,在几个页面都有。如果每个页面拷贝一份样式,js,dom,当需求方要更改样式或者增加功能的时候,徒增工作量。

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

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

如果不熟悉ejs模板的语法,可以百度一下。另外,此模板还支持嵌套,并传入参数。

例如,下面是一个列表容器的dom结构,配合js可以实现上拉加载功能,但列表项的样式可能不一样,你可以在使用时再根据传入的templateName参数决定用哪个模板,非常灵活。

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

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

然后,再来考虑js和css文件应当怎么处理。如果在页面中逐个引入组件的js和css文件,维护起来会非常不方便。所以我考虑将某个页面涉及到的组件,还有页面本身的js和css打包成一个。这样做有个缺点,每个页面的js和css文件会有重复的内容。如果用seajs或requirejs等模块加载,可以解决重复的问题,但也可能增加项目的复杂度。考虑到打包后的文件只有10K大小,还是暂时使用打包的方法。有兴趣的朋友也可以将js模块化并测试一下性能。

打包涉及到gulp的应用,有许多文章谈论到,而我是通过开源项目学习的。

首先我需要写一个page-config.json文件,告诉gulp我要打包哪些资源:

将文件放在模板目录的根目录下面,与src,dist同级。src存放原文件,dist存放生成后的文件。

再写一个gulpfile.js,用于自动构建。

下面是gulp文件的写法:

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

 前端通常作为模板,后端负责数据。

前后端合作的主要目的,就是把后端产生的数据丢到前端的模板中。通常这一步有两种方式:

1. 前端的模板交给后端处理,直接写到后端逻辑中,或者通过 MVC 框架整合成后端的相对独立的部分;

2. 后端的数据通过 API 的方式交给前端处理,通过 Ajax 等方式传输数据。

(当然,也有两种方式混合处理的)

如果采用了后端处理模板的方式,那前端开发完静态模板后,需要交给后端开发人员进行模板的整合。这一步要求前端代码整洁易读,而且后端必须熟悉各种前端知识和调试技术。最后需要前端对后端处理过的页面进行检验和调试。(这种方式对沟通要求很高,如果两个人不坐在一起,那合作起来非常麻烦。出现问题或者需要升级时,往往很难定位谁的错,谁去改。所以最好两个人坐在一起开发,甚至一个人负责前后端)

如果采用前端处理数据,Ajax 等方式通信的话,前后端只要商量好所需的 API,然后持续交付一个个 API 就好了。前后端完全不需要了解,技术没有限制,也不需要知道彼此的代码和实现。

两种方式如何选择?

1. 如果前端页面主要做内容展示,需要后端处理的内容比较多,而前端逻辑简单时,建议采用后端 MVC。如博客、新闻类的网站;

2. 如果前端页面的交互和数据处理较多,可以将逻辑放在前端,而后端只负责数据存取。比如各类管理后台。