编辑文档 更新于

云函数开发指南 · PHP

云函数是云引擎（LeanEngine）的一个子模块，请确保在阅读本文档之前已经阅读了 云引擎服务概览。

当你开发移动端应用时，可能会有下列需求：

  • 应用在多平台客户端（Android、iOS、浏览器等）中很多逻辑都是一样的，希望将这部分逻辑抽取出来只维护一份。
  • 有些逻辑希望能够较灵活的调整（比如某些个性化列表的排序规则），但又不希望频繁的更新和发布移动客户端。
  • 有些逻辑需要的数据量很大，或者运算成本高（比如某些统计汇总需求），不希望在移动客户端进行运算，因为这样会消耗大量的网络流量和手机运算能力。
  • 当应用执行特定操作时，由云端系统自动触发一段逻辑（称为 Hook 函数），例如用户注册后对该用户增加一些信息记录用于统计；或某业务数据发生变化后希望做一些别的业务操作。
  • 客户端提供能够越过 ACL 或表权限的限制，对数据进行操作。
  • 需要定时任务，比如每天凌晨清理垃圾注册账号等。

这时，你可以使用云引擎的云函数，云函数是一段部署在服务端的代码，编写 JavaScript、Python、PHP 或 Java 代码，并部署到我们的平台上，可以很好地完成上述需求。

如果还不知道如何创建云引擎项目、本地调试并部署到云端，请阅读 云引擎快速入门。

多语言支持

云引擎支持多种语言的运行环境，你可以选择自己熟悉的语言开发应用：

切换云引擎环境

云引擎应用有「生产环境」和「预备环境」之分。在云引擎通过 SDK 调用云函数时，包括显式调用以及隐式调用（由于触发 hook 条件导致 hook 函数被调用），SDK 会根据云引擎所属环境（预备、生产）调用相应环境的云函数。例如，假定定义了 beforeDelete 云函数，在预备环境通过 SDK 删除一个对象，会触发预备环境的 beforeDelete hook 函数。

在云引擎以外的环境通过 SDK 显式或隐式调用云函数时，X-LC-Prod 的默认值一般为 1，也就是调用生产环境。但由于历史原因，各 SDK 的具体行为有一些差异：

  • 在 Node.js、PHP、Java 这三个 SDK 下，默认总是调用生产环境的云函数。
  • 在 Python SDK 下，配合 lean-cli 本地调试时，且应用存在预备环境时，默认调用预备环境的云函数，其他情况默认调用生产环境的云函数。
  • 云引擎 Java 环境的模板项目 java-war-getting-started 和 spring-boot-getting-started 做了处理，配合 lean-cli 本地调试时，且应用存在预备环境时，默认调用预备环境的云函数，其他情况默认调用生产环境的云函数（与 Python SDK 的行为一致）。

你还可以在 SDK 中指定客户端将请求所发往的环境：

[AVCloud setProductionMode:NO]; // 调用预备环境

// 调用预备环境
do {
    let environment: LCApplication.Environment = [.cloudEngineDevelopment]
    let configuration = LCApplication.Configuration(environment: environment)
    try LCApplication.default.set(
        id: {{appid}},
        key: {{appkey}},
        // 请将 xxx.example.com 替换为你的应用绑定的自定义 API 域名
        serverURL: "https://xxx.example.com",
        configuration: configuration)
} catch {
    print(error)
}

AV.setProduction(false); // 调用预备环境

leancloud.use_production(False) # 调用预备环境
# 需要在 SDK 初始化语句 `leancloud.init` 之前调用

LeanClient::useProduction(false); // 调用预备环境

AVCloud.setProductionMode(false); // 调用预备环境

免费版云引擎 应用只有「生产环境」，因此请不要切换到预备环境。

云函数

示例项目 中 src/cloud.php 文件定义了一个很简单的 hello 云函数。在云端进行计算的一个重要理由是，你不需要将大量的数据发送到设备上做计算，而是将这些计算放到服务端，并返回结果这一点点信息就好。

