BlackSheep框架中如何跟踪请求匹配的路由模式

在开发基于BlackSheep框架的Web应用时，我们经常需要记录请求的访问路径用于监控和日志分析。然而直接使用请求的URL路径可能会带来基数过高的问题，特别是当路径中包含动态参数时。本文将介绍如何在BlackSheep中优雅地获取和记录请求匹配的原始路由模式。

问题背景

在Web应用中，我们通常会定义路由模板如/get/:id，但实际请求的URL可能是/get/123、/get/456等。如果直接将请求URL记录到监控系统，会导致指标基数过高，影响系统性能。理想情况下，我们应该记录原始的路由模板/get/:id。

解决方案

BlackSheep框架提供了几种方法来解决这个问题：

方法一：包装路由匹配方法

我们可以通过包装路由器的get_match方法来记录匹配的路由模式：

def wrap_get_route_match(fn):
    @wraps(fn)
    def get_route_match(request):
        match = fn(request)
        request.route = match.pattern.decode() if match else "Not Found"
        return match
    return get_route_match

app.router.get_match = wrap_get_route_match(app.router.get_match)

这种方法简单直接，但修改了原始方法的行为。

方法二：自定义路由器类

更优雅的方式是创建自定义路由器类：

from blacksheep import Application, Router
from blacksheep.messages import Request
from blacksheep.server.routing import RouteMatch

class TrackingRouter(Router):
    def get_match(self, request: Request) -> RouteMatch | None:
        match = super().get_match(request)
        request.route = match.pattern.decode() if match else "Not Found"
        return match

app = Application(router=TrackingRouter())

这种方式更加面向对象，也更容易维护。

方法三：使用WeakKeyDictionary存储路由信息

如果不希望直接修改request对象，可以使用WeakKeyDictionary来存储路由信息：

import weakref
requests_routes = weakref.WeakKeyDictionary()

class TrackingRouter(Router):
    def get_match(self, request: Request) -> RouteMatch | None:
        match = super().get_match(request)
        requests_routes[request] = match.pattern.decode() if match else "Not Found"
        return match

这种方法避免了直接修改request对象，同时利用弱引用防止内存泄漏。

注意事项

1. 如果使用子路由器，需要确保所有路由器都实现了相同的跟踪逻辑
2. 在生产环境中，应该考虑性能影响，避免不必要的计算
3. 对于404等未匹配路由的情况，应该统一处理

总结

在BlackSheep框架中跟踪请求匹配的路由模式有多种实现方式，开发者可以根据项目需求选择最适合的方法。自定义路由器类是最推荐的方式，它既保持了代码的整洁性，又提供了足够的灵活性。无论选择哪种方法，都能有效解决监控指标基数过高的问题，提升系统的可观测性。