AWS CDK / LINE / Honoで作るMessage API

タグ:

aws cdkHonolambda functionline botLINE Messaging APIserverless architectureTypeScriptWebhook

今回はAWS CDK、LINE Messaging API、Honoを組み合わせて、効率的で拡張性の高いLINEボットを構築する方法を紹介。AWS LambdaにHonoフレームワークを導入し、LINE Webhookを処理してユーザーからのメッセージに自動返信する機能を実装します。

広告ここから
広告ここまで

目次

    今回はAWS CDK、LINE Messaging API、そしてHonoというWebフレームワークを組み合わせて、LINEbotを構築する方法について解説します。

    LINE公式アカウントを通じてユーザーとのコミュニケーションを自動化したいと思ったことはありませんか？あるいは、すでにLINE Messaging APIを使っているけれど、より効率的なサーバーレスアーキテクチャで実装したいとお考えではないでしょうか。

    この記事では、AWS CDKを使ってAWS Lambda上にHonoフレームワークを活用したLINE Webhook処理システムを構築し、効率的で拡張性の高いLINEボットを実装する方法を紹介します。

    前提知識と環境構築

    この記事を理解するには、以下の前提知識があると役立ちます：

    • LINEボットの基本的な仕組み

    • AWS CDKの基本的な使い方

    • TypeScriptの基本文法

    環境構築として、以下のツールをインストールしておく必要があります： 

    # Node.jsがインストール済みであることを前提とします
npm install -g aws-cdk
npm install -g typescript

    また、AWSアカウントとLINE Developersアカウントも必要です。LINE DevelopersアカウントはLINE Developersコンソールから作成できます。

    LINE Messaging APIの基本

    LINE Messaging APIは、LINE公式アカウントとユーザー間のメッセージのやり取りを自動化するためのAPIです。主な特徴は以下の通りです：

    1. Webhook: ユーザーからのメッセージを受け取るためのエンドポイント

    2. Reply API: ユーザーのメッセージに返信するためのAPI

    3. Push API: ユーザーにメッセージを送信するためのAPI

    今回はこのうち、WebhookをAWS LambdaとHonoで実装し、Reply APIを使ってユーザーからのメッセージに自動返信する機能を構築します。

    プロジェクト構成

    今回構築するプロジェクトの全体構成は以下のようになります： 

    my-line-bot/
├── bin/
│   └── app.ts
├── lib/
│   └── school-app-backend-stack.ts
├── lambda/
│   ├── line-webhook.ts
│   └── utils/
│       └── line-client.ts
├── package.json
└── tsconfig.json

    AWS CDK スタックの作成

    まずはAWS CDKを使って、必要なAWSリソースを定義していきます。主に以下のリソースを作成します：

    1. LINE Webhook用のLambda関数

    2. Lambda関数のURL（Function URL）

    以下は、lib/school-app-backend-stack.tsのコードです： 

    import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { aws_lambda_nodejs, aws_iam } from 'aws-cdk-lib';
import { FunctionUrlAuthType, LoggingFormat } from 'aws-cdk-lib/aws-lambda';
import { join } from 'path'

export class SchoolAppBackendStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps & {
    environment: string
  }) {
    super(scope, id, props);

    /**
     * LINE Message API handler
     */
    const lambdaLineMessageApiHandler = new aws_lambda_nodejs.NodejsFunction(this, `LINEWebhook-${props?.environment}`, {
      entry: join(__dirname, '../lambda/line-webhook.ts'),
      handler: 'handler',
      environment: {
        APP_ENV: props?.environment || 'dev',
        SNS_TOPIC_ARN: process.env.SLACK_NOTIFICATION_SNS_ARN as string,
        LINE_CHANNEL_ACCESS_TOKEN: process.env.LINE_CHANNEL_ACCESS_TOKEN as string,
        LINE_CHANNEL_SECRET: process.env.LINE_CHANNEL_SECRET as string,
      },
      loggingFormat: LoggingFormat.TEXT,
    });

    const lambdaLineMessageApiUrl = lambdaLineMessageApiHandler.addFunctionUrl({
      authType: FunctionUrlAuthType.NONE, // 認証なしの場合
    });

    new cdk.CfnOutput(this, 'LINEWebhookAPIURL', {
      value: lambdaLineMessageApiUrl.url,
      description: 'URL for the Lambda function',
    });
  }
}

    このコードでは、NodejsFunctionを使ってTypeScriptのLambda関数を定義し、環境変数としてLINE APIのチャネルアクセストークンとチャネルシークレットを設定しています。また、Lambda Function URLを作成して外部からアクセス可能なエンドポイントを提供します。

    Honoを使ったLINE Webhookハンドラーの実装

    次に、Lambda関数の中でHonoを使ってWebhookハンドラーを実装します。Honoは軽量で高速なWebフレームワークで、サーバーレス環境との相性が非常に良いのが特徴です。

    まず、必要なパッケージをインストールします： 

    npm install hono @line/bot-sdk

    以下は、lambda/line-webhook.tsのコードです： 

    import { Hono } from 'hono';
