Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
uni-app
提交
babbd1fa
U
uni-app
项目概览
DCloud
/
uni-app
2 个月 前同步成功
通知
717
Star
38705
Fork
3642
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
7
列表
看板
标记
里程碑
合并请求
1
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
uni-app
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
7
Issue
7
列表
看板
标记
里程碑
合并请求
1
合并请求
1
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
babbd1fa
编写于
4月 13, 2021
作者:
DCloud_Heavensoft
提交者:
Gitee
4月 13, 2021
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs/uniCloud/cf-functions.md.
上级
28adfeab
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
99 addition
and
99 deletion
+99
-99
docs/uniCloud/cf-functions.md
docs/uniCloud/cf-functions.md
+99
-99
未找到文件。
docs/uniCloud/cf-functions.md
浏览文件 @
babbd1fa
...
...
@@ -32,25 +32,25 @@ exports.main = async (event, context) => {
let
spaceInfo
=
context
.
SPACEINFO
// 当前环境信息 {spaceId:'xxx',provider:'tencent'}
...
//其它业务代码
}
```
云函数url化的场景下无法获取
`context.OS`
、
`context.PLATFORM`
、
`context.APPID`
、
`context.CLIENTUUID`
>在云函数URL化的场景无法获取客户端平台信息,可以在调用依赖客户端平台的接口接口之前(推荐在云函数入口)通过修改context.PLATFORM手动传入客户端平台信息供其他插件(如:uni-id)使用
例:
```
js
```
云函数url化的场景下无法获取
`context.OS`
、
`context.PLATFORM`
、
`context.APPID`
、
`context.CLIENTUUID`
>在云函数URL化的场景无法获取客户端平台信息,可以在调用依赖客户端平台的接口接口之前(推荐在云函数入口)通过修改context.PLATFORM手动传入客户端平台信息供其他插件(如:uni-id)使用
例:
```
js
exports
.
main
=
async
(
event
,
context
)
=>
{
context
.
PLATFORM
=
'
app-plus
'
}
}
```
云函数中如果要使用其他服务(比如mysql数据库、redis等),可以按照nodejs的写法即可。但注意这些非uniCloud数据库和云函数运行环境不在一起,访问速度受影响。
**注意事项**
-
服务商为阿里云时,暂不可使用相对路径读取文件(比如
`fs.readFileSync('./info.txt')`
),可以使用绝对路径
`fs.readFileSync(path.resolve(__dirname,'./info.txt'))`
-
服务商为阿里云时,暂不可使用相对路径读取文件(比如
`fs.readFileSync('./info.txt')`
),可以使用绝对路径
`fs.readFileSync(path.resolve(__dirname,'./info.txt'))`
-
event大小不可超过100kb
## API列表
...
...
@@ -131,30 +131,30 @@ const res = await uniCloud.httpclient.request(apiUrl, {
method
:
'
POST
'
,
data
:
{
test
:
'
testValue
'
},
},
contentType
:
'
json
'
,
// 指定以application/json发送data内的数据
dataType
:
'
json
'
// 指定返回值为json格式,自动进行parse
})
console
.
log
(
res
)
```
返回数据结构如下
```
js
{
"
data
"
:
{
"
name
"
:
"
DCloud
"
},
// 响应内容
"
status
"
:
200
,
// 状态码
"
headers
"
:
{
// 响应头,仅作示例,不同服务器返回的有差异
"
date
"
:
"
Tue, 29 Dec 2020 08:10:30 GMT
"
,
"
content-type
"
:
"
application/json
"
,
"
content-length
"
:
"
276
"
,
"
connection
"
:
"
keep-alive
"
,
"
server
"
:
"
gunicorn/19.9.0
"
,
"
access-control-allow-origin
"
:
"
*
"
,
"
access-control-allow-credentials
"
:
"
true
"
}
}
```
返回数据结构如下
```
js
{
"
data
"
:
{
"
name
"
:
"
DCloud
"
},
// 响应内容
"
status
"
:
200
,
// 状态码
"
headers
"
:
{
// 响应头,仅作示例,不同服务器返回的有差异
"
date
"
:
"
Tue, 29 Dec 2020 08:10:30 GMT
"
,
"
content-type
"
:
"
application/json
"
,
"
content-length
"
:
"
276
"
,
"
connection
"
:
"
keep-alive
"
,
"
server
"
:
"
gunicorn/19.9.0
"
,
"
access-control-allow-origin
"
:
"
*
"
,
"
access-control-allow-credentials
"
:
"
true
"
}
}
```
## 使用npm
...
...
@@ -249,12 +249,12 @@ let callFunctionResult = await uniCloud.callFunction({
-
使用路由框架,在一个云函数内通过控制器、路由的方式编写服务器接口,控制更灵活。插件市场有很多这类插件,
[
详见
](
https://ext.dcloud.net.cn/search?q=%E8%B7%AF%E7%94%B1&orderBy=WeekDownload&cat1=7
)
## 云函数配置
### 超时时间
**注意**
-
目前阿里云的超时时间和腾讯云有区别,如果在阿里云云函数运行超过10秒那么客户端没法同步接收返回结果,但是云函数仍会运行到配置的超时时间。腾讯云在云函数运行到配置的超时时间之前客户端都是可以收到返回结果的。
### 超时时间
**注意**
-
目前阿里云的超时时间和腾讯云有区别,如果在阿里云云函数运行超过10秒那么客户端没法同步接收返回结果,但是云函数仍会运行到配置的超时时间。腾讯云在云函数运行到配置的超时时间之前客户端都是可以收到返回结果的。
### 固定出口IP@eip
...
...
@@ -270,67 +270,67 @@ serverless默认是没有固定的服务器IP的,因为有很多服务器在
-
同一个服务空间内所有开启固定出口IP的云函数使用的是同一个IP。
-
如果你是免费版升配到付费版,开启
`固定IP`
功能后,会导致付费版到期无法自动降级到免费版,请注意按时续费
### 单实例
并发度@concurrency
> 仅阿里云支持
默认情况下云函数仅支持单实例单并发,即同一时间一个实例仅可为一个用户服务(不同用户同一时间访问会被分派到不同实例进行处理)。通过修改云函数单实例并发度,可以修改云函数同一时间最多能处理多少请求。
请务必确保你已经了解了开启后的效果及负面作用后再决定是否要配置
假设同时有3个请求需要处理,当实例并发度设置为1时,需要创建3个实例来处理这3个请求,每个实例分别处理1个请求
;当实例并发度设置为10时(即1个实例可以同时处理10个请求),只需要创建1个实例就能处理这3个请求。
**开启方式**
云函数详情页面配置单实例并发度即可,支持1-100之间的数值
**效果**
-
有效减少并发请求时云函数冷启动次数
**
副作用**
-
云函数内存使用量会随着并发量增大而增加
-
如果
同时处理的不同请求对全局变量进行读写会污染全局变量,可能会导致意想不到的后果,开启单实例多并发后请尽量不要编写修改全局变量的代码,除非你知道后果是什么并且期望得到此结果
**适用场景**
|场景 |适用性 |理由 |
|:-: |:-: |:-: |
|函数中有较多时间在等待下游服务的响应 |适用 |等待响应一般不消耗资源,在一个实例内并发处理可以节省费用。 |
|函数中有共享状态且不能并发访问 |不适用 |例如全局变量,多请求并发执行修改共享状态可能会导致错误。 |
|单个请求的执行要消耗大量CPU及内存资源|不适用 |多请求并发执行会造成资源争抢,可能会导致内存不足(OOM)或者延时增加。|
**关于uni-id的特殊说明**
```
js
// 开启单实例多并发前的uni-id用法
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
res
=
uniID
.
login
({
// ...一些参数
})
return
res
}
// 由于uni-id默认会从一个内置全局变量上获取客户端平台信息,不同请求会修改此全局变量可能造成混乱,开启单实例多并发后需要将uni-id修改为如下写法
let
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
let
uniIDIns
=
uniID
.
createInstance
({
// 创建uni-id实例,其上方法同uniID
context
:
context
,
// 传入context防止不同请求互相影响
config
:
{}
// 完整uni-id配置信息,使用config.json进行配置时无需传此参数
})
const
res
=
uniIDIns
.
login
({
// ...一些参数
})
return
res
}
```
**进阶**
开启单实例多并发后的全局变量复用并非一定是坏的结果,如果你很了解此行为,也可以对此进行有效的利用
例:
[
ip-filter
](
https://ext.dcloud.net.cn/plugin?id=4619
)
中就利用云函数全局缓存一些ip访问信息来限制单ip访问频率,可以下载示例项目体验一下
### 单实例
多并发@concurrency
> 仅阿里云支持
默认情况下云函数仅支持单实例单并发,即同一时间一个实例仅可为一个用户服务(不同用户同一时间访问会被分派到不同实例进行处理)。通过修改云函数单实例并发度,可以修改云函数同一时间最多能处理多少请求。
假设同时有3个请求需要处理,当实例并发度设置为1时,需要创建3个实例来处理这3个请求,每个实例分别处理1个请求
。而每开启一个实例都会引发云函数冷启动;当云函数的实例并发度设置为10时(即1个实例可以同时处理10个请求),只需要创建1个实例就能处理这3个请求。这样后面2个并发请求不会造成云函数的冷启动。
**开启方式**
云函数详情页面配置单实例并发度即可,支持1-100之间的数值
**效果**
-
有效减少并发请求时云函数冷启动次数
**
使用注意**
-
云函数内存使用量会随着并发量增大而增加
-
如果
并发的不同请求对全局变量同时进行读写会污染全局变量,可能会导致意想不到的后果,开启单实例多并发后请不要编写修改全局变量的代码,除非你熟悉这种技术带来的特殊应用,比如下文进阶部分提到的ip过滤。
**适用场景**
|场景 |适用性 |理由 |
|:-: |:-: |:-: |
|函数中有较多时间在等待下游服务的响应 |适用 |等待响应一般不消耗资源,在一个实例内并发处理可以节省费用。 |
|函数中有共享状态且不能并发访问 |不适用 |例如全局变量,多请求并发执行修改共享状态可能会导致错误。 |
|单个请求的执行要消耗大量CPU及内存资源|不适用 |多请求并发执行会造成资源争抢,可能会导致内存不足(OOM)或者延时增加。|
**关于uni-id的特殊说明**
```
js
// 开启单实例多并发前的uni-id用法
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
res
=
uniID
.
login
({
// ...一些参数
})
return
res
}
// 由于uni-id默认会从一个内置全局变量上获取客户端平台信息,不同请求会修改此全局变量可能造成混乱,开启单实例多并发后需要将uni-id修改为如下写法
let
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
let
uniIDIns
=
uniID
.
createInstance
({
// 创建uni-id实例,其上方法同uniID
context
:
context
,
// 传入context防止不同请求互相影响
config
:
{}
// 完整uni-id配置信息,使用config.json进行配置时无需传此参数
})
const
res
=
uniIDIns
.
login
({
// ...一些参数
})
return
res
}
```
**进阶**
开启单实例多并发后的全局变量复用并非一定是坏的结果,如果你很了解此行为,也可以对此进行有效的利用
例:
[
ip-filter
](
https://ext.dcloud.net.cn/plugin?id=4619
)
中就利用云函数全局缓存一些ip访问信息来限制单ip访问频率,可以下载示例项目体验一下
## 云函数package.json@packagejson
...
...
@@ -369,7 +369,7 @@ package.json是一个标准json文件,不可带注释。下面是一个package
其中cloudfunction-config字段是云函数配置,支持的配置如下
```
js
{
{
"
concurrency
"
:
10
,
// 单个云函数实例最大并发量,不配置的情况下默认是1
"
memorySize
"
:
256
,
// 函数的最大可用内存,单位MB,可选值: 128|256|512|1024|2048,默认值256
"
timeout
"
:
5
,
// 函数的超时时间,单位秒,默认值5。最长为60秒,阿里云在定时触发时最长可以是600秒
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录