本記事では、TypeScriptライブラリであるHonoとLine bot SDKを用いて、LINE botを作成する方法について紹介します。
TypeScriptを手軽に実行・デプロイするために、今回はDenoとdeno deployを使用していきます！
1. LINE Developers Consoleに登録
LINE botを作成するには、LINEアカウントを用いてLINE Developers Consoleに登録する必要があります。
ユーザーが送信したメッセージに対して応答するbotを作成するには、LINE Messaging APIを利用します。
Developers Consoleに登録出来たら、
- プロバイダの作成
- LINE Messaging APIを選択してチャネルの作成
の順に行います。この段階で、LINE botの名前やアイコンを登録します。（後から変更も可能です。）
LINE Developers Consoleの操作についてはこちらの記事が詳しいので、併せて参考にしてみてください。
続いて、応答設定を変更します。
Messageing API設定タブの中の「応答設定」から、webhook以外をオフにしてください。
この設定をしないと、「申し訳ありませんが、このアカウントでは個別のお問い合わせを受け付けておりません」のような自動返信が入ります。
2. 自動返信を行うプログラムの作成
LINE botはwebhookという仕組みで動いています。
作成したLINE botにユーザーがメッセージを送信すると、自分が用意したサーバーにPOSTリクエストが送られてきます。そのPOSTリクエストを受け取った際に、返信を返すというプログラムを作成します。
プログラムについて、今回はNode.jsではなくDenoを使ってTypeScriptを書いていきたいと思います。
Denoを使えばTypeScriptに関するツールのインストールや設定ファイルの記述が不要ですし、deno deployというサービスに無料でサーバーを公開できます。
エディタの設定
多くのエディタでは、デフォルトではTypeScriptに対してNode.js向けの設定が適用されるかと思います。そのため、設定を調整してDeno向けの設定が適用されるようにする必要があります。
筆者はVSCodeを使っているので、.vscode/settings.jsonに以下のような設定を書きました。
{
"deno.enable": true,
"deno.lint": true,
"deno.cacheOnSave": true,
"editor.formatOnSave": true,
"editor.defaultFormatter": "denoland.vscode-deno"
}
その他のエディタの設定方法はこちらの公式ドキュメントを参考にしてください。
https://docs.deno.com/runtime/manual/getting_started/setup_your_environment/
続いてプログラムを作成していきます。
完成したプログラムの全体像はこちらになります。
import { Hono, type HonoRequest } from "jsr:@hono/hono@4.4.12";
import {
messagingApi,
SignatureValidationFailed,
validateSignature,
type WebhookRequestBody,
} from "npm:@line/bot-sdk@9.2.2";
// LINE bot SDKの初期化
const CHANNEL_SECRET = Deno.env.get("CHANNEL_SECRET")!;
const client = new messagingApi.MessagingApiClient({
channelAccessToken: Deno.env.get("CHANNEL_ACCESS_TOKEN")!,
});
// Honoの初期化
const app = new Hono();
app.get("/", (c) => c.text("hello world"));
// https://<ドメイン>/webhookに対するPOSTリクエストを受け付け
app.post("/webhook", async (c) => {
// リクエストがLINEプラットフォームから送られたことを確認し、bodyをパース
const request = await validateAndParseRequest(c.req);
console.log(request);
for (const event of request.events) {
// メッセージイベントのみ処理する
if (event.type !== "message" || event.message.type !== "text") {
continue;
}
// event.message.textの中に受信したメッセージが入っている
console.log(event.message.text);
// LINE bot SDKを用いて返信する
await client.replyMessage({
replyToken: event.replyToken,
messages: [{ type: "text", text: reply(event.message.text) }],
});
}
return c.json({ status: "success" });
});
/**
* リクエストを検証してbodyをパースする
* Note:リクエストがLINEプラットフォームから送られたことを確認するために、ボットサーバーでリクエストヘッダーのx-line-signatureに含まれる署名を検証します。
* ref: https://developers.line.biz/ja/reference/messaging-api/#signature-validation
*/
async function validateAndParseRequest(req: HonoRequest) {
// bodyを取得
const body = await req.text();
// x-line-signatureヘッダーを取得
const signature = req.header("x-line-signature")!;
// 署名を検証し、LINEから送られたものではないと判断したらエラーを投げる
if (!validateSignature(body, CHANNEL_SECRET, signature)) {
throw new SignatureValidationFailed("signature validation failed", {
signature,
});
}
// bodyをパースして返す
return JSON.parse(body) as WebhookRequestBody;
}
/**
* 受信したメッセージに対する返信を作成する
* @param message 受信したメッセージ
* @returns 返信する文字列
*/
function reply(message: string) {
// 現在はオウム返し（受信した内容をそのまま返信）
return message;
}
export default app;
少し長いですが、全体像は以下のようになります。
- Honoを使ってLINEからのPOSTリクエストを受け取る
- 受け取ったリクエストに含まれるメッセージ内容を元に、
client.replyMessageで返信メッセージを送信する
どのようなメッセージを返すかを制御しているのがreply関数です。現在はreply関数が受け取ったメッセージをそのまま返すようになっています。
この部分を独自の処理に置き換えることで、任意のメッセージを返すことができるようになります。
3. デプロイしてwebhookを登録
deno deployにサーバーをデプロイして、LINE botを動くようにしていきましょう。
deno deployにサーバーをデプロイするには、playgroundを利用する方法と、GitHub連携を利用する方法があります。今回はGitHub連携でデプロイしたいと思います。
3-1. deno deployにデプロイ
まずGitHubリポジトリを作成し、ソースコードをGitHubにアップロードします。
ファイル名はなんでもよいですが、ここではmain.tsというファイル名を使って話を進めていきます。
GitHubリポジトリにソースコードを上げたら、deno deployのダッシュボードから新規プロジェクトを作成します。
新規プロジェクトを作成すると色々設定を聞かれます。
まずリポジトリを選択後、プロジェクト名を設定します。
最終的にデプロイされるドメインがhttps://<プロジェクト名>.deno.devになりますので、かっこいい名前を付けておきましょう。
使っているフレームワークなども聞かれますが、今回の場合はビルドステップ等も無いので空欄で大丈夫です。最後にentrypointのところでmain.tsを選択し、「deploy project」を押します。
3-2. 環境変数の設定
最後にLINEとの連携設定です。
LINEから提供されるAPIトークンを、deno deployの環境変数に設定します。
設定する環境変数は以下の2つです。
- LINE Messaging API設定の「チャネルアクセストークン」から「チャネルアクセストークン（長期）」を選択し、
CHANNEL_ACCESS_TOKENに設定 - チャネル基本設定の「チャネルシークレット」をコピーし、
CHANNEL_SECRETに設定
deno deployの環境変数の設定は、ダッシュボードのsettingsタブから行うことができます。
3-3. Webhook URLの設定
LINE botにメッセージが送信された時に、どのサーバーにPOSTするかを設定します。
今回はdeno deployのサーバーのURLを設定します。
Messaging API設定の「Webhook URL」に、https://<project-id>.deno.dev/webhookを指定します。
これで完成です！
4. 試してみる
それでは実際にLINE botが動くかどうかを試してみましょう。
ちゃんと動きましたね。
以上、deno deployとHonoでLINE botを作る方法について解説しました！