苹果微信小程序怎么用(微信小程序代码和配置)

一、前言上篇文章我们谈到了关于小程序的项目文件结构,了解到小程序的运行流程,其中小程序的项目各种配置是很重要的,他直接决定了项目的布局和功能,下面我们一起来看下小程序中的一些配置文件的使用方法吧。二、项目配置文件文件名为project.config.json,这个文件被用来记录所有在开发者工具上所做…

一、前言

上篇文章我们谈到了关于小程序的项目文件结构,了解到小程序的运行流程,其中小程序的项目各种配置是很重要的,他直接决定了项目的布局和功能,下面我们一起来看下小程序中的一些配置文件的使用方法吧。

二、项目配置文件

文件名为project.config.json,这个文件被用来记录所有在开发者工具上所做的配置,这个文件中的配置一般不需要我们来手动修改,因此可以跳过。

三、全局配置文件

可以将这些配置参数应用到所有的文件当中去,文件名为app.json,如图:


苹果微信小程序怎么用(微信小程序代码和配置)

该文件一般来说可以配置页面上的很多选项,并且是通过设置常用的属性来进行功能的实现的。常用属性如下:

属性

类型

必填

描述

最低版本

entryPagePath

String

小程序默认启动首页

pages

string[]

页面路径列表

window

Object

全局的默认窗口表现

tabBar

Object

底部 tab 栏的表现

networkTimeout

Object

网络超时时间

debug

boolean

是否开启 debug 模式,默认关闭

functionalPages

boolean

是否启用插件功能页,默认关闭

2.1.0

subpackages

Object[]

分包结构配置

1.7.3

workers

string

Worker 代码放置的目录

1.9.90

requiredBackgroundModes

string[]

需要在后台使用的能力,如「音乐播放」

plugins

Object

使用到的插件

1.9.6

preloadRule

Object

分包预下载规则

2.3.0

resizable

boolean

PC 小程序是否支持用户任意改变窗口大小(包括最大化窗口);iPad 小程序是否支持屏幕旋转。默认关闭

2.3.0

usingComponents

Object

全局自定义组件配置

开发者工具 1.02.1810190

permission

Object

小程序接口权限相关设置

微信客户端 7.0.0

sitemapLocation

string

指明 sitemap.json 的位置

style

string

指定使用升级后的weui样式

2.8.0

useExtendedLib

Object

指定需要引用的扩展库

2.2.1

entranceDeclare

Object

微信消息用小程序打开

微信客户端7.0.9

darkmode

boolean

小程序支持 DarkMode

2.11.0

themeLocation

string

指明 theme.json 的位置,darkmode为true为必填

开发者工具 1.03.2004271

lazyCodeLoading

string

配置自定义组件代码按需注入

2.11.1

singlePage

Object

单页模式相关配置

2.12.0

supportedMaterials

Object

聊天素材小程序打开相关配置

2.14.3

serviceProviderTicket

string

定制化型服务商票据

embeddedAppIdList

string[]

内嵌小程序 appId

这些属性同时又对应有很多选项,如下:

entryPagePath

指定小程序的默认启动路径(首页),常见情景是从微信聊天列表页下拉启动、小程序列表启动等。如果不填,将默认为 pages 列表的第一项。不支持带页面路径参数。

{
"entryPagePath": "pages/index/index"
}

pages

用于指定小程序由哪些页面组成,每一项都对应一个页面的 路径(含文件名) 信息。文件名不需要写文件后缀,框架会自动去寻找对应位置的 .json, .js, .wxml, .wxss 四个文件进行处理。

未指定 entryPagePath 时,数组的第一项代表小程序的初始页面(首页)。

小程序中新增/减少页面,都需要对 pages 数组进行修改。

如开发目录为:

├── app.js
├── app.json
├── app.wxss
├── pages
│ │── index
│ │ ├── index.wxml
│ │ ├── index.js
│ │ ├── index.json
│ │ └── index.wxss
│ └── logs
│ ├── logs.wxml
│ └── logs.js
└── utils

则需要在 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 自定义导航栏,只保留右上角胶囊按钮。参见注 2。

iOS/Android 微信客户端 6.6.0,Windows 微信客户端不支持

backgroundColor

HexColor

#ffffff

窗口的背景色

backgroundTextStyle

string

dark

下拉 loading 的样式,仅支持 dark / light

backgroundColorTop

string

#ffffff