import { handle } from 'hono/aws-lambda';
import { Client, middleware, WebhookEvent } from '@line/bot-sdk';

// LINEクライアントの設定
const config = {
  channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN || '',
  channelSecret: process.env.LINE_CHANNEL_SECRET || '',
};

// LINEクライアントの初期化
const lineClient = new Client(config);

// Honoアプリの作成
const app = new Hono();

// LINEミドルウェアの設定
app.use('/webhook', async (c, next) => {
  const signature = c.req.header('x-line-signature');
  if (!signature) {
    return c.text('Invalid signature', 401);
  }

  // リクエストボディを取得
  const body = await c.req.text();
  
  // LINE SDKミドルウェアでシグネチャを検証
  try {
    middleware(config)(
      { headers: { 'x-line-signature': signature }, body },
      {} as any,
      () => {}
    );
  } catch (err) {
    console.error('Invalid signature:', err);
    return c.text('Invalid signature', 401);
  }

  c.set('lineBody', JSON.parse(body));
  await next();
});

// Webhookエンドポイント
app.post('/webhook', async (c) => {
  const body = c.get('lineBody');
  
  // イベントを処理
  await Promise.all(
    body.events.map(async (event: WebhookEvent) => {
      try {
        await handleEvent(event);
      } catch (err) {
        console.error('Error handling event:', err);
      }
    })
  );
  
  return c.text('OK');
});

// イベントハンドラー
async function handleEvent(event: WebhookEvent) {
  // メッセージイベントのみを処理
  if (event.type !== 'message' || event.message.type !== 'text') {
    return;
  }

  // 受信したメッセージテキスト
  const receivedText = event.message.text;
  
  // 返信メッセージを作成
  let replyText = `「${receivedText}」というメッセージを受け取りました！`;
  
  // メッセージに応じた返答を設定（例：簡単なエコーボット）
  if (receivedText.includes('こんにちは')) {
    replyText = 'こんにちは！何かお手伝いできることはありますか？';
  } else if (receivedText.includes('ありがとう')) {
    replyText = 'どういたしまして！他にも質問があればどうぞ😊';
  }

  // 返信を送信
  await lineClient.replyMessage(event.replyToken, {
    type: 'text',
    text: replyText,
  });
}

// Lambda Handler
export const handler = handle(app);

    このコードでは：

    1. Honoアプリケーションを作成し、AWS Lambda用のハンドラーを定義

    2. LINE Messaging APIのシグネチャ検証を行うミドルウェアを実装

    3. Webhookエンドポイントを定義し、LINEからのイベントを処理

    4. テキストメッセージを受け取った時に自動で返信する機能を実装

    LINEクライアントユーティリティの実装

    より機能を分離するために、LINEクライアントの処理を別ファイルに切り出すこともできます。以下はlambda/utils/line-client.tsの例です： 

    import { Client, ClientConfig, MessageAPIResponseBase } from '@line/bot-sdk';

export class LineClientWrapper {
  private client: Client;

  constructor(config: ClientConfig) {
    this.client = new Client(config);
  }

  /**
   * テキストメッセージを送信する
   */
  async sendTextMessage(to: string, text: string): Promise<MessageAPIResponseBase> {
    return this.client.pushMessage(to, {
      type: 'text',
      text,
    });
  }

  /**
   * 複数のメッセージを送信する
   */
  async sendMessages(to: string, messages: any[]): Promise<MessageAPIResponseBase> {
    return this.client.pushMessage(to, messages);
  }

  /**
   * 返信トークンを使ってメッセージを返信する
   */
  async replyWithToken(replyToken: string, messages: any): Promise<MessageAPIResponseBase> {
    return this.client.replyMessage(replyToken, messages);
  }
}

// デフォルトのLINEクライアントインスタンスを作成
export const lineClient = new LineClientWrapper({
  channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN || '',
  channelSecret: process.env.LINE_CHANNEL_SECRET || '',
});

    このユーティリティクラスを使えば、主要なLINE Messaging APIの機能をより簡単に利用できます。

    デプロイと設定

    1. CDKプロジェクトのデプロイ

    プロジェクトをデプロイするには、以下のコマンドを実行します： 

    # 環境変数の設定
