Spring MVC 視圖解析器詳解

---

1. 視圖解析器概述

視圖解析器（ViewResolver）是 Spring MVC 的核心組件，負責將控制器返回的視圖名稱（如 success）轉換為具體的 View 對象（如 Thymeleaf 模板或 JSP 文件）。Spring 提供了多種視圖解析器，支持不同的模板引擎和渲染方式。

---

2. 常用視圖解析器詳解

---

1. InternalResourceViewResolver

作用：解析 JSP 或其他服務器端包含（JSP/Servlet）的視圖，默認用于傳統 JSP 開發。

配置方式：

@Configuration
public class WebConfig implements WebMvcConfigurer {@Beanpublic InternalResourceViewResolver internalResourceViewResolver() {InternalResourceViewResolver resolver = new InternalResourceViewResolver();resolver.setPrefix("/WEB-INF/views/"); // 視圖文件路徑前綴resolver.setSuffix(".jsp");            // 視圖文件后綴resolver.setOrder(1);                  // 設置優先級（數值越小優先級越高）return resolver;}
}

使用示例：

@Controller
public class MyController {@GetMapping("/jsp")public String jspView() {return "hello"; // 實際路徑：/WEB-INF/views/hello.jsp}
}

---

2. ThymeleafViewResolver

作用：解析 Thymeleaf 模板文件，需配合 Thymeleaf 依賴。

依賴：需添加 Thymeleaf 依賴：

<dependency><groupId>org.thymeleaf</groupId><artifactId>thymeleaf-spring5</artifactId><version>3.0.12.RELEASE</version>
</dependency>

配置方式：

@Configuration
public class ThymeleafConfig {@Beanpublic SpringTemplateEngine templateEngine() {SpringTemplateEngine engine = new SpringTemplateEngine();engine.setTemplateResolver(templateResolver());return engine;}@Beanpublic SpringResourceTemplateResolver templateResolver() {SpringResourceTemplateResolver resolver = new SpringResourceTemplateResolver();resolver.setPrefix("classpath:/templates/"); // 模板文件路徑resolver.setSuffix(".html");resolver.setTemplateMode("HTML5");return resolver;}@Beanpublic ThymeleafViewResolver thymeleafViewResolver() {ThymeleafViewResolver resolver = new ThymeleafViewResolver();resolver.setTemplateEngine(templateEngine());resolver.setCharacterEncoding("UTF-8");resolver.setOrder(0); // 設置優先級return resolver;}
}

使用示例：

@Controller
public class MyController {@GetMapping("/thymeleaf")public String thymeleafView() {return "hello"; // 實際路徑：src/main/resources/templates/hello.html}
}

---

3. FreeMarkerViewResolver

作用：解析 FreeMarker 模板文件。

依賴：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

配置方式（Spring Boot 自動配置）：

# application.properties
spring.freemarker.template-loader-path=classpath:/templates/
spring.freemarker.suffix=.ftl

使用示例：

@Controller
public class MyController {@GetMapping("/freemarker")public String freemarkerView() {return "hello"; // 實際路徑：src/main/resources/templates/hello.ftl}
}

---

4. ContentNegotiatingViewResolver

作用：根據請求的 Accept 頭或擴展名動態選擇視圖解析器，常用于 RESTful API 多媒體格式支持。

配置方式：

@Configuration
public class WebConfig implements WebMvcConfigurer {@Beanpublic ContentNegotiatingViewResolver contentNegotiatingViewResolver() {ContentNegotiatingViewResolver resolver = new ContentNegotiatingViewResolver();List<ViewResolver> resolvers = new ArrayList<>();resolvers.add(new InternalResourceViewResolver()); // JSPresolvers.add(new ThymeleafViewResolver());        // Thymeleafresolver.setViewResolvers(resolvers);return resolver;}
}

使用場景：

• 請求 /api/data.json → 返回 JSON 格式。
• 請求 /api/data.html → 返回 HTML 模板。

---

5. BeanNameViewResolver

作用：根據視圖名稱直接查找 BeanFactory 中的 View Bean，無需配置前綴/后綴。

配置示例：

@Bean
public View myView() {InternalResourceView view = new InternalResourceView();view.setUrl("/WEB-INF/views/custom.jsp");return view;
}@Bean
public BeanNameViewResolver beanNameViewResolver() {BeanNameViewResolver resolver = new BeanNameViewResolver();resolver.setOrder(2); // 優先級最低return resolver;
}

使用示例：

@Controller
public class MyController {@GetMapping("/bean")public String beanView() {return "myView"; // 直接匹配 Bean 名稱}
}

---

3. 核心屬性說明

視圖解析器的通用屬性：

屬性	說明	示例
prefix	視圖文件的路徑前綴（如 /WEB-INF/views/）。	resolver.setPrefix("/templates/")
suffix	視圖文件的后綴（如 .jsp, .html）。	resolver.setSuffix(".ftl")
order	優先級（數值越小優先級越高）。	resolver.setOrder(0)
viewClass	指定視圖實現類（如 InternalResourceView）。	resolver.setViewClass(ThymeleafView.class)

---

4. 視圖解析流程

1. 請求處理：控制器方法返回視圖名稱（如 success）。
2. 解析匹配：Spring 按 order 從小到大順序調用視圖解析器。
3. 生成 View：第一個匹配的解析器將名稱轉換為具體 View 對象（如 Thymeleaf 模板）。
4. 渲染響應：View 對象填充數據并生成最終 HTML。

---

5. 總結表格

視圖解析器	適用場景	核心配置屬性
InternalResourceViewResolver	JSP 或傳統 Servlet 開發	prefix, suffix, viewClass = InternalResourceView
ThymeleafViewResolver	Thymeleaf 模板開發	templateResolver, templateEngine
FreeMarkerViewResolver	FreeMarker 模板開發	prefix, suffix
ContentNegotiatingViewResolver	動態選擇視圖格式（如 JSON/HTML）	viewResolvers（集合其他解析器）
BeanNameViewResolver	直接綁定 Bean 名稱到 View	order（通常最低優先級）

---

6. 常見問題與解決方案

• 視圖文件找不到：
  • 檢查 prefix/suffix 配置是否正確。
  • 確認視圖文件路徑（如 src/main/resources/templates）。
• 多個解析器沖突：
  • 通過 order 屬性調整優先級。
  • 確保不同解析器的 prefix 不重疊。
• Thymeleaf/Freemarker 配置失敗：
  • 添加對應依賴并檢查模板引擎配置（如 templateResolver）。

---

關鍵總結

1. 選擇解析器：根據項目使用的模板引擎（如 Thymeleaf、FreeMarker）選擇對應解析器。
2. 配置優先級：通過 order 確定解析器處理順序，避免沖突。
3. 路徑規范：確保 prefix/suffix 正確指向視圖文件位置。
4. 混合使用：通過 ContentNegotiatingViewResolver 支持多格式響應（如 RESTful API）。