微信小程序WXS模块的使用

WXS模块的使用

微信官方文档地址

index.wxml

<view class="container">
	<view>{{common.msg}}</view>
	<view>{{common.foo}}</view>
	<view>{{foo.value}}</view>
</view>

<!-- module 当前 <wxs> 标签的模块名。必填字段。 -->
<!-- src 引用 .wxs 文件的相对路径。仅当本标签为单闭合标签或标签的内容为空时有效。 -->

<!-- 单标签 引入wxs文件-->
<wxs src="../wxs/common.wxs" module="common" />

<!-- 双标签 -->
<wxs module="foo">
	var common = require('../wxs/common.wxs')
	// 在.wxs模块中引用其他 wxs 文件模块， 可以使用 require 函数。
	module.exports = {
		value: common.inArray([1, 2, 3], 1)
	}
	// 方法一：单行注释
	/*
	方法二：多行注释
	*/
	/*
	方法三：结尾注释。即从 /* 开始往后的所有 WXS 代码均被注释
</wxs>

index.wxss

.container{
  height: 100vh;
  display: flex;
  flex-direction: column;
  align-items: center;
  justify-content: flex-start;
  box-sizing: border-box;
  background-color: rgb(240, 240, 240);
}

common.wxs

var foo="'hello world' from common.wxs"

//inArray方法  判断数组中是否存在某元素
function inArray(arr,val){
  return arr.indexOf(val)>-1
}

var msg="some msg"

//module 对象  每个 wxs 模块均有一个内置的 module 对象。
//属性  exports: 通过该属性，可以对外共享本模块的私有变量与函数。
module.exports={
  foo:foo,
  inArray:inArray
}

module.exports.msg=msg

WXS使用注意

WXS 模块

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

模块

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

require函数

• 在.wxs模块中引用其他 wxs 文件模块，可以使用 require 函数。

• 引用的时候，要注意如下几点：

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

< wxs> 标签

属性名	类型	默认值	说明
module	String		当前 <wxs> 标签的模块名。必填字段。
src	String		引用 .wxs 文件的相对路径。仅当本标签为单闭合标签或标签的内容为空时有效。

module 属性

• module 属性是当前 < wxs > 标签的模块名。在单个 wxml 文件内，建议其值唯一。有重复模块名则按照先后顺序覆盖（后者覆盖前者）。不同文件之间的 wxs 模块名不会相互覆盖。
• module 属性值的命名必须符合下面两个规则：
  • 首字符必须是：字母（a-zA-Z），下划线（_）
  • 剩余字符可以是：字母（a-zA-Z），下划线（_）， 数字（0-9）

src 属性

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

注意

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

变量

概念
不支持 let const
WXS 中的变量均为值的引用。
没有声明的变量直接赋值使用，会被定义为全局变量。
如果只声明变量而不赋值，则默认值为 undefined。
var表现与javascript一致，会有变量提升。

var foo = 1;
var bar = "hello world";
var i; // i === undefined

上面代码，分别声明了 foo、 bar、 i 三个变量。然后，foo 赋值为数值 1 ，bar 赋值为字符串 “hello world”。

变量名

• 变量命名必须符合下面两个规则：

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

以下标识符不能作为变量名：

delete
void
typeof

null
undefined
NaN
Infinity
var

if
else

true
false

require

this
function
arguments
return

for
while
do
break
continue
switch
case
default

注释

<!-- wxml -->
<wxs module="sample">
// 方法一：单行注释

/*
方法二：多行注释
*/

/*
方法三：结尾注释。即从 /* 开始往后的所有 WXS 代码均被注释

var a = 1;
var b = 2;
var c = "fake";

</wxs>

更多详细内容点击查看小程序官方文档wxs语法参考