sea.js快速上手

html-css021

sea.js快速上手,第1张

一、seajs.config配置说明:

1.base说明:

base是字符串类型,表示基础或叫做根路径(最好绝对地址)

备注:

(1)base如果不写的话是根据你引用sea.js的地址目录

(2)base如果写了’.’或者 ‘/’或者’ ’这些,会默认从服务根目录开始

(3)base如果写了’js/’之类的相对路径,会默认根据你引用sea.js的地址目录

例如:

seajs.config({

base: 'http://example.com/path/to/base/'

})

2.alias说明

例如:

seajs.config({

base: 'http://example.com/path/to/base/',

// 别名配置

alias: {

'es5-safe': 'gallery/es5-safe/0.9.3/es5-safe',

'jquery': 'jquery/jquery/1.10.1/jquery'

}

})

引入的时候:加载模块(seajs.use("es5-safe"))  引入模块 :(require("jquery"))

3.paths说明:

当目录比较深,或需要跨目录调用模块时,可以使用paths来简化书写。

例如:

seajs.config({

base:'http://example.com/path/to/base/',

//表示路径配置

paths:{

'cwd':'static/common/js'

},

alias: {

'es5-safe': 'gallery/es5-safe/0.9.3/es5-safe',

'jquery': 'jquery/jquery/1.10.1/jquery',

'jquery':'cwd/common/jquery-1.11.3'//alias中使用 static/common/js/common/jquery-1.11.3

}

})

seajs.use('cwd/project/AA')//static/common/js/project/AA

var index = require(cwd/index)//  static/common/js/index.js

4.map说明:

map是Array类型,表示配置可对模块路径进行映射修改,可用于路径转换、在线调试等。

例如:

seajs.config({

map: [

//[ '.js' ,  '-debug.js' ]

['.js' , '.js?_t='+(new Date).getTime()]

]

})

define(function(require, exports, module) {

var a = require('./a')

//=>加载的是 path/to/a-debug.js

})

5.preload说明:(备注该属性在V2.3版本时候去除了)

preload是Array或String类型,表示预加载项,可以在普通模块加载前,提前加载并初始化好指定模块。

备注:preload中的空字符串会被忽略掉。使用时需要等到 use 才加载

例如:

seajs.config({

preload: ["jquery"]

})

6.debugBoolean 调试使用

值为 true 时,加载器不会删除动态插入的 script 标签。插件也可以根据 debug 配置,来决策 log 等信息的输出。

seajs.config({

debug:true

})

7.vars变量配置

有些场景下,模块路径在运行时才能确定,这时可以使用vars变量来配置。

seajs.config({

vars: {

'locale': 'zh-cn'

}

})

define(function(require, exports, module) {

var lang = require('./i18n/{locale}.js')

//=>加载的是 path/to/i18n/zh-cn.js

})

vars配置的是模块标识中的变量值,在模块标识中用{key}来表示变量。

二、 define

1.所有模块都通过 define 来定义

define(function(require, exports, module) {

(1). // 通过require.async引入依赖(引入模块)

require.async是异步加载的在引入后,的回调函数中才能使用,函数返回值就是require对象

require.async("jquery",fun) 异步加载模块  jquery(别名)  fun回调函数(可选参数)

require.async(['lib/common/common.js','lib/common/index.js'],function(){

Echo.init({

offset: 150,  //离可视区域多少像素的图片可以被加载

throttle: 10  //图片延迟多少毫秒加载

})

})  //调用多个模块    fun回调函数可选()

(2).require引入依赖(引入模块)

Require引入就可以使用

var Spinning = require('lib/common/common.js')  基础地址/lib/common/common.js

Spinning.tostring()      调用Spinning里面的tostring方法

require直接引入整个文件

require.async(["swiper"], function() {

require('module/Mycenter/mycenter')

})

2.对外暴露接口

// 通过exports对外提供接口

exports.tonumber = function(){ var  a = 0}

// 或者通过module.exports提供整个接口  (推荐使用)

module.exports.tonumber = function(){ var  a = 0}

})

三 、use()

seajs.use 用来在页面中加载模块。通过 use 方法,可以在页面中加载任意模块。use 的模块路径相对于当前页面

语法:seajs.use(id, callback?)

// 加载模块 main,并在加载完成时,执行指定回调

seajs.use(‘./main’)加载模块

seajs.use(‘./main’, function(main) {

main.init()

})

use 方法还可以一次加载多个模块:

// 并发加载模块 a 和模块 b,并在都加载完成时,执行指定回调

seajs.use(['./a', './b'], function(a, b) {        加载多个模块  fun回调函数(可选参数)

a.init()

b.init()

})

四、注意

引入 sea.js 时,可以把 sea.js 与其他文件打包在一起,可提前合并好,或利用 combo 服务动态合并。无论哪一种方式,为了让 sea.js内部能快速获取到自身路径,推荐手动加上 id 属性:

seajs.config

alias

别名配置,配置之后可在模块中使用require调用 require('jquery')

paths

设置路径,方便跨目录调用。通过灵活的设置path可以在不影响base的情况下指定到某个目录。

vars

变量配置。有些场景下,模块路径在运行时才能确定,这时可以使用 vars变量来配置。

vars 配置的是模块标识中的变量值,在模块标识中用 {key}来表示变量。

map

该配置可对模块路径进行映射修改,可用于路径转换、在线调试等。

preload

使用preload配置项,可以在普通模块加载前,提前加载并初始化好指定模块。

注:preload中的空字符串会被忽略掉。

注:preload中的配置,需要等到 use 时才加载。比如:

注:preload 配置不能放在模块文件里面:

debug

值为true时,加载器不会删除动态插入的 script 标签。插件也可以根据debug配置,来决策 log 等信息的输出。

base

Sea.js 在解析顶级标识时,会相对 base 路径来解析。

charset

获取模块文件时,<script>或 <link>标签的charset属性。 默认是utf-8

charset还可以是一个函数:

seajs.use

用来在页面中加载一个或多个模块。seajs.use(id, callback?)

注意:seajs.use 与 DOM ready 事件没有任何关系。如果某些操作要确保在 DOM ready 后执行,需要使用 jquery 等类库来保证。比如

注意:use方法第一个参数一定要有,但是可以是null,也可以是一个变量

seajs.cache

通过 seajs.cache,可以查阅当前模块系统中的所有模块信息。

比如,打开 seajs.org,然后在 WebKit Developer Tools 的 Console 面板中输入 seajs.cache,可以看到:

seajs.reslove

类似require.resolve,会利用模块系统的内部机制对传入的字符串参数进行路径解析。

seajs.data

通过 seajs.data,可以查看 seajs 所有配置以及一些内部变量的值,可用于插件开发。当加载遇到问题时,也可用于调试。