现在让我们看一个较复杂的例子来展示云引擎的用途。

例如，你写了一个应用，让用户对电影评分，一个评分对象大概是这样：

{
  "movie": "夏洛特烦恼",
  "stars": 5,
  "comment": "夏洛一梦，笑成麻花"
}

stars 表示评分，1-5。如果你想查找《夏洛特烦恼》这部电影的平均分，你可以找出这部电影的所有评分，并在设备上根据这个查询结果计算平均分。但是这样一来，尽管你只是需要平均分这样一个数字，却不得不耗费大量的带宽来传输所有的评分。通过云引擎，我们可以简单地传入电影名称，然后返回电影的平均分。

云函数接收 JSON 格式的请求对象，我们可以用它来传入电影名称。整个 LeanStorage PHP SDK 都在云引擎运行环境上有效，可以直接使用，所以我们可以使用它来查询所有的评分。结合在一起，实现 averageStars 函数的代码如下：

use \LeanCloud\Engine\Cloud;
use \LeanCloud\Query;
use \LeanCloud\CloudException;

Cloud::define("averageStars", function($params, $user) {
    $query = new Query("Review");
    $query->equalTo("movie", $params["movie"]);
    try {
        $reviews = $query->find();
    } catch (CloudException $ex) {
        // 查询失败，将错误输出到日志
        error_log($ex->getMessage());
        return 0;
    }
    $sum = 0;
    forEach($reviews as $review) {
        $sum += $review->get("stars");
    }
    if (count($reviews) > 0) {
         return $sum / count($reviews);
    } else {
         return 0;
    }
});

PHP SDK 提供了 Cloud::start 函数，可以方便快捷地初始化云函数服务。例如，一个专门提供云函数服务的云引擎项目的 index.php：

<?php
use \LeanCloud\Engine\Cloud;
require __DIR__ . '/../vendor/autoload.php';
require __DIR__ . '/../src/cloud.php'; // 其中包含云函数定义
Cloud::start();

参数和返回值

传递给云函数的参数依次为：

  • $params: array：客户端发送的参数。
  • $user: User：客户端所关联的用户（根据客户端发送的 X-LC-Session 头）。
  • $meta: array：有关客户端的更多信息，目前只有一个 $meta['remoteAddress'] 属性表示客户端的 IP。

SDK 调用云函数

LeanCloud 各个语言版本的 SDK 都提供了调用云函数的接口：

// 构建传递给服务端的参数字典
NSDictionary *dicParameters = [NSDictionary dictionaryWithObject:@"夏洛特烦恼"
                                                          forKey:@"movie"];

// 调用指定名称的云函数 averageStars，并且传递参数
[AVCloud callFunctionInBackground:@"averageStars"
                   withParameters:dicParameters
                   block:^(id object, NSError *error) {
                   if(error == nil){
                     // 处理结果
                   } else {
                     // 处理报错
                   }
}];

LCEngine.run("averageStars", parameters: ["movie": "夏洛特烦恼"]) { (result) in
    switch result {
    case .success(value: let resultValue):
        print(resultValue)
    case .failure(error: let error):
        print(error)
    }
}

var paramsJson = {
  movie: "夏洛特烦恼"
};
AV.Cloud.run('averageStars', paramsJson).then(function (data) {
  // 处理结果
}, function (err) {
  // 处理报错
});

from leancloud import cloudfunc

cloudfunc.run('averageStars', movie='夏洛特烦恼')

use \LeanCloud\Engine\Cloud;
$params = array(
    "movie" => "夏洛特烦恼"
);
Cloud::run("averageStars", $params);

// 构建传递给服务端的参数字典
Map<String, String> dicParameters = new HashMap<String, String>();
dicParameters.put("movie", "夏洛特烦恼");

// 调用指定名称的云函数 averageStars，并且传递参数（默认不使用缓存）
AVCloud.callFunctionInBackground("averageStars", dicParameters).subscribe(new Observer<Object>() {
  @Override
  public void onSubscribe(Disposable disposable) {

  }

  @Override
  public void onNext(Object object) {
    // succeed.
  }

  @Override
  public void onError(Throwable throwable) {
    // failed.
  }

  @Override
  public void onComplete() {

  }
});

// Java SDK 还提供了一个支持缓存的版本，和 AVQuery 一样，开发者在请求的时候，可以指定 CachePolicy 以及缓存的
// 最长期限，这样可以避免短时间一直直接请求云端服务器。
// 下面的请求表示优先使用上次缓存的结果，缓存有效期为 30 秒（30000 毫秒）。
AVCloud.callFunctionWithCacheInBackground("averageStars", dicParameters, AVQuery.CachePolicy.CACHE_ELSE_NETWORK, 30000)
.subscribe(new Observer<Object>() {
  @Override
  public void onSubscribe(Disposable disposable) {

  }

  @Override
  public void onNext(Object object) {
    // succeed.
  }

  @Override
  public void onError(Throwable throwable) {
    // failed.
  }

  @Override
  public void onComplete() {

  }
});

通过 REST API 调用云函数

请查看我们的 云引擎 REST API 使用指南。

云引擎调用云函数

在云引擎中可以使用 LeanCloudEngineCloud::run 调用 LeanCloudEngineCloud::define 定义的云函数：

try {
    $result = Cloud::run("averageStars", array("movie" => "夏洛特烦恼"));
} catch (\Exception $ex) {
    // 云函数错误
}

云引擎中默认会直接进行一次本地的函数调用，而不是像客户端一样发起一个 HTTP 请求。PHP 云引擎暂不支持发起 HTTP 请求来调用云函数。

RPC 调用云函数

RPC 调用云函数是指：云引擎会在这种调用方式下自动为 HTTP Response Body 做序列化，而 SDK 调用之后拿回的返回结果就是一个完整的 LeanObject 或包含这样的对象的数据结构：

NSDictionary *dicParameters = [NSDictionary dictionaryWithObject:@"夏洛特烦恼"
                                                          forKey:@"movie"];

[AVCloud rpcFunctionInBackground:@"averageStars"
                  withParameters:parameters
                  block:^(id object, NSError *error) {
                  if(error == nil){
                    // 处理结果
                  }
                  else {
                    // 处理报错
                  }
}];

LCEngine.call("averageStars", parameters: ["movie": "夏洛特烦恼"]) { (result) in
    switch result {
    case .success(object: let object):
        if let object = object {
            print(object)
        }
    case .failure(error: let error):
        print(error)
    }
}

var paramsJson = {
  movie: "夏洛特烦恼"
};

AV.Cloud.rpc('averageStars', paramsJson).then(function (object) {
  // 处理结果
}, function (error) {
  // 处理报错
});

from leancloud import cloudfunc

cloudfunc.rpc('averageStars', movie='夏洛特烦恼')

// 构建参数
Map<String, String> dicParameters = new HashMap<String, String>();
dicParameters.put("movie", "夏洛特烦恼");

AVCloud.callRPCInBackground("averageStars", dicParameters).subscribe(new Observer<AVObject>() {
  @Override
  public void onSubscribe(Disposable disposable) {

  }

  @Override
  public void onNext(AVObject avObject) {
    // succeed.
  }

  @Override
  public void onError(Throwable throwable) {
    // failed
  }

  @Override
  public void onComplete() {

  }
});

// Java SDK 还提供了一个支持缓存的版本，和 AVQuery 一样，开发者在请求的时候，可以指定 CachePolicy 以及缓存的
// 最长期限，这样可以避免短时间一直直接请求云端服务器。
// 下面的请求表示优先使用上次缓存的结果，缓存有效期为 30 秒（30000 毫秒）。
AVCloud.callRPCWithCacheInBackground("averageStars", dicParameters, AVQuery.CachePolicy.CACHE_ELSE_NETWORK, 30000)
.subscribe(new Observer<AVObject>() {
  @Override
  public void onSubscribe(Disposable disposable) {

  }

  @Override
  public void onNext(AVObject avObject) {
    // succeed.
  }

  @Override
  public void onError(Throwable throwable) {
    // failed
  }

  @Override
  public void onComplete() {

  }
});

