Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
littlefishear
unidocs-zh
提交
8b52ad63
unidocs-zh
项目概览
littlefishear
/
unidocs-zh
与 Fork 源项目一致
Fork自
DCloud / unidocs-zh
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
8b52ad63
编写于
7月 27, 2022
作者:
d-u-a
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add uni-open-bridge-common
上级
4a2e2d8e
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
368 addition
and
0 deletion
+368
-0
docs/uniCloud/uni-open-bridge-common.md
docs/uniCloud/uni-open-bridge-common.md
+368
-0
未找到文件。
docs/uniCloud/uni-open-bridge-common.md
0 → 100644
浏览文件 @
8b52ad63
# 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`
## access_token
`access_token`
是微信小程序全局唯一后台接口调用凭据,调用绝大多数后台接口时都需使用。开发者可以通过 getAccessToken 接口获取并进行妥善保存。
[
详情
](
https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html#access_token
)
### getAccessToken(key: Object)
读取 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
)
|
|fallback |Function |否 |
[
详情
](
#fallback
)
|
### 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 / 数据库 / http url)
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
)
### getUserKey(key: Object)
读取 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 |是 | |
|fallback |Function |否 |
[
详情
](
#fallback
)
|
### 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 / 数据库 / http url)
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)
读取 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 |是 |版本 |
|fallback |Function |否 |
[
详情
](
#fallback
)
|
### 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 / 数据库 / http url)
let
result1
=
await
getEncryptKey
(
key
)
// 删除
await
removeEncryptKey
(
key
)
// 删除后读取, 返回 null
let
result2
=
await
getEncryptKey
(
key
)
console
.
log
(
result2
)
// null
return
null
};
```
## ticket
`ticket`
是公众号用于调用微信 JS 接口的临时票据。
[
详情
](
https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html#72
)
### getTicket(key: Object)
读取 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
)
|
|fallback |Function |否 |
[
详情
](
#fallback
)
|
### 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 / 数据库 / http url)
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`
,当
`reids -> database`
都找不到对应
`key`
时,调用此方法,需要返回数据格式如下
```
json
{
value:
null
,
duration:
1
}
```
注意事项
-
所有方法类型为
`async`
,需要使用
`await`
-
所有方法都校验传入的参数是否有效,无效则
`throw new Error()`
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录