edit-icon download-icon

ハンドラ

最終更新日: Aug 26, 2019

関数を作成するときは、コード実行中に Function Compute (FC) によって呼び出すことができるイベントハンドラ関数を指定する必要があります。Node.js でのハンドラ関数のシグネチャは次の通りです。

  1. exports.myHandler = function(event, context, callback) {
  2. ...
  3. // Use callback() to return information to the caller.
  4. }

myHandler は、FC が呼び出す関数の名前です。FC から見えるように、この関数をエクスポートする必要があります。たとえば、エントリポイントが helloworld.js にある場合、helloworld.myHandler ({filename}.{handlername}) が関数ハンドラです。詳細は、「関数の作成」をご参照ください。

  • event:Buffer 型のイベントぺイロードです。
  • context:呼び出された関数の有用なランタイム情報を含む Context 型オブジェクトです。
  • callback:関数呼び出しを停止して、呼び出し元にデータを返して FC に通知する関数です。

関数例:

  1. exports.myHandler = function(event, context, callback) {
  2. // Assume that the given event is a JSON string.
  3. var eventObj = JSON.parse(event.toString());
  4. console.log("value1 = " + eventObj.key1);
  5. console.log("value2 = " + eventObj.key2);
  6. // The first callback parameter is of the error type and null indicates that the function execution is successful.
  7. callback(null, "some success message");
  8. // or
  9. // callback("some error type");
  10. }

上記の例は、イベントハンドラ関数を示しています。指定された event は、まず JSON オブジェクトに変換され、 console.log() 文によってイベントデータが Alibaba Cloud Log Service に保存されます。callback が呼び出されると、関数は終了し、”some error message” が返されます。

event の形式

関数が呼び出されると、FC は、InvokeFunction リクエストの本文を関数に渡します。FC は event の形式を制限しません。ビジネス要件に基づいて、JSON、XML、Image、Video などの形式を選択できます。event の解釈は開発者によって完全に制御されています。

次の例は、OSS トリガーを使用した場合、event が JSON 形式であることを示しています。

  1. {
  2. "events": [
  3. {
  4. "eventName": "ObjectCreated:PutObject",
  5. "eventSource": "acs:oss",
  6. "eventTime": "2017-04-21T12:46:37.000Z",
  7. "eventVersion": "1.0",
  8. "oss": {
  9. "bucket": {
  10. "arn": "acs:oss:cn-shanghai:123456789:bucketname",
  11. "name": "testbucket",
  12. "ownerIdentity": "123456789",
  13. "virtualBucket": ""
  14. },
  15. "object": {
  16. "deltaSize": 122539,
  17. "eTag": "688A7BF4F233DC9C88A80BF985AB7329",
  18. "key": "image/a.jpg",
  19. "size": 122539
  20. },
  21. "ossSchemaVersion": "1.0",
  22. "ruleId": "9adac8e253828f4f7c0466d941fa3db81161e853"
  23. },
  24. "region": "cn-shanghai",
  25. "requestParameters": {
  26. "sourceIPAddress": "140.205.128.221"
  27. },
  28. "responseElements": {
  29. "requestId": "58F9FF2D3DF792092E12044C"
  30. },
  31. "userIdentity": {
  32. "principalId": "123456789"
  33. }
  34. }
  35. ]
  36. }

callback の使用

callback のパラメーターは、関数の実行結果を呼び出し側に返すために使用されます。callback 関数のシグネチャは、次のように定義されます。

  1. callback(Error error, Object result)

callback が呼び出されると、FC は呼び出しを終了します。

  • error:オプションのパラメーターで、関数が失敗したことを示し、呼び出し元にエラー情報を返します。

  • result:オプションのパラメーターで、成功した関数の実行結果を呼び出し元に返します。error パラメーターが callback に渡された場合、このパラメーターは無視されます。

callback の使用例を次に示します。

  1. callback(); // function execution is successful with no information to return.
  2. callback(null); // function execution is successful with no information to return.
  3. callback(null, null); // function execution is successful with no information to return.
  4. callback(null, "success"); // function execution is successful with a "success" string as returned value.
  5. callback(new Error("error")); // function execution fails with an "error" message as returned value.
  6. callback(new Error("error"), "ignored message") // function execution fails with an "error" message and the second parameter is ignored.
  7. callback("error"); // function execution fails with an "error" message

注意:

  • 関数の実行が完了したことを FC に通知するには、callback 関数を呼び出す必要があります。そうしないと、タイムアウトエラーが発生するまで関数の実行を終了できません。
  • callback の error パラメーターを使用してエラーメッセージが返されると、FC はサービスに関連付けられている LogStore にエラーメッセージを自動的に記録します。エラーメッセージのサイズが 256 KB より大きい場合は、最初の 256 KB のデータのみが格納され、”Truncated by FunctionCompute” というメッセージが表示されます。
  • 関数が同期的に呼び出されると、エラーメッセージまたは結果データが HTTP の本文に追加され、クライアントに返されます。関数が非同期に呼び出されると、エラーメッセージまたは結果データは返されません。