云函数错误响应码

可以根据 HTTP status codes 自定义错误响应码。

Cloud::define("errorCode", function($params, $user) {
    User::logIn("not_this_user", "P@ssword");
});

客户端收到的响应：{ "code": 211, "error": "Could not find the user." }。

Cloud::define("customErrorCode", function($params, $user) {
    throw new FunctionError("自定义错误信息。", 123);
});

客户端收到的响应：{ "code": 123, "error": "自定义错误信息。" }。

云函数超时

云函数超时时间为 15 秒，如果超过阈值，客户端将收到 HTTP status code 为 503 的响应，body 为 The request timed out on the server。服务端会出现类似这样的日志：WARNING: [pool www] child ... exited on signal 9 (SIGKILL) after ... seconds from start。 除了 503 错误外，有些情况下客户端也可能收到其他报错，如 524 或 141。

Hook 函数

Hook 函数本质上是云函数，但它有固定的名称，定义之后会 由系统 在特定事件或操作（如数据保存前、保存后，数据更新前、更新后等等）发生时 自动触发，而不是由开发者来控制其触发时机。需要注意：

对于 before 类的 Hook（也包括 onLogin），如果返回了一个错误的话，这个操作就会被中断，你可以在这些 Hook 中主动抛出一个错误来拒绝掉某些操作。对于 after 类的 Hook（也包括 onVerified），返回错误并不会影响操作的执行（因为其实操作已经执行完了）。

graph LR
A((save)) -->D{object}
D-->E(new)
E-->|beforeSave|H{error?}
H-->N(No)
N-->B[create new object on the cloud]
B -->|afterSave|C((done))
H-->Y(Yes)
Y-->Z((interrupted))
D-->F(existing)
F-->|beforeUpdate|I{error?}
I-->Y
I-->V(No)
V-->G[update existing object on the cloud]
G-->|afterUpdate|C

graph LR
A((delete))-->|beforeDelete|H{error?}
H-->Y(Yes)
Y-->Z((interrupted))
H-->N(No)
N-->B[delete object on the cloud]
B -->|afterDelete|C((done))

为了认证 Hook 调用者的身份，我们的 SDK 内部会确认请求确实是从云引擎内网的云存储组件发出的，如果认证失败，可能会出现 Hook key check failed 的提示，如果在本地调试时出现这样的错误，请确保是通过命令行工具启动调试的。

beforeSave

在创建新对象之前，可以对数据做一些清理或验证。例如，一条电影评论不能过长，否则界面上显示不开，需要将其截断至 140 个字符：

Cloud::beforeSave("Review", function($review, $user) {
    $comment = $review->get("comment");
    if ($comment) {
        if (strlen($comment) > 140) {
            // 截断并添加 '…'
            $review->set("comment", substr($comment, 0, 140) . "…");
        }
    } else {
        // 不保存数据，并返回错误
        throw new FunctionError("No comment provided!", 101);
    }
});

afterSave

在创建新对象后触发指定操作，比如当一条留言创建后再更新一下所属帖子的评论总数：

Cloud::afterSave("Comment", function($comment, $user) {
    $query = new Query("Post");
    $post = $query->get($comment->get("post")->getObjectId());
    $post->increment("commentCount");
    try {
        $post->save();
    } catch (CloudException $ex) {
        throw new FunctionError("An error occurred while trying to save the post: " . $ex->getMessage());
    }
});

再如，在用户注册成功之后，给用户增加一个新的属性 from 并保存：

Cloud::afterSave("_User", function($userObj, $currentUser) {
    $userObj->set("from", "LeanCloud");
    try {
        $userObj->save();
    } catch (CloudException $ex) {
        throw new FunctionError("An error occurred while trying to save the user: " . $ex->getMessage());
    }
});

