Function Compute:ハンドラ

ハンドラとは

FC 関数のハンドラは、ご利用の関数コード内でリクエストを処理するメソッドです。FC 関数が呼び出されると、Function Compute は設定されたハンドラを実行してリクエストを処理します。ハンドラは、Function Compute コンソールの ハンドラー パラメーターを使用して設定できます。

Node.js の FC 関数では、ハンドラのフォーマットは filename.methodName です。たとえば、ファイル名が index.js または index.mjs で、メソッド名が handler の場合、ハンドラは index.handler となります。

FC 関数および関連操作の詳細については、「イベントトリガー関数の作成」をご参照ください。

ハンドラの設定は、Function Compute の設定仕様に準拠する必要があります。設定仕様はハンドラのタイプによって異なります。

ハンドラシグネチャ

シンプルなイベントハンドラのシグネチャは次のとおりです。

// index.mjs
export const handler = async (event, context) => {
  console.log("receive event: \n" + event);
  return "Hello World!";
};

// index.js
exports.handler = async function(event, context) {
  console.log("receive event: \n" + event);
  return "Hello World!";
};

// index.js
exports.handler = async function(event, context, callback) {
  console.log("event: \n" + event);
  callback(null, 'hello world');
};

上記のサンプルコードの説明は次のとおりです。

handler は、Function Compute コンソールで設定された ハンドラー に対応するメソッド名です。 たとえば、関数を作成するときに index.handler を ハンドラー として指定した場合、Function Compute は index.js で定義されている handler 関数をロードして実行を開始します。

Function Compute ランタイムは、リクエストパラメーターをリクエストハンドラに渡します。最初のパラメーターは event オブジェクトで、リクエストペイロードが含まれています。event オブジェクトは Buffer 型であり、必要なオブジェクトタイプに変換できます。2 番目のパラメーターは context オブジェクトで、呼び出しのランタイムコンテキスト情報を提供します。詳細については、「コンテキスト」をご参照ください。

説明

• Node.js 18 以降のランタイムを使用する場合、callback の代わりに Async/Await 機能を使用してください。

• Function Compute は、返された結果をそのタイプに基づいて変換します。

• Buffer 型：そのまま返されます。

• オブジェクトタイプ：JSON 形式に変換されて返されます。

• その他のタイプ：文字列に変換されて返されます。

Async/Await

Node.js 18 以降の実行環境を使用する場合は、Async/Await アプローチを使用することを推奨します。Async/Await は、Node.js で非同期コードを記述するための簡潔で読みやすい方法であり、ネストされたコールバックやチェーン呼び出しを回避できます。

Async/Await アプローチには、コールバック関数 callback と比較して、次の利点があります。

• 可読性の向上： async/await を使用するコードは、より線形で同期的になります。これにより、コードの理解と保守が容易になります。深くネストされたコールバックを回避できるため、コード構造がより明確になります。

• デバッグとエラーハンドリングの簡素化： try-catch ブロックを使用して、非同期操作のエラーをより簡単にキャッチして処理できます。エラースタックがより明確になり、エラーの原因をより正確に追跡できます。

• 効率の向上： コールバックは、コードの異なる部分を切り替える必要があることがよくあります。async/await アプローチは、コンテキストスイッチの数を減らし、コードの効率を向上させます。

例 1：JSON 形式のパラメーターの解析

サンプルコード

Function Compute は JSON 形式のパラメーターを直接関数に渡します。これらのパラメーターをコードで解析する必要があります。次のコードは、JSON 形式のイベントを解析する方法を示しています。

export const handler = async (event, context) => {
  var eventObj = JSON.parse(event.toString());
  return eventObj['key'];
};

exports.handler = function(event, context, callback) {
  var eventObj = JSON.parse(event.toString());
  callback(null, eventObj['key']);
};

前提条件

Node.js 関数を作成します。詳細については、「イベントトリガー関数の作成」をご参照ください。コードを ES モジュールとして指定する場合は、関数の作成時にランタイムとして Node.js 18 または Node.js 20 を選択します。

操作手順

1. Function Compute コンソールにログインします。左側のナビゲーションウィンドウで、関数管理 > 関数を選択します。

