前端开发

入门必读：小程序代码构成详解

一文搞懂小程序代码的基本构成及其作用

本文由 墨然 发布于 2021-06-18

我们知道，在小程序项目里边，包含了不同类型的文件，它们是：

  • .json 后缀的 JSON 配置文件
  • .wxml 后缀的 WXML 模板文件
  • .wxss 后缀的 WXSS 样式文件
  • .js 后缀的 JS 脚本逻辑文件

下面我们就来看看这 4 种文件各自的作用。

1、JSON 配置

JSON 是一种数据格式，并不是编程语言，在小程序中，JSON 扮演的静态配置的角色。

我们可以看到在项目的根目录有一个 app.json 和 project.config.json，此外在 pages/logs 目录下还有一个 logs.json，我们依次来说明一下它们的用途。

小程序配置 app.json

app.json 是当前小程序的全局配置，包括了小程序的所有页面路径、界面表现、网络超时时间、底部 tab 等。通常，小程序项目里边的 app.json 配置内容如下：

1
2
3
4
5
6
7
8
9
10
11
12
{
  "pages":[
    "pages/index/index",
    "pages/logs/logs"
  ],
  "window":{
    "backgroundTextStyle": "light",
    "navigationBarBackgroundColor": "#fff",
    "navigationBarTitleText": "Weixin",
    "navigationBarTextStyle":"black"
  }
}

我们简单说一下这个配置各个项的含义:

  1. pages 字段 —— 用于描述当前小程序所有页面路径，这是为了让微信客户端知道当前你的小程序页面定义在哪个目录。
  2. window 字段 —— 定义小程序所有页面的顶部背景颜色，文字颜色定义等。

其他配置项细节可以参考小程序官方文档《小程序的配置 app.json》一节。

工具配置 project.config.json

通常大家在使用一个工具的时候，都会针对各自喜好做一些个性化配置，例如界面颜色、编译配置等等，当你换了另外一台电脑重新安装工具的时候，你还要重新配置。

考虑到这点，小程序开发者工具在每个项目的根目录都会生成一个 project.config.json，你在工具上做的任何配置都会写入到这个文件，当你重新安装工具或者换电脑工作时，你只要载入同一个项目的代码包，开发者工具就自动会帮你恢复到当时你开发项目时的个性化配置，其中会包括编辑器的颜色、代码上传时自动压缩等等一系列选项。

页面配置 page.json

这里的 page.json 其实用来表示 pages/logs 目录下的 logs.json 这类和小程序页面相关的配置。

如果你整个小程序的风格是蓝色调，那么你可以在 app.json 里边声明顶部颜色是蓝色即可。实际情况可能不是这样，可能你小程序里边的每个页面都有不一样的色调来区分不同功能模块，因此我们提供了 page.json 让开发者可以独立定义每个页面的属性。例如：顶部颜色、是否允许下拉刷新等等。

其他更详细的配置请参考小程序官方文档。

JSON 语法

接下来我们说一下小程序里 JSON 配置的一些注意事项。

JSON 文件都是被包裹在一个大括号中 {}，通过 key-value 的方式来存储数据。JSON 的 Key 必须包裹在一个双引号中（这是由 JSON 规范要求的）。在实践中，忘了给 Key 值加双引号或者是把双引号写成单引号是常见错误。

提示：推荐使用 JSON 校验工具 来检查 JSON 文件是否符合规范要求。

JSON 的值（也就是 value）只能由以下几种数据格式组成，其他任何格式都会引发错误，例如 JavaScript 中的 undefined。

  • 数字，包含浮点数和整数
  • 字符串，需要包裹在双引号中
  • Bool 值，true 或者 false
  • 数组，需要包裹在方括号中 []
  • 对象，需要包裹在大括号中 {}
  • Null

还需要注意的是 JSON 文件中无法使用注释，试图添加注释将会引发报错。

2、WXML 模板

从事过网页编程的人知道，网页编程采用的是 HTML + CSS + JS 这样的组合。其中：

  • HTML 是用来描述当前这个页面的结构
  • CSS 用来描述页面的样子
  • JS 通常是用来处理这个页面和用户的交互

类似的，在小程序中也有同样的角色，其中 WXML 充当的就是类似 HTML 的角色。

打开项目中的 pages/index/index.wxml 文件，你会看到以下的内容:

1
2
3
4
5
6
7
8
9
10
11
12
<view class="container">
  <view class="userinfo">
    <button wx:if="{{!hasUserInfo && canIUse}}"> 获取头像昵称 </button>
    <block wx:else>
      <image src="{{userInfo.avatarUrl}}" background-size="cover"></image>
      <text class="userinfo-nickname">{{userInfo.nickName}}</text>
    </block>
  </view>
  <view class="usermotto">
    <text class="user-motto">{{motto}}</text>
  </view>