顶部窗口的背景色,仅 iOS 支持

微信客户端 6.5.16

backgroundColorBottom

string

#ffffff

底部窗口的背景色,仅 iOS 支持

微信客户端 6.5.16

enablePullDownRefresh

boolean

false

是否开启全局的下拉刷新。详见 Page.onPullDownRefresh

onReachBottomDistance

number

50

页面上拉触底事件触发时距页面底部距离,单位为 px。详见 Page.onReachBottom

pageOrientation

string

portrait

屏幕旋转设置,支持 auto / portrait / landscape 详见 响应显示区域变化

2.4.0 (auto) / 2.5.0 (landscape)

restartStrategy

string

homePage

重新启动策略配置

2.8.0

initialRenderingCache

string

页面初始渲染缓存配置,支持 static / dynamic

2.11.1

visualEffectInBackground

string

none

切入系统后台时,隐藏页面内容,保护用户隐私。支持 hidden / none

2.15.0

  • 注 1:HexColor(十六进制颜色值),如"#ff00ff"
  • 注 2:关于navigationStyle
    • iOS/Android 客户端 7.0.0 以下版本,navigationStyle 只在 app.json 中生效。
    • iOS/Android 客户端 6.7.2 版本开始,navigationStyle: custom 对 web-view 组件无效
    • 开启 custom 后,低版本客户端需要做好兼容。开发者工具基础库版本切到 1.7.0(不代表最低版本,只供调试用)可方便切到旧视觉
    • Windows 客户端 3.0 及以上版本,为了给用户提供更符合桌面软件的使用体验,统一了小程序窗口的导航栏,navigationStyle: custom 不再生效

restartStrategy

基础库 2.8.0 开始支持,低版本需做兼容处理。

重新启动策略配置

可选值

含义

homePage

(默认值)如果从这个页面退出小程序,下次将从首页冷启动

homePageAndLatestPage

如果从这个页面退出小程序,下次冷启动后立刻加载这个页面,页面的参数保持不变(不可用于 tab 页)

如:

{
"window": {
"navigationBarBackgroundColor": "#ffffff",
"navigationBarTextStyle": "black",
"navigationBarTitleText": "微信接口功能演示",
"backgroundColor": "#eeeeee",
"backgroundTextStyle": "light"
}
}


苹果微信小程序怎么用(微信小程序代码和配置)

tabBar

如果小程序是一个多 tab 应用(客户端窗口的底部或顶部有 tab 栏可以切换页面),可以通过 tabBar 配置项指定 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

tabBar 的位置,仅支持 bottom / top

custom

boolean

false

自定义 tabBar,见详情

2.5.0

其中 list 接受一个数组,只能配置最少 2 个、最多 5 个 tab。tab 按数组的顺序排序,每个项都是一个对象,其属性值如下:

属性

类型

必填

说明

pagePath

string

页面路径,必须在 pages 中先定义

text

string

tab 上按钮文字

iconPath

string

图片路径,icon 大小限制为 40kb,建议尺寸为 81px * 81px,不支持网络图片。positiontop 时,不显示 icon。

selectedIconPath

string

选中时的图片路径,icon 大小限制为 40kb,建议尺寸为 81px * 81px,不支持网络图片。positiontop 时,不显示 icon。


苹果微信小程序怎么用(微信小程序代码和配置)

networkTimeout

各类网络请求的超时时间,单位均为毫秒。

属性

类型

必填

默认值

说明

request

number

60000

wx.request 的超时时间,单位:毫秒。

connectSocket

number

60000

wx.connectSocket 的超时时间,单位:毫秒。

uploadFile

number

60000

wx.uploadFile 的超时时间,单位:毫秒。

downloadFile

number

60000

wx.downloadFile 的超时时间,单位:毫秒。

debug

可以在开发者工具中开启 debug 模式,在开发者工具的控制台面板,调试信息以 info 的形式给出,其信息有 Page 的注册,页面路由,数据更新,事件触发等。可以帮助开发者快速定位一些常见的问题。

functionalPages

基础库 2.1.0 开始支持,低版本需做兼容处理。

插件所有者小程序需要设置这一项来启用插件功能页。

subpackages

微信客户端 6.6.0 ,基础库 1.7.3 及以上版本支持

启用分包加载时,声明项目分包结构。

写成 subPackages 也支持。

workers

基础库 1.9.90 开始支持,低版本需做兼容处理。