2. 上部のナビゲーションバーで、リージョンを選択します。[関数] ページで、対象の関数をクリックします。

3. 関数の設定ページで、コード タブを選択します。コードエディタに上記のサンプルコードを入力し、デプロイメントコード をクリックします。

   説明

   上記のサンプルコードの関数のハンドラは、index.js の handler メソッドです。関数のハンドラが異なる設定になっている場合は、対応するファイルとメソッドを更新してください。

4. コード タブで、関数のテスト の右側にある アイコンをクリックします。ドロップダウンリストから テストパラメーターの設定 を選択します。次のサンプルテストパラメーターを入力し、OK をクリックします。

   {
     "key": "value"
   }

5. 関数のテスト をクリックします。

   関数が正常に実行された後、応答を確認します。応答は value です。

例 2：一時的な AccessKey ペアを使用した OSS リソースの安全な読み書き

サンプルコード

Function Compute が提供する一時的な AccessKey ペアを使用して、Object Storage Service (OSS) にアクセスします。次のコードは一例です。

// index.mjs
import OSSClient from 'ali-oss';

export const handler = async (event, context) => {
    console.log(event.toString());

    var ossClient = new OSSClient({
        accessKeyId: context.credentials.accessKeyId,
        accessKeySecret: context.credentials.accessKeySecret,
        stsToken: context.credentials.securityToken,
        region: 'oss-cn-shenzhen',
        bucket: 'my-bucket',
    });

    try {
      const uploadResult = await ossClient.put('myObj', Buffer.from('hello, fc', "utf-8"));
      console.log('upload success, ', uploadResult);
      return "put object"
    } catch (error) {
      throw error
    }
};

var OSSClient = require('ali-oss');

exports.handler = function (event, context, callback) {
    console.log(event.toString());

    var ossClient = new OSSClient({
        accessKeyId: context.credentials.accessKeyId,
        accessKeySecret: context.credentials.accessKeySecret,
        stsToken: context.credentials.securityToken,
        region: `oss-${context.region}`,
    		bucket: process.env.BUCKET_NAME,
    });

    ossClient.put('myObj', Buffer.from('hello, fc', "utf-8")).then(function (res) {
        callback(null, 'put object');
    }).catch(function (err) {
        callback(err);
    });  
};

前提条件

• OSS にアクセスする権限を持つサービスロールを設定します。詳細については、「関数ロールを使用して Function Compute に他のクラウドサービスへのアクセス権限を付与する」をご参照ください。

• Node.js ランタイムを使用する関数を作成します。詳細については、「イベントトリガー関数の作成」をご参照ください。コードを ES モジュールとして指定する場合は、関数の作成時にランタイムとして Node.js 18 または Node.js 20 を設定します。

操作手順

1. Function Compute コンソールにログインします。左側のナビゲーションウィンドウで、関数管理 > 関数を選択します。

2. 上部のナビゲーションバーで、リージョンを選択します。[関数] ページで、対象の関数をクリックします。

3. (オプション) 関数の 関数の詳細 タブで、コード タブをクリックします。WebIDE セクションで、を選択してターミナルを開きます。次に、次のコマンドを実行して ali-oss 依存関係をインストールします。

   npm install ali-oss --save

   インストールが完了すると、WebIDE の左側にあるコードディレクトリに node_modules フォルダが生成されます。このフォルダには、ali-oss ディレクトリとその他の依存ライブラリが含まれています。

4. 関数の 関数の詳細 タブで、コード タブをクリックします。コードエディタに、上記のサンプルコードを入力します。次に、コードを保存して デプロイメントコード をクリックします。

   説明

   • サンプルコードでは、関数のハンドラは index.js または index.mjs ファイルの handler メソッドです。関数で異なるハンドラを使用している場合は、ファイルとメソッドを適宜更新してください。

   • サンプルコードでは、要件に応じて region と bucket を設定する必要があります。

5. 関数のテスト をクリックします。

   関数が実行された後、返された結果を確認します。結果は put object です。

例 3：外部コマンドの呼び出し

Node.js プログラムは、fork プロセスを作成して外部コマンドを呼び出すこともできます。たとえば、child_process モジュールを使用して Linux の ls -l コマンドを呼び出し、現在のディレクトリ内のファイルを一覧表示できます。次のコードは一例です。

