会话与数据存储（内置）

你可以通过自己编写代码来实现连接你选择的数据存储，但是 grammY 提供了一个非常方便的存储模式，称为会话。

向下跳转如果你已经知道会话是怎样工作的。

为什么我们必须考虑存储问题？

和 Telegram 上的普通用户相反，bot 在 Telegram 云中只有有限的云存储空间open in new window 。因此，下面这几件事你不能用 bot 来做：

你不能访问你的 bot 收到的旧消息。
你不能访问你的 bot 发送的旧消息。
你不能获取所有与你的 bot 聊天的列表。
还有更多，比如没有媒体概览等

基本上，它可以总结成这样一个事实，即一个 bot 只能访问当前传入的 update（比如消息），即上下文对象 ctx 上的信息。

因此，如果你 真的想访问 旧数据，你必须在收到它时立刻把它存下来。也就是说你必须有一个数据存储，比如说文件、数据库或者内存存储。

当然，grammY 在这里为你提供了保障：你不需要自己托管。你可以直接使用 grammY 的会话存储，它不需要任何设置，而且永久免费。

当然，还有很多其他提供数据存储的服务，而 grammY 也能与它们无缝整合。如果你想运行自己的数据库，请放心，grammY 同样支持这个的能力。向下跳转查看目前支持的集成。

什么是会话？

通常情况下，对于 bot 来说，每次聊天都会存储一些数据。举个例子，假设我们想建立一个 bot，计算一条消息的文本中包含披萨表情 🍕 的次数。这个 bot 可以添加到一个小组里，并且它可以告诉你，你和你的朋友有多喜欢披萨。

当我们的披萨 bot 收到一条消息时，它必须记住之前在当前聊天中看到过多少次 🍕。并且当你的妹妹将披萨 bot 添加到她的群聊中时，别的披萨计数器不应该发生改变，也就是说我们真正想要的是可以存储 每个聊天一个计数器。

会话就是这样一种优雅的方式来给 每个聊天 存储数据。你将会使用聊天标识符来作为数据库的键，和一个计数器作为值。在这种情况下，我们会把聊天标识符称为 会话密钥。

你可以在这里阅读更多关于会话密钥的信息。

我们可以在 bot 上安装中间件，这个中间件会在运行前，从数据库中加载聊天会话数据到 ctx.session 来提供给每个 update。它还会确保一旦我们完成了工作，会话数据就会被写回数据库，这样我们就不用再担心与数据存储的实际通信了。

在我们的例子中，我们可以在会话对象 ctx.session 上访问 对应的聊天 的披萨数量。

如何使用会话

你可以添加内置的会话中间件来为 grammY 添加会话支持。

使用示例

下面是一个计算含有披萨表情 🍕 的信息的 bot 例子

import { Bot, Context, session, SessionFlavor } from "grammy";

// 定义我们的会话。
interface SessionData {
  pizzaCount: number;
}

// 对上下文类型进行修饰以包含会话。
type MyContext = Context & SessionFlavor<SessionData>;

const bot = new Bot<MyContext>("");

// 安装会话中间件，并定义会话初始值。
function initial(): SessionData {
  return { pizzaCount: 0 };
}
bot.use(session({ initial }));

bot.command("hunger", async (ctx) => {
  const count = ctx.session.pizzaCount;
  await ctx.reply(`Your hunger level is ${count}!`);
});

bot.hears(/.*🍕.*/, (ctx) => ctx.session.pizzaCount++);

bot.start();

const { Bot, session } = require("grammy");

const bot = new Bot("");

// 安装会话中间件，并定义会话初始值。
function initial(): SessionData {
  return { pizzaCount: 0 };
}
bot.use(session({ initial }));

bot.command("hunger", async (ctx) => {
  const count = ctx.session.pizzaCount;
  await ctx.reply(`Your hunger level is ${count}!`);
});

bot.hears(/.*🍕.*/, (ctx) => ctx.session.pizzaCount++);

bot.start();

import {
  Bot,
  Context,
  session,
  SessionFlavor,
} from "https://deno.land/x/grammy/mod.ts";

// 定义我们的会话。
interface SessionData {
  pizzaCount: number;
}

// 对上下文类型进行修饰以包含会话。
type MyContext = Context & SessionFlavor<SessionData>;

const bot = new Bot<MyContext>("");

// 安装会话中间件，并定义会话初始值。
function initial(): SessionData {
  return { pizzaCount: 0 };
}
bot.use(session({ initial }));

bot.command("hunger", async (ctx) => {
  const count = ctx.session.pizzaCount;
  await ctx.reply(`Your hunger level is ${count}!`);
});

bot.hears(/.*🍕.*/, (ctx) => ctx.session.pizzaCount++);

bot.start();