</view>

和 HTML 非常相似，WXML 也是由标签、属性等等构成。但是也有很多不一样的地方，我们来一一阐述一下：

1、标签名字有点不一样

往往写 HTML 的时候，经常会用到的标签是 div, p, span，开发者在写一个页面的时候可以根据这些基础的标签组合出不一样的组件，例如日历、弹窗等等。换个思路，既然大家都需要这些组件，为什么我们不能把这些常用的组件包装起来，大大提高我们的开发效率。

从上边的例子可以看到，小程序的 WXML 用的标签是 view, button, text 等等，这些标签就是小程序给开发者包装好的基本能力，我们还提供了地图、视频、音频等组件能力。

2、多了一些 wx:if 这样的属性以及 {{ }} 这样的表达式

在网页的一般开发流程中，我们通常会通过 JS 操作 DOM (对应 HTML 的描述产生的树)，以引起界面的一些变化响应用户的行为。

例如，用户点击某个按钮的时候，JS 会记录一些状态到 JS 变量里边，同时通过 DOM API 操控 DOM 的属性或者行为，进而引起界面一些变化。当项目越来越大的时候，你的代码会充斥着非常多的界面交互逻辑和程序的各种状态变量，显然这不是一个很好的开发模式，因此就有了 MVVM 的开发模式（例如 React, Vue），提倡把渲染和逻辑分离。简单来说，就是不要再让 JS 直接操控 DOM，JS 只需要管理状态即可，然后再通过一种模板语法来描述状态和界面结构的关系即可。

小程序的框架也是用到了这个思路，如果你需要把一个 Hello World 的字符串显示在界面上。在 WXML 里是这么写 :

1
<text>{{msg}}</text>

而 JS 只需要管理状态即可：

1
this.setData({ msg: "Hello World" })

通过 {{ }} 的语法把一个变量绑定到界面上，我们称为数据绑定。仅仅通过数据绑定还不够完整的描述状态和界面的关系，还需要 if/else, for 等控制能力，在小程序里边，这些控制能力都用 wx: 开头的属性来表达。

3、WXSS 样式

WXSS 具有 CSS 大部分的特性，小程序在 WXSS 也做了一些扩充和修改。

  1. 新增了尺寸单位。在写 CSS 样式时，开发者需要考虑到手机设备的屏幕会有不同的宽度和设备像素比，采用一些技巧来换算一些像素单位。WXSS 在底层支持新的尺寸单位 rpx，开发者可以免去换算的烦恼，只要交给小程序底层来换算即可，由于换算采用的浮点数运算，所以运算结果会和预期结果有一点点偏差；
  2. 提供了全局的样式和局部样式。和前边 app.json, page.json 的概念相同，你可以写一个 app.wxss 作为全局样式，会作用于当前小程序的所有页面，局部页面样式 page.wxss 仅对当前页面生效；
  3. WXSS 仅支持部分 CSS 选择器。

4、JS 逻辑交互

一个服务仅仅只有界面展示是不够的，还需要和用户做交互：响应用户的点击、获取用户的位置等等。在小程序里边，我们就通过编写 JS 脚本文件来处理用户的操作。

1
2
<view>{{ msg }}</view>
<button bindtap="clickMe">点击我</button>

点击 button 按钮的时候，我们希望把界面上 msg 显示成 "Hello World"。于是我们在 button 上声明一个属性：bindtap，在 JS 文件里边声明了 clickMe 方法来响应这次点击操作：

1
2
3
4
5
Page({
  clickMe: function() {
    this.setData({ msg: "Hello World" })
  }
})

响应用户的操作就是这么简单，更详细的事件处理，请参考小程序官方文档。

除此以外，你还可以在 JS 中调用小程序提供的丰富的 API，利用这些 API 可以很方便的调起微信提供的能力，例如：获取用户基本信息、本地存储、微信支付等。在之前的例子中，在 pages/index/index.js 文件里就调用了 wx.getUserInfo 方法来获取微信用户的头像和昵称，最后通过 setData 方法把获取到的信息显示到界面上。

总结

本文详细介绍了小程序涉及到的文件类型以及对应的角色，希望对你理解小程序工作方法有初步的了解；另外，如果对小程序网络请求感兴趣，请参考本站文章微信小程序网络请求最佳实践，有更详细地说明。

感谢阅读，全文完。

JavaScript 微信 小程序 WXML WXS WXSS

更多精彩文章

← 返回首页