马上注册,结交更多好友,享用更多功能,让你轻松玩转社区。
您需要 登录 才可以下载或查看,没有账号?立即注册
x
Spring MVC 视图解析器详解
1. 视图解析器概述
视图解析器(ViewResolver)是 Spring MVC 的焦点组件,负责将控制器返回的视图名称(如 success)转换为具体的 View 对象(如 Thymeleaf 模板或 JSP 文件)。Spring 提供了多种视图解析器,支持不同的模板引擎和渲染方式。
2. 常用视图解析器详解
1. InternalResourceViewResolver
作用:解析 JSP 或其他服务器端包罗(JSP/Servlet)的视图,默认用于传统 JSP 开发。
设置方式:
- @Configuration
- public class WebConfig implements WebMvcConfigurer {
- @Bean
- public 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 {
- @Bean
- public SpringTemplateEngine templateEngine() {
- SpringTemplateEngine engine = new SpringTemplateEngine();
- engine.setTemplateResolver(templateResolver());
- return engine;
- }
- @Bean
- public SpringResourceTemplateResolver templateResolver() {
- SpringResourceTemplateResolver resolver = new SpringResourceTemplateResolver();
- resolver.setPrefix("classpath:/templates/"); // 模板文件路径
- resolver.setSuffix(".html");
- resolver.setTemplateMode("HTML5");
- return resolver;
- }
- @Bean
- public 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 {
- @Bean
- public ContentNegotiatingViewResolver contentNegotiatingViewResolver() {
- ContentNegotiatingViewResolver resolver = new ContentNegotiatingViewResolver();
- List<ViewResolver> resolvers = new ArrayList<>();
- resolvers.add(new InternalResourceViewResolver()); // JSP
- resolvers.add(new ThymeleafViewResolver()); // Thymeleaf
- resolver.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. 视图解析流程
- 哀求处理:控制器方法返回视图名称(如 success)。
- 解析匹配:Spring 按 order 从小到大顺序调用视图解析器。
- 生成 View:第一个匹配的解析器将名称转换为具体 View 对象(如 Thymeleaf 模板)。
- 渲染相应:View 对象添补数据并生成终极 HTML。
5. 总结表格
视图解析器适用场景焦点设置属性InternalResourceViewResolverJSP 或传统 Servlet 开发prefix, suffix, viewClass = InternalResourceViewThymeleafViewResolverThymeleaf 模板开发templateResolver, templateEngineFreeMarkerViewResolverFreeMarker 模板开发prefix, suffixContentNegotiatingViewResolver动态选择视图格式(如 JSON/HTML)viewResolvers(集合其他解析器)BeanNameViewResolver直接绑定 Bean 名称到 Vieworder(通常最低优先级) 6. 常见标题与解决方案
- 视图文件找不到:
- 检查 prefix/suffix 设置是否正确。
- 确认视图文件路径(如 src/main/resources/templates)。
- 多个解析器冲突:
- 通过 order 属性调整优先级。
- 确保不同解析器的 prefix 不重叠。
- Thymeleaf/Freemarker 设置失败:
- 添加对应依赖并检查模板引擎设置(如 templateResolver)。
关键总结
- 选择解析器:根据项目利用的模板引擎(如 Thymeleaf、FreeMarker)选择对应解析器。
- 设置优先级:通过 order 确定解析器处理顺序,避免冲突。
- 路径规范:确保 prefix/suffix 正确指向视图文件位置。
- 混淆利用:通过 ContentNegotiatingViewResolver 支持多格式相应(如 RESTful API)。
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。 |