tRPC ベストプラクティス

あなたは tRPC v11、TypeScript、Next.js 開発の専門家です。tRPC はエンドツーエンドのタイプセーフな API を実現し、スキーマ、コード生成、ランタイムエラーなしで API を構築・利用できます。

要件

• TypeScript >= 5.7.2
• 厳密な TypeScript モード有効化

プロジェクト構造

src/
  pages/
    _app.tsx              # createTRPCNext setup
    api/
      trpc/
        [trpc].ts         # tRPC HTTP handler
  server/
    routers/
      _app.ts             # Main router
      [feature].ts        # Feature-specific routers
    context.ts            # App context
    trpc.ts               # Procedure helpers
  utils/
    trpc.ts               # Typesafe React hooks

サーバーサイドセットアップ

tRPC バックエンドの初期化

アプリケーション単位で tRPC バックエンドを初期化します。再利用可能なルーターと手続きヘルパーをエクスポートします：

// server/trpc.ts
import { initTRPC } from '@trpc/server';
import superjson from 'superjson';

const t = initTRPC.context<Context>().create({
  transformer: superjson,
});

export const router = t.router;
export const publicProcedure = t.procedure;
export const protectedProcedure = t.procedure.use(isAuthed);
export const adminProcedure = t.procedure.use(isAdmin);

フィーチャールーターの作成

ルーターをフィーチャー/ドメイン単位で整理します。入力検証には Zod を使用します：

// server/routers/user.ts
import { z } from 'zod';
import { router, publicProcedure, protectedProcedure } from '../trpc';

export const userRouter = router({
  getById: publicProcedure
    .input(z.object({ id: z.string() }))
    .query(async ({ input, ctx }) => {
      return ctx.db.user.findUnique({ where: { id: input.id } });
    }),

  update: protectedProcedure
    .input(z.object({
      name: z.string().min(1),
      email: z.string().email(),
    }))
    .mutation(async ({ input, ctx }) => {
      return ctx.db.user.update({
        where: { id: ctx.user.id },
        data: input,
      });
    }),
});

メインアプリケーションルーター

// server/routers/_app.ts
import { router } from '../trpc';
import { userRouter } from './user';
import { postRouter } from './post';

export const appRouter = router({
  user: userRouter,
  post: postRouter,
});

export type AppRouter = typeof appRouter;

クライアントサイドセットアップ

tRPC クライアントの設定

// utils/trpc.ts
import { httpBatchLink } from '@trpc/client';
import { createTRPCNext } from '@trpc/next';
import superjson from 'superjson';
import type { AppRouter } from '../server/routers/_app';

function getBaseUrl() {
  if (typeof window !== 'undefined') return '';
  if (process.env.VERCEL_URL) return `https://${process.env.VERCEL_URL}`;
  return `http://localhost:${process.env.PORT ?? 3000}`;
}

export const trpc = createTRPCNext<AppRouter>({
  config() {
    return {
      transformer: superjson,
      links: [
        httpBatchLink({
          url: `${getBaseUrl()}/api/trpc`,
          maxURLLength: 2083,
        }),
      ],
    };
  },
  ssr: false,
});

主要なベストプラクティス

1. 入力検証

すべての手続きの入力に対して常に Zod を使用しタイプセーフティとランタイム検証を実現します：

.input(z.object({
  email: z.string().email(),
  age: z.number().min(0).max(120),
}))

2. ルーター整理

1 つのモノリシックなルーターではなく、フィーチャー/ドメイン単位でルーターを構造化します。各フィーチャーは独自のルーターファイルを持つべきです。

3. ミドルウェア実装

認証、ロギング、横断的関心事についてミドルウェアを実装します：

const isAuthed = t.middleware(({ ctx, next }) => {
  if (!ctx.user) {
    throw new TRPCError({ code: 'UNAUTHORIZED' });
  }
  return next({ ctx: { user: ctx.user } });
});

4. エラーハンドリング

一貫した有益なエラーレスポンスのために TRPCError を使用します：

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

throw new TRPCError({
  code: 'NOT_FOUND',
  message: 'User not found',
});

5. データトランスフォーマー

SuperJSON を適用して Date、Map、Set およびその他の JavaScript 型の自動シリアライゼーションを実現します：

import superjson from 'superjson';

const t = initTRPC.create({
  transformer: superjson,
});

6. React Query 統合

データフェッチング、ミューテーション、キャッシングのために tRPC の組み込み React Query ユーティリティを活用します：

// Queries
const { data, isLoading } = trpc.user.getById.useQuery({ id: '123' });

// Mutations
const mutation = trpc.user.update.useMutation({
  onSuccess: () => {
    utils.user.getById.invalidate();
  },
});

// Prefetching
await utils.user.getById.prefetch({ id: '123' });

7. コンテキスト作成

コンテキスト経由で手続き全体にリソース（データベース接続、ユーザーセッション）を共有します：

// server/context.ts
export async function createContext({ req, res }: CreateNextContextOptions) {
  const user = await getUser(req);
  return {
    db: prisma,
    user,
    req,
    res,
  };
}

export type Context = Awaited<ReturnType<typeof createContext>>;

8. 型のエクスポート

ルーター実装ではなく、型シグネチャのみをクライアントコードにエクスポートします：

// Only export the type
export type AppRouter = typeof appRouter;

// Never export the actual router to client code

9. 認可レベル

異なる認可レベルのために個別の手続きタイプを作成します：

export const publicProcedure = t.procedure;
export const protectedProcedure = t.procedure.use(isAuthed);
export const adminProcedure = t.procedure.use(isAuthed).use(isAdmin);

10. パフォーマンス最適化

• httpBatchLink でリクエストバッチングを有効化
• URL 長の問題を防ぐために maxURLLength を設定
• 静的/予測可能なデータのプリフェッチを実装
• React Query のキャッシング戦略を使用

避けるべきアンチパターン

• any 型を使用しないこと - tRPC の完全な型推論を活用する
• 入力検証をスキップしないこと
• 内部エラーをクライアントに公開しないこと
• サーバーとクライアントのコードを混在させないこと
• 過度に大きなルーターを作成しないこと - フィーチャー単位で分割する