TypeScript 中的数据建模

在 TypeScript 应用程序中，通常希望创建强类型、文档完善的对象来包含应用程序操作的数据。使用接口或类，您可以描述程序中对象的形状和行为。

但是，如果您使用 Deno KV，则需要做一些额外的工作才能持久化和检索强类型的对象。在本指南中，我们将介绍在 Deno KV 中进出强类型对象的工作策略。

使用接口和类型断言跳转到标题

在 Deno KV 中存储和检索应用程序数据时，您可能希望首先使用 TypeScript 接口描述数据的形状。以下是一个对象模型，它描述了博客系统的一些关键组件

model.ts

export interface Author {
  username: string;
  fullName: string;
}

export interface Post {
  slug: string;
  title: string;
  body: string;
  author: Author;
  createdAt: Date;
  updatedAt: Date;
}

此对象模型描述了博客文章和相关的作者。

使用 Deno KV，您可以将这些 TypeScript 接口用作数据传输对象 (DTO) - 围绕您可能发送到或接收自 Deno KV 的未类型化对象的强类型包装器。

无需任何额外工作，您就可以愉快地将其中一个 DTO 的内容存储在 Deno KV 中。

import { Author } from "./model.ts";

const kv = await Deno.openKv();

const a: Author = {
  username: "acdoyle",
  fullName: "Arthur Conan Doyle",
};

await kv.set(["authors", a.username], a);

但是，从 Deno KV 中检索同一个对象时，默认情况下它不会与类型信息相关联。但是，如果您知道为键存储的对象的形状，则可以使用类型断言来告知 TypeScript 编译器对象的形状。

import { Author } from "./model.ts";

const kv = await Deno.openKv();

const r = await kv.get(["authors", "acdoyle"]);
const ac = r.value as Author;

console.log(ac.fullName);

您还可以为 get 指定一个可选的类型参数

import { Author } from "./model.ts";

const kv = await Deno.openKv();

const r = await kv.get<Author>(["authors", "acdoyle"]);

console.log(r.value.fullName);

对于更简单的數據结构，这种技术可能就足够了。但通常情况下，您可能希望或需要在创建或访问域对象时应用一些业务逻辑。当出现这种需求时，您可以开发一组可以对 DTO 进行操作的纯函数。

使用服务层封装业务逻辑跳转到标题

当您的应用程序的持久化需求变得更加复杂时 - 例如，当您需要创建二级索引以便通过不同的键查询您的数据，或维护对象之间的关系时 - 您将希望创建一组函数来位于 DTO 之上，以确保传递的数据是有效的（而不仅仅是类型正确）。

从我们上面的业务对象来看，Post 对象足够复杂，可能需要一层代码来保存和检索对象的实例。下面是两个函数的示例，它们包装了底层的 Deno KV API，并为 Post 接口返回强类型对象实例。

值得注意的是，我们需要存储 Author 对象的标识符，以便稍后从 KV 中检索作者信息。

import { Author, Post } from "./model.ts";

const kv = await Deno.openKv();

interface RawPost extends Post {
  authorUsername: string;
}

export async function savePost(p: Post): Promise<Post> {
  const postData: RawPost = Object.assign({}, p, {
    authorUsername: p.author.username,
  });

  await kv.set(["posts", p.slug], postData);
  return p;
}

export async function getPost(slug: string): Promise<Post> {
  const postResponse = await kv.get(["posts", slug]);
  const rawPost = postResponse.value as RawPost;
  const authorResponse = await kv.get(["authors", rawPost.authorUsername]);

  const author = authorResponse.value as Author;
  const post = Object.assign({}, postResponse.value, {
    author,
  }) as Post;

  return post;
}

这层薄薄的代码使用 RawPost 接口，它扩展了实际的 Post 接口，以包含一些用于引用另一个索引（关联的 Author 对象）的数据。

savePost 和 getPost 函数取代了直接的 Deno KV get 或 set 操作，以便它们可以为我们正确地序列化和“水化”模型对象，并具有适当的类型和关联。

TypeScript 中的数据建模

使用接口和类型断言 跳转到标题#

使用服务层封装业务逻辑 跳转到标题#

使用接口和类型断言跳转到标题

使用服务层封装业务逻辑跳转到标题