JS注解指在JavaScript中通过特定注释或对象结构标注路由元信息，如@route定义路径，@param声明参数类型与规则，供Objective-C端解析并自动映射到原生页面跳转与属性赋值，提升混合开发效率。
在使用 JavaScript 与原生 iOS（Objective-C）进行交互时，特别是在混合开发框架（如 JSPatch、React Native 或自定义 WebView 桥接方案）中，常需要通过 URL 路由机制跳转页面并传递参数。为了使 Objective-C 端能够正确解析路由和参数，可以通过 JS 注解的方式对路由信息进行标注，帮助原生层识别路径、参数类型及处理方式。
什么是 JS 注解标注路由参数
“JS 注解”并非 JavaScript 原生语法中的概念，而是指在 JS 中以特定格式的注释或对象结构来描述路由元信息（如路径、参数、类型等），供工具或原生代码解析使用。这类注解主要用于配合 OC（Objective-C）端的路由注册系统，实现自动化的页面跳转与参数映射。
例如，在调用一个跳转函数前，通过注释或配置对象声明该路由所需的参数名、是否必传、数据类型等，OC 层可通过正则匹配或 JSON 解析读取这些信息，动态构建目标视图控制器并传参。
常见的 JS 注解写法示例
以下是一种常见的模拟“注解”写法，用于标注路由及其参数：
/**
* @route /user/detail
* @param id string 必填 用户唯一标识
* @param name string 可选 用户姓名
* @param age number 可选 用户年龄
*/
function openUserDetail() {
window.location.href = 'app://user/detail?id=123&name=John&age=25';
}
或者使用对象形式描述：
const routeConfig = {
path: '/order/confirm',
params: {
orderId: { type: 'string', required: true, desc: '订单ID' },
amount: { type: 'number', required: false, desc: '金额' }
}
};
<p>function gotoOrderConfirm() {
const url = <code>app://order/confirm?orderId=ORD123456&amount=99.5</code>;
bridge.navigate(url);
}</p>Objective-C 端如何解析路由参数
在 OC 端，通常会有一个路由管理器（URL Router）负责拦截和处理来自 JS 的跳转请求。它可以基于预注册的路由表查找对应类，并根据参数名自动赋值。
示例代码如下：
// ZJRouter.h
+ (void)registerRoute:(NSString *)route pattern:(Class)cls;
<p>// ZJRouter.m</p><ul><li><p>(void)open:(NSString <em>)url {
NSURL </em>nsUrl = [NSURL URLWithString:url];
NSString <em>path = nsUrl.host;
NSDictionary </em>params = [self parseQueryParams:nsUrl.query];</p><p>Class vcClass = [self.routeMap objectForKey:path];
if (vcClass) {
UIViewController *vc = [[vcClass alloc] init];
[self bindProperties:vc withParams:params];
[[UIApplication sharedApplication].keyWindow.rootViewController presentViewController:vc animated:YES completion:nil];
}
}</p></li><li><p>(void)bindProperties:(id)obj withParams:(NSDictionary <em>)params {
[params enumerateKeysAndObjectsUsingBlock:^(id key, id value, BOOL </em>stop) {
SEL setter = NSSelectorFromString([NSString stringWithFormat:@"set%@:", [[key capitalizedString] stringByAppendingString:@""]]);
if ([obj respondsToSelector:setter]) {
[obj performSelector:setter withObject:value];
}
}];
}</p>这样，只要 JS 发起的 URL 包含参数，OC 层就能自动将 id、name 等字段设置到目标 VC 的属性上。
实际应用场景建议
在团队协作或大型项目中，推荐统一规范 JS 路由注解格式，便于生成文档或自动化注册。可结合构建脚本扫描 JS 文件中的 @route 注解，自动生成 OC 路由注册代码或 TypeScript 接口定义。
几点建议：
- 统一使用 @route 标记路径，@param 描述每个参数（名称、类型、是否必填、说明）
- 避免在 URL 中传递敏感信息，参数应做编码处理
- OC 端应对关键参数做类型校验和容错处理，防止崩溃
- 支持默认值机制，提升调用灵活性
基本上就这些。虽然 JavaScript 没有真正的注解机制，但通过约定注释格式 + 原生解析逻辑，完全可以实现类似“注解驱动”的路由传参模式，提高混合开发效率。
