ModelAndView对象中的view对象,可以使用字符串来让Spring框架进行解析获得适合的视图。而解析View的就是ViewResolver技术。
ViewResolver的定义如下:
public interface ViewResolver { View resolveViewName(String viewName, Locale locale) throws Exception; }
在[spring-dispatcher-name]-servlet.xml中,可以定义viewResolver:
<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/jsp/"/>
<property name="suffix" value=".jsp"/>
</bean>
来让DispacherServlet进行加载默认的viewResolver,如果没有设置viewResolver,spring使用InternalResourceViewResolver进行解析。
Spring实现ViewResolver的非抽象类且我们经常使用的viewResolver有以下四种:
InternalResourceViewResolver | 将逻辑视图名字解析为一个路径 |
BeanNameViewResolver | 将逻辑视图名字解析为bean的Name属性,从而根据name属性,找定义View的bean |
ResourceBundleResolver | 和BeanNameViewResolver一样,只不过定义的view-bean都在一个properties文件中,用这个类进行加载这个properties文件 |
XmlViewResolver | 和ResourceBundleResolver一样,只不过定义的view-bean在一个xml文件中,用这个类来加载xml文件 |
使用多视图解析器:
我们不想只使用一种视图解析器的话,可以在[spring-dispatcher-name]-servlet.xml定义多个viewResolver:
<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/jsp/"/> <property name="suffix" value=".jsp"/> </bean> <bean id=”beanNameViewResolver” class=”...BeanNameViewResolver”> <property name="order" value="1"></property> </bean> <bean id=”beanNameViewResolver” class=”...XmlViewResolver”> <property name="order" value="0"></property> </bean>
DispatcherServlet会加载所有的viewResolver到一个list中,并按照优先级进行解析。注意order中的值越小,优先级越高。而id为viewResolver
的viewResolver的优先级是最低的。
=============
spring学习笔记:配置视图解析器ViewResolver
我们在controller里面经常这样return一个ModelAndView: return new ModelAndView('user', 'model', model);
DispatcherServlet靠ViewResolver把user解析为/WEB-INF/jsp/user.jsp:
常用的ViewResolver:
InternalResourceViewResolver:
- <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
- <property name="prefix" value="/WEB-INF/jsp/" />
- <property name="suffix" value=".jsp" />
- </bean>
其实InternalResourceViewResolver的工作很简单: 在视图逻辑名前面加上prefix,后面加上suffix;
ResourceBundleViewResolver:把视图逻辑名和真实文件的映射关系放在配置文件中.
- <bean id="myViewResolver" class="org.springframework.web.servlet.view.ResourceBundleViewResolver">
- <property name="order" value="1"/>
- <property name="basename" value="views"/>
- </bean>
因为可以配置多个viewResolver,所以上面的resolver还有一个选项order, 标明优先级。
views.properties放在classpath下面,内容大约是这样的:
userDetail.class=org.springframework.web.servlet.view.JstlView
userDetail.url=/WEB-INF/jsp/userDetail.jsp
userList.class=org.springframework.web.servlet.view.JstlView
userList.url=/WEB-INF/jsp/userList.jsp
......
我们可以在controller里面这样返回一个ModelAndView:
return new ModelAndView("userDetail","model", model);
=========
Spring MVC中的视图解析ViewResolver
在Spring MVC中,当Controller将请求处理结果放入到ModelAndView中以后,DispatcherServlet会根据ModelAndView选择合适的视图进行渲染。那么在Spring MVC中是如何选择合适的View呢?View对象是是如何创建的呢?答案就在ViewResolver中,ViewResolver接口定义了resolverViewName方法,根据viewName创建合适类型的View实现。
那么,如何配置ViewResolver呢?在Spring中,ViewResolver作为Spring Bean存在,可以在Spring配置文件中进行配置,例如下面的代码,配置了jsp相关的viewResolver。
- <!-- Resolves view names to protected .jsp resources within the /WEB-INF/views directory -->
- <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
- <property name="prefix" value="/WEB-INF/views/"/>
- <property name="suffix" value=".jsp"/>
- </bean>
在Spring MVC中,因为ViewResolver是使用bean来配置的,所以扩展起来非常的容易,可以根据自己的需要定制ViewResolver,然后在配置文件中进行相关的配置即可。
ViewResolver接口声明了resolverViewName方法,这个方法的主要功能是根据ModelAndView中给定的viewName信息,再结合相关的配置,创建出合适类型的View对象。
ViewResolver接口是在DispatcherServlet中进行调用的,当DispatcherServlet调用完Controller后,会得到一个ModelAndView对象,然后DispatcherServlet会调用render方法进行视图渲染。
- protected void render(ModelAndView mv, HttpServletRequest request, HttpServletResponse response) throws Exception {
- // Determine locale for request and apply it to the response.
- Locale locale = this.localeResolver.resolveLocale(request);
- response.setLocale(locale);
- View view;
- if (mv.isReference()) {
- // We need to resolve the view name.
- view = resolveViewName(mv.getViewName(), mv.getModelInternal(), locale, request);
- if (view == null) {
- throw new ServletException(
- "Could not resolve view with name '" + mv.getViewName() + "' in servlet with name '" +
- getServletName() + "'");
- }
- }
- else {
- // No need to lookup: the ModelAndView object contains the actual View object.
- view = mv.getView();
- if (view == null) {
- throw new ServletException("ModelAndView [" + mv + "] neither contains a view name nor a " +
- "View object in servlet with name '" + getServletName() + "'");
- }
- }
- // Delegate to the View object for rendering.
- if (logger.isDebugEnabled()) {
- logger.debug("Rendering view [" + view + "] in DispatcherServlet with name '" + getServletName() + "'");
- }
- view.render(mv.getModelInternal(), request, response);
- }
在DispatcherServlet类中,init方法中已经进行了相关的初始化,配置的ViewResolver信息都存放在viewResolvers中。在render方法中调用resolverViewName方法,在这个方法中逐一调用ViewResolver去取得View对象。
- protected View resolveViewName(String viewName, Map<String, Object> model, Locale locale,
- HttpServletRequest request) throws Exception {
- for (ViewResolver viewResolver : this.viewResolvers) {
- View view = viewResolver.resolveViewName(viewName, locale);
- if (view != null) {
- return view;
- }
- }
- return null;
- }
在这里需要关于ViewResolver的选择是通过循环进行的,只选择第一个符合要求的,因此在定义ViewResolver时,需要注意定义其优先级。
下面就来着重关注一下ViewResolver的类结构。
关于View对象的创建,不同的ViewResolver的解决方法是各部相同的。如BeanNameViewResolver是根据viewName选择相应名称的bean(这里需要注意bean的scope,是否需要线程安全),而UrlBasedViewResolver则是使用反射机制,根据viewClass信息创建view对象,因此这个view不受IoC容器的管理。ContentNegotiationViewResolver中可以嵌套ViewResolver,根据不同的的请求类型选择合适的ViewResolver。
DispatcherServlet得到View对象后,即调用View的render方法,执行真正的渲染工作。
最后,看一下View的类结构图。
有上述的View类结构图可知,Spring已经为我们提供了一系列可用的View。同时,如果当前提供的View不能满足我们的要求时,可以通过实现View接口进行扩展。如需要根据model中的数据使用JFreeChart绘图,或者将这些数据作为文件下载时,我们可以扩展出JFreeChartView和FileDownloadView等,这样就能更灵活的将同一份数据用不同的方式展现出来。