掃二維碼與項(xiàng)目經(jīng)理溝通
我們?cè)谖⑿派?4小時(shí)期待你的聲音
解答本文疑問(wèn)/技術(shù)咨詢/運(yùn)營(yíng)咨詢/技術(shù)建議/互聯(lián)網(wǎng)交流
作者: YourBatman 2021-06-28 08:17:32
云計(jì)算 通過(guò)本文希望能讓你不再被Servlet的模式匹配所困擾,更不要被一些似可非可的結(jié)論所迷惑,搖擺不定時(shí)大不了編碼驗(yàn)證一下嘛。

成都創(chuàng)新互聯(lián)主營(yíng)富順網(wǎng)站建設(shè)的網(wǎng)絡(luò)公司,主營(yíng)網(wǎng)站建設(shè)方案,App定制開(kāi)發(fā),富順h5成都小程序開(kāi)發(fā)搭建,富順網(wǎng)站營(yíng)銷推廣歡迎富順等地區(qū)企業(yè)咨詢
本文轉(zhuǎn)載自微信公眾號(hào)「BAT的烏托邦」,作者YourBatman 。轉(zhuǎn)載本文請(qǐng)聯(lián)系BAT的烏托邦公眾號(hào)。
你好,我是YourBatman。
這次的標(biāo)題??吹得有點(diǎn)大,倍感壓力。不過(guò)沒(méi)關(guān)系,畢竟吹牛不用上睡,也不犯法。在信息大爆炸的時(shí)代,連技術(shù)圈的標(biāo)題黨也不少啦:
我標(biāo)榜自己從不標(biāo)題黨,是的這次也不例外。本文將分析/和/*的區(qū)別這個(gè)老生常談的問(wèn)題,看別的博文總是看了忘忘了看,本文不同的是,關(guān)于此問(wèn)題這一篇文章就夠了,它將成為你的永久記憶(一不小心又吹牛了??)
什么樣的答案終身難忘?學(xué)生時(shí)代關(guān)于記憶經(jīng)常能聽(tīng)見(jiàn)兩種論調(diào):
死記硬背:見(jiàn)效快,但也忘得快,且一般不會(huì)靈活運(yùn)用(指標(biāo)不治本)
理解性記憶:見(jiàn)效慢,但記憶持久且會(huì)靈活運(yùn)用(治標(biāo)又治本)
如果是你,你愿意pick哪種?
正所謂授人以魚不如授人以漁,后者方能形成永久記憶。不謀而合,本文將采用后種講述方式,幫你記憶持久化。
關(guān)于/和/*的區(qū)別這個(gè)問(wèn)題,依稀記得2015年我自學(xué)那會(huì)就能把它倆搞得明明白白,并且通過(guò)理解形成了“永久記憶”,所以至那會(huì)其就從來(lái)沒(méi)有犯過(guò)迷糊,難道我就這么重視基礎(chǔ)么(md,又在吹牛。)
如果用谷歌百度一下關(guān)鍵字:/和/*的區(qū)別,搜索出來(lái)的答案不客氣的說(shuō),基本全錯(cuò)!!! 錯(cuò)誤的姿勢(shì)基本還一模一樣,原因你懂的。
各種錯(cuò)誤case,且聽(tīng)我娓娓道來(lái)。搜集了下有如下4種主流答案,一一點(diǎn)撥。
環(huán)境說(shuō)明:使用原生Servlet,war包方式部署至外置Tomcat作為服務(wù)器,端口號(hào)8080,context-path為:appcontext
反例:
- @WebFilter(urlPatterns = {"/*"})
- public class FakeServlet extends HttpServlet {
- @Override
- protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
- System.out.println("FakeServlet收到請(qǐng)求:" + req.getRequestURI());
- }
- }
啟動(dòng)服務(wù)器,瀏覽器訪問(wèn):http://localhost:8080/appcontext/api/demo1,控制臺(tái)輸出:
- FakeServlet收到請(qǐng)求:/appcontext/api/demo1
一般來(lái)講/確實(shí)用于Servlet,/*用于Filter,但并不代表這是正確的。
說(shuō)明:Filter路徑模式使用/無(wú)效
這個(gè)結(jié)論表面上看沒(méi)有問(wèn)題,但是往深了想一步,是否能夠推導(dǎo)出這個(gè)結(jié)論:“/不會(huì)匹配.html請(qǐng)求,而/*可以匹配到.html請(qǐng)求”。試試看:
- @WebServlet(urlPatterns = {"/"})
- public class FakeServlet extends HttpServlet {
- @Override
- protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
- System.out.println("FakeServlet收到請(qǐng)求:" + req.getRequestURI());
- }
- }
- @WebFilter(urlPatterns = {"/*"})
- public class FakeFilter extends HttpFilter {
- @Override
- protected void doFilter(HttpServletRequest req, HttpServletResponse res, FilterChain chain) throws IOException, ServletException {
- System.out.println("FakeFilter收到請(qǐng)求:" + req.getRequestURI());
- super.doFilter(req, res, chain);
- }
- }
啟動(dòng)服務(wù)器,瀏覽器訪問(wèn):http://localhost:8080/appcontext/api/demo1.jsp,控制臺(tái)輸出:
- FakeFilter收到請(qǐng)求:/appcontext/api/demo1.jsp
servlet并未匹配上,似乎符合此結(jié)論:/不會(huì)匹配.jsp請(qǐng)求,而/*可以。
瀏覽器再訪問(wèn):http://localhost:8080/appcontext/api/demo1.html,控制臺(tái)輸出:
- FakeFilter收到請(qǐng)求:/appcontext/api/demo1.html
- FakeServlet收到請(qǐng)求:/appcontext/api/demo1.html
Filter和Servlet都匹配成功,破功了吧!
所以說(shuō),局限于該回答本身沒(méi)有問(wèn)題,而問(wèn)題在于.jsp后綴是一種特殊的請(qǐng)求,拿特殊案例當(dāng)做通用結(jié)論肯定是站不住腳的。
通過(guò)本文下面的講解你就會(huì)知道:/屬于最大的的匹配范圍,而/*恰好是范圍和/一樣了而已,但/*的優(yōu)先級(jí)比/高,并不是它的匹配范圍比/大。
用一句話反駁:/*也能匹配上/api/demo1.html這種后綴型url(其實(shí)上面已經(jīng)給出示例了)
這4個(gè)結(jié)論搜索排名非??壳埃恢`導(dǎo)了多少小朋友呀。與其每次將信將疑,倒不如花點(diǎn)時(shí)間寫代碼自己做個(gè)試驗(yàn)來(lái)得靠譜。我一向推崇的代碼多動(dòng)手,人云亦云不如自己來(lái)上一發(fā)。
帶著這幾個(gè)?結(jié)論,接下來(lái)開(kāi)始發(fā)大招啦:從根本上帶你理解Servlet規(guī)范的URL匹配機(jī)制,從而理解到/和/*的區(qū)別,授之以漁讓你終身難忘。
說(shuō)明:本文所指的Servlet是廣義的(規(guī)范),所以也包含F(xiàn)ilter的urlPatterns
Servlet/Filter是服務(wù)端的一段小程序,用于處理Http請(qǐng)求。每個(gè)Servlet可以映射1個(gè)or多個(gè)路徑,在xml時(shí)代這么寫(url-pattern標(biāo)簽可寫多個(gè)):
Demo1Servlet /api/demo1 /api/demo2
@WebServlet注解方式這么寫:
- @WebServlet(urlPatterns = {"/api/demo1", "/api/demo2"})
- public class Demo1Servlet extends HttpServlet { ... }
此時(shí),該Servlet就能處理這兩種 URL了。
問(wèn)題來(lái)了,如果希望本Servlet處理某一類請(qǐng)求,該怎么破呢?
一類請(qǐng)求顯然是無(wú)法一一枚舉出來(lái)的,這時(shí)就需要用到Servlet的模式匹配了。urlPatterns除了寫字面量的字符串,還支持pattern模式的字符串(從該屬性的命名你應(yīng)該也能看出來(lái))。
接下來(lái)聚焦于Servlet的匹配方式展開(kāi)詳細(xì)講解,這是本文的核心內(nèi)容。
在Servlet規(guī)范中一共約定了四種匹配方式,無(wú)一例外,每種方式都非常重要和常用,下面逐一介紹。
1. 精確匹配
顧名思義,urlPatterns是個(gè)無(wú)通配符的精確字符串,如:
- @WebServlet(urlPatterns = {"/api/demo1", "/api/demo2"}) // 精確匹配
- public class UrlPatternDemoServlet extends HttpServlet {
- @Override
- protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
- System.out.printf("收到請(qǐng)求:%s ServletPath:%s PathInfo:%s\n", req.getRequestURI(), req.getServletPath(), req.getPathInfo());
- }
- }
打印里輸出servletPath和pathInfo信息,讓日志更具對(duì)比性
瀏覽器訪問(wèn)http://localhost:8080/appcontext/api/demo1和/api/demo2均能收到該請(qǐng)求,控制臺(tái)分別打印:
- 收到請(qǐng)求:/appcontext/api/demo1 ServletPath:/api/demo1 PathInfo:null
- 收到請(qǐng)求:/appcontext/api/demo2 ServletPath:/api/demo2 PathInfo:null
2. 路徑匹配
pattern規(guī)則:以/開(kāi)頭,且以/*結(jié)尾。如:
- @WebServlet(urlPatterns = {"/api/*", "/*"}) // 路徑匹配
- public class UrlPatternDemoServlet extends HttpServlet {
- @Override
- protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
- // 同上
- }
- }
瀏覽器訪問(wèn)http://localhost:8080/appcontext/api/demo1,控制臺(tái)輸出(匹配的/api/*):
- 收到請(qǐng)求:/appcontext/api/demo1 ServletPath:/api PathInfo:/demo1
訪問(wèn)http://localhost:8080/appcontext/apiapi/demo1,控制臺(tái)輸出(匹配的/*:
- 收到請(qǐng)求:/appcontext/apiapi/demo1 ServletPath: PathInfo:/apiapi/demo1
關(guān)注點(diǎn):當(dāng)匹配上/*模式時(shí),ServletPath的值為空串,但PathInfo的值更為“豐富”了。
patten規(guī)則:以*.開(kāi)頭(注意是開(kāi)頭,所以/api/*.jsp這么寫是非法的)。如:
- @WebServlet(urlPatterns = {"*.jsp", "*.*"}) // 后綴名匹配
- public class UrlPatternDemoServlet extends HttpServlet {
- @Override
- protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
- // 同上
- }
- }
訪問(wèn)http://localhost:8080/appcontext/api/demo1,結(jié)果404,因?yàn)闆](méi)有后綴嘛;訪問(wèn)http://localhost:8080/appcontext/api/demo1.jsp,控制臺(tái)輸出(匹配*.jsp):
- 收到請(qǐng)求:/appcontext/api/demo1.jsp ServletPath:/api/demo1.jsp PathInfo:null
訪問(wèn)http://localhost:8080/appcontext/api/demo1.servlet,結(jié)果404,因?yàn)閡rlPatterns里沒(méi)有匹配.servlet后綴的模式;訪問(wèn)http://localhost:8080/appcontext/api/demo1.,結(jié)果404,原因同上 訪問(wèn)http://localhost:8080/appcontext/api/demo1.*,控制臺(tái)打印(匹配*.*):
- 收到請(qǐng)求:/appcontext/api/demo1.* ServletPath:/api/demo1.* PathInfo:null
發(fā)現(xiàn)沒(méi),這種匹配方式還蠻“特殊”的,需要注意這兩點(diǎn):
該模式以*.開(kāi)頭,后面的均是常量,即使是*也是常量。比如*.*匹配的后綴必須是.*而不能是其它
該匹配方式下,pathInfo永遠(yuǎn)是null,servletPath永遠(yuǎn)是“全部”
pattern規(guī)則:固定值/。如:
想一想,這不就是我們熟悉的DispatcherServlet的匹配路徑么?
- @WebServlet(urlPatterns = "/") // 缺省匹配
- public class UrlPatternDemoServlet extends HttpServlet {
- @Override
- protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
- // 同上
- }
- }
這個(gè)時(shí)候匹配任意路徑。
訪問(wèn)http://localhost:8080/appcontext,控制臺(tái)打?。?/p>
- 收到請(qǐng)求:/appcontext/ ServletPath:/ PathInfo:null
訪問(wèn)http://localhost:8080/appcontext/api/demo1,控制臺(tái)打?。?/p>
- 收到請(qǐng)求:/appcontext/api/demo1 ServletPath:/api/demo1 PathInfo:null
訪問(wèn)http://localhost:8080/appcontext/api/demo1.html,控制臺(tái)打?。?/p>
- 收到請(qǐng)求:/appcontext/api/demo1.html ServletPath:/api/demo1.html PathInfo:null
此匹配規(guī)則下,pathInfo永遠(yuǎn)是null,servletPath永遠(yuǎn)是“全部”。
關(guān)于pathInfo:pathInfo只有當(dāng)Servlet是路徑匹配時(shí),才有值。其它情況永遠(yuǎn)為null
Servlet對(duì)URL的匹配既不是Ant風(fēng)格,也不是Regex。特殊符號(hào)只有單個(gè)的*,且使用位置有強(qiáng)約束,切忌想當(dāng)然的隨意拼湊。
舉例兩種典型的錯(cuò)誤理解,應(yīng)該能幫助到你:
有時(shí)候一個(gè)URL會(huì)被多個(gè)urlPatterns所匹配,這時(shí)誰(shuí)優(yōu)先呢?
Servlet同樣遵循“國(guó)際慣例”:越精確越優(yōu)先,越模糊越靠后。站在pattern模式的角度換句話講就是:范圍越小越優(yōu)先,范圍越大越靠后。
因此Servlet四種匹配方式順序按范圍從小到大(優(yōu)先級(jí)從高到底)排序?yàn)椋壕_匹配 > 路徑匹配 > 后綴名匹配 > 缺省匹配。
終于,來(lái)到了今天的主菜。
從上至下的閱讀到這里,再看這個(gè)問(wèn)題,是不是覺(jué)得答案已經(jīng)浮出水面?那么,最后我還是來(lái)總結(jié)一下它倆的異同點(diǎn):
絕大部分場(chǎng)景下具有相同的表現(xiàn):匹配所有。
就是由于它們的相同點(diǎn)(如此相似),所以才讓我們難以區(qū)分。
關(guān)于/:
關(guān)于/*:
/只能用于Servlet上,/*一般只用于Filter上。
大家熟悉的Spring MVC的DispatcherServlet的匹配路徑默認(rèn)就是/,它會(huì)攔截各種各樣的請(qǐng)求,諸如下面這種請(qǐng)求都會(huì)攔截:
但是,它不會(huì)攔截/api/demo1.jsp這種以.jsp結(jié)尾的請(qǐng)求。據(jù)此現(xiàn)象就出現(xiàn)了:/不攔.jsp請(qǐng)求而/*攔截(/*的范圍比/大)這種“錯(cuò)誤”言論。
下面告訴你此現(xiàn)象的根因:Servlet容器(如Tomcat)內(nèi)置有專門匹配.jsp這種請(qǐng)求的Servlet處理器,如下圖所示:
而后綴名匹配優(yōu)先級(jí)高于缺省匹配,所以.jsp結(jié)尾的請(qǐng)求不會(huì)被DispatcherServlet所“截胡”而是交給了JspServlet處理。
有了這波分析后,就問(wèn)你,是不是就不用死記答案了?是不是就終身難忘啦?
Servlet的urlPatterns匹配方式是學(xué)習(xí)Java Web的重要一環(huán),也是深入理解Spring MVC原理的大門,畢竟Spring MVC依舊是做業(yè)務(wù)開(kāi)發(fā)的首選,而且還會(huì)持續(xù)很久、很久。
本文對(duì)Servlet的匹配方式做了全覆蓋講解,包括:
通過(guò)本文希望能讓你不再被Servlet的模式匹配所困擾,更不要被一些似可非可的結(jié)論所迷惑,搖擺不定時(shí)大不了編碼驗(yàn)證一下嘛。
本文通過(guò)授人以漁的方式道出/和/*的區(qū)別,期待能成為你的永久記憶,我做到了嗎?

我們?cè)谖⑿派?4小時(shí)期待你的聲音
解答本文疑問(wèn)/技術(shù)咨詢/運(yùn)營(yíng)咨詢/技術(shù)建議/互聯(lián)網(wǎng)交流