Springboot 2.x中server.servlet.context-path的運用詳解

Posted on by

今天在開發項目的時候遇到瞭請求不通API的問題，最開始以為是server.servlet.context-path配置導致的問題，最終發現是由於AWS端口未開放/監聽導致的connection refuse。雖然如此，仍然想記錄一下server.servlet.context-path的作用。

功能

這個配置能夠設置項目中的所有API的上下文路徑(URL的一部分)，與@RequestMapping有異曲同工之妙。

我們知道，@RequestMapping能夠在API方法層級聲明，同時能夠在Controller的類層級聲明，為什麼能夠在多層級聲明呢？大傢很容易想到，為瞭使API url的語義性，遵從REST標準的API是非常棒的，同一個Controller下的URL前綴相同能夠非常明確的表達語義與關聯關系。

那麼，如果我們有多個項目/微服務呢？也應該做到這一點，隻不過是以更大的層級方式在應用。server.servlet.context-path能夠以一個project為單位配置默認的URL上下文路徑，保持設計的一致性是非常合適的做法。

用法

如果我們沒有添加任何配置，則為默認值“/”，
我們可以在Springboot的properties下配置：

server.servlet.context-path=/api/demo

如果使用的是yml配置方式，則為：

server：
 servlet:
 context-path:/api/demo

那麼我們調用一個地址本來為 [ip地址]:[端口號]/books 的API，現在變成瞭 [ip地址]:[端口號]/api/demo/books

註意！！！ 配置上有一個小坑，如果你使用的是Springboot 1.x版本，我們需要改為使用 server.context-path 來配置路徑。

優點

  • 我們能夠通過此配置在更大的層級上做統一的路徑配置，體現瞭RESTFul的語義化API URL的優勢。
  • 便於配置Ngnix的請求分發

SpringBoot2.X配置server.context-path不生效的解決

之前看視頻教程的時候發現教程上的配置是這樣的

 server.context-path=/IMooc

然後我按照這樣配置發現重啟瞭並未生效

Tomcat started on port(s): 8081 (http) with context path ”

後來百度發現原來1.X版本這樣配置是可以的，但是2.X版本需要如下配置才能生效

server.servlet.context-path=/Daojihe
Tomcat started on port(s): 8081 (http) with context path '/Daojihe'

到此這篇關於Springboot 2.x中server.servlet.context-path的運用詳解的文章就介紹到這瞭,更多相關Springboot 2.x server.servlet.context-path內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：