文件依赖使用手册

概述

随着前端系统的日渐复杂,一套系统所引入的脚本文件会越来越多,为了便于开发者管理脚本文件,本文档提供了一套依赖管理系统,按照此系统中定义的规范来管理和使用脚本,在后续开发过程中会得到更多的支持,配套提供前端打包发布工具。 依赖管理系统所管理的最小单元为文件,即每个文件需要定义本文件名称和依赖的文件名称列表

使用

依赖库

img

依赖接口

####define img

应用举例

img

## 依赖配置 依赖配置使用define.js文件的查询参数进行配置

路径配置

文件定义时指定的路径可以通过路径配置的变量来指定前缀,如路径配置时指定了变量A,则文件定义时可以直接使用”{A}”来表示A指定的路径前缀。

img

lib

框架路径配置名称为”lib”,文件定义和依赖时可直接使用”{lib}”来表示框架的路径。此配置信息通过外联的define.js路径自动解析。

pro

项目脚本根路径配置名称为“pro”,文件定义和依赖时可直接使用“{pro}”来表示脚本根路径,此配置信息可以通过外联的define.js路径中的查询串进行配置。如果没有自定义配置则默认相对于引入define.js的文件所在目录的“../javascript/”路径。

patch

框架补丁路径配置名称为“patch”,文件定义和依赖时可直接使用”{patch}”来表示补丁的路径。此配置信息通过外联的define.js路径中的查询串中的p参数解析。

native

框架混合模式路径配置名称为“native”,文件定义和依赖时可直接使用”{native}”来表示混合native适配的路径。此配置信息通过外联的define.js路径中的查询串中的p参数解析。

自定义路径

其他自定义路径可以通过引入define.js文件时作为查询参数输入进行配置,如自定义com路径,则可以通过以下方式进行配置(配置路径中以”./”、”../”起始的相对路径相对于当前html文件) img

###平台配置 平台参数在开发及打包过程中都会使用,框架支持平台参数的配置通过define.js路径上查询串中的p参数输入。 平台配置信息,此配置又分两类基本配置:补丁配置和混合配置,因为混合模式下使用的浏览器引擎固定,因此当配置中出现混合类型的配置时忽略补丁配置的值。 如果在引入依赖定义库时未指定平台信息则表示系统需对全平台浏览器支持。

补丁配置

主要用来修正浏览器平台对接口及控件的支持,按照目前浏览器引擎划分,参数值由一个或者多个平台标识组成,标识支持如下所示: img 对于此类值的配置自动生成的patch路径值为{lib}patched/目录下的一个或者多个路径,因为为非混合模式,因此native值不存在,实际引入的框架和应用中都不允许出现{native}的路径。

混合配置

主要用于混合开发模式下对native接口的适配,按照native平台划分,参数值由一个标识组成,多个标识则以识别的第一个标识为准,标识支持如下所示: img 对于此类值的配置自动生成的patch路径值为{lib}patched/目录下对应的引擎目录,native值为{lib}native/目录下的具体配置目录。 img

文件定义

###通用 文件定义使用define接口,define支持以下几种形式 完整形式:带三个参数依次为:当前文件路径,依赖文件列表,文件执行函数

img

省略当前文件路径:带两个参数依次为:依赖文件列表,文件执行函数,用于系统入口文件

img

省略依赖列表:带两个参数依次为:当前文件路径,文件执行函数

img

只有执行函数:带一个文件执行函数的参数,多用于没有依赖的入口文件,这类文件等价于直接定义一个函数执行,一般也可以不使用依赖系统

img

规范

考虑到实际开发过程中IDE支持的情况,项目中采用统一的规范来进行文件定义

  • 文件执行函数统一定义为函数变量f
  • 文件定义语句写在文件尾端,文件执行函数传入前面定义的具名函数变量f

img

使用范例

html文件中使用

img

javascript文件中使用

img

© 1997-2013 Netease. All Rights Reserved.
comments powered by Disqus