小程序开发之脚本语言WXS

WXS

WXS（WeiXin Script）是小程序的一套脚本语言，结合 WXML，可以构建出页面的结构。
注意

1. wxs 不依赖于运行时的基础库版本，可以在所有版本的小程序中运行。
2. wxs 与 javascript 是不同的语言，有自己的语法，并不和 javascript 一致。
3. wxs 的运行环境和其他 javascript 代码是隔离的，wxs 中不能调用其他 javascript 文件中定义的函数，也不能调用小程序提供的API。
4. wxs 函数不能作为组件的事件回调。
5. 由于运行环境的差异，在 iOS 设备上小程序内的 wxs 会比 javascript 代码快 2 ~ 20 倍。在 android 设备上二者运行效率无差异。

以下是一些使用 WXS 的简单示例

页面渲染

index.wxml

<!--wxml-->
<wxs module="m1">var msg = "hello world"; module.exports.message = msg;</wxs>

<view>{
  {m1.message}}</view>

解析：页面输出：hello world

数据处理

index.js

  // page.js
  Page({
    data: {
      array: [1, 2, 3, 4, 5, 1, 2, 3, 4]
}
  })

index.wxml

<!--wxml-->
<!-- 下面的 getMax 函数，接受一个数组，且返回数组中最大的元素的值 -->
<wxs module="m1">
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;
</wxs>

<!-- 调用 wxs 里面的 getMax 函数，参数为 page.js 里面的 array -->
<view>{
  {m1.getMax(array)}}</view>

解析：页面输出：5

WXS 模块

WXS 代码可以编写在 wxml 文件中的 标签内，或以 .wxs 为后缀名的文件内。

模块

每一个 .wxs 文件和 标签都是一个单独的模块。
每个模块都有自己独立的作用域。即在一个模块里面定义的变量与函数，默认为私有的，对其他模块不可见。
一个模块要想对外暴露其内部的私有变量与函数，只能通过 module.exports 实现。

.wxs 文件

在微信开发者工具里面，右键可以直接创建 .wxs 文件，在其中直接编写 WXS 脚本。
示例代码：
index.wxs

// /pages/index.wxs
var foo = "'hello world' from comm.wxs";
var bar = function (d) {
  return d;
}
module.exports = {
  foo: foo,
  bar: bar
};

上述例子在 /pages//index.wxs 的文件里面编写了 WXS 代码。该 .wxs 文件可以被其他的 .wxs 文件 或 WXML 中的 标签引用。

module 对象

每个 wxs 模块均有一个内置的 module 对象。

exports – module 对象属性

• exports: 通过该属性，可以对外共享本模块的私有变量与函数。

例如：
tools.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";

index.wxml

<!-- page/index/index.wxml -->

<wxs src="./../tools.wxs" module="tools" />
<view>{
  {tools.msg}}</view>
<view>{
  {tools.bar(tools.FOO)}}</view>

解析：页面输出：

some msg
‘hello world’ from tools.wxs

require函数

在.wxs模块中引用其他 wxs 文件模块，可以使用 require 函数。
引用的时候，要注意如下几点：

• 只能引用 .wxs 文件模块，且必须使用相对路径。
• wxs 模块均为单例，wxs 模块在第一次被引用时，会自动初始化为单例对象。多个页面，多个地方，多次引用，使用的都是同一个 wxs 模块对象。
• 如果一个 wxs 模块在定义之后，一直没有被引用，则该模块不会被解析与运行。

示例代码：
tools.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";

logic.wxs

// /pages/logic.wxs

var tools = require("./tools.wxs");

console.log(tools.FOO);
console.log(tools.bar("logic.wxs"));
console.log(tools.msg);

index.wxml

<!-- /page/index/index.wxml -->

<wxs src="./../logic.wxs" module="logic" />

解析：控制台输出：

‘hello world’ from tools.wxs
logic.wxs
some msg

标签

module 属性

module 属性是当前 标签的模块名。在单个 wxml 文件内，建议其值唯一。有重复模块名则按照先后顺序覆盖（后者覆盖前者）。不同文件之间的 wxs 模块名不会相互覆盖。
module 属性值的命名必须符合下面两个规则：

• 首字符必须是：字母（a-zA-Z），下划线（_）
• 剩余字符可以是：字母（a-zA-Z），下划线（_）， 数字（0-9）

index.wxml

<!--wxml-->

<wxs module="foo">
  var some_msg = "hello world"; module.exports = { msg : some_msg, }
</wxs>
<view>{
  {foo.msg}}</view>

解析：页面输出：

hello world

上面例子声明了一个名字为 foo 的模块，将 some_msg 变量暴露出来，供当前页面使用。

src 属性

src 属性可以用来引用其他的 wxs 文件模块。