它是基于 go_router 封装的。代表着你拥有官方路由的所有功能比较丰富，但用法简化了 倍！😍 告别手写字符串跳转，从此爱上写路由！

✨ 为什么选它？

• 🗝️ 嵌套路由不迷路只要告诉路由 “我爸是谁”，自动给你安排得明明白白！话说回来，
• 📐 类型安全太香了UserRoute.teleport再也不用担心拼错字符串导致崩溃。
• 🐚 底部导航栏工具注解配置 BottomNav，几行代码搞定复杂嵌套！
• 🛡️ 守卫鉴权类型安全的路由守卫。未登录自动跳走，甚至还能监听登录状态自动刷新！其实，
• 🧩 智能代码生成参数、返回值、Deep Link 全部自动搞定。让你不必在文件里手工维护方法。

🧩 主要原理大揭秘

痛点一：手动维护路由表耗时且易出错。

. 黄金三角

• Routes : 你的页面配置图纸。
• Generator: 搬砖工，把你写的注解变成代码。
• Router : 大管家，底层指挥 go_router 干活。

. TeleportNavKey：真正的幕后大佬

痛点二：自定义导航栈管理繁琐，需要频繁手动 pop / push 操作。

class MainKey extends TeleportNavKey { …}

. 智能观察者

• `popUntil`
• `removeWhere`
• `popToInitial`

📦 安装

在pubspec.yaml<\/code> 里加上：

dependencies:
teleport_router: ^0.x.x
teleport_router_annotation: ^0.x.x
dev_dependencies:
build_runner: ^0.x.x
teleport_router_generator: ^0.x.x
<\/code>

运行小助手这方面，

dart run build_runner build
<\/code>

🚀 快速上手详细教程

. Define NavKeys

新建文件lib/routes/nav_keys.dart<\/code> ：

// 主 Shell 的钥匙
class MainNavKey extends TeleportNavKey {
const MainNavKey : super;}
// 首页的钥匙
class HomeNavKey extends TeleportNavKey {
const HomeNavKey : super;}
<\/code>

. Define Shells

给你的主页面加上注解，它是容器！

@TeleportShellRoute(
navigatorKey: MainNavKey。// <--认领钥匙
  isIndexedStack: true,
  // 开启状态保持 
  branchKeys:,
  // <-- 定义分支)
class MainShellPage extends StatelessWidget {
  final TeleportStatefulNavigationShell navigationShell;
  // 拿到控制器
  …
}
<\/code>

. Define Routes

给页面加注解，想嵌套就认爹！

// 首页，认 HomeNavKey 当爹，自动放进 Branch
@TeleportRoute(
再看path，'/home'。isInitial:true,parentNavigatorKey:Homenavkey )
class HomePage extends StatelessWidget{…}
//详情页，没有爹，就是顶层页面
@TeleportRoute
class DetailPage extends StatelessWidget{…}
<\/code>

. Initialize

void main{
final router = TeleportRouter(
从routes来看，,// 已生成代码
);runApp)，}
​ ​ ​ ​ ​
​
​
​
​
​
​
​
​​
​​
​
​
​
​
​


​





plaintext



Note: Replace placeholders like yourBranch and add your actual route definitions in teleportRoutes.


🧭 导航操作，丝滑！

类型安全跳转 



// 等待返回值
final result = await SelectRoute.teleport;

// 替换当前页
LoginRoute.teleport;



栈操作