beforeUpdate

在更新已存在的对象前执行操作，这时你可以知道哪些字段已被修改，还可以在特定情况下拒绝本次修改：

Cloud::beforeUpdate("Review", function($review, $user) {
    // 如果 comment 字段被修改了，检查该字段的长度
    if (in_array("comment", $review->updatedKeys) &&
        strlen($review->get("comment")) > 140) {
        throw new FunctionError("comment 长度不得超过 140 字符。");
    }
});

对 $review 直接进行的修改不会被保存。如需拒绝修改，可以让函数返回一个错误。

传入的对象是一个尚未保存到数据库的临时对象，并不保证与最终储存到数据库的对象完全相同，这是因为修改中可能包含自增、数组增改、关系增改等原子操作。

afterUpdate

本 Hook 使用不当可能会造成死循环，导致数据存储 API 的调用次数暴涨，甚至产生更多的费用。因此请仔细阅读 防止死循环调用 部分，做出必要的调整和预防措施。

在更新已存在的对象后执行特定的动作。和 beforeUpdate 一样，你可以知道哪些字段已被修改。

Cloud::afterUpdate("Review", function($review, $user) {
    if (in_array("comment", $review->updatedKeys) &&
        strlen($review->get("comment")) < 5) {
        error_log(review.ObjectId . " 看起来像灌水评论：" . comment);
    }
});

防止死循环调用

你也许会好奇为什么可以在 afterUpdate 中保存 post 而不会再次触发该 hook。这是因为云引擎对所有传入 LeanObject 的对象做了处理，以阻止死循环调用的产生。

不过请注意，以下情况还需要开发者自行处理：

  • 对传入的 LeanObject 对象进行 fetch 操作。
  • 重新构造传入的 LeanObject 对象，如使用 LeanObject::create() 方法。

对于使用上述方式产生的对象，请根据需要自行调用 LeanObject->disableBeforeHook() 或 LeanObject->disableAfterHook()：

Cloud::afterUpdate("Post", function($post, $user) {
    // 直接修改并保存对象不会再次触发 afterUpdate Hook 函数
    $post->set('foo', 'bar');
    $post->save();

    // 如果有 fetch 操作，则需要在新获得的对象上调用 disableAfterHook 来确保不会再次触发 Hook 函数
    $post->fetch();
    $post->disableAfterHook();
    $post->set('foo', 'bar');
    $post->save();

    // 如果是其他方式构建对象，则需要在新构建的对象上调用 disableAfterHook 来确保不会再次触发 Hook 函数
    $post = LeanObject::create("Post", $post->getObjectId());
    $post->disableAfterHook();
    $post->save();
});

beforeDelete

在删除一个对象之前做一些检查工作，比如在删除一个相册 Album 前，先检查一下该相册中还有没有照片 Photo：

Cloud::beforeDelete("Album", function($album, $user) {
    $query = new Query("Photo");
    $query->equalTo("album", $album);
    try {
        $count = $query->count();
    } catch (CloudException $ex) {
        throw new FunctionError("An error occurred when getting photo count: {$ex->getMessage()}");
    }
    if ($count > 0) {
        // delete 操作会被丢弃
        throw new FunctionError("Cannot delete an album if it still has photos in it.");
    }
});

afterDelete

在一个对象后被删执行操作，例如递减计数、删除关联对象等等。同样以相册为例，这次我们不在删除相册前检查是否还有照片，而是在删除后，同时删除相册中的照片：

Cloud::afterDelete("Album", function($album, $user) {
    $query = new Query("Photo");
    $query->equalTo("album", $album);
    try {
        $photos = $query->find();
        LeanObject::destroyAll($photos);
    } catch (CloudException $ex) {
        throw new FunctionError("An error occurred when getting photo count: {$ex->getMessage()}");
    }
});

onVerified

当用户通过邮箱或者短信验证时，对该用户执行特定操作。比如：

Cloud::onVerifed("sms", function($user, $meta) {
    error_log("User {$user->getUsername()} is verified by SMS.");
});

