微信小程序WXS模塊的使用詳解

WXS 模塊

WXS 代碼可以編寫(xiě)在 wxml 文件中的 <wxs> 標(biāo)簽內(nèi)，或以 .wxs 為后綴名的文件內(nèi)。

模塊

每一個(gè) .wxs 文件和 <wxs> 標(biāo)簽都是一個(gè)單獨(dú)的模塊。

每個(gè)模塊都有自己獨(dú)立的作用域。即在一個(gè)模塊里面定義的變量與函數(shù)，默認(rèn)為私有的，對(duì)其他模塊不可見(jiàn)。

一個(gè)模塊要想對(duì)外暴露其內(nèi)部的私有變量與函數(shù)，只能通過(guò) module.exports 實(shí)現(xiàn)。

.wxs 文件

在微信開(kāi)發(fā)者工具里面，右鍵可以直接創(chuàng)建 .wxs 文件，在其中直接編寫(xiě) 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 的文件里面編寫(xiě)了 WXS 代碼。該 .wxs 文件可以被其他的 .wxs 文件 或 WXML 中的 <wxs> 標(biāo)簽引用。

module 對(duì)象

每個(gè) wxs 模塊均有一個(gè)內(nèi)置的 module 對(duì)象。

屬性

exports: 通過(guò)該屬性，可以對(duì)外共享本模塊的私有變量與函數(shù)。

示例代碼：

// /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";

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

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

<view> {{tools.msg}} </view>

<view> {{tools.bar(tools.FOO)}} </view>

頁(yè)面輸出：

some msg

'hello world' from tools.wxs

require 函數(shù)

在.wxs模塊中引用其他 wxs 文件模塊，可以使用 require 函數(shù)。

引用的時(shí)候，要注意如下幾點(diǎn)：

只能引用 .wxs 文件模塊，且必須使用相對(duì)路徑。

wxs 模塊均為單例，wxs 模塊在第一次被引用時(shí)，會(huì)自動(dòng)初始化為單例對(duì)象。多個(gè)頁(yè)面，多個(gè)地方，多次引用，使用的都是同一個(gè) wxs 模塊對(duì)象。

如果一個(gè) wxs 模塊在定義之后，一直沒(méi)有被引用，則該模塊不會(huì)被解析與運(yùn)行。

示例代碼：

// /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);

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

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

控制臺(tái)輸出：

'hello world' from tools.wxs

logic.wxs

some msg

<wxs> 標(biāo)簽

屬性名	類(lèi)型	默認(rèn)值	說(shuō)明
module	String		當(dāng)前<wxs>標(biāo)簽的模塊名。必填字段。
src	String		引用 .wxs 文件的相對(duì)路徑。僅當(dāng)本標(biāo)簽為單閉合標(biāo)簽或標(biāo)簽的內(nèi)容為空時(shí)有效。

module 屬性

module 屬性是當(dāng)前 <wxs> 標(biāo)簽的模塊名。在單個(gè) wxml 文件內(nèi)，建議其值唯一。有重復(fù)模塊名則按照先后順序覆蓋（后者覆蓋前者）。不同文件之間的 wxs 模塊名不會(huì)相互覆蓋。

module 屬性值的命名必須符合下面兩個(gè)規(guī)則：

首字符必須是：字母（a-zA-Z），下劃線(xiàn)（_）

剩余字符可以是：字母（a-zA-Z），下劃線(xiàn)（_）， 數(shù)字（0-9）

示例代碼：

<!--wxml-->

<wxs module="foo">

var some_msg = "hello world";

module.exports = {

    msg : some_msg,

}

</wxs>

<view> {{foo.msg}} </view>

頁(yè)面輸出：

hello world

上面例子聲明了一個(gè)名字為 foo 的模塊，將 some_msg 變量暴露出來(lái)，供當(dāng)前頁(yè)面使用。

src 屬性

src 屬性可以用來(lái)引用其他的 wxs 文件模塊。

引用的時(shí)候，要注意如下幾點(diǎn)：

只能引用 .wxs 文件模塊，且必須使用相對(duì)路徑。

wxs 模塊均為單例，wxs 模塊在第一次被引用時(shí)，會(huì)自動(dòng)初始化為單例對(duì)象。多個(gè)頁(yè)面，多個(gè)地方，多次引用，使用的都是同一個(gè) wxs 模塊對(duì)象。

如果一個(gè) wxs 模塊在定義之后，一直沒(méi)有被引用，則該模塊不會(huì)被解析與運(yùn)行。

示例代碼：

// /pages/index/index.js

Page({

  data: {

    msg: "'hello wrold' from js",

  }

})

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

<wxs src="./../comm.wxs" module="some_comms"></wxs>

<!-- 也可以直接使用單標(biāo)簽閉合的寫(xiě)法

<wxs src="./../comm.wxs" module="some_comms" />

-->

<!-- 調(diào)用 some_comms 模塊里面的 bar 函數(shù)，且參數(shù)為 some_comms 模塊里面的 foo -->

<view> {{some_comms.bar(some_comms.foo)}} </view>

<!-- 調(diào)用 some_comms 模塊里面的 bar 函數(shù)，且參數(shù)為 page/index/index.js 里面的 msg -->

<view> {{some_comms.bar(msg)}} </view>

頁(yè)面輸出：

'hello world' from comm.wxs

'hello wrold' from js

上述例子在文件 /page/index/index.wxml 中通過(guò) <wxs> 標(biāo)簽引用了 /page/comm.wxs 模塊。

注意

<wxs> 模塊只能在定義模塊的 WXML 文件中被訪問(wèn)到。使用 <include> 或 <import> 時(shí)，<wxs> 模塊不會(huì)被引入到對(duì)應(yīng)的 WXML 文件中。

<template> 標(biāo)簽中，只能使用定義該 <template> 的 WXML 文件中定義的 <wxs> 模塊。