WXS 官方文档的内容
WXS(WeiXin Script)是小程序的一套脚本语言,结合 WXML,可以构建出页面的结构。
注意
- WXS 不依赖于运行时的基础库版本,可以在所有版本的小程序中运行。
- WXS 与 JavaScript 是不同的语言,有自己的语法,并不和 JavaScript 一致。
- WXS 的运行环境和其他 JavaScript 代码是隔离的,WXS 中不能调用其他
JavaScript 文件中定义的函数,也不能调用小程序提供的API。 - WXS 函数不能作为组件的事件回调。
- 由于运行环境的差异,在 iOS 设备上小程序内的 WXS 会比 JavaScript 代码快 2 ~ 20 倍。在 android 设备上二者运行效率无差异。
以下是一些使用 WXS 的简单示例,要完整了解 WXS 语法,请参考WXS 语法参考。
页面渲染
var msg = "hello world"; module.exports.message = msg; {{m1.message}} 页面输出: hello world 数据处理
// page.js Page({ data: { array: [1, 2, 3, 4, 5, 1, 2, 3, 4] } }) var getMax = function(array) { var max = undefined; for (var i = 0; i < array.length; ++i) { max = max === undefined ? array[i] : (max >= array[i] ? max : array[i]); } return max; } module.exports.getMax = getMax; {{m1.getMax(array)}} 页面输出: 5 注释
WXS 主要有 3 种注释的方法。
示例代码:
// 方法一:单行注释 /* 方法二:多行注释 */ /* 方法三:结尾注释。即从 /* 开始往后的所有 WXS 代码均被注释 var a = 1; var b = 2; var c = "fake"; 上述例子中,所有 WXS 代码均被注释掉了。 wxs ,如同HTML和JavaScript可以混写一样,WXML也可以和wxs混写,但是WXML不允许和JavaScript混写。
为什么要引入wxs?
(这主要是因为原先在WXML中,只能通过简单的数据绑定来实现交互。交互的目的从根本上说也就是能够动态地根据系统和用户的操作事件来给出动态地响应。原先要实现这一点,必须把视图层和逻辑层完全分开,在视图层放置一些数据变量,然后一切事件响应只能在逻辑层完成。逻辑层中的数据变了,视图中的数据才能发生变化。这样的设计让人感觉不太方便。在针对浏览器的编程中,视图层和逻辑层不一定分开,可以直接在视图层中完成很多事件响应等逻辑。这样对于开发者来说,有些时候比较直观一点。)这是别人的一些描述。现在它的功能又增加了许多,看一下官方对wxs 响应事件的背景描述。
有频繁用户交互的效果在小程序上表现是比较卡顿的,例如页面有 2 个元素 A 和 B,用户在 A 上做 touchmove 手势,要求 B 也跟随移动,movable-view 就是一个典型的例子。一次 touchmove 事件的响应过程为:
a、 touchmove 事件从视图层(Webview)抛到逻辑层(App Service)
b、逻辑层(App Service)处理 touchmove 事件,再通过 setData 来改变 B 的位置
一次 touchmove 的响应需要经过 2 次的逻辑层和渲染层的通信以及一次渲染,通信的耗时比较大。此外 setData 渲染也会阻塞其它脚本执行,导致了整个用户交互的动画过程会有延迟。
| 小程序框架 | 浏览器 | 作用 |
|---|---|---|
| wxml | html | 决定视图层中有哪些元素和组件 |
| wxss | css | 决定视图层中的元素和组件的外观和位置 |
| wxs | js | 在视图层引入一些逻辑操作 |
| js | js | 逻辑层 |
在 开发者文档——>>框架——>>wxs语法参考 下面有许多子项,可以拿来读一读。
WXS 模块
WXS 代码可以编写在 wxml 文件中的 标签内,或以 .wxs 为后缀名的文件内。
模块
每一个 .wxs 文件和 标签都是一个单独的模块。
每个模块都有自己独立的作用域。即在一个模块里面定义的变量与函数,默认为私有的,对其他模块不可见。
一个模块要想对外暴露其内部的私有变量与函数,只能通过 module.exports 实现。
.wxs 文件
在微信开发者工具里面,右键可以直接创建 .wxs 文件,在其中直接编写 WXS 脚本。
示例代码:
// /pages/comm.wxs var foo = "'hello world' from comm.wxs"; var bar = function(d) { return d; } module.exports = { foo: foo, bar: bar }; 上述例子在 /pages/comm.wxs 的文件里面编写了 WXS 代码。该 .wxs 文件可以被其他的 .wxs 文件 或 WXML 中的 标签引用。
module 对象
每个 wxs 模块均有一个内置的 module 对象
属性
- exports: 通过该属性,可以对外共享本模块的私有变量与函数。
示例代码:
// /pages/tools.wxs var foo = "'hello world' from tools.wxs"; var bar = function (d) { return d; } module.exports = { FOO: foo, bar: bar, }; module.exports.msg = "some msg"; {{tools.msg}} {{tools.bar(tools.FOO)}} 页面输出:
some msg 'hello world' from tools.wxs require函数
在.wxs模块中引用其他 wxs 文件模块,可以使用 require 函数。
引用的时候,要注意如下几点:
- 只能引用 .wxs 文件模块,且必须使用相对路径。
- wxs 模块均为单例,wxs 模块在第一次被引用时,会自动初始化为单例对象。多个页面,多个地方,多次引用,使用的都是同一个 wxs 模块对象。
- 如果一个 wxs 模块在定义之后,一直没有被引用,则该模块不会被解析与运行。
示例代码:
// /pages/tools.wxs var foo = "'hello world' from tools.wxs"; var bar = function (d) { return d; } module.exports = { FOO: foo, bar: bar, }; module.exports.msg = "some msg"; // /pages/logic.wxs var tools = require("./tools.wxs"); console.log(tools.FOO); console.log(tools.bar("logic.wxs")); console.log(tools.msg); 控制台输出:
'hello world' from tools.wxs logic.wxs some msg 标签
| 属性名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| module | String | 当前 标签的模块名。必填字段。 | |
| src | String | 引用 .wxs 文件的相对路径。仅当本标签为单闭合标签或标签的内容为空时有效。 |
module 属性
module 属性是当前 标签的模块名。在单个 wxml 文件内,建议其值唯一。有重复模块名则按照先后顺序覆盖(后者覆盖前者)。不同文件之间的 wxs 模块名不会相互覆盖。
module 属性值的命名必须符合下面两个规则:
- 首字符必须是:字母(a-zA-Z),下划线(_)
- 剩余字符可以是:字母(a-zA-Z),下划线(_), 数字(0-9)
示例代码:
var some_msg = "hello world"; module.exports = { msg : some_msg, } {{foo.msg}} 页面输出:
hello world 上面例子声明了一个名字为 foo 的模块,将 some_msg 变量暴露出来,供当前页面使用。
src 属性
src 属性可以用来引用其他的 wxs 文件模块。
引用的时候,要注意如下几点:
- 只能引用 .wxs 文件模块,且必须使用相对路径。
- wxs 模块均为单例,wxs 模块在第一次被引用时,会自动初始化为单例对象。多个页面,多个地方,多次引用,使用的都是同一个 wxs 模块对象。
- 如果一个 wxs 模块在定义之后,一直没有被引用,则该模块不会被解析与运行。
示例代码:
// /pages/index/index.js Page({ data: { msg: "'hello wrold' from js", } }) {{some_comms.bar(some_comms.foo)}} {{some_comms.bar(msg)}} 页面输出:
'hello world' from comm.wxs 'hello wrold' from js 上述例子在文件 /page/index/index.wxml 中通过 标签引用了 /page/comm.wxs 模块。
注意
- 模块只能在定义模块的 WXML 文件中被访问到。使用 或 时, 模块不会被引入到对应的 WXML 文件中。
标签中,只能使用定义该的 WXML 文件中定义的 模块。