AnalogJS 项目中如何实现 Monorepo 架构下的路由共享方案

在基于 AnalogJS 框架的 Monorepo 项目中，开发者经常面临一个挑战：如何在多个应用间共享页面路由配置。本文将深入探讨这一问题的解决方案，并介绍 AnalogJS 框架对此提供的支持。

核心问题分析

在传统的单仓库多应用(Monorepo)架构中，特别是使用 NX 等工具时，通常会遇到以下情况：

1. 多个应用作为"外壳"存在，实际业务逻辑和页面组件位于共享库中
2. 路由配置需要跨应用共享，但默认情况下 AnalogJS 的路由器只监控应用目录下的页面
3. 需要统一管理 API 路由和 tRPC 路由配置

解决方案演进

初始方案：自定义路由提供器

最初开发者尝试通过创建自定义路由提供器来解决这个问题。这需要访问框架内部的一些功能，如：

• createRoutes：用于从文件对象创建路由配置
• updateMetaTagsOnRouteChange：用于处理路由变更时的元标签更新

虽然这种方法可行，但它依赖于框架内部实现，不够优雅且可能带来维护问题。

改进方案：利用 Angular 的 ROUTES 多令牌

更优雅的解决方案是利用 Angular 提供的 ROUTES 多令牌特性。这种方案的优势在于：

1. 完全基于 Angular 官方机制，无需依赖框架内部实现
2. 可以灵活组合多个来源的路由配置
3. 保持代码的整洁性和可维护性

实现方式如下：

export const appConfig: ApplicationConfig = {
  providers: [
    { provide: ROUTES, useValue: customRoutes, multi: true },
    provideFileRouter(withNavigationErrorHandler(console.error)),
    provideHttpClient(withFetch()),
    provideClientHydration(),
  ],
};

完整实现方案

页面路由共享

1. 在共享库中导出页面路由配置：

const pagesRaw = import.meta.glob<RouteExport>(['./pages/**/*.page.ts']);
export const mPages = prepareRouteFileObject(pagesRaw);

2. 在应用中合并路由：

import { mPages as mPagesA } from '@modules/mod-a';
import { mPages as mPagesB } from '@modules/mod-b';
export const PAGE_ROUTES = mergePageRoutes(mPagesA, mPagesB);

3. 创建并注册路由：

const customRoutes = createRoutes(PAGE_ROUTES);
{ provide: ROUTES, useValue: customRoutes, multi: true }

API 路由处理

对于 Nitro 的 API 路由，需要通过修改 Vite 配置来实现：

analog({
  nitro: {
    scanDirs: [...API_ROUTES, normalizePath(`${__dirname}/src/server`)],
    rollupConfig: {
      plugins: [typescriptPaths({ tsConfigPath: 'tsconfig.base.json' })]
    }
  }
})

tRPC 路由整合

1. 在各模块中定义子路由：

export const noteRouter = router({
  // ...路由定义
});

2. 导出模块级路由：

export const mTRPCRouter = router({
  note: noteRouter,
});

3. 在应用中合并所有 tRPC 路由：

export const TRPC_ROUTER = combineRouters([mA_TRPCRouter, mB_TRPCRouter]);

框架支持改进

AnalogJS 框架在 0.2.44 版本中增加了对 Monorepo 路由共享的官方支持，主要包括：

1. 导出 createRoutes 方法，允许从文件对象创建路由
2. 公开 Files 和 RouteExport 类型，便于类型安全地传递路由配置
3. 优化了路由元标签更新的实现方式

最佳实践建议

1. 路由配置应该尽可能靠近业务模块，而不是应用外壳
2. 对于大型项目，考虑将路由配置工具函数封装为共享库
3. 注意区分客户端和服务端环境下的路由处理
4. 保持路由配置的强类型，充分利用 TypeScript 的类型系统

通过这套方案，开发者可以在 AnalogJS 项目中实现优雅的跨应用路由共享，同时保持代码的整洁性和可维护性。这种架构特别适合中大型项目，能够显著提高代码复用率并降低维护成本。