通过开发者工具快速创建了一个 QuickStart 项目,里边生成了不同类型的文件:
.json 后缀的 JSON 配置文件
.wxml 后缀的 WXML 模板文件
.wxss 后缀的 WXSS 样式文件
.js 后缀的 JS 脚本逻辑文件
JSON 配置
在项目的根目录有一个 app.json 和 project.config.json,此外在 pages/logs 目录下还有一个 logs.json,我们依次来说明一下他们的用途。
小程序配置 app.json
app.json 是对当前小程序的全局配置,包括了小程序的所有页面路径、界面表现、网络超时时间、底部 tab 等。QuickStart 项目里边的 app.json 配置内容如下:
{
"pages" :[
"pages/index/index" ,
"pages/logs/logs"
],
"window" :{
"backgroundTextStyle" :"light" ,
"navigationBarBackgroundColor" : "#fff" ,
"navigationBarTitleText" : "WeChat" ,
"navigationBarTextStyle" :"black"
}
}
pages字段 —— 用于描述当前小程序所有页面路径,这是为了让微信客户端知道当前你的小程序页面定义在哪个目录。
window字段 —— 小程序所有页面的顶部背景颜色,文字颜色定义在这里的。
app.json
文件用来对微信小程序进行全局配置,决定页面文件的路径、窗口表现、设置网络超时时间、设置多 tab 等。
以下是一个包含了所有配置选项的 app.json
:
{
"pages" : [
"pages/index/index" ,
"pages/logs/index"
],
"window" : {
"navigationBarTitleText" : "Demo"
},
"tabBar" : {
"list" : [{
"pagePath" : "pages/index/index" ,
"text" : "首页"
}, {
"pagePath" : "pages/logs/logs" ,
"text" : "日志"
}]
},
"networkTimeout" : {
"request" : 10000 ,
"downloadFile" : 10000
},
"debug" : true
}
app.json 配置项列表
属性
类型
必填
描述
pages
String Array
是
设置页面路径
window
Object
否
设置默认页面的窗口表现
tabBar
Object
否
设置底部 tab 的表现
networkTimeout
Object
否
设置网络超时时间
debug
Boolean
否
设置是否开启 debug 模式
pages 接受一个数组,每一项都是字符串,来指定小程序由哪些页面组成。每一项代表对应页面的【路径+文件名】信息,数组的第一项代表小程序的初始页面。小程序中新增/减少页面,都需要对 pages 数组进行修改。
文件名不需要写文件后缀,因为框架会自动去寻找路径下 .json
, .js
, .wxml
, .wxss
四个文件进行整合。
如开发目录为:
pages/
pages/index/index.wxml
pages/index/index.js
pages/index/index.wxss
pages/logs/logs.wxml
pages/logs/logs.js
app.js
app.json
app.wxss
则需要在 app.json 中写
{
"pages" :[
"pages/index/index" ,
"pages/logs/logs"
]
}
window 用于设置小程序的状态栏、导航条、标题、窗口背景色。
属性
类型
默认值
描述
最低版本
navigationBarBackgroundColor
HexColor
#000000
导航栏背景颜色,如"#000000"
navigationBarTextStyle
String
white
导航栏标题颜色,仅支持 black/white
navigationBarTitleText
String
导航栏标题文字内容
navigationStyle
String
default
导航栏样式,仅支持 default/custom。custom 模式可自定义导航栏,只保留右上角胶囊状的按钮
微信版本 6.6.0
backgroundColor
HexColor
#ffffff
窗口的背景色
backgroundTextStyle
String
dark
下拉背景字体、loading 图的样式,仅支持 dark/light
enablePullDownRefresh
Boolean
false
是否开启下拉刷新,详见页面相关事件处理函数
onReachBottomDistance
Number
50
页面上拉触底事件触发时距页面底部距离,单位为px
注:HexColor(十六进制颜色值),如"#ff00ff"
注:navigationStyle 只在 app.json 中生效。开启 custom 后,低版本客户端需要做好兼容。开发者工具基础库版本切到 1.7.0(不代表最低版本,只供调试用) 可方便切到旧视觉
如 app.json :
{
"window" :{
"navigationBarBackgroundColor" : "#ffffff" ,
"navigationBarTextStyle" : "black" ,
"navigationBarTitleText" : "微信接口功能演示" ,
"backgroundColor" : "#eeeeee" ,
"backgroundTextStyle" : "light"
}
}
tabBar 如果小程序是一个多 tab 应用(客户端窗口的底部或顶部有 tab 栏可以切换页面),可以通过 tabBar 配置项指定 tab 栏的表现,以及 tab 切换时显示的对应页面。
Tip:
当设置 position 为 top 时,将不会显示 icon
tabBar 中的 list 是一个数组,只能配置最少2个、最多5个 tab ,tab 按数组的顺序排序。
属性说明:
属性
类型
必填
默认值
描述
color
HexColor
是
tab 上的文字默认颜色
selectedColor
HexColor
是
tab 上的文字选中时的颜色
backgroundColor
HexColor
是
tab 的背景色
borderStyle
String
否
black
tabbar上边框的颜色, 仅支持 black/white
list
Array
是
tab 的列表,详见 list 属性说明,最少2个、最多5个 tab
position
String
否
bottom
可选值 bottom、top
其中 list 接受一个数组,数组中的每个项都是一个对象,其属性值如下:
属性
类型
必填
说明
pagePath
String
是
页面路径,必须在 pages 中先定义
text
String
是
tab 上按钮文字
iconPath
String
否
图片路径,icon 大小限制为40kb,建议尺寸为 81px * 81px,当 postion 为 top 时,此参数无效,不支持网络图片
selectedIconPath
String
否
选中时的图片路径,icon 大小限制为40kb,建议尺寸为 81px * 81px ,当 postion 为 top 时,此参数无效
networkTimeout 可以设置各种网络请求的超时时间。
属性说明:
属性
类型
必填
说明
request
Number
否
wx.request的超时时间,单位毫秒,默认为:60000
connectSocket
Number
否
wx.connectSocket的超时时间,单位毫秒,默认为:60000
uploadFile
Number
否
wx.uploadFile的超时时间,单位毫秒,默认为:60000
downloadFile
Number
否
wx.downloadFile的超时时间,单位毫秒,默认为:60000
debug 可以在开发者工具中开启 debug 模式,在开发者工具的控制台面板,调试信息以 info 的形式给出,其信息有Page的注册
,页面路由
,数据更新
,事件触发
。 可以帮助开发者快速定位一些常见的问题。
page.json 每一个小程序页面也可以使用.json
文件来对本页面的窗口表现进行配置。 页面的配置比app.json
全局配置简单得多,只是设置 app.json 中的 window 配置项的内容,页面中配置项会覆盖 app.json 的 window 中相同的配置项。
页面的.json
只能设置 window
相关的配置项,以决定本页面的窗口表现,所以无需写 window
这个键,如:
属性
类型
默认值
描述
navigationBarBackgroundColor
HexColor
#000000
导航栏背景颜色,如"#000000"
navigationBarTextStyle
String
white
导航栏标题颜色,仅支持 black/white
navigationBarTitleText
String
导航栏标题文字内容
backgroundColor
HexColor
#ffffff
窗口的背景色
backgroundTextStyle
String
dark
下拉背景字体、loading 图的样式,仅支持 dark/light
enablePullDownRefresh
Boolean
false
是否开启下拉刷新,详见页面相关事件处理函数。
disableScroll
Boolean
false
设置为 true 则页面整体不能上下滚动;只在 page.json 中有效,无法在 app.json 中设置该项
onReachBottomDistance
Number
50
页面上拉触底事件触发时距页面底部距离,单位为px
{
"navigationBarBackgroundColor" : "#ffffff" ,
"navigationBarTextStyle" : "black" ,
"navigationBarTitleText" : "微信接口功能演示" ,
"backgroundColor" : "#eeeeee" ,
"backgroundTextStyle" : "light"
}
工具配置 project.config.json
通常大家在使用一个工具的时候,都会针对各自喜好做一些个性化配置,例如界面颜色、编译配置等等,当你换了另外一台电脑重新安装工具的时候,你还要重新配置。
考虑到这点,小程序开发者工具在每个项目的根目录都会生成一个 project.config.json,你在工具上做的任何配置都会写入到这个文件,当你重新安装工具或者换电脑工作时,你只要载入同一个项目的代码包,开发者工具就自动会帮你恢复到当时你开发项目时的个性化配置,其中会包括编辑器的颜色、代码上传时自动压缩等等一系列选项。
项目配置文件
字段名
类型
说明
miniprogramRoot
Path String
指定小程序源码的目录(需为相对路径)
qcloudRoot
Path String
指定腾讯云项目的目录(需为相对路径)
setting
Object
项目设置
libVersion
String
基础库版本
appid
String
项目的 appid,只在新建项目时读取
projectname
String
项目名字,只在新建项目时读取
setting 中可以指定以下设置
字段名
类型
说明
es6
Boolean
是否启用 es5 转 es6
postcss
Boolean
上传代码时样式是否自动补全
minified
Boolean
上传代码时是否自动压缩
urlCheck
Boolean
是否检查安全域名和 TLS 版本
示例:
{
"miniprogramRoot" : "./src" ,
"qcloudRoot" : "./svr" ,
"setting" : {
"postcss" : true ,
"es6" : true ,
"minified" : true ,
"urlCheck" : false
}
}
页面配置 page.json
这里的 page.json 其实用来表示 pages/logs 目录下的 logs.json 这类和小程序页面相关的配置。
如果你整个小程序的风格是蓝色调,那么你可以在 app.json 里边声明顶部颜色是蓝色即可。实际情况可能不是这样,可能你小程序里边的每个页面都有不一样的色调来区分不同功能模块,因此我们提供了 page.json,让开发者可以独立定义每个页面的一些属性,例如刚刚说的顶部颜色、是否允许下拉刷新等等。
page.json 每一个小程序页面也可以使用.json
文件来对本页面的窗口表现进行配置。 页面的配置比app.json
全局配置简单得多,只是设置 app.json 中的 window 配置项的内容,页面中配置项会覆盖 app.json 的 window 中相同的配置项。
页面的.json
只能设置 window
相关的配置项,以决定本页面的窗口表现,所以无需写 window
这个键,如:
属性
类型
默认值
描述
navigationBarBackgroundColor
HexColor
#000000
导航栏背景颜色,如"#000000"
navigationBarTextStyle
String
white
导航栏标题颜色,仅支持 black/white
navigationBarTitleText
String
导航栏标题文字内容
backgroundColor
HexColor
#ffffff
窗口的背景色
backgroundTextStyle
String
dark
下拉背景字体、loading 图的样式,仅支持 dark/light
enablePullDownRefresh
Boolean
false
是否开启下拉刷新,详见页面相关事件处理函数。
disableScroll
Boolean
false
设置为 true 则页面整体不能上下滚动;只在 page.json 中有效,无法在 app.json 中设置该项
onReachBottomDistance
Number
50
页面上拉触底事件触发时距页面底部距离,单位为px
{
"navigationBarBackgroundColor" : "#ffffff" ,
"navigationBarTextStyle" : "black" ,
"navigationBarTitleText" : "微信接口功能演示" ,
"backgroundColor" : "#eeeeee" ,
"backgroundTextStyle" : "light"
}
WXML 模板
网页编程采用的是 HTML + CSS + JS 这样的组合,其中 HTML 是用来描述当前这个页面的结构,CSS 用来描述页面的样子,JS 通常是用来处理这个页面和用户的交互。
同样道理,在小程序中也有同样的角色,其中 WXML 充当的就是类似 HTML 的角色。打开 pages/index/index.wxml,你会看到以下的内容:
获取头像昵称
{{userInfo.nickName}}
{{motto}}
和 HTML 非常相似,有标签、属性等等构成。但是也有很多不一样的地方,我们来一一阐述一下:
标签名字有点不一样 往往写 HTML 的时候,经常会用到的标签是 div, p, span,开发者在写一个页面的时候可以根据这些基础的标签组合出不一样的组件,例如日历、弹窗等等。换个思路,既然大家都需要这些组件,为什么我们不能把这些常用的组件包装起来,大大提高我们的开发效率。 从上边的例子可以看到,小程序的 WXML 用的标签是 view, button, text 等等,这些标签就是小程序给开发者包装好的基本能力,我们还提供了地图、视频、音频等等组件能力 更多详细的组件讲述参考下个章节 小程序的能力
多了一些 wx:if 这样的属性以及 {{ }} 这样的表达式 在网页的一般开发流程中,我们通常会通过 JS 操作 DOM (对应 HTML 的描述产生的树),以引起界面的一些变化响应用户的行为。例如,用户点击某个按钮的时候,JS 会记录一些状态到 JS 变量里边,同时通过 DOM API 操控 DOM 的属性或者行为,进而引起界面一些变化。当项目越来越大的时候,你的代码会充斥着非常多的界面交互逻辑和程序的各种状态变量,显然这不是一个很好的开发模式,因此就有了 MVVM 的开发模式(例如 React, Vue),提倡把渲染和逻辑分离。简单来说就是不要再让 JS 直接操控 DOM,JS只需要管理状态即可,然后再通过一种模板语法来描述状态和界面结构的关系即可。 小程序的框架也是用到了这个思路,如果你需要把一个 Hello World 的字符串显示在界面上。 WXML 是这么写 :
JS 只需要管理状态即可:
this .setData({ msg: "Hello World" })
通过 {{ }} 的语法把一个变量绑定到界面上,我们称为数据绑定。仅仅通过数据绑定还不够完整的描述状态和界面的关系,还需要 if/else, for等控制能力,在小程序里边,这些控制能力都用 wx: 开头的属性来表达。 更详细的文档可以参考 WXML
WXSS 样式
WXSS 具有 CSS 大部分的特性,小程序在 WXSS 也做了一些扩充和修改。
新增了尺寸单位。在写 CSS 样式时,开发者需要考虑到手机设备的屏幕会有不同的宽度和设备像素比,采用一些技巧来换算一些像素单位。WXSS 在底层支持新的尺寸单位 rpx ,开发者可以免去换算的烦恼,只要交给小程序底层来换算即可,由于换算采用的浮点数运算,所以运算结果会和预期结果有一点点偏差。
提供了全局的样式和局部样式。和前边 app.json, page.json 的概念相同,你可以写一个 app.wxss 作为全局样式,会作用于当前小程序的所有页面,局部页面样式 page.wxss 仅对当前页面生效。
此外 WXSS 仅支持部分 CSS 选择器
WXSS WXSS(WeiXin Style Sheets)是一套样式语言,用于描述 WXML 的组件样式。
WXSS 用来决定 WXML 的组件应该怎么显示。
为了适应广大的前端开发者,WXSS 具有 CSS 大部分特性。同时为了更适合开发微信小程序,WXSS 对 CSS 进行了扩充以及修改。
与 CSS 相比,WXSS 扩展的特性有:
尺寸单位
rpx(responsive pixel): 可以根据屏幕宽度进行自适应。规定屏幕宽为750rpx。如在 iPhone6 上,屏幕宽度为375px,共有750个物理像素,则750rpx = 375px = 750物理像素,1rpx = 0.5px = 1物理像素。
设备
rpx换算px (屏幕宽度/750)
px换算rpx (750/屏幕宽度)
iPhone5
1rpx = 0.42px
1px = 2.34rpx
iPhone6
1rpx = 0.5px
1px = 2rpx
iPhone6 Plus
1rpx = 0.552px
1px = 1.81rpx
建议: 开发微信小程序时设计师可以用 iPhone6 作为视觉稿的标准。
注意: 在较小的屏幕上不可避免的会有一些毛刺,请在开发时尽量避免这种情况。
样式导入 使用@import
语句可以导入外联样式表,@import
后跟需要导入的外联样式表的相对路径,用;
表示语句结束。
示例代码:
.small-p {
padding :5px ;
}
@import "common.wxss" ;
.middle-p {
padding :15px ;
}
内联样式 框架组件上支持使用 style、class 属性来控制组件的样式。
style:静态的样式统一写到 class 中。style 接收动态的样式,在运行时会进行解析,请尽量避免将静态的样式写进 style 中,以免影响渲染速度。
<view style ="color:{{color}};" />
class:用于指定样式规则,其属性值是样式规则中类选择器名(样式类名)的集合,样式类名不需要带上.
,样式类名之间用空格分隔。
<view class ="normal_view" />
选择器 目前支持的选择器有:
选择器
样例
样例描述
.class
.intro
选择所有拥有 class="intro" 的组件
#id
#firstname
选择拥有 id="firstname" 的组件
element
view
选择所有 view 组件
element, element
view, checkbox
选择所有文档的 view 组件和所有的 checkbox 组件
::after
view::after
在 view 组件后边插入内容
::before
view::before
在 view 组件前边插入内容
全局样式与局部样式 定义在 app.wxss 中的样式为全局样式,作用于每一个页面。在 page 的 wxss 文件中定义的样式为局部样式,只作用在对应的页面,并会覆盖 app.wxss 中相同的选择器。
JS 交互逻辑
一个服务仅仅只有界面展示是不够的,还需要和用户做交互:响应用户的点击、获取用户的位置等等。在小程序里边,我们就通过编写 JS 脚本文件来处理用户的操作。
{{ msg }}
点击我
点击 button 按钮的时候,我们希望把界面上 msg 显示成 "Hello World",于是我们在 button 上声明一个属性: bindtap ,在 JS 文件里边声明了 clickMe 方法来响应这次点击操作:
Page({
clickMe: function ( ) {
this .setData({ msg: "Hello World" })
}
})
响应用户的操作就是这么简单,更详细的事件可以参考文档 WXML - 事件 。
此外你还可以在 JS 中调用小程序提供的丰富的 API,利用这些 API 可以很方便的调起微信提供的能力,例如获取用户信息、本地存储、微信支付等。在前边的 QuickStart 例子中,在 pages/index/index.js 就调用了 wx.getUserInfo 获取微信用户的头像和昵称,最后通过 setData 把获取到的信息显示到界面上。更多 API 可以参考文档 小程序的API 。