请注意，我们还必须调整上下文类型，使得会话可以在上下文上使用。上下文修饰器被称为 SessionFlavor。

初始化会话数据

当一个用户第一次联系你的 bot 时，他们没有任何会话数据可以使用。因此，你需要在会话中间件中指定 initial 选项。传入一个函数，为新的聊天生成一个带有初始会话数据的新对象。

// 创建一个新的对象，作为初始会话数据使用。
function createInitialSessionData() {
  return {
    pizzaCount: 0,
    // 更多数据放在这里
  };
}
bot.use(session({ initial: createInitialSessionData }));

相同但更短的写法：

bot.use(session({ initial: () => ({ pizzaCount: 0 }) }));

共享对象

请确保总是创建一个 新的对象。不要这样做：

// 危险的，不安全的，错误的，应该被制止的
const initialData = { pizzaCount: 0 }; // 不要这么干
bot.use(session({ initial: { initialData } })); // 邪恶的

如果你这样做，几个不同的聊天室可能会在内存中共享同一个会话对象。因此，在一个聊天中更改会话数据可能会导致另一个聊天的会话数据也被更改。

你也可以完全忽略 initial 选项，尽管我们建议你不要这样做。如果你不指定它，读取 ctx.session 时将会给新用户抛出一个错误。

会话密钥

本章节介绍一个大多数人不需要关心的高级特性。你可能想继续阅读有关存储数据的章节。

你可以通过向 optionsopen in new window 传入一个名为 getSessionKey 的函数来指定会话使用哪个会话密钥。这样，你可以从根本上改变会话插件的工作方式。默认情况下，会话数据存储在每个聊天中。使用 getSessionKey，你可以按每个用户，或每个用户-聊天组合，或任何你想要的方式存储数据。这里有三个示例：

// 为每个聊天存储数据（默认）。
function getSessionKey(ctx: Context): string | undefined {
  // 让群聊中的所有用户共享同一个会话，
  // 但私聊中每个用户都有一个独立的私人会话
  return ctx.chat?.id.toString();
}
// 为每个用户存储数据。
function getSessionKey(ctx: Context): string | undefined {
  // 给每个用户提供一个私人的会话存储
  //（将在群聊和私人聊天中共享）
  return ctx.from?.id.toString();
}
// 为用户-聊天组合存储数据。
function getSessionKey(ctx: Context): string | undefined {
  // 在每次与 bot 聊天时，给每个用户一个独立的会话存储
  // （给每个群聊和私人聊天一个独立的会话存储）
  return ctx.from === undefined || ctx.chat === undefined
    ? undefined
    : `${ctx.from.id}/${ctx.chat.id}`;
}
bot.use(session({ getSessionKey }));

// 为每个聊天存储数据（默认）。
function getSessionKey(ctx) {
  // 让群聊中的所有用户共享同一个会话，
  // 但私聊中每个用户都有一个独立的私人会话
  return ctx.chat?.id.toString();
}
// 为每个用户存储数据。
function getSessionKey(ctx) {
  // 给每个用户提供一个私人的会话存储
  //（将在群聊和私人聊天中共享）
  return ctx.from?.id.toString();
}
// 为用户-聊天组合存储数据。
function getSessionKey(ctx) {
  // 在每次与 bot 聊天时，给每个用户一个独立的会话存储
  // （给每个群聊和私人聊天一个独立的会话存储）
  return ctx.from === undefined || ctx.chat === undefined
    ? undefined
    : `${ctx.from.id}/${ctx.chat.id}`;
}
bot.use(session({ getSessionKey }));

当 getSessionKey 返回 undefined 时，ctx.session 也会被设置为 undefined。举个例子，默认的会话密钥解析器不能处理 poll/poll_answer update 或 inline_query update，因为它们不属于一个聊天（ctx.chat 是 undefined）。

会话密钥和 webhooks

当你在 webhooks 上运行你的 bot，你应该避免使用 getSessionKey 选项。 Telegram 在每次聊天时都会按照顺序发送 webhooks，因此默认的会话密钥解析器是唯一能保证不会丢失数据的实现。

如果你必须使用该选项（当然，这仍然是可能的），你应该知道你在做什么。通过阅读这个，特别是这个，确保你了解使用这个配置的后果。

储存你的数据

在上面的例子中，会话数据存储在你的内存中，所以一旦你的 bot 被停止了，所有的数据都会丢失。当你开发 bot 或者运行自动测试时，这样会很方便（因为不需要配置数据库），但是不应该在生产环境中使用这种方式。在生产环境中，你应该使用会话中间件的 storage 选项，将它连接到你的数据存储中。这里可能已经有你需要并且可以使用的为 grammY 编写的存储适配器（见下文），如果没有，通常只需要 5 行代码就可以自己实现一个。

