ServiceComb Java Chassis 通配符路径匹配问题解析

背景介绍

在基于Spring Boot和ServiceComb Java Chassis的微服务开发中，开发者经常会遇到路径匹配的需求。Spring Boot原生支持使用**通配符来匹配多级路径，例如/symbol/**可以匹配/symbol/test和/symbol/test/test1等多级路径请求。然而，ServiceComb Java Chassis默认并不支持这种通配符写法，这给开发者带来了一定的困扰。

问题根源分析

ServiceComb Java Chassis内部使用org.apache.servicecomb.common.rest.definition.path.PathRegExp来处理路径匹配，该组件会将路径模式编译为正则表达式。而**这种写法在正则表达式中是无效的，因此会导致编译错误。

解决方案

经过社区讨论和验证，ServiceComb Java Chassis提供了替代方案来实现类似的功能：

1. 使用正则表达式路径变量：

@RequestMapping(path = {"/{path:.+}"}, produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<byte[]> catchAll(@PathVariable String path, HttpServletRequest request) {
    System.out.println(path);
}

2. 端口配置注意事项：
   • 当server.port与servicecomb.rest.address端口不一致时，可能会出现单级路径匹配成功但多级路径匹配失败的情况
   • 建议保持两个端口配置一致，或者确保请求发送到正确的服务端口

技术实现细节

ServiceComb Java Chassis支持两种运行模式：

1. Servlet容器模式：使用Spring Boot内嵌的Servlet容器
2. Vert.x容器模式：使用ServiceComb自带的Vert.x容器

在Servlet容器模式下，Spring Boot原生的路径匹配机制可以正常工作；而在Vert.x容器模式下，需要使用ServiceComb特定的路径匹配规则。

最佳实践建议

1. 对于需要匹配多级路径的场景，推荐使用/{path:.+}的正则表达式写法
2. 保持server.port和servicecomb.rest.address端口配置一致
3. 明确了解服务运行在哪种容器模式下(Servlet或Vert.x)，以便选择合适的路径匹配策略

总结

ServiceComb Java Chassis虽然不直接支持Spring Boot的**通配符写法，但通过正则表达式路径变量提供了等效的功能。开发者在使用时需要注意端口配置和容器模式的差异，以确保路径匹配功能正常工作。这一设计既保持了与Spring Boot的兼容性，又确保了ServiceComb自身路由机制的高效性。