初始化

更新时间：2022/11/29 访问次数：34146

一、应用端初始化
二、服务端初始化（Node）

一、应用端初始化

1.环境配置

在IDE项目中，打开client目录下的package.json文件（不含云服务的工程，直接在目录下查看改文件），

dependencies中的@tbmp/mp-cloud-sdk为云端SDK，版本号位 * ，表示依赖最新版本，每次小程序打包会字段更新到最新版本。

若IDE安装云SDK失败，可在小程序工程目录手动安装完成。

npm install @tbmp/mp-cloud-sdk --save

修改SDK版本号后，若需要强制更新，可在IDE中完成依赖重新安装。

2.工程初始化

1）在MiniApp的入口app.js中初始化sdk, 将cloud实例挂载到App全局对象中, 方便在page中引用；

2）env对应小程序环境，对于线上小程序请务必不填或者改成 online，已发布小程序在容器中会识别环境自动切换；

3）env字段只对预览模式、真机调试模式生效，允许设置为online作为测试、调试；

4）env字段线上环境将自动使用online，流量只访问线上环境。

import cloud from '@tbmp/mp-cloud-sdk';
App({
  cloud,  
  onLaunch(options) {
     //执行相关代码     
    cloud.init({
     env: 'test',
     options
    }); 
  } 
});

3.参数说明

字段名	类型	必选	默认值	说明
env	string	否	默认为online	当取值为字符串时, 可选值为 test \| pre \| online, 对应测试预发线上三套环境

二、服务端初始化（Node）

云函数中通过context.cloud可以获取到cloud实例，无需初始化。接下来可以通过cloud实例调用云服务提供的方法。

1.示例

exports.main = async function(context) {
    const cloud = context.cloud;
    const collectionName = 'users'; 
    try {
        const name = `Tom ${Math.random()}`;
        const res = await cloud.db.collection(collectionName).insertOne({  name  });
        return `添加成功! 可在IDE中查看数据(${context.env}环境)`;
    } catch (e) {
        console.log(`添加失败!, 请先在IDE中创建集合 users (${context.env}环境)`);
    } 
}

2.context参数说明

字段名	类型	说明
appkey	string	运行时使用的appkey， 1,如果是BC模式，那么这里是B端appkey; 2,如果是模板开发模式，这里是模板的appkey; 3,如果是插件开发模式，这里是宿主小程序的appkey;
sourceAppKey	string	当前调用小程序的appkey 1,如果是BC模式，那么这里是C端appkey; 2,如果是模板开发模式，这里是实例的appkey; 3,如果是插件开发模式，这里是插件的appkey;
userNick	string	当前用户的昵称。若在小程序中未调用授权API，则无此字段
mixNick	string	当前用户的mixNick
miniappId	string	运行时使用的小程序ID， 1,如果是BC模式，那么这里是B端小程序ID; 2,如果是模板开发模式，这里是模板的小程序ID; 3,如果是插件开发模式，这里是宿主小程序的小程序ID;
sourceMiniAppId	string	当前调用小程序的小程序ID 1,如果是BC模式，那么这里是C端小程序ID; 2,如果是模板开发模式，这里是实例的小程序ID; 3,如果是插件开发模式，这里是插件的小程序ID;
accessToken	string	当前用户授权产生的sessionKey, 主要用于调用TOP-API。若在小程序中未调用授权API，则无此字段
openId	string	当前使用用户的openId
cloudId	string	当前商家云的ID
env	string	当前云函数环境
traceId	string	云函数调用唯一ID
fcName	string	当前被调用的云函数名称
handler	string	当前被调用的云函数中的Handler
appOwnerOpenId	string	当前小程序的拥有者的openId，用于BC打通。对于BC打通场景，在B端，openId是当前登录用户ID，由于是商家使用B端，这里openId即为商家ID；在C端，小程序拥有者为商家，appOwnerOpenId即为商家Id ;
data	JSON	从端上传输的业务参数

FAQ

关于此文档暂时还没有FAQ

有用(0) 我要提问

开放平台

店铺动态卡片-开发指引

初始化