函数的第一个参数是验证类型。短信验证为 sms，邮箱验证为 email。

数据库中相关的验证字段，如 emailVerified 不需要修改，系统会自动更新。

onLogin

在用户登录之时执行指定操作，比如禁止在黑名单上的用户登录：

Cloud::onLogin(function($user) {
    error_log("User {$user->getUsername()} is trying to log in.");
    if ($user->get("blocked")) {
        // 如果抛出异常，则用户无法登录（收到 401 响应）
        throw new FunctionError("Forbidden");
    }
    // 没有抛出异常，函数正常执行完毕的话，用户可以登录
});

再比如校验第三方登录的 access token：

假设某 Example 平台的 authData 如下：

{
    "uid": "42",
    "access_token": "access token string",
}

平台名称为 example_platform。 那么我们可以定义如下 onLogin 函数：

Cloud::onLogin(function($user) {
  $authData = $user->get("authData");
  $userID = $authData["example_platform"]["uid"];
  $token = $authData["example_platform"]["access_token"];

  $headers = get_headers("https://example.com/applications/${userID}/tokens/${token}");
  $statusCode = $header[0];
  if (strpos($statusCode, "200") === false) {
    throw new FunctionError("Example platform token invalid");
  }
});

注意，上面的示例片段仅为示意，为了简短省略了许多逻辑，包括 token 时效性检查、其他登录方式的处理、网络请求异常的处理等。

即时通讯 Hook 函数

请阅读 即时通讯概览 · 云引擎 Hook 来了解以下函数的相关参数和用法。

_messageReceived

在消息达到服务器、群组成员已解析完成、发送给收件人之前触发。例如，提前过滤掉聊天内容中的一些广告类的关键词：

Cloud::define("_messageReceived", function($params, $user) {
    // params: {
    //     fromPeer: 'Tom',
    //     receipt: false,
    //     groupId: null,
    //     system: null,
    //     content: '{"_lctext":"Hello!","_lctype":-1}',
    //     convId: '5789a33a1b8694ad267d8040',
    //     toPeers: ['Jerry'],
    //     __sign: '1472200796787,a0e99be208c6bce92d516c10ff3f598de8f650b9',
    //     bin: false,
    //     transient: false,
    //     sourceIP: '121.239.62.103',
    //     timestamp: 1472200796764
    // };

    error_log('_messageReceived start');
    $content = json_decode($params["content"], true);
    $text = $content["_lctext"];
    error_log($text);
    $processedContent = preg_replace("中介", "**", $text);
    // 必须含有以下语句给服务端一个正确的返回，否则会引起异常
    return array("content" => $processedContent);
});

_receiversOffline

在消息发送完成时触发、对话中某些用户却已经下线，此时可以根据发送的消息来生成离线消息推送的标题等等。例如截取所发送消息的前 6 个字符作为推送的标题：

Cloud::define('_receiversOffline', function($params, $user) {
    error_log('_receiversOffline start');
    // content 为消息内容
    $shortContent = $params["content"];
    if (strlen($shortContent) > 6) {
        $shortContent = substr($shortContent, 0, 6);
    }

    $json = array(
        // 自增未读消息的数目
        // 不想自增就设为数字
        "badge" => "Increment",
        "sound" => "default",
        // 使用开发证书
        "_profile" => "dev",
        "alert" => shortContent
    );

    $pushMessage = json_encode($json);
    return array(
        "pushMessage" => $pushMessage,
    );
});

_messageSent

消息发送完成之后触发，例如消息发送完后，在云引擎中打印一下日志：

Cloud::define('_messageSent', function($params, $user) {
    error_log('_messageSent start');
    error_log('params:' . json_encode($params));
    return array();

    // _messageSent start
    // params: {
    //   fromPeer: 'Tom',
    //   receipt: false,
    //   onlinePeers: [],
    //   content: '12345678',
    //   convId: '5789a33a1b8694ad267d8040',
    //   msgId: 'fptKnuYYQMGdiSt_Zs7zDA',
    //   __sign: '1472703266575,30e1c9b325410f96c804f737035a0f6a2d86d711',
    //   bin: false,
    //   transient: false,
    //   sourceIP: '114.219.127.186',
    //   offlinePeers: ['Jerry'],
    //   timestamp: 1472703266522
    // }
});