'use strict';

import { exec } from 'child_process';
import { promisify } from 'util';

const execPromisify = promisify(exec);
export const handler = async (event, context) => {
  try {
    const { stdout, stderr } = await execPromisify("ls -l");
    console.log(`stdout: ${stdout}`);
    if (stderr !== "") {
      console.error(`stderr: ${stderr}`);
    }
    return stdout;
  } catch (error) {
    console.error(`exec error: ${error}`);
    return error;
  }
}

'use strict';

var exec = require('child_process').exec;
exports.handler = (event, context, callback) => {
  console.log('start to execute a command');
  exec("ls -l", function(error, stdout, stderr){
    callback(null, stdout);
});
}

例 4：HTTP トリガーを使用した関数の呼び出し

サンプルコード

HTTP トリガーによって提供される URL を使用して関数を呼び出します。次のコードは一例です。

• HTTP トリガーの 認証方法 が 認証不要 に設定されている場合、Postman または curl コマンドを使用して関数を呼び出します。詳細については、「操作手順」をご参照ください。

• HTTP トリガーの 認証方法 が 署名認証、JWT 認証または Bearer 認証 に設定されている場合、対応する認証方式を使用して関数を呼び出します。詳細については、「認証」をご参照ください。

HTTP トリガーによる呼び出しのリクエストとレスポンスのペイロード形式については、「HTTP トリガーを使用した関数の呼び出し」をご参照ください。

'use strict';

export const handler = async (event, context) => {
  const eventObj = JSON.parse(event);
  console.log(`receive event: ${JSON.stringify(eventObj)}`);

  let body = 'Hello World!';
  // HTTP リクエストボディを取得
  if ("body" in eventObj) {
    body = eventObj.body;
    if (eventObj.isBase64Encoded) {
      body = Buffer.from(body, 'base64').toString('utf-8');
    }
  }
  console.log(`receive http body: ${body}`);

  return {
    'statusCode': 200,
    'body': body
  };
}

'use strict';
exports.handler = (event, context, callback) => {
  const eventObj = JSON.parse(event);
  console.log(`receive event: ${JSON.stringify(eventObj)}`);

  let body = 'Hello World!';
  // HTTP リクエストボディを取得
  if ("body" in eventObj) {
    body = eventObj.body;
    if (eventObj.isBase64Encoded) {
      body = Buffer.from(body, 'base64').toString('utf-8');
    }
  }
  console.log(`receive http body: ${body}`);

  callback(null, {
    'statusCode': 200,
    'body': body
  });
}

前提条件

上記の例に基づいて、Node.js ランタイムを使用する関数と HTTP トリガーが作成されます。詳細については、「イベントトリガー関数の作成」および「HTTP トリガーの設定」をご参照ください。コードを ES モジュールとして指定する場合は、関数の作成時にランタイムとして Node.js 18 または Node.js 20 を選択します。

操作手順

1. Function Compute コンソールにログインします。左側のナビゲーションウィンドウで、関数管理 > 関数を選択します。

2. 上部のナビゲーションバーで、リージョンを選択します。[関数] ページで、対象の関数をクリックします。

3. 関数の詳細ページで、[トリガー] タブをクリックします。[トリガー] ページで、HTTP トリガーのパブリックエンドポイントを取得します。

4. curl ツールで次のコマンドを実行して、関数を呼び出します。

   curl -i "https://test-nodejs-dlgxxr****.cn-shanghai.fcapp.run" -d 'Hello World!'

   上記のコマンドで、https://test-nodejs-dlgxxr****.cn-shanghai.fcapp.run は HTTP トリガーのパブリックエンドポイントです。

   次の応答が返されます。

   HTTP/1.1 200 OK
   Access-Control-Expose-Headers: Date,x-fc-request-id
   Content-Disposition: attachment
   Content-Length: 12
   Content-Type: text/html; charset=utf-8
   Etag: W/"c-Lve95gjOVATpfV8EL5X4nxwjKHE"
   X-Fc-Request-Id: 1-65d866a8-15d8796a-cb9b4feb69ca
   X-Powered-By: Express
   Date: Fri, 23 Feb 2024 09:34:34 GMT
   
   Hello World!