DRF-Nested-Routers 项目中的路由嵌套与正则路径问题解析

在 Django REST framework (DRF) 生态系统中，drf-nested-routers 是一个常用的扩展库，用于处理嵌套路由的场景。随着 DRF 3.15 版本的发布，引入了一个重要的路由配置选项 use_regex_path，这给嵌套路由的实现带来了一些兼容性问题。

问题背景

在 DRF 3.15 中，SimpleRouter 新增了 use_regex_path 参数，当设置为 False 时，路由器会去除路由模式中的正则表达式字符（^ 和 $），转而使用 Django 的 path() 函数而非 re_path() 函数。这一变化旨在提供更简洁的路由配置方式。

然而，drf-nested-routers 中的 NestedSimpleRouter 在处理嵌套路由时，默认假设路由模式始终包含正则表达式字符 ^，并基于此假设进行父路由前缀的拼接。当 use_regex_path=False 时，这种假设不再成立，导致父路由前缀无法正确预置到子路由上。

技术细节分析

问题的核心在于 NestedMixin 类中的路由处理逻辑。在原始实现中，它直接对路由 URL 进行字符串替换操作：

route_contents['url'] = route.url.replace('^', '^' + escaped_parent_regex)

当 use_regex_path=False 时，route.url 已经移除了 ^ 字符，导致替换操作失效，最终生成的嵌套路由缺少父路由前缀。

解决方案

针对这一问题，社区贡献者提出了一个优雅的解决方案：在 NestedMixin 中同样引入 use_regex_path 参数，并根据其值采用不同的路由拼接策略：

1. 当 use_regex_path=True 时，保持原有的正则表达式替换逻辑
2. 当 use_regex_path=False 时，直接拼接父路由前缀和子路由路径

修改后的核心代码如下：

if self.use_regex_path:
    route_contents['url'] = route.url.replace('^', '^' + escaped_parent_regex)
else:
    route_contents['url'] = escaped_parent_regex + route_contents['url']

实际应用示例

在实际项目中，我们可以这样配置嵌套路由：

router = SimpleRouter(use_regex_path=False)
router.register(r'domains', DomainViewSet)

domains_router = NestedSimpleRouter(
    router, 
    r'domains', 
    lookup='domain', 
    use_regex_path=False
)
domains_router.register(r'nameservers', NameserverViewSet)

这种配置方式既保持了与 DRF 3.15 新特性的兼容性，又能正确生成嵌套路由路径。

总结

drf-nested-routers 0.94.2 版本已经包含了这一修复，使得开发者可以在使用 DRF 3.15+ 时，灵活选择是否使用正则表达式路径。这一改进体现了开源社区对框架兼容性的重视，也为开发者提供了更一致的路由配置体验。

对于正在使用或计划升级到 DRF 3.15 的开发者，建议更新到 drf-nested-routers 的最新版本，以确保嵌套路由功能正常工作。同时，这也提醒我们在使用第三方扩展时，需要注意其与核心框架版本之间的兼容性问题。