使用 Worker 处理多线程任务时,设置 Worker 代码放置的目录

requiredBackgroundModes

微信客户端 6.7.2 及以上版本支持

申明需要后台运行的能力,类型为数组。目前支持以下项目:

  • audio: 后台音乐播放
  • location: 后台定位

如:

{
"pages": ["pages/index/index"],
"requiredBackgroundModes": ["audio", "location"]
}

注:在此处申明了后台运行的接口,开发版和体验版上可以直接生效,正式版还需通过审核。

plugins

基础库 1.9.6 开始支持,低版本需做兼容处理。

声明小程序需要使用的插件。

preloadRule

基础库 2.3.0 开始支持,低版本需做兼容处理。

声明分包预下载的规则。

resizable

基础库 2.3.0 开始支持,低版本需做兼容处理。

在 iPad 上运行的小程序可以设置支持屏幕旋转。

在 PC 上运行的小程序,用户可以按照任意比例拖动窗口大小,也可以在小程序菜单中最大化窗口

usingComponents

开发者工具 1.02.1810190 及以上版本支持

在此处声明的自定义组件视为全局自定义组件,在小程序内的页面或自定义组件中可以直接使用而无需再声明。

permission

微信客户端 7.0.0 及以上版本支持

小程序接口权限相关设置。字段类型为 Object,结构为:

属性

类型

必填

默认值

描述

scope.userLocation

PermissionObject

位置相关权限声明

PermissionObject 结构

属性

类型

必填

默认值

说明

desc

string

小程序获取权限时展示的接口用途说明。最长 30 个字符

如:

{
"pages": ["pages/index/index"],
"permission": {
"scope.userLocation": {
"desc": "你的位置信息将用于小程序位置接口的效果展示" // 高速公路行驶持续后台定位
}
}
}


苹果微信小程序怎么用(微信小程序代码和配置)

sitemapLocation

指明 sitemap.json 的位置;默认为 'sitemap.json' 即在 app.json 同级目录下名字的 sitemap.json 文件

style

基础库 2.8.0 开始支持,低版本需做兼容处理。

微信客户端 7.0 开始,UI 界面进行了大改版。小程序也进行了基础组件的样式升级。app.json 中配置 "style": "v2"可表明启用新版的组件样式。

本次改动涉及的组件有 button icon radio checkbox switch slider。可前往小程序示例进行体验。

useExtendedLib

基础库 2.2.1 开始支持,低版本需做兼容处理。

最新的 nightly 版开发者工具开始支持,同时基础库从支持 npm 的版本(2.2.1)起支持

指定需要引用的扩展库。目前支持以下项目:

  • kbone: 多端开发框架
  • weui: WeUI 组件库

指定后,相当于引入了对应扩展库相关的最新版本的 npm 包,同时也不占用小程序的包体积。rc工具版本支持分包引用。用法如下:

{
"useExtendedLib": {
"kbone": true,
"weui": true
}
}

entranceDeclare

微信客户端 7.0.9 及以上版本支持,iOS 暂不支持

聊天位置消息用打车类小程序打开,详情参考。

"entranceDeclare": {
"locationMessage": {
"path": "pages/index/index",
"query": "foo=bar"
}
}

darkmode

开发者工具 1.03.2004271 及以上版本支持,基础库 2.11.0 及以上版本支持

微信iOS客户端 7.0.12 版本、Android客户端 7.0.13 版本正式支持 DarkMode,可通过配置"darkmode": true表示当前小程序可适配 DarkMode,所有基础组件均会根据系统主题展示不同的默认样式,navigation bar 和 tab bar 也会根据开发者的配置自动切换。

配置后,请根据DarkMode 适配指南自行完成基础样式以外的适配工作。

{
"darkmode": true
}

themeLocation

自定义 theme.json 的路径,当配置"darkmode":true时,当前配置文件为必填项。

{
"themeLocation": "/path/to/theme.json"
}

lazyCodeLoading

目前仅支持值 requiredComponents,代表开启小程序「按需注入」特性。

{
"lazyCodeLoading": "requiredComponents"
}

singlePage

基础库 2.11.3 及以上版本支持,目前分享到朋友圈 (Beta) 后打开会进入单页模式

单页模式相关配置

属性

类型

必填

默认值

描述

navigationBarFit

String

默认自动调整,若原页面是自定义导航栏,则为 float,否则为 squeezed

