快速入门 编辑文档

本篇文档介绍 Sync 微信小程序客户端的使用。

1.下载地址

https://github.com/WildDogTeam/wilddog-weapp/blob/master/wilddog-weapp-all.js

2.前期准备

1.在控制面板中创建应用。

2.在 微信公众开放平台管理中心 设置—开发设置—服务器配置,配置域名白名单。为了简化配置,你需要增加以下 2 个域名到白名单:


注意:


微信给开发者设置了每月只能修改 3 次的限制,所以修改时一定要慎重。

3.在 微信公众开放平台管理中心,获取应用的 AppIDAppSecret

4.在控制面板 身份认证—登录方式 中打开微信小程序登录授权开关,配置微信小程序 AppIDAppSecret

3.安装 SDK 到微信小程序

1.将 Wilddog-weapp-all.js 放到微信小程序的项目中

2.使用 commonjs 引入

var wilddog = require('wilddog-weapp-all')

3.初始化

var config = {
syncURL: 'https://<WD-APPID>.wilddogio.com',
authDomain: '<WD-APPID>.wilddog.com'
}
wilddog.initializeApp(config)

4.API

微信小程序平台与一般的开放平台不同之一是它有默认的用户,所以我们提供了一个可以使用一个 api 进行 auth 的方法:

auth.signInWeapp(opt_callback)

  • opt_callback: function(err,user) 可选回调函数,认证成功后被调用,如果认证过程一切正常errnull,user是一个包含用户idprovider等信息的对象。否则 err 是一个Error对象,user为null

return Promise 对象

var config = {
syncURL: 'https://<WD-APPID>.wilddogio.com',
authDomain: '<WD-APPID>.wilddog.com'
}
wilddog.initializeApp(config)
wilddog.auth().signInWeapp(function(err,user){
// do your logic
})
//或者使用Promise
wilddog.auth().signInWeapp().then(function(user){
}).catch(function(err){
})

ref.bindAsArray(page,varName,opt_callback)

将一个reference或query 与page.data中某个Array绑定,绑定后这个reference指向的数据发生任何变化都将实时同步到绑定到的变量上,从而实时同步到页面。使用bindAsArray 相当于已经监听了 所有 child_* 事件。

bindAsArray 可以很方便列表展示

  • page 小程序的page对象
  • varName 与页面绑定的变量名
  • opt_callback: function(err) 可选回调函数,绑定结束后被调用,如果绑定过程一切正常errnull
  • return Promise 对象

例子

app.js

var config = {
syncURL: 'https://<WD-APPID>.wilddogio.com',
authDomain: '<WD-APPID.wilddog.com>'
}
App({
onLaunch:function () {
wilddog.initializeApp(config)
this.todoRef = wilddog.sync().ref('todo').orderByPriority().limitToFirst(20)
}
})

page (假设是 index)

index.js

var app = getApp()
Page({
...
onLoad: function () {
app.todoRef.bindAsArray(this,'todo',function(err){
if(err != null){
// 数据绑定失败,失败原因:err.message;
} else {
// 数据绑定成功
}
})
}
...
})

index.wxml

...
<view wx:for = "{{todo}}">{{item[".key"]}}-{{item[".value"]}}--{{item[".priority"]}}</view>
...

注意:
数据绑定的过程中,野狗数据与微信小程序的数据是一一对应的,但形式发生了变化

{
"1234": "hello",
"1235": "hello again"
}

会映射如下 Array

[
{
".key": "1234",
".value": "hello",
".priority": null
},
{
".key": "1235",
".value": "hello again",
".priority": null
}
]

ref.bindAsObject(page,varName,opt_callback)

与bindAsArray 类似,不过是绑定到一个Object,而不是Array。
bindAsObject 可以很方便的展示结构化数据,比如某种配置信息。

index.js

var app = getApp()
Page({
...
onLoad: function () {
//userInfoRef 在app中提供,在这个例子中不再重复出现
app.userInfoRef.bindAsObject(this,'userInfo',function(err){
if(err != null){
// 数据绑定失败,失败原因:err.message;
} else {
// 数据绑定成功
}
})
}
...
})

index.wxml

<view>
userName: {{userInfo[".value"]["userName"]}}
</view>

在这里,同样数据会发生映射
比如原始数据:

key: "1234"
value:{
"userName": "Jack"
}

将会被映射为:

{
".key": "1234",
".value": {
"userName": "Jack"
},
".priority": null
}

ref.unbind(page,varName)

取消数据绑定

5.数据安全

你可以在 Sync 中使用规则表达式进行数据访问权限的控制。规则表达式可以实现以下功能:

  • 数据访问权限控制
  • 用户访问权限控制
  • 数据格式校验
  • 数据索引

规则表达式的具体使用,请参考 安全性与规则


注意:



初始配置下,所有人都能读写你的应用数据,请及时在 实时通信引擎-读写权限 中更改规则表达式。

6.更多使用

野狗新手?
立即注册,为你提供安全可靠的实时通信云服务。
没找到需要的文档?
你可以提交工单反馈 或 阅读常见问题