前端框架选型是企业提升开发效率与用户体验的关键因素
822
2022-10-20
scrat- WEBAPP 模块化开发框架
在模块化系统的结构中,模块是可组合、可分解和更换的单元,这就要求模块本身具有一定的独立性,完整的前端模块化方案需要将js、css和模板维护在一起,保证模块的独立。
规范
在scrat中静态资源分成 模块化资源 和 非模块化资源 两类,其中模块化资源还分为 工程模块 和 生态模块 两类。
模块化资源:具有独立性的模块所对应的静态资源。每个独立的模块将自己所需要的js、css、模板、图片等资源放在一起维护,使得模块具备独立性,引用模块的js即可。工程模块:当前工程所开发的模块。这些模块通常跟业务耦合较高。生态模块:从 模块生态 -的模块,属于外部依赖。非模块化资源:虽然在模块化开发体系内,应该 一切皆模块,但总有不应该成为模块的资源,比如入口页面、模块化框架、页面启动器等。
其目录规范为:
project ├─ component_modules (生态模块) ├─ components (工程模块) ├─ views (非模块化资源) ├─ ...
如果把所有资源都扔到 views 目录下,scrat也可以退化为传统的无模块前端项目,模块化与非模块化资源之间的平衡可以由开发者自己把握。
开发工程模块
在模块化系统中,开发模块将变得非常简单,比如我们要开发一个 foo 模块,有模板、样式、交互功能。首先,在 工程模块目录下创建一个foo目录,并在其中添加js、css、模板、图片等资源:
project ├─ component_modules (生态模块目录) ├─ components (工程模块目录) │ └─ foo │ ├─ icon.png │ ├─ foo.css │ ├─ foo.tpl │ └─ foo.js ├─ views (非模块化资源) ├─ ...
foo.js
像写nodejs一样写js模块
// 使用__inline函数嵌入其他资源,如果// 是图片,构建后会替换为base64字符串var tpl = __inline('foo.tpl');// 使用__uri函数定位资源,构建后会替换// 为部署后的绝对路径var icon = __uri('icon.png');//像nodejs那样导出APIexports.render = function(dom){ dom.innerHTML = tpl;};exports.icon = function(img){ img.src = icon;};
foo.tpl
模板会被嵌入到js中使用
blablabla
foo.css
css也能模块化
.foo { font-size: 12px;}.foo-title { /* 使用相对路径引用资源 */ background: url(icon.png) no-repeat; padding-left: 30px; font-size: 15px;}.foo-content { padding: 10px;}
将源码中的相对路径构建后替换为部署后的绝对路径,是模块独立性的基本保证。只有将模块所需的样式、结构、逻辑都维护在一起,并且部署后还能定位到,才能保证模块独立可用。
关于工程模块的一些约定:
与目录同名的js为模块主文件。即foo.js是foo模块的主文件。与js同名的css文件会自动建立依赖关系。比如foo.js自动依赖foo.css。任何文件命名没有约束,主文件的与目录同名要求只是为了引用方便而已。在代码中使用工程相对路径开发,scrat构建会后自动替换成绝对路径。
安装生态模块
使用生态模块可以提高开发效率,scrat采用 component规范作为生态规范,因此用户可以从component生态中直接-组件供项目使用。
从生态安装模块之前,需要先在工程中创建一个 component.json 文件,内容为空的json内容 {} 即可:
project ├─ component_modules (生态模块目录) ├─ components ├─ views ├─ component.json (生态依赖描述) ├─ ...
component有很丰富的组件生态,比如 FortAwesome/Font-Awesome字体图标库,可以使用scrat直接从GitHub-放到项目中使用。
在项目目录下执行:
scrat install FortAwesome/Font-Awesome
安装完成后,component_modules目录下下会出现font-awesome模块的安装文件:
project ├─ component_modules (生态模块目录) │ └─ FortAwesome-Font-Awesome │ └─ 4.1.0 │ ├─ component.json │ ├─ css │ │ └─ font-awesome.css │ └─ fonts │ ├─ FontAwesome.otf │ ├─ fontawesome-webfont.eot │ ├─ fontawesome-webfont.svg │ ├─ fontawesome-webfont.ttf │ └─ fontawesome-webfont.woff ├─ components ├─ views ├─ component.json (生态依赖描述) ├─ ...
component.json文件也记录了安装的模块名及其版本:
{ "dependencies": { "FortAwesome/Font-Awesome": "4.1.0" }}
这样,一个来自生态的模块就可以在项目中直接使用了。
有关模块生态的更多内容请阅读 这里。
引用模块
开发或安装好一个模块之后,需要做的仅仅就是使用它们。由于资源分为模块化和非模块化两类,因此在不同的资源下引用模块是有所不同的。
在模块化js中引用模块
如nodejs般使用require函数就可以了
// 引用其他模块var foo = require('foo');// 引用当前目录下的文件var conf = require('./conf.js');// 调用模块接口foo.render(document.body);
在模块化css中引用模块
使用注释中的@require xxx来标记依赖
/** * 引用模块 * @require font-awesome * * 引用文件 * @require ./bar.css */.foo .fa { font-size: 20px;}
在非模块化文件中使用模块
非模块化文件通过 模块化框架 来异步加载需要的模块,比如项目的主页面:
......
模块化框架的具体工作原理请阅读这里。
版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。
发表评论
暂时没有评论,来抢沙发吧~