导航栏与页面的相交状态,值为 float 时表示导航栏浮在页面上,与页面相交;值为 squeezed 时表示页面被导航栏挤压,与页面不相交

配置示例

{
"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,
}

embeddedAppIdList

指定小程序可通过wx.openEmbeddedMiniProgram打开的小程序名单。

{
"embeddedAppIdList": ["wxe5f52902cf4de896"]
}

四、页面配置文件

每个我们所创建的页面文件都会有这么一个文件,它的文件名是"文件夹名.json",如图:


苹果微信小程序怎么用(微信小程序代码和配置)

这就是单页面的配置文件,我们都知道一个项目是由一个个页面组合而成的,所以每个页面不能用同一个配置,因此我们可以给每个页面不同的配置,相当于是局部配置,所以只能作用于当前页面,常用的属性如下:

属性

类型

默认值

描述

最低版本

navigationBarBackgroundColor

HexColor

#000000

导航栏背景颜色,如 #000000

navigationBarTextStyle

string

white

导航栏标题颜色,仅支持 black / white

navigationBarTitleText

string

导航栏标题文字内容

navigationStyle

string

default

导航栏样式,仅支持以下值:default 默认样式 custom 自定义导航栏,只保留右上角胶囊按钮。参见注 1。

iOS/Android 微信客户端 7.0.0,Windows 微信客户端不支持

backgroundColor

HexColor

#ffffff

窗口的背景色

backgroundTextStyle

string

dark

下拉 loading 的样式,仅支持 dark / light

backgroundColorTop

string

#ffffff

顶部窗口的背景色,仅 iOS 支持

微信客户端 6.5.16

backgroundColorBottom

string

#ffffff

底部窗口的背景色,仅 iOS 支持

微信客户端 6.5.16

enablePullDownRefresh

boolean

false

是否开启当前页面下拉刷新。详见 Page.onPullDownRefresh

onReachBottomDistance

number

50

页面上拉触底事件触发时距页面底部距离,单位为px。详见 Page.onReachBottom

pageOrientation

string

portrait

屏幕旋转设置,支持 auto / portrait / landscape 详见 响应显示区域变化

2.4.0 (auto) / 2.5.0 (landscape)

disableScroll

boolean

false

设置为 true 则页面整体不能上下滚动。只在页面配置中有效,无法在 app.json 中设置

usingComponents

Object

页面自定义组件配置

1.6.3

initialRenderingCache

string

页面初始渲染缓存配置,支持 static / dynamic

2.11.1

style

string

default

启用新版的组件样式

2.10.2

singlePage

Object

单页模式相关配置

2.12.0

restartStrategy

string

homePage

重新启动策略配置

2.8.0

页面配置中只能设置 app.jsonwindow 对应的配置项,以决定本页面的窗口表现,所以无需写 window 这个属性。

  • 注 1:关于navigationStyle
    • iOS/Android 客户端 7.0.0 以下版本,navigationStyle 只在 app.json 中生效。
    • iOS/Android 客户端 6.7.2 版本开始,navigationStyle: custom 对 web-view 组件无效
    • 开启 custom 后,低版本客户端需要做好兼容。开发者工具基础库版本切到 1.7.0(不代表最低版本,只供调试用)可方便切到旧视觉
    • Windows 客户端 3.0 及以上版本,为了给用户提供更符合桌面软件的使用体验,统一了小程序窗口的导航栏,navigationStyle: custom 不再生效

singlePage

基础库 2.11.3 及以上版本支持,目前分享到朋友圈 (Beta) 后打开会进入单页模式

单页模式相关配置

属性

类型

必填

默认值

描述

navigationBarFit

String

默认自动调整,若原页面是自定义导航栏,则为 float,否则为 squeezed

导航栏与页面的相交状态,值为 float 时表示导航栏浮在页面上,与页面相交;值为 squeezed 时表示页面被导航栏挤压,与页面不相交

restartStrategy

基础库 2.8.0 开始支持,低版本需做兼容处理。

重新启动策略配置,与 app.json 中一致。

配置示例

{
"navigationBarBackgroundColor": "#ffffff",
"navigationBarTextStyle": "black",
"navigationBarTitleText": "微信接口功能演示",
"backgroundColor": "#eeeeee",
"backgroundTextStyle": "light"
}

那么当我们要创建其它页面的时候该怎么办了,很简单,如图:


苹果微信小程序怎么用(微信小程序代码和配置)