_conversationStart

创建对话，在签名校验（如果开启）之后、实际创建之前触发。例如对话创建时，在云引擎中打印一下日志：

Cloud::define('_conversationStart', function($params, $user) {
    error_log('_conversationStart start');
    error_log('params:' . json_encode($params));
    return array();

    // _conversationStart start
    // params: {
    //     initBy: 'Tom',
    //     members: ['Tom', 'Jerry'],
    //     attr: {
    //         name: 'Tom & Jerry'
    //     },
    //     __sign: '1472703266397,b57285517a95028f8b7c34c68f419847a049ef26'
    // }
});

_conversationStarted

创建对话完成触发。例如对话创建之后，在云引擎打印一下日志：

Cloud::define('_conversationStarted', function($params, $user) {
    error_log('_conversationStarted start');
    error_log('params:' . json_encode($params));
    return array();

    // _conversationStarted start
    // params: {
    //     convId: '5789a33a1b8694ad267d8040',
    //     __sign: '1472723167361,f5ceedde159408002fc4edb96b72aafa14bc60bb'
    // }
});

_conversationAdd

向对话添加成员，在签名校验（如果开启）之后、实际加入之前，包括主动加入和被其他用户加入两种情况都会触发。注意如果在创建对话时传入了其他用户的 clientId 作为成员，则不会触发该 hook。例如在云引擎中打印成员加入时的日志：

Cloud::define('_conversationAdd', function($params, $user) {
    error_log('_conversationAdd start');
    error_log('params:' . json_encode($params));
    return array();

    // _conversationAdd start
    // params: {
    //     initBy: 'Tom',
    //     members: ['Mary'],
    //     convId: '5789a33a1b8694ad267d8040',
    //     __sign: '1472786231813,a262494c252e82cb7a342a3c62c6d15fffbed5a0'
    // }
});

_conversationRemove

从对话中踢出成员，在签名校验（如果开启）之后、实际踢出之前触发，用户自己退出对话不会触发。例如在踢出某一个成员时，在云引擎日志中打印出该成员的 clientId：

Cloud::define('_conversationRemove', function($params, $user) {

    error_log('_conversationRemove start');
    error_log('params:' . json_encode($params));
    error_log('Removed clientId:' . $params['members'][0]);
    return array();

    // _conversationRemove start
    // params: {
    //     initBy: 'Tom',
    //     members: ['Jerry'],
    //     convId: '57c8f3ac92509726c3dadaba',
    //     __sign: '1472787372605,abdf92b1c2fc4c9820bc02304f192dab6473cd38'
    // }
    // Removed clientId: Jerry
});

_conversationUpdate

修改对话名称、自定义属性，设置或取消对话消息提醒，在实际修改之前触发。例如在更新发生时，在云引擎日志中打印出对话的名称：

Cloud::define('_conversationUpdate', function($params, $user) {
    error_log('_conversationUpdate start');
    error_log('params:' . json_encode($params));
    error_log('name:' . $params['attr']['name']);
    return array();

    // _conversationUpdate start
    // params: {
    //     convId: '57c9208292509726c3dadb4b',
    //     initBy: 'Tom',
    //     attr: {
    //         name: 'Tom and Jerry',
    //         type: 'public'
    //     }
    // }
    // name: Tom and Jerry
});

Hook 函数错误响应码

为 beforeSave 这类的 hook 函数定义错误码，需要这样：

Cloud::beforeSave("Review", function($review, $user) {
   $comment = $review->get("comment");
   if (!$comment) {
       throw new FunctionError(json_encode(array(
           "code" => 123,
           "message" => "An error occurred.",
       )));
   }
});