export LINE_CHANNEL_ACCESS_TOKEN=your_access_token
export LINE_CHANNEL_SECRET=your_channel_secret
export SLACK_NOTIFICATION_SNS_ARN=your_sns_arn  # 通知用（オプション）

# CDKデプロイ
cdk deploy

    デプロイが成功すると、出力としてLambda Function URLが表示されます。このURLをLINE Developersコンソールに設定します。

    2. LINE Developersコンソールでの設定

    1. LINE Developersコンソールにログイン

    2. プロバイダーとチャネルを選択

    3. 「Messaging API設定」タブを開く

    4. 「Webhook設定」セクションで「Webhook URL」に、CDKデプロイで取得したLambda Function URLを設定し、末尾に/webhookを追加（例：https://xxxx.lambda-url.ap-northeast-1.on.aws/webhook）

    5. 「Webhookの利用」をオンに設定

    6. 「検証」ボタンをクリックして、Webhookが正しく設定されていることを確認

    動作確認

    設定が完了したら、LINE公式アカウントにメッセージを送信して動作を確認します。

    1. LINE公式アカウントを友達追加

    2. テキストメッセージを送信（例：「こんにちは」）

    3. ボットから自動返信があれば成功です！

    Honoを使うメリット

    この実装でHonoを使用するメリットは以下の通りです：

    1. 軽量: バンドルサイズが小さく、コールドスタートに優れている

    2. パフォーマンス: 高速なルーティングと処理

    3. TypeScript対応: 型安全なWeb APIの実装が可能

    4. ミドルウェア: 柔軟なミドルウェア機能でコードを整理しやすい

    5. マルチプラットフォーム: AWS Lambda以外の環境でも同じコードが動作

    トラブルシューティング

    よくある問題と解決方法を紹介します：

    1. Webhookの検証に失敗する

    • LINE Developers側のWebhook URLが正しく設定されているか確認

    • チャネルシークレットとアクセストークンが正しく環境変数に設定されているか確認

    • Lambda Function URLのパスに/webhookが含まれているか確認

    2. メッセージに返信がない

    • CloudWatchログでエラーを確認

    • イベント処理部分に例外処理を追加して詳細なログを取得

    • LINE Messaging APIの利用制限を確認（無料プランでは一日の送信メッセージ数に制限あり）

    3. Lambda関数のデプロイに失敗する

    • IAMロールの権限が適切か確認

    • 依存パッケージがすべてインストールされているか確認

    • TypeScriptのコンパイルエラーがないか確認

    運用面での注意点

    運用面では以下の点に注意しましょう：

    1. セキュリティ: LINEチャネルシークレットとアクセストークンは安全に管理する

    2. モニタリング: CloudWatchでのログ監視とアラームの設定

    3. コスト管理: Lambda実行回数とメモリ使用量の監視

    4. スケーリング: トラフィック増加時の対応策の検討

    まとめ

    この記事では、AWS CDK、LINE Messaging API、Honoフレームワークを組み合わせて、サーバーレスなLINEボットを構築する方法を紹介しました。この構成は以下のメリットがあります：

    • コスト効率: サーバーレスアーキテクチャによる従量課金

    • メンテナンス性: コードの整理がしやすいHonoフレームワークの活用

    • 拡張性: AWS各種サービスとの連携が容易

    LINE Messaging APIとAWSサーバーレスサービスを組み合わせることで、ビジネスとユーザー間のコミュニケーションを効率化するソリューションを低コストで実現できます。

    次のステップとして、ボットに独自のビジネスロジックを組み込んだり、LINEとWebアプリケーションを連携させたりして、より高度なユーザー体験を提供していくことをお勧めします。

    皆さんも是非、LINEボットを活用したサービスの開発に挑戦してみてください！何か質問や困ったことがあれば、コメント欄でお知らせください。

    参考になれば幸いです。

    広告ここから
    広告ここまで

    Random posts

    Cloudflare AI Gatewayを、LangChain.jsで作ったアプリに入れてみた

    MomentoをCloudflare Workers / Pages functionsで使う時は、Web SDKを使おう

    AWSのApplication Composerのデモを触ってみた

    Amazon AppFlowで、StripeのデータをAmazon S3に取り込んでみる

    Node.jsで、特定のGoogleカレンダーに登録されたイベント情報を取得する

    Alexaスキルのネタに困っている人はオープンデータを使ってみよう

    Virtual AlexaでS3 Persistance Adapterを利用しているスキルのテストを実行するワークアラウンド

    [Fx0でアプリを作る]Framinでメイン画像を切り替えるアプリを作った覚書

    PolymerのLayout属性を使ってフレキシブルレイアウトを実現させる覚書

    [CSS]CSSNiteinOSAKA vol.36まとめ【StyleGuideのススメ】

    Home
    Search
    Bookmark