首先新建一个文件夹,比如register,然后新建page,还是register,这样就可以创建一个单页面所要用到的所有文件了,如图:


苹果微信小程序怎么用(微信小程序代码和配置)

不过此时我们可以看到,我们是没有能访问该页面的条件的,现在我们给他修改一下,如图:


苹果微信小程序怎么用(微信小程序代码和配置)

可以看到,此时显示的就是register页面的默认内容了,实现的方法就是把该页面的地址放在第一位,这样默认启动页面就是register页面了。

五、sitemap配置

小程序根目录下的 sitemap.json 文件用于配置小程序及其页面是否允许被微信索引,文件内容为一个 JSON 对象,如果没有 sitemap.json ,则默认为所有页面都允许被索引;sitemap.json 有以下属性:

配置项

属性

类型

必填

描述

rules

Object[]

索引规则列表

rules

rules 配置项指定了索引规则,每项规则为一个JSON对象,属性如下所示:

属性

类型

必填

默认值

取值

取值说明

action

string

"allow"

"allow"、"disallow"

命中该规则的页面是否能被索引

page

string

"*"、页面的路径

* 表示所有页面,不能作为通配符使用

params

string[]

[]

当 page 字段指定的页面在被本规则匹配时可能使用的页面参数名称的列表(不含参数值)

matching

string

"inclusive"

参考 matching 取值说明

当 page 字段指定的页面在被本规则匹配时,此参数说明 params 匹配方式

priority

Number

优先级,值越大则规则越早被匹配,否则默认从上到下匹配

matching 取值说明

说明

exact

当小程序页面的参数列表等于 params 时,规则命中

inclusive

当小程序页面的参数列表包含 params 时,规则命中

exclusive

当小程序页面的参数列表与 params 交集为空时,规则命中

partial

当小程序页面的参数列表与 params 交集不为空时,规则命中

配置示例

{
"rules":[{
"action": "allow",
"page": "path/to/page",
"params": ["a", "b"],
"matching": "exact"
}, {
"action": "disallow",
"page": "path/to/page"
}]
}

  • path/to/page?a=1&b=2 => 优先索引
  • path/to/page => 不被索引
  • path/to/page?a=1 => 不被索引
  • path/to/page?a=1&b=2&c=3 => 不被索引
  • 其他页面都会被索引

{
"rules":[{
"action": "allow",
"page": "path/to/page",
"params": ["a", "b"],
"matching": "inclusive"
}, {
"action": "disallow",
"page": "path/to/page"
}]
}

  • path/to/page?a=1&b=2 => 优先索引
  • path/to/page?a=1&b=2&c=3 => 优先索引
  • path/to/page => 不被索引
  • path/to/page?a=1 => 不被索引
  • 其他页面都会被索引

{
"rules":[{
"action": "allow",
"page": "path/to/page",
"params": ["a", "b"],
"matching": "exclusive"
}, {
"action": "disallow",
"page": "path/to/page"
}]
}

  • path/to/page => 优先索引
  • path/to/page?c=3 => 优先索引
  • path/to/page?a=1 => 不被索引
  • path/to/page?a=1&b=2 => 不被索引
  • 其他页面都会被索引

{
"rules":[{
"action": "allow",
"page": "path/to/page",
"params": ["a", "b"],
"matching": "partial"
}, {
"action": "disallow",
"page": "path/to/page"
}]
}

  • path/to/page?a=1 => 优先索引
  • path/to/page?a=1&b=2 => 优先索引
  • path/to/page => 不被索引
  • path/to/page?c=3 => 不被索引
  • 其他页面都会被索引

注:没有 sitemap.json 则默认所有页面都能被索引

注:{"action": "allow", "page": "*"} 是优先级最低的默认规则,未显式指明 "disallow" 的都默认被索引

六、总结

以上的内容大部分均来自于腾讯官方文档,感兴趣可以去看看,这里小编只是加了一些个人的拙见,不够上述内容我们肯定是需要了解并且应用到的。更多精彩好文敬请关注公众号“简易编程网”

趣懂得网所有文章资讯、展示的图片素材等内容均为注册用户上传(部分报媒/平媒内容转载自网络合作媒体),仅供学习参考。用户通过本站上传、发布的任何内容的知识产权归属用户或原始著作权人所有。如有侵犯您的版权,请联系我们1875979182@qq.com 反馈 本站将在三个工作日内改正。

发表评论

您的电子邮箱地址不会被公开。