客户端收到的响应为 Cloud Code validation failed. Error detail: { "code": 123, "message": "An error occurred." }。可通过 截取字符串 的方式取出错误信息，再转换成需要的对象。

Hook 函数超时

Before 类 Hook 函数的超时时间为 10 秒，其他类 Hook 函数的超时时间为 3 秒。如果 Hook 函数被其他的云函数调用（比如因为保存对象而触发 beforeSave 和 afterSave），那么它们的超时时间会进一步被其他云函数调用的剩余时间限制。

例如，如果一个 beforeSave 函数是被一个已经运行了 13 秒的云函数触发，那么 beforeSave 函数就只剩下 2 秒的时间来运行。同时请参考 云函数超时及处理方案。

定时任务

定时任务可以按照设定，以一定间隔自动完成指定动作，比如半夜清理过期数据，每周一向所有用户发送推送消息等等。定时任务的最小时间单位是 秒，正常情况下时间误差都可以控制在秒级别。

定时任务是普通的云函数，也会遇到 超时问题，具体请参考 超时处理方案。

一个定时任务如果在 24 小时内收到了超过 30 次的 400（Bad Request）或 502（Bad Gateway）的应答，它将会被云引擎禁用，同时系统会向开发者发出相关的禁用通知邮件。在控制台的日志中，对应的错误信息为 timerAction short-circuited and no fallback available。

部署云引擎之后，进入 控制台 > 云引擎 > 定时任务，点击 创建定时任务，然后设定执行的函数名称、执行环境等等。例如定义一个打印循环打印日志的任务 logTimer：

Cloud::define("logTimer", function($params, $user) {
    error_log("This log is printed by logTimer.");
});

定时任务分为两类：

  • 使用 Cron 表达式安排调度
  • 以秒为单位的简单循环调度

以 Cron 表达式为例，比如每周一早上 8 点打印日志（运行之前定义的 logTimer 函数），创建定时任务的时候，选择 Cron 表达式 并填入 0 0 8 ? * MON。

Cron 表达式的语法可以参考 云队列使用指南的 Cron 表达式一节。

点击「非必填」会展开更多选项：

  • 运行参数：传递给云函数的参数（JSON 对象）。
  • 异常策略：任务因云函数超时失败后重试执行还是放弃执行。

定时任务创建后，会显示「最近一次执行时间」和「下次执行时间」。 「最近一次执行时间」除了显示时间外，还会显示执行结果，点击「查看详情」还可以查看细节：

  • status 任务的状态，包括 success（成功）、failed（失败）
  • uniqueId 任务的唯一 ID
  • finishedAt 执行完成的精确时间（仅限成功任务）
  • statusCode 云函数响应的 HTTP 状态码（仅限成功任务）
  • result 来自云函数的响应（仅限成功任务）
  • error 错误提示（仅限失败任务）
  • retryAt 下次重试时间（仅限失败任务）

具体的执行日志可以在控制台 > 云引擎 > 日志 查看。 例如：

CloudQueue 运行失败 24e1b480-aeb5-4222-ab7d-7d4b8ee170b9: hello !! {"error":"Error: ESOCKETTIMEDOUT"}

如果希望暂停定时任务（比如遇到报错需要排查），可以点击状态栏的「暂停」按钮。 相应地，点击「启用」按钮可以重新启用暂停的任务。 点击操作栏的「编辑」、「删除」按钮则可以修改、删除定时任务。

Master Key 和超级权限

因为云引擎运行在可信的服务器端环境中，所以你可以全局开启超级权限（Master Key），这样云端会跳过包括 ACL 和 Class 权限在内的检查，让你自由地操作所有云存储中的数据，当然这种方式也允许调用一些仅供 Master Key 使用的 API。开启 Master Key 的方法如下：

// 通常位于 src/app.php
Client::useMasterKey(true);

关于云引擎上的权限问题，还可以参考 ACL 权限管理开发指南 和 在云引擎中使用 ACL。

{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论