SpringBoot首頁設置解析(推薦)

Posted on by

首先來解釋一下SpringBoot首頁設置的三種方式

1.SpringBoot默認首頁設置

編寫一個最簡單的html文件 index.html

<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
</head>
<body>
<h1>首頁</h1>
</body>
</html>

將index.html文件置於SpringBoot的任一靜態資源目錄下

在這裡插入圖片描述

http://localhost:8080/訪問，成功顯示

在這裡插入圖片描述

源碼分析

首先找對應的自動配置類WebMvcAutoConfiguration中的對應代碼

@Bean
public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext, FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider) {
 WelcomePageHandlerMapping welcomePageHandlerMapping = 
 	new WelcomePageHandlerMapping(new TemplateAvailabilityProviders(applicationContext),
 		 applicationContext, this.getWelcomePage(), this.mvcProperties.getStaticPathPattern());
 welcomePageHandlerMapping.setInterceptors(this.getInterceptors(mvcConversionService, mvcResourceUrlProvider));
 welcomePageHandlerMapping.setCorsConfigurations(this.getCorsConfigurations());
 return welcomePageHandlerMapping;
}

可以看到 SpringBoot註冊瞭WelcomePageHandlerMappingBean來處理項目的默認首頁,構造器中的this.getWelcomePage()為首頁資源。

private Resource getWelcomePage() {
 String[] var1 = this.resourceProperties.getStaticLocations();
 int var2 = var1.length;

 for(int var3 = 0; var3 < var2; ++var3) {
  String location = var1[var3];
  Resource indexHtml = this.getIndexHtml(location);
  if (indexHtml != null) {
  return indexHtml;
  }
 }

 ServletContext servletContext = this.getServletContext();
 if (servletContext != null) {
  return this.getIndexHtml((Resource)(new ServletContextResource(servletContext, "/")));
 } else {
  return null;
 }
}

分析這段代碼，首先獲取瞭this.resourceProperties的StaticLocations字段，顧名思義就是靜態路徑，那就先跟蹤StaticLocations

在這裡插入圖片描述

可以看出StaticLocations是WebPropertis中內部靜態類Resources的屬性，從構造器中可以看出它的值為

 private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]{"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"};

顯而易見，這其實就是SpringBoot的靜態資源目錄

/META-INF

/resources/

/resources/

/static/

/public/

回到之前的代碼，獲取瞭StaticLocations後，通過循環遍歷，很明顯可以看到一個新的方法this.getIndexHtml(location)

private Resource getIndexHtml(String location) {
 return this.getIndexHtml(this.resourceLoader.getResource(location));
}

使用this.resourceLoader返回一個與location對應的Resource執行另一個getIndexHtml()函數

private Resource getIndexHtml(Resource location) {
 try {
  Resource resource = location.createRelative("index.html");
  if (resource.exists() && resource.getURL() != null) {
  return resource;
  }
 } catch (Exception var3) {
 }

 return null;
}

很明顯，這個方法是獲取對應目錄下的index.html文件。再往回看

for(int var3 = 0; var3 < var2; ++var3) {
 String location = var1[var3];
 Resource indexHtml = this.getIndexHtml(location);
 if (indexHtml != null) {
  return indexHtml;
 }
}

當找到對應文件的時候就返回對應的資源，這就是SpringBoot設置首頁的默認方式的原理。

從源碼中也可以看出另一個關於靜態資源目錄優先級的問題。getWelcomePage遍歷靜態資源目錄，一旦找到就返回，所以優先級和staticLocations中的順序相對，驗證一下。

先在每一個目錄下建立對應的indx.html文件

在這裡插入圖片描述

http://localhost:8080/訪問

在這裡插入圖片描述

和得出的結論一樣，優先級最高的是 /META-INF/resources/，把 /META-INF/resources/下的index.html文件刪除再次驗證

在這裡插入圖片描述

驗證成功！

2.controller裡添加”/”的映射路徑

新建IndexController.java

package com.springboot04webapp.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class IndexController {

 @RequestMapping("/")
 public String index(){
 return "indexController";
 }
}

首頁資源indexController.html

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
</head>
<body>
<h1>indexController首頁</h1>
</body>
</html>

http://localhost:8080/訪問

在這裡插入圖片描述

3.MVC擴展配置實現

新建MyMvcConfiguration配置類，擴展MVC配置，重寫addViewControllers方法

package com.springboot04webapp.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class MyMvcConfiguration implements WebMvcConfigurer {

 @Override
 public void addViewControllers(ViewControllerRegistry registry) {
 registry.addViewController("/").setViewName("indexMVC");
 }
}

首頁資源indexMVC.html

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
</head>
<body>
<h1>indexMVC首頁</h1>
</body>
</html>

http://localhost:8080/訪問

在這裡插入圖片描述

擴展：優先級問題

之前的三個方法都是單獨設置的，現在把他們結合起來

在這裡插入圖片描述

http://localhost:8080/訪問

在這裡插入圖片描述

優先級最高的是第二種方法，然後將indexController刪除，再次驗證

在這裡插入圖片描述

得出結論：Controller>MyMvcConfiguration>默認方法

到此這篇關於SpringBoot首頁設置解析詳解的文章就介紹到這瞭,更多相關SpringBoot首頁設置內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：