快捷導(dǎo)航

TypeScript中如何實(shí)現(xiàn)類型安全的路由系統(tǒng)

更新時(shí)間：2025年10月25日 14:51:14 作者：代碼保安

本文講述TypeScript如何實(shí)現(xiàn)類型安全的路由系統(tǒng),路由類型結(jié)構(gòu)、使用infer和Extract提取參數(shù)類型、定義路由配置類型、創(chuàng)建路由表、實(shí)現(xiàn)類型安全的導(dǎo)航和位置鉤子等,使用React?Router?v6或Next.js?App?Router,結(jié)合zod進(jìn)行查詢參數(shù)驗(yàn)證,以實(shí)現(xiàn)類型安全的路由系統(tǒng)

在 TypeScript 中實(shí)現(xiàn)一個(gè)類型安全的路由系統(tǒng)，可以通過 類型推導(dǎo) 和 類型約束 來確保路由路徑、參數(shù)、查詢參數(shù)和組件類型之間的強(qiáng)一致性。以下是實(shí)現(xiàn)一個(gè)類型安全路由系統(tǒng)的完整方案：

目標(biāo)

路由路徑類型安全（路徑錯(cuò)誤編譯時(shí)報(bào)錯(cuò)）
路由參數(shù)類型安全（路徑參數(shù)類型正確）
查詢參數(shù)類型安全（查詢參數(shù)類型正確）
路由組件類型安全（路由組件類型正確）
支持嵌套路由

1. 定義路由類型結(jié)構(gòu)

我們使用一個(gè) RouteConfig 類型來定義路由結(jié)構(gòu)，支持嵌套和參數(shù)。

type RouteConfig<T extends string> = {
  path: T;
  component: React.ComponentType<any>;
  children?: RouteConfig<any>[];
  params?: Record<string, string>; // 可選參數(shù)類型
  query?: Record<string, string>; // 查詢參數(shù)類型
};

但更推薦使用 泛型 + 映射類型 來實(shí)現(xiàn)類型安全。

2. 使用infer和Extract實(shí)現(xiàn)路徑參數(shù)類型推導(dǎo)

我們使用 infer 來從路徑字符串中提取參數(shù)類型。

// 從路徑字符串中提取參數(shù)類型
type PathParams<T extends string> = T extends `${infer P}/${infer R}`
  ? P extends `:${infer Param}`
    ? { [K in Param]: string } & PathParams<R>
    : PathParams<R>
  : {};

示例：

type P1 = PathParams<'users/:id'>; // { id: string }
type P2 = PathParams<'users/:id/posts/:postId'>; // { id: string; postId: string }

3. 定義路由配置類型（支持嵌套）

type Route<T extends string> = {
  path: T;
  component: React.ComponentType<any>;
  children?: Route<T>[];
  params?: PathParams<T>; // 參數(shù)類型
  query?: Record<string, string>; // 查詢參數(shù)類型
};

4. 創(chuàng)建路由表（類型安全）

const routes = {
  home: {
    path: '/',
    component: Home,
  },
  users: {
    path: '/users',
    component: Users,
    children: [
      {
        path: '/users/:id',
        component: UserDetail,
        params: { id: 'string' },
      },
      {
        path: '/users/:id/posts/:postId',
        component: PostDetail,
        params: { id: 'string', postId: 'string' },
      },
    ],
  },
} as const;

使用 as const 強(qiáng)制類型推導(dǎo)為字面量類型，防止類型丟失。

5. 實(shí)現(xiàn)類型安全的useNavigate和useLocation

useNavigate類型安全

type NavigateOptions<T extends string> = {
  to: T;
  query?: Record<string, string>;
};

function useNavigate() {
  const navigate = useNavigate(); // 假設(shè)使用 React Router v6

  return <T extends string>(options: NavigateOptions<T>) => {
    const { to, query } = options;
    const search = query ? new URLSearchParams(query).toString() : '';
    navigate(`${to}${search ? `?${search}` : ''}`);
  };
}