懒会话

本章节介绍了大多数人不需要关心的性能优化。你可能想继续写阅读有关已知的存储适配器的章节。

懒会话是会话的另一种实现方式，通过跳过多余的读写操作，可以大大减少你的 bot 的数据库流量。

假设你的 bot 在一个群组聊天中，它只响应命令而不响应普通的文本消息。没有会话时，会发生下列情况：

附带新的文本消息的 update 会被发送到你的 bot 上
没有调用处理程序，所以不采取任何行动
中间件会立刻完成

一旦你添加了（默认，严格）的会话，直接在上下文对象中提供会话数据，会发生下列情况：

附带新的文本消息的 update 会被发送到你的 bot 上
从会话存储（例如数据库）中加载会话数据
没有调用处理程序，所以不采取任何行动
相同的会话数据会被写回到会话存储中
中间件完成后，堆数据存储进行了一次读和一次写

根据你的 bot 的性质，这可能会导致大量多余的读和写。如果发现没有没有调用处理程序需要会话数据，懒会话允许你跳过步骤 2 和步骤 4。在这种情况下，不会从数据存储中读出数据，也不会写回数据。

这是通过拦截对 ctx.session 的访问来实现的。如果没有调用处理程序，那么 ctx.session 将永远不会被访问。懒会话以这个为一个指标来避免进行数据库通信。

在实践中，不是在 ctx.session 下提供会话数据，而是在 ctx.session 下提供 一个会话数据的 promise。

// 默认会话 (严格会话)
bot.command("settings", (ctx) => {
  // `session` 是会话数据
  const session = ctx.session;
});

// 懒会话
bot.command("settings", async (ctx) => {
  // `promise` 是会话数据的一个 promise
  const promise = ctx.session;
  // `session` 是会话数据
  const session = await ctx.session;
});

如果你一直没有访问 ctx.session，就不会发生任何操作，但只要你访问了上下文对象的 session 属性，就会触发读操作。如果你一直没有触发读取（或者直接给 ctx.session 赋一个新值），因为它不可能被改变，所以我们知道我们不需要写回任何数据。因此，我们也会跳过写入操作。通过上诉操作，我们实现了最小的读写操作，只需要在你的代码中添加 async 和 await 关键字，你就可以像之前一样使用会话。

所以使用懒会话而不是默认（严格）的会话需要什么？主要是下面这三件事请：

用 LazySessionFlavor 而不是 SessionFlavor 来装饰你的上下文它们的工作方式是一样的，只是 ctx.session 被包裹在一个懒变量的 promise 中。
使用 lazySession 而不是 session 来注册你的会话中间件。
在你的中间件中，不管是读还是写，都要使用內联的 await ctx.session 来替代 ctx.session。不要担心：你可以用会话数据多次使用 await Promise，但你会一直引用相同的值，所以永远不会有重复读取更新。

注意，对于懒会话，你可以把对象和 promise 对象都赋值给 ctx.session。如果你把 ctx.session 设置为一个 promise，那在把数据写会数据仓库之前，它会被 await。这样可以实现以下代码：

bot.command("reset", (ctx) => {
  // 比 `await ctx.session` 要短得多：
  ctx.session = ctx.session.then((stats) => {
    stats.counter = 0;
  });
});

有人可能会争论说，明确地使用 await 比赋值一个 promise 给 ctx.session 要更好，但重点是如果你出于某种原因更喜欢这种风格，你可以这样写。

需要会话的插件

使用 ctx.session 的插件开发者应该始终允许用户传入 SessionFlavor | LazySessionFlavor，从而支持这两种模式。在插件代码中，只需要一直 await ctx.session：如果一个非 promise 对象被传入，那么它将会简单地计算为它自己，因此你实际上只需要支持懒会话就能够自动支持严格的会话。

已知的存储适配器

默认情况下，会话会由内置的存储适配器存储在你的内存中。你也可以使用 grammY 免费提供的存储适配器，或者连接到外部存储。

你可以使用下面的一个存储适配器来安装它。

const storageAdapter = ... // 取决于配置

bot.use(session({
  initial: ...
  storage: storageAdapter,
}));

内存（默认）

默认情况下，所有数据都会被存储在内存中。这意味着，当你的机器人停止时，所有的会话都会丢失。

如果你想配置更多的内存存储选项，你可以使用 grammY 核心包中的 MemorySessionStorage 类（API Referenceopen in new window）。

bot.use(session({
  initial: ...
  storage: new MemorySessionStorage() // 同样使用默认选项
}));

免费存储

免费存储是为了用于业余项目。产品级应用程序应该使用自己的数据库。支持的外部存储解决方案的支持请参考这里。

使用 grammY 的一个好处是你可以使用免费的云存储。它不需要任何配置，所有的认证都是痛使用你的 bot token 完成的。查看这个仓库open in new window！

它非常容易使用：

import { freeStorage } from "@grammyjs/storage-free";

bot.use(session({
  initial: ...
  storage: freeStorage<SessionData>(bot.token),
}));

const { freeStorage } = require("@grammyjs/storage-free");

bot.use(session({
  initial: ...
  storage: freeStorage(bot.token),
}));

import { freeStorage } from "https://deno.land/x/grammy_storages@v2.0.0/free/src/mod.ts";

bot.use(session({
  initial: ...
  storage: freeStorage<SessionData>(bot.token),
}));

完成！你的 bot 将会使用一个持久的数据存储。

这是一个完整的 bot 示例，你可以复制它来试试。

import { Bot, Context, session, SessionFlavor } from "grammy";
import { freeStorage } from "@grammyjs/storage-free";

// 定义会话结构。
interface SessionData {
  count: number;
}
type MyContext = Context & SessionFlavor<SessionData>;

// 创建 bot 并且注册会话中间件。
const bot = new Bot<MyContext>(""); // <-- 把你的 bot token 放在 "" 中间

bot.use(session({
  initial: () => ({ count: 0 }),
  storage: freeStorage<SessionData>(bot.token),
}));

// 在 update 处理中使用持久会话数据。
bot.on("message", async (ctx) => {
  ctx.session.count++;
  await ctx.reply(`Message count: ${ctx.session.count}`);
});

bot.catch((err) => console.error(err));
bot.start();

const { Bot, session } = require("grammy");
const { freeStorage } = require("@grammyjs/storage-free");

// 创建 bot 并且注册会话中间件。
const bot = new Bot(""); // <-- 把你的 bot token 放在 "" 中间

bot.use(session({
  initial: () => ({ count: 0 }),
  storage: freeStorage(bot.token),
}));

// 在 update 处理中使用持久会话数据。
bot.on("message", async (ctx) => {
  ctx.session.count++;
  await ctx.reply(`Message count: ${ctx.session.count}`);
});

bot.catch((err) => console.error(err));
bot.start();

import {
  Bot,
  Context,
  session,
  SessionFlavor,
} from "https://deno.land/x/grammy/mod.ts";
import { freeStorage } from "https://deno.land/x/grammy_storages@v2.0.0/free/src/mod.ts";

// 定义会话结构。
interface SessionData {
  count: number;
}
type MyContext = Context & SessionFlavor<SessionData>;

// 创建 bot 并且注册会话中间件。
const bot = new Bot<MyContext>(""); // <-- 把你的 bot token 放在 "" 中间

bot.use(session({
  initial: () => ({ count: 0 }),
  storage: freeStorage<SessionData>(bot.token),
}));

// 在 update 处理中使用持久会话数据。
bot.on("message", async (ctx) => {
  ctx.session.count++;
  await ctx.reply(`Message count: ${ctx.session.count}`);
});

bot.catch((err) => console.error(err));
bot.start();

外部存储解决方案

我们维护了一个官方的存储适配器列表，允许你存储会话数据在不同的地方。它们中的每一个都需要你在托管提供商处注册，或者托管你自己的存储解决方案。请查看各自的仓库，了解不同适配器的设置。

Supabase: https://github.com/grammyjs/storages/tree/main/packages/supabaseopen in new window
Deta.sh Base: https://github.com/grammyjs/storages/tree/main/packages/detaopen in new window
Google Firestore (Node.js-only): https://github.com/grammyjs/storages/tree/main/packages/firestoreopen in new window
Files: https://github.com/grammyjs/storages/tree/main/packages/fileopen in new window
MongoDB: https://github.com/grammyjs/storages/tree/main/packages/mongodbopen in new window
Redis: https://github.com/grammyjs/storages/tree/main/packages/redisopen in new window
PostgreSQL: https://github.com/grammyjs/storages/tree/main/packages/psqlopen in new window
TypeORM (Node.js-only): https://github.com/grammyjs/storages/tree/main/packages/typeormopen in new window
DenoDB (Deno-only): https://github.com/grammyjs/storages/tree/main/packages/denodbopen in new window

插件概述

这个插件是内置在 grammY 的核心中的。你不需要安装任何东西来使用它。只需要导入 grammY 即可。

并且，这个插件的文档和 API 参考都与核心包一致。

# 会话与数据存储（内置）

# 为什么我们必须考虑存储问题？

# 什么是会话？

# 如何使用会话

# 使用示例

# 初始化会话数据

# 会话密钥

# 储存你的数据

# 懒会话

# 已知的存储适配器

# 内存（默认）

# 免费存储

# 外部存储解决方案

# 插件概述