微信小程序学习记录——2.框架-配置

朴灿烈づ我的快乐病毒、 2023-06-13 06:14 3阅读 0赞

### 文章目录 ###

*  1.全局配置
 *   *  小程序配置文件
     *   *  app.json-pages
         *  app.json-window
         *  app.json-tabBar
         *  app.json-networkTimeout 和 debug
 *  2.页面配置

# 1.全局配置 #

## 小程序配置文件 ##

**app.json**文件用来对微信小程序进行**全局配置**，它决定了**页面文件的路径**、**窗口表现**、**设置网络超时时间**、**设置多tab** 等配置。

app.json 配置项列表：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>必填</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>pages</td> 
   <td>String Array</td> 
   <td>是</td> 
   <td>设置页面路径</td> 
  </tr> 
  <tr> 
   <td>window</td> 
   <td>Object</td> 
   <td>否</td> 
   <td>设置默认页面的窗口表现</td> 
  </tr> 
  <tr> 
   <td>tabBar</td> 
   <td>Object</td> 
   <td>否</td> 
   <td>设置底部 tab 的表现</td> 
  </tr> 
  <tr> 
   <td>networkTimeout</td> 
   <td>Object</td> 
   <td>否</td> 
   <td>设置网络超时时间</td> 
  </tr> 
  <tr> 
   <td>debug</td> 
   <td>Boolean</td> 
   <td>否</td> 
   <td>设置是否开启 debug 模式</td> 
  </tr> 
 </tbody> 
</table>

以下是一个包含了所有配置选项的 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 ###

**pages**用于存放一个数组，每一项都是字符串，来指定小程序由哪些页面组成。每一项代表对应页面的【路径+文件名】信息，**数组的第一项代表小程序的初始页面（首页）**。小程序中新增/减少页面，都需要对 pages 数组进行修改。

例如开发目录为：

![img][]

则需要在 app.json 中写

{ 
      "pages":[
        "pages/index/index",
        "pages/logs/logs"
      ]
    }

> 文件名不需要写文件后缀，因为框架会自动去寻找路径下 .json, .js, .wxml, .wxss 四个文件进行整合。

### app.json-window ###

**window** 用于设置小程序的状态栏、导航条、标题、窗口背景色等配置。

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>默认值</th> 
   <th>描述</th> 
   <th>最低版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>navigationBarBackgroundColor</td> 
   <td>HexColor</td> 
   <td>#000000</td> 
   <td>导航栏背景颜色，如"#000000"</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>navigationBarTextStyle</td> 
   <td>String</td> 
   <td>white</td> 
   <td>导航栏标题颜色，仅支持 black/white</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>navigationBarTitleText</td> 
   <td>String</td> 
   <td></td> 
   <td>导航栏标题文字内容</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>navigationStyle</td> 
   <td>String</td> 
   <td>default</td> 
   <td>导航栏样式，仅支持 default/custom。custom 模式可自定义导航栏，只保留右上角胶囊状的按钮</td> 
   <td>微信版本 6.6.0</td> 
  </tr> 
  <tr> 
   <td>backgroundColor</td> 
   <td>HexColor</td> 
   <td>#ffffff</td> 
   <td>窗口的背景色</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>backgroundTextStyle</td> 
   <td>String</td> 
   <td>dark</td> 
   <td>下拉背景字体、loading 图的样式，仅支持 dark/light</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>enablePullDownRefresh</td> 
   <td>Boolean</td> 
   <td>false</td> 
   <td>是否开启下拉刷新，详见页面相关事件处理函数</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>onReachBottomDistance</td> 
   <td>Number</td> 
   <td>50</td> 
   <td>页面上拉触底事件触发时距页面底部距离，单位为px</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

> 注：HexColor（十六进制颜色值），如"\#ff00ff"

> 注：navigationStyle 只在 app.json 中生效。开启 custom 后，低版本客户端需要做好兼容。开发者工具基础库版本切到 1.7.0（不代表最低版本，只供调试用） 可方便切到旧视觉

配置示例：

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

执行结果：

![img][img 1]

### app.json-tabBar ###

如果小程序是一个多 tab 应用（客户端窗口的底部或顶部有 tab 栏可以切换页面），可以通过 tabBar 配置项指定 tab 栏的表现，以及 tab 切换时显示的对应页面。

> Tip：当设置 position 为 top 时，将不会显示 icon。tabBar 中的 list 是一个数组，只能配置最少2个，最多5个 tab。tab 按数组的顺序排序。

属性说明：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>必填</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>color</td> 
   <td>HexColor</td> 
   <td>是</td> 
   <td></td> 
   <td>tab 上的文字默认颜色</td> 
  </tr> 
  <tr> 
   <td>selectedColor</td> 
   <td>HexColor</td> 
   <td>是</td> 
   <td></td> 
   <td>tab 上的文字选中时的颜色</td> 
  </tr> 
  <tr> 
   <td>backgroundColor</td> 
   <td>HexColor</td> 
   <td>是</td> 
   <td></td> 
   <td>tab 的背景色</td> 
  </tr> 
  <tr> 
   <td>borderStyle</td> 
   <td>String</td> 
   <td>否</td> 
   <td>black</td> 
   <td>tabbar上边框的颜色， 仅支持 black/white</td> 
  </tr> 
  <tr> 
   <td>list</td> 
   <td>Array</td> 
   <td>是</td> 
   <td></td> 
   <td>tab 的列表，详见 list 属性说明，最少2个、最多5个 tab</td> 
  </tr> 
  <tr> 
   <td>position</td> 
   <td>String</td> 
   <td>否</td> 
   <td>bottom</td> 
   <td>可选值 bottom、top</td> 
  </tr> 
 </tbody> 
