注解RequestMapping中的URI路径最前面到底需不需要加斜线?
您有没有这样的困惑:在协同开发过程中,使用RequestMapping,或者是GetMapping,或者是PostMapping这类注解时,有的程序员加了斜线,有的程序员没有加斜线,实际好像都能访问到,那么到底需不需要加呢?
举例
以上路径写法都是可以访问的
加不加都可以访问,从这一点可以推断出结论:RequestMapping最前面的斜线可加可不加(这里只是说最前面,如果是/a/b/c中间的斜线分隔符是一定要加的)
所谓知其然,一定要知其所以然,为什么可以加,也可以不加呢?Spring框架一定是做了什么处理,那么框架是怎么处理的呢?
这里,就用这个TestController测试控制器,路径/test/testPath来扒一扒源码,一窥裙底,满足一下好奇心
思路:我们可以访问/test/testPath这个路径,服务端根据这个路径提供相应的服务,那么第一,服务端已经准备好了这个路径等着客户端来调用;第二,当客户端访问这个路径时,服务端要去找到这个路径对应的服务。
第一:web容器启动的时候,(org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping)会扫描Controller注解找到所有的Handler(这里把处理器就称为Handler,等会儿好理解)类,拿到所有的Handler类之后,会遍历这些Handler类,并且遍历这个Handler类中所有带RequestMapping的方法,同时把类和方法的路径拼起来(框架叫做combine,联结在一起,注意:Handler类可以不要RequestMapping),在这个过程中,会判断路径的最前面是否有斜线(/),如果没有,会拼一个斜线(/),所以这就是为什么不加可以
以下简单的写出相关的类和方法,简单的说明以下调用时序,当然不够规范,如果要来真的,应该画个时序图
扫描Handler调用时序
1,org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping afterPropertiesSet2,org.springframework.web.servlet.handler.AbstractHandlerMethodMapping afterPropertiesSet initHandlerMethods detectHandlerMethods(到这个地方,循环发现所有Handler,以下为找到具体的URL,并处理为规范的URL) getMappingForMethod3,org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping getMappingForMethod createRequestMappingInfo combine4,org.springframework.web.servlet.mvc.method.RequestMappingInfo RequestMappingInfo.Builder build PatternsRequestCondition5,org.springframework.web.servlet.mvc.condition.PatternsRequestCondition prependLeadingSlash
接下来,调皮的人来了,不加斜线,框架会帮我拼一个斜线,相当于加了斜线,那么我加很多很多斜线呢,比如说(斜线斜线斜线testPath)(这里打斜线符号会被转义,所以用中文),这样可以吗?
像上图这样,也是可以访问的,这是为什么呢?要解答这个问题,就要看客户端访问服务端时,服务端是怎么找相应的Handler的
第二:客户端(注意:框架会将客户端的URI处理成标准格式,即/test/testPath,不管是浏览器地址栏上的URI,还是使用HttpClient刻意加上很多斜线,最终服务端要处理的URI都会是/test/testPath)在访问服务端时,服务端的org.springframework.web.servlet.DispatcherServlet会拿到本次请求的request,根据请求的路径找到已经准备好的Handler,而在找Handler的时候会匹配路径,匹配路径的时候,会把路径按斜线分割后匹配,///test///testPath和/test/testPath按斜线分割后都是{“test”,“testPath”},所以,你加了多个斜线没关系,效果一样(注:Spring框架是用的java.util.StringTokenizer工具类来分割URI的,StringTokenizer stringTokenizer = new StringTokenizer("//testtestPath", “/”))
框架处理客户端的URI
框架匹配客户端和服务端的URI
分割后匹配URI
查找Handler调用时序
查找Handler调用时序
1,org.springframework.web.servlet.DispatcherServlet doService doDispatch getHandler2,org.springframework.web.servlet.HandlerMapping getHandler3,org.springframework.web.servlet.handler.AbstractHandlerMapping getHandler getHandlerInternal(到这个地方,已经发现所有的Handler)4,org.springframework.web.servlet.handler.AbstractHandlerMethodMapping getHandlerInternal lookupHandlerMethod addMatchingMappings getMatchingMapping5,org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping getMatchingMapping getMatchingCondition6,org.springframework.web.servlet.mvc.method.RequestMappingInfo getMatchingCondition getMatchingCondition7,org.springframework.web.servlet.mvc.condition.PatternsRequestCondition getMatchingCondition getMatchingPatterns getMatchingPattern this.pathMatcher.match8,org.springframework.util.AntPathMatcher match doMatch tokenizePattern(该部分为工具类,只用于处理并规范URL)