Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
你丑我先上
unidocs-zh
提交
a9f4673f
U
unidocs-zh
项目概览
你丑我先上
/
unidocs-zh
与 Fork 源项目一致
Fork自
DCloud / unidocs-zh
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
a9f4673f
编写于
8月 05, 2022
作者:
d-u-a
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
uni-open-bridge:合并 uni-open-bridge-common
上级
dcb22407
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
423 addition
and
8 deletion
+423
-8
docs/uniCloud/uni-open-bridge.md
docs/uniCloud/uni-open-bridge.md
+423
-8
未找到文件。
docs/uniCloud/uni-open-bridge.md
浏览文件 @
a9f4673f
# uni-open-bridge
`uni-open-bridge`
是
`uni-id`
体系中用于
`开放平台数据`
定时刷新
`access_token`
、
`ticket`
的云对象,使用
`uni-open-bridge`
可免维护
`access_token`
、
`ticket`
的定时刷新
`uni-open-bridge`
是
统一接管微信等三方平台认证的开源库
`uni-open-bridge`
从微信的服务器获取数据,通过
[
uni-open-bridge-commmon
](
https://uniapp.dcloud.net.cn/uniCloud/uni-open-bridge-common
)
保存到
`Redis`
或
`database`
`uni-open-bridge`
由云对象
`uni-open-bridge`
和公共模块
`uni-open-bridge-common`
两部分组成
`uni-open-bridge`
提供了 http 请求的操作方式
## 简介
调用微信绝大多数后台接口时都需使用
`access_token`
、
`session_key`
、
`ticket`
开发者需要进行统一保存,部分参数需要定时刷新。为了解决这个问题,使用公共模块
`uni-open-bridge-common`
统一调用,详情见下文说明
## config.json
## 云对象 uni-open-bridge
云对象
`uni-open-bridge`
提供以下功能
1.
定时从三方平台服务器获取数据,通过公共模块
`uni-open-bridge-commmon`
保存到
`Redis`
或
`database`
2.
通过 http 方式操作开放平台数据的读取、写入、删除
### uni-open-bridge 配置
配置文件需要依赖
`uni-config-center`
,在
`uni-config-center`
根目录添加文件夹
`uni-open-bridge`
, 新增
`config.json`
, 内容如下
...
...
@@ -26,16 +36,16 @@
}
}
},
"ipWhite
l
ist"
:
[
"0.0.0.0"
]
//
用于
http
调用的服务器IP白名单,支持配置多个,阿里云暂不支持独立IP,可以先使用腾讯云,如果需要使用阿里云,可以通过http的方式将值保存
"ipWhite
L
ist"
:
[
"0.0.0.0"
]
//
用于
http
调用的服务器IP白名单,支持配置多个,阿里云暂不支持独立IP,可以先使用腾讯云,如果需要使用阿里云,可以通过http的方式将值保存
}
```
注意:拷贝此文件内容到
`config.json`
时需要移除
`注释`
## http 调用
##
#
http 调用
请求类型
`POST`
, 需要配置IP白名单字段
`ipWhite
l
ist`
,参见
`config.json`
请求类型
`POST`
, 需要配置IP白名单字段
`ipWhite
L
ist`
,参见
`config.json`
同时需要开启
[
URL化
](
https://uniapp.dcloud.net.cn/uniCloud/http.html
)
,详见
[
uniCloud Web
](
https://unicloud.dcloud.net.cn/
)
控制台
...
...
@@ -207,4 +217,409 @@ https://xxxxxxxx-xxxx-4xxx-xxxx-xxxxxxxxxxxx.bspapp.com/uni-open-bridge/removeTi
```
注意:部署后将自动开启定时任务,间隔1小时执行
### 注意事项
-
部署后将自动开启定时任务,间隔1小时执行
-
仅支持 callFunction、url 化调用
## 公共模块 uni-open-bridge-common
`uni-open-bridge-common`
是
`uni-id`
体系中用于
`开放平台数据`
管理的公共模块。
> `云函数公共模块`是不同云函数共享代码的一种方式。如果你不了解什么是`云函数公共模块`,请另读文档[公共模块](https://uniapp.dcloud.io/uniCloud/cf-common)
`uni-open-bridge-common`
提供了
`access_token`
、
`session_key`
、
`encrypt_key`
、
`ticket`
的读取、写入、删除操作。
`uni-open-bridge-common`
支持多层 读取 / 写入 机制,
`redis -> database -> fallback`
,优先级如下:
如果用户没有开通
`redis`
或者操作失败,透传到
`database`
,
`database`
失败后,如果用户配置了
`fallback`
,继续调用
`fallback`
方法,否则抛出
`Error`
`database`
对应的表为:
`opendb-open-data`
### access_token
#### 简介
-
微信小程序
`access_token`
是微信小程序全局唯一后台接口调用凭据,调用绝大多数后台接口时都需使用。
[
详情
](
https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html#access_token
)
-
微信H5
`access_token`
是公众号的全局唯一接口调用凭据,公众号调用各接口时都需使用access_token。开发者需要进行妥善保存。access_token的存储至少要保留512个字符空间。access_token的有效期目前为2个小时,需定时刷新,重复获取将导致上次获取的access_token失效。
公众平台的 API 调用所需的access_token的使用及生成方式说明:
1、建议公众号开发者使用中控服务器统一获取和刷新access_token,其他业务逻辑服务器所使用的access_token均来自于该中控服务器,不应该各自去刷新,否则容易造成冲突,导致access_token覆盖而影响业务;
2、目前access_token的有效期通过返回的expires_in来传达,目前是7200秒之内的值。中控服务器需要根据这个有效时间提前去刷新新access_token。在刷新过程中,中控服务器可对外继续输出的老access_token,此时公众平台后台会保证在5分钟内,新老access_token都可用,这保证了第三方业务的平滑过渡;
3、access_token的有效时间可能会在未来有调整,所以中控服务器不仅需要内部定时主动刷新,还需要提供被动刷新access_token的接口,这样便于业务服务器在 API 调用获知access_token已超时的情况下,可以触发access_token的刷新流程。
4、对于可能存在风险的调用,在开发者进行获取 access_token调用时进入风险调用确认流程,需要用户管理员确认后才可以成功获取。具体流程为:
开发者通过某 IP 发起调用->平台返回错误码[89503]并同时下发模板消息给公众号管理员->公众号管理员确认该 IP 可以调用->开发者使用该 IP 再次发起调用->调用成功。
如公众号管理员第一次拒绝该 IP 调用,用户在1个小时内将无法使用该 IP 再次发起调用,如公众号管理员多次拒绝该 IP 调用,该 IP 将可能长期无法发起调用。平台建议开发者在发起调用前主动与管理员沟通确认调用需求,或请求管理员开启 IP 白名单功能并将该 IP 加入 IP 白名单列表。
#### getAccessToken(key: Object, fallback: Function)
读取 access_token
#### setAccessToken(key: Object, value: Object, expiresIn: Number)
写入 access_token
#### removeAccessToken(key: Object)
删除 access_token
#### key 属性
|参数 |类型 |必填 |描述 |
|:-: |:-: |:-: |:-: |
|dcloudAppid|String |是 |DCloud应用appid。
[
详情
](
https://ask.dcloud.net.cn/article/35907
)
|
|platform |String |是 |
[
详情
](
#platform
)
|
#### value 属性
|参数 |类型 |描述 |
|:-: |:-: |:-: |
|access_token |String | |
#### expiresIn
有效时间(秒)
#### 示例代码
```
js
'
use strict
'
;
const
{
getAccessToken
,
setAccessToken
,
removeAccessToken
}
=
require
(
'
uni-open-bridge-common
'
)
exports
.
main
=
async
(
event
,
context
)
=>
{
const
key
=
{
dcloudAppid
:
''
,
platform
:
''
}
const
value
=
{
access_token
:
''
}
const
expiresIn
=
7200
// 写入 (redis / 数据库)
await
setAccessToken
(
key
,
value
,
expiresIn
)
// 读取 (redis / 数据库)
let
result1
=
await
getAccessToken
(
key
)
// 删除
await
removeAccessToken
(
key
)
// 删除后读取, 返回 null
let
result2
=
await
getAccessToken
(
key
)
console
.
log
(
result2
)
// null
return
null
};
```
### user_key
平台对应的值
|平台 |值 |描述 |
|:-: |:-: |:-: |
|微信小程序 |session_key|微信小程序会话密钥。
[
详情
](
https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-login/code2Session.html
)
|
会话密钥
`session_key`
有效性
开发者如果遇到因为
`session_key`
不正确而校验签名失败或解密失败,请关注下面几个与
`session_key`
有关的注意事项。
`uni.login`
调用时,用户的
`session_key`
可能会被更新而致使旧
`session_key`
失效(刷新机制存在最短周期,如果同一个用户短时间内多次调用 uni.login,并非每次调用都导致
`session_key`
刷新)。
开发者应该在明确需要重新登录时才调用
`uni.login`
,及时通过
`code2Session`
接口更新服务器存储的
`session_key`
。
微信不会把
`session_key`
的有效期告知开发者。我们会根据用户使用小程序的行为对
`session_key`
进行续期。用户越频繁使用小程序,
`session_key`
有效期越长。
开发者在
`session_key`
失效时,可以通过重新执行登录流程获取有效的
`session_key`
。使用接口
`uni.checkSession`
可以校验
`session_key`
是否有效,从而避免小程序反复执行登录流程。
当开发者在实现自定义登录态时,可以考虑以
`session_key`
有效期作为自身登录态有效期,也可以实现自定义的时效性策略。
#### getUserKey(key: Object, fallback: Function)
读取 user_key
#### setUserKey(key: Object, value: Object, expiresIn: Number)
写入 user_key
#### removeUserKey(key: Object)
删除 user_key
#### key 属性
|参数 |类型 |必填 |描述 |
|:-: |:-: |:-: |:-: |
|dcloudAppid|String |是 |DCloud应用appid。
[
详情
](
https://ask.dcloud.net.cn/article/35907
)
|
|platform |String |是 |
[
详情
](
#platform
)
|
|openid |String |是 | |
#### value 属性
|参数 |类型 |描述 |
|:-: |:-: |:-: |
|session_key|String |微信小程序会话密钥 |
#### expiresIn
有效时间(秒)
#### 示例代码
```
js
'
use strict
'
;
const
{
getUserKey
,
setUserKey
,
removeUserKey
,
}
=
require
(
'
uni-open-bridge-common
'
)
exports
.
main
=
async
(
event
,
context
)
=>
{
const
key
=
{
dcloudAppid
:
''
,
platform
:
''
,
openid
:
''
}
const
value
=
{
'
session_key
'
:
''
}
const
expiresIn
=
7200
// 写入 (redis / 数据库)
await
setUserKey
(
key
,
value
,
expiresIn
)
// 读取 (redis / 数据库)
let
result1
=
await
getUserKey
(
key
)
// 删除
await
removeUserKey
(
key
)
// 删除后读取, 返回 null
let
result2
=
await
getUserKey
(
key
)
console
.
log
(
result2
)
// null
return
null
};
```
### encrypt_key
为了避免小程序与开发者后台通信时数据被截取和篡改,微信侧维护了一个用户维度的可靠key,用于小程序和后台通信时进行加密和签名。
[
详情
](
https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/user-encryptkey.html
)
开发者可以分别通过小程序前端和微信后台提供的接口,获取用户的加密 key。
#### getEncryptKey(key: Object, fallback: Function)
读取 encrypt_key
#### setEncryptKey(key: Object, value: Object, expiresIn: Number)
写入 encrypt_key
#### removeEncryptKey(key: Object)
删除 encrypt_key
#### key 属性
|参数 |类型 |必填 |描述 |
|:-: |:-: |:-: |:-: |
|dcloudAppid|String |是 |DCloud应用appid。
[
详情
](
https://ask.dcloud.net.cn/article/35907
)
|
|platform |String |是 |
[
详情
](
#platform
)
|
|openid |String |是 | |
|version |Number |是 |版本 |
#### value 属性
|参数 |类型 |描述 |
|:-: |:-: |:-: |
|encrypt_key|String |加密 key |
|iv |String |加密 iv |
#### expiresIn
有效时间(秒)
#### 示例代码
```
js
'
use strict
'
;
const
{
getEncryptKey
,
setEncryptKey
,
removeEncryptKey
}
=
require
(
'
uni-open-bridge-common
'
)
exports
.
main
=
async
(
event
,
context
)
=>
{
const
key
=
{
dcloudAppid
:
''
,
platform
:
''
,
openid
:
''
,
version
:
1
}
const
value
=
{
encrypt_key
:
''
,
iv
:
''
}
const
expiresIn
=
7200
// 写入 (redis / 数据库)
await
setEncryptKey
(
key
,
value
,
expiresIn
)
// 读取 (redis / 数据库)
let
result1
=
await
getEncryptKey
(
key
)
// 删除
await
removeEncryptKey
(
key
)
// 删除后读取, 返回 null
let
result2
=
await
getEncryptKey
(
key
)
console
.
log
(
result2
)
// null
return
null
};
```
### ticket
`ticket`
是公众号用于调用微信 JS 接口的临时票据。正常情况下,
`ticket`
的有效期为7200秒,通过
`access_token`
来获取。由于获取
`ticket`
的 api 调用次数非常有限,频繁刷新
`ticket`
会导致 api 调用受限,影响自身业务,开发者必须在自己的服务全局缓存
`ticket `
。
[
详情
](
https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html#62
)
#### getTicket(key: Object, fallback: Function)
读取 ticket
#### setTicket(key: Object, value: Object, expiresIn: Number)
写入 ticket
#### removeTicket(key: Object)
删除 ticket
#### key 属性
|参数 |类型 |必填 |描述 |
|:-: |:-: |:-: |:-: |
|dcloudAppid|String |是 |DCloud应用appid。
[
详情
](
https://ask.dcloud.net.cn/article/35907
)
|
|platform |String |是 |
[
详情
](
#platform
)
|
#### value 属性
|参数 |类型 |描述 |
|:-: |:-: |:-: |
|ticket |String | |
#### expiresIn
有效时间(秒)
#### 示例代码
```
js
'
use strict
'
;
const
{
getTicket
,
setTicket
,
removeTicket
}
=
require
(
'
uni-open-bridge-common
'
)
exports
.
main
=
async
(
event
,
context
)
=>
{
const
key
=
{
dcloudAppid
:
''
,
platform
:
''
}
const
value
=
{
ticket
:
''
}
const
expiresIn
=
7200
// 写入 (redis / 数据库)
await
setTicket
(
key
,
value
,
expiresIn
)
// 读取 (redis / 数据库)
let
result1
=
await
getTicket
(
key
)
// 删除
await
removeTicket
(
key
)
// 删除后读取, 返回 null
let
result2
=
await
getTicket
(
key
)
console
.
log
(
result2
)
// null
return
null
};
```
#### Platform@platform
平台对应的值
|值 |描述 |
|:-: |:-: |
|mp-weixin |微信小程序 |
|app-weixin |微信 App |
|h5-weixin |微信公众号 |
|web-weixin |微信pc网页 |
|mp-qq |QQ 小程序 |
|app-qq |QQ App |
#### fallback@fallback
可选
`async function fallback()`
,当
`reids -> database`
都找不到对应
`key`
时,调用此方法,需要返回数据格式如下
```
json
{
value:
null
,
duration:
1
}
```
为了简化调用
`getAccessToken()`
、
`getTicket()`
已内置
`fallback`
到微信的服务器,需要在
`config-center`
中配置
`appid`
`appsecret`
### 注意事项
-
所有方法类型为
`async`
,需要使用
`await`
-
所有方法校验
`key`
属性是否有效,无效则
`throw new Error()`
,对
`value`
仅校验是否为
`undefined`
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录