</table>

其中 list 接受一个数组，数组中的每个项都是一个对象，其属性值如下：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>必填</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>pagePath</td> 
   <td>String</td> 
   <td>是</td> 
   <td>页面路径，必须在 pages 中先定义</td> 
  </tr> 
  <tr> 
   <td>text</td> 
   <td>String</td> 
   <td>是</td> 
   <td>tab 上按钮文字</td> 
  </tr> 
  <tr> 
   <td>iconPath</td> 
   <td>String</td> 
   <td>否</td> 
   <td>图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px，当 postion 为 top 时，此参数无效，不支持网络图片</td> 
  </tr> 
  <tr> 
   <td>selectedIconPath</td> 
   <td>String</td> 
   <td>否</td> 
   <td>选中时的图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px ，当 postion 为 top 时，此参数无效</td> 
  </tr> 
 </tbody> 
</table>

执行结果：

![img][img 2]

### app.json-networkTimeout 和 debug ###

networkTimeout 可以设置各种网络请求的超时时间。

属性说明：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>必填</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>request</td> 
   <td>Number</td> 
   <td>否</td> 
   <td>wx.request的超时时间，单位毫秒，默认为：60000</td> 
  </tr> 
  <tr> 
   <td>connectSocket</td> 
   <td>Number</td> 
   <td>否</td> 
   <td>wx.connectSocket的超时时间，单位毫秒，默认为：60000</td> 
  </tr> 
  <tr> 
   <td>uploadFile</td> 
   <td>Number</td> 
   <td>否</td> 
   <td>wx.uploadFile的超时时间，单位毫秒，默认为：60000</td> 
  </tr> 
  <tr> 
   <td>downloadFile</td> 
   <td>Number</td> 
   <td>否</td> 
   <td>wx.downloadFile的超时时间，单位毫秒，默认为：60000</td> 
  </tr> 
 </tbody> 
</table>

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

# 2.页面配置 #

每一个小程序页面也可以使用`.json`文件来对本页面的窗口表现进行配置。 页面的配置比`app.json`全局配置简单得多，只是设置 app.json 中的 window 配置项的内容，页面中配置项会覆盖 app.json 的 window 中相同的配置项。

页面的`.json`只能设置 `window` 相关的配置项，以决定本页面的窗口表现，所以无需写 `window` 这个键，如：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>navigationBarBackgroundColor</td> 
   <td>HexColor</td> 
   <td>#000000</td> 
   <td>导航栏背景颜色，如"#000000"</td> 
  </tr> 
  <tr> 
   <td>navigationBarTextStyle</td> 
   <td>String</td> 
   <td>white</td> 
   <td>导航栏标题颜色，仅支持 black/white</td> 
  </tr> 
  <tr> 
   <td>navigationBarTitleText</td> 
   <td>String</td> 
   <td></td> 
   <td>导航栏标题文字内容</td> 
  </tr> 
  <tr> 
   <td>backgroundColor</td> 
   <td>HexColor</td> 
   <td>#ffffff</td> 
   <td>窗口的背景色</td> 
  </tr> 
  <tr> 
   <td>backgroundTextStyle</td> 
   <td>String</td> 
   <td>dark</td> 
   <td>下拉背景字体、loading 图的样式，仅支持 dark/light</td> 
  </tr> 
  <tr> 
   <td>enablePullDownRefresh</td> 
   <td>Boolean</td> 
   <td>false</td> 
   <td>是否开启下拉刷新，详见页面相关事件处理函数。</td> 
  </tr> 
  <tr> 
   <td>disableScroll</td> 
   <td>Boolean</td> 
   <td>false</td> 
   <td>设置为 true 则页面整体不能上下滚动；只在 page.json 中有效，无法在 app.json 中设置该项</td> 
  </tr> 
  <tr> 
   <td>onReachBottomDistance</td> 
   <td>Number</td> 
   <td>50</td> 
   <td>页面上拉触底事件触发时距页面底部距离，单位为px</td> 
  </tr> 
 </tbody> 
</table>

示例代码：

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

[img]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cudzNjc2Nob29sLmNuL2F0dGFjaG1lbnRzL2ltYWdlLzIwMTgwMjA5LzE1MTgxNjU1NjE1NTQyODUucG5n?x-oss-process=image/format,png
[img 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cudzNjc2Nob29sLmNuL2F0dGFjaG1lbnRzL2ltYWdlLzIwMTkwNzExLzE1NjI4MzczNjg3NzA3ODkucG5n?x-oss-process=image/format,png
[img 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cudzNjc2Nob29sLmNuL2F0dGFjaG1lbnRzL2ltYWdlLzIwMTkwNzExLzE1NjI4Mzc2NTY4NDI0MTkucG5n?x-oss-process=image/format,png