useLocation類型安全

function useLocation<T extends string>() {
  const location = useLocation();
  const path = location.pathname as T;

  // 提取路徑參數(shù)
  const params = path.split('/').reduce((acc, segment, index, arr) => {
    if (segment.startsWith(':')) {
      const key = segment.slice(1);
      const value = arr[index + 1];
      return { ...acc, [key]: value };
    }
    return acc;
  }, {} as Record<string, string>);

  // 查詢參數(shù)
  const searchParams = new URLSearchParams(location.search);
  const query = {} as Record<string, string>;
  searchParams.forEach((value, key) => {
    query[key] = value;
  });

  return { path, params, query };
}

6. 使用useNavigate和useLocation的示例

function UserDetail() {
  const { params, query } = useLocation<'/users/:id'>();

  const navigate = useNavigate();

  return (
    <div>
      User: {params.id}
      <button onClick={() => navigate({ to: '/users', query: { page: '2' } })}>
        Go to Users
      </button>
    </div>
  );
}

7. 類型安全的Link組件

type LinkProps<T extends string> = {
  to: T;
  query?: Record<string, string>;
  children: React.ReactNode;
};

function Link<T extends string>({ to, query, children }: LinkProps<T>) {
  const navigate = useNavigate();

  return (
    <button onClick={() => navigate({ to, query })}>
      {children}
    </button>
  );
}

8. 使用React Router的類型安全封裝

如果你使用 react-router-dom，可以使用 useParams 和 useSearchParams 并結(jié)合類型推導(dǎo)。

function UserDetail() {
  const { id } = useParams<{ id: string }>();
  const [searchParams] = useSearchParams();

  const postId = searchParams.get('postId');

  return <div>User {id} Post {postId}</div>;
}

useParams 和 useSearchParams 本身支持類型推導(dǎo)，但需要手動(dòng)指定類型。

9. 高級(jí)：使用zod+TypeScript實(shí)現(xiàn)查詢參數(shù)驗(yàn)證

import { z } from 'zod';

const UserQuerySchema = z.object({
  page: z.string().optional(),
  limit: z.string().optional(),
});

type UserQuery = z.infer<typeof UserQuerySchema>;

然后在 useLocation 中使用：

const query = UserQuerySchema.parse(Object.fromEntries(searchParams));

10. 總結(jié)：類型安全路由系統(tǒng)的關(guān)鍵點(diǎn)

功能	實(shí)現(xiàn)方式
路徑類型安全	使用 `infer` 提取路徑參數(shù)
參數(shù)類型安全	`params` 字段顯式定義類型
查詢參數(shù)類型安全	`query` 字段定義類型，配合 `zod` 驗(yàn)證
組件類型安全	`component` 類型為 `React.ComponentType<any>`
路由跳轉(zhuǎn)安全	`useNavigate` 類型約束 `to` 路徑
嵌套路由	使用 `children` 字段遞歸定義

最終建議

使用 React Router v6 或 Next.js App Router（推薦）
使用 zod 驗(yàn)證查詢參數(shù)
使用 as const 固定路由配置類型
使用 infer 提取路徑參數(shù)類型
使用 useNavigate 和 useLocation 封裝類型安全接口

示例項(xiàng)目結(jié)構(gòu)

src/
  routes/
    index.ts
    user.ts
  components/
    Home.tsx
    UserDetail.tsx
  hooks/
    useNavigate.ts
    useLocation.ts

通過以上方式，你可以構(gòu)建一個(gè) 完全類型安全 的路由系統(tǒng)，避免運(yùn)行時(shí)錯(cuò)誤，提升開發(fā)體驗(yàn)。

到此這篇關(guān)于TypeScript中如何實(shí)現(xiàn)類型安全的路由系統(tǒng)的文章就介紹到這了,更多相關(guān)TypeScript實(shí)現(xiàn)路由系統(tǒng)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: