概述

在现代Web开发中，构建RESTful API已成为行业标准。TRPC，一个基于TypeScript的高性能API客户端库，简化了API调用、错误处理，并提供了强大中间件系统。本文将引领你轻松入门TRPC，助你高效地构建维护良好的RESTful API，从安装基础到高级特性，一应俱全。

TRPC简介：构建RESTful API的新选择

在构建现代Web应用程序时，RESTful API已经成为了一种标准实践。TRPC（TypeScript RESTful Client）是一个基于TypeScript编写的高性能API客户端库，它简化了API调用、错误处理，并提供了强大的中间件系统。本文将引导你轻松掌握TRPC，帮助你构建高效、易于维护的RESTful API。

安装TRPC：入门第一步

首先，你需要在项目中安装TRPC。这可以通过npm或yarn来完成。以npm为例：

npm install trpc @trpc/server @trpc/client

一旦安装成功，你就可以开始构建你的API服务器和客户端了。

基本使用：创建RESTful API端点

接下来，我们将创建一个简单的RESTful API端点。首先，你需要定义一个API服务器：

import { createTRPCInferServer } from '@trpc/server';

const api = createTRPCInferServer({
  router: {
    greeting: {
      query: () => 'Hello from API',
    },
  },
});

export default api;

在这里，我们定义了一个名为greeting的路由，它包含一个查询方法query，返回一个简单的字符串。

创建客户端：与API交互

为了让客户端能够调用API，我们需要创建一个客户端：

import { createTRPCClient } from '@trpc/client';

const client = createTRPCClient({
  url: 'http://localhost:3000/api',
});

async function getGreeting() {
  const { data } = await client.greeting.query();
  console.log(data);
}

getGreeting();

通过createTRPCClient，我们可以根据API服务器的URL创建一个客户端实例。然后，我们可以像调用JavaScript函数一样调用API的端点。

中间件介绍：增强API功能

中间件在TRPC中扮演了非常重要的角色，它们可以在请求处理链的任意位置执行逻辑，比如日志记录、认证、性能度量等。我们可以通过以下方式添加中间件：

const api = createTRPCInferServer({
  router: {
    greeting: {
      query: () => 'Hello from API',
    },
  },
  middleware: {
    logRequest: async (req) => {
      console.log(`Received request for ${req.url}`);
    },
  },
});

export default api;

在这个例子中，我们添加了一个名为logRequest的中间件，它在每个请求被处理前打印一条日志信息。

错误处理：确保API的稳定性和用户体验

良好的错误处理是API开发中不可或缺的一部分。TRPC提供了灵活的错误处理机制。例如，我们可以为查询方法添加错误处理：

import { createTRPCInferServer } from '@trpc/server';
import { createHttpError } from '@trpc/server';

const api = createTRPCInferServer({
  router: {
    greeting: {
      query: () => 'Hello from API',
      async transformError({ error }) {
        if (error.type === 'http') {
          return createHttpError(error.statusCode, error.message);
        }
        return error;
      },
    },
  },
});

export default api;

通过transformError方法，我们可以自定义特定错误类型的响应，例如HTTP错误。

实践案例：构建一个完整的RESTful API

构建一个完整的RESTful API，结合前面所学的每个特性，我们可以创建一个简单的博客API。此API将包含用户认证、文章列表和单篇文章详情等功能。

首先，我们将定义API服务器：

import { createTRPCInferServer } from '@trpc/server';
import { z } from 'zod';

const api = createTRPCInferServer({
  router: {
    user: {
      login: {
        input: z.object({
          username: z.string(),
          password: z.string(),
        }),
        async resolve({ ctx }) {
          // 实现用户登录逻辑
          return {
            token: 'generated-token',
          };
        },
      },
    },
    article: {
      list: {
        query: async () => {
          // 实现获取文章列表逻辑
          return [];
        },
      },
      detail: z.object({
        id: z.number(),
      }).transform(({ id }) => ({
        query: async (id) => {
          // 实现获取单篇文章逻辑
          return {
            title: 'Sample Title',
            content: 'Sample Content',
          };
        },
      }),
    },
  },
});

export default api;

接着，我们将创建客户端：

import { createTRPCClient } from '@trpc/client';
import { z } from 'zod';

const client = createTRPCClient({
  url: 'http://localhost:3000/api',
});

async function login(username: string, password: string) {
  const { token } = await client.user.login.input({ username, password });
  // 使用token进行后续请求
}

async function fetchArticle(id: number) {
  const { data } = await client.article.detail.query(id);
  console.log(data);
}

fetchArticle(1);

通过这个案例，我们综合应用了TRPC的基本使用、中间件、错误处理和客户端功能，构建了一个完整的RESTful API。通过实践，你可以进一步探索TRPC的更多特性，以满足更复杂的应用场景需求。