Fork me on GitHub

微信小程序之WXS模块

前言

  • WXS(WeiXin Script)是小程序的一套脚本语言与 wxml 结合,可以构建出页面的结构。
  • WXS 代码可以编写在wxml文件中的 <wxs> 标签内,或以 .wxs 为后缀名的文件内。

基本介绍

模块
  • 每一个 .wxs 文件和 <wxs> 标签都是一个单独的模块
  • 每个模块都有自己独立的作用域。即在一个模块里面定义的变量与函数,默认为私有的对其他模块不可见
  • 一个模块要想对外暴露其内部的私有变量与函数,只能通过 module.exports 实现
.wxs 文件
  • 在微信开发者工具里面,右键可以直接创建 .wxs 文件,在其中直接编写 WXS 脚本。示例代码:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    /*
    /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 对象
  • module 对象有一个exports属性。 通过该属性,可以对外共享本模块的私有变量与函数
  • 示例代码:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    /*
    /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";
  • wxml的内容如下:

    1
    2
    3
    4
    5
    <!-- page/index/index.wxml -->

    <wxs src="./../tools.wxs" module="tools" />
    <view> {{tools.msg}} </view>
    <view> {{tools.bar(tools.FOO)}} </view>
  • 页面输出:

    1
    2
    some msg
    'hello world' from tools.wxs
require 函数
  • .wxs模块中引用其他 wxs 文件模块,可以使用 require函数
  • 引用的时候,要注意如下几点:
    • 只能引用.wxs文件模块,且必须使用相对路径
    • wxs 模块均为单例,wxs 模块在第一次被引用时,会自动初始化为单例对象。多个页面,多个地方,多次引用,使用的都是同一个 wxs 模块对象
    • 如果一个 wxs 模块在定义之后,一直没有被引用,则该模块不会被解析与运行
  • 示例代码:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    /*
    /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模块中引用tools.wxs文件模块:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    /*
    /pages/logic.wxs
    */

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

    console.log(tools.FOO);
    console.log(tools.bar("logic.wxs"));
    console.log(tools.msg);
  • wxml的内容如下:

    1
    2
    3
    <!-- /page/index/index.wxml -->

    <wxs src="./../logic.wxs" module="logic" />
  • 控制台输出:

    1
    2
    3
    'hello world' from tools.wxs
    logic.wxs
    some msg
wxs标签
  • <wxs>标签有两个属性,如下表所示:
属性名 类型 说明
module String 当前 <wxs> 标签的模块名。必填字段
src String 引用 .wxs 文件的相对路径。仅当本标签为单闭合标签标签的内容为空时有效
module 属性
  • module 属性是当前 <wxs> 标签的模块名。在单个 wxml 文件内,建议其值唯一。有重复模块名则按照先后顺序覆盖(后者覆盖前者)。不同文件之间的 wxs 模块名不会相互覆盖
  • module 属性值的命名必须符合下面两个规则:
    • 首字符必须是:字母(a-zA-Z),下划线(_)
    • 剩余字符可以是:字母(a-zA-Z),下划线(_), 数字(0-9)
  • 示例代码:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    <!--wxml-->

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

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

src 属性
  • src 属性可以用来引用其他的 wxs 文件模块
  • 示例代码:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    /*
    /pages/index/index.js
    */

    Page({
    data: {
    msg: "'hello wrold' from js",
    }
    })
  • wxml的内容如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    <!-- /pages/index/index.wxml -->

    <wxs src="./../comm.wxs" module="some_comms"></wxs>
    <!-- 也可以直接使用单标签闭合的写法
    <wxs src="./../comm.wxs" module="some_comms" />
    -->

    <!-- 调用 some_comms 模块里面的 bar 函数,且参数为 some_comms 模块里面的 foo -->
    <view> {{some_comms.bar(some_comms.foo)}} </view>

    <!-- 调用 some_comms 模块里面的 bar 函数,且参数为 page/index/index.js 里面的 msg -->
    <view> {{some_comms.bar(msg)}} </view>
  • 页面输出:

    1
    2
    'hello world' from comm.wxs
    'hello wrold' from js
  • 上述例子在文件/page/index/index.wxml中通过 <wxs> 标签引用了/page/comm.wxs模块。

  • 注意:
    • <wxs> 模块只能在定义模块的 WXML 文件中被访问到。使用 <include> 或 <import> 时,<wxs> 模块不会被引入到对应的 WXML 文件中。
    • <template> 标签中,只能使用定义该 <template> 的 WXML 文件中定义的 <wxs> 模块。

微信小程序,用js还是wxs?

  • 在开发微信小程序的时候,应该根据情况,选择使用js或wxs。
  • wxs是专门用于wxml页面的,如果我们有在页面中使用js脚本的需求可以使用wxs来实现。
  • wxs和js不能互相直接调用
  • wxs其实就是封装后的js,用法跟js一模一样。有些功能,用wxs和js都能实现,但是有时会发现用wxs更方便、直接
------ 本文结束 ------