SpringMVC自定义视图

我们在使用SpringMVC拦截并处理客户端请求时，需要添加一个InternalResourceViewResolver内部视图解析器来解析视图（将逻辑视图转化为物理视图），如下：

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" p:prefix="/WEB-INF/view/" p:suffix=".jsp"></bean>

然而默认的viewResolver往往不能满足我们的需求，因此我们可以自定义一个视图，并代替内部视图解析器解析视图。

一、实现

①自定义一个实现View接口的类，添加@Component注解将其放入SpringIOC容器，如：

package com.jd.view;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.View;

@Component//添加@Component注解并在xml配置文件添加scan标签，以便将自定义视图加入IOC容器
public class ToView implements View {

	public String getContentType() {
		return "text/html; charset=UTF-8";//设置内容编码
	}

	public void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response)
			throws Exception {//自定义视图解析方法
		response.getWriter().print("Hello and resolve this view!");
	}

}

②在spring配置文件root.xml中添加并配置BeanNameViewResolver视图解析器（可通过视图名来解析视图）来解析视图。

注意：由于我们同时也添加了InternalResourceViewResolver视图解析器，并且解析视图时默认使用该视图解析器，因此在添加BeanNameViewResoler视图解析器时需要添加order属性并赋值为“1”，以达到优先使用BeanName解析器的目的（后篇源码分析中有演示）。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:p="http://www.springframework.org/schema/p"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd
		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">

	<context:component-scan base-package="com.jd"></context:component-scan>
	
	<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" p:prefix="/WEB-INF/view/" p:suffix=".jsp"></bean>
	
	<bean class="org.springframework.web.servlet.view.BeanNameViewResolver" p:order="1"></bean>
</beans>

此时再次处理方后将使用自定义视图解析器解析视图，返回我们想要的页面。

二、源码分析

首先还是<loadon-1-startup>标签的作用，依次执行：init——initServletBean——initWebApplicationContext——onrefresh——initStrategies——initViewResolvers方法初始化视图视图解析器

如果我们自定义了视图解析器，则可在该初始化方法中看到我们自定义视图解析器的对象

initViewResolvers方法（DispatcherServlet类第708行）：

此时，视图解析器已经初始化完毕

接着开始进行调用视图解析器解析视图：

doService———doDispatch———processDispatchResult———render———resolveViewName———“返回上一级”———render（调用的是方法实现类AbstractView中的render方法）———renderMergedOutputModel（调用的是方法实现类InternalResourceView中的方法）———最后执行forward方法请求转发

 

注意：我们在添加BeanName视图解析器时添加了order属性，其作用是在调用视图解析器解析视图时，获取视图解析器时，将我们的自定义解析器作为第一个元素，以便可以使用我们自定义的解析器解析视图，否则还将继续使用InternalResourceViewResolver视图解析器，如下图：

 通过debug模式可以看出解析到的view指向我们自定义视图解析方法ToView，说明已经成功调用了自定义的视图解析器。

三、自定义拓展

1、Excel视图

（1）通过Maven的pom添加jar包

<dependency>
	<groupId>org.apache.poi</groupId>
       	<artifactId>poi</artifactId>
       	<version>3.11</version>
</dependency>

（2）自定义Excel视图

import java.io.OutputStream;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.view.document.AbstractXlsView;

import com.jd.vo.UserInfo;

@Component
public class ExcelView extends AbstractXlsView {
     
	@Override
	protected void buildExcelDocument(Map<String, Object> model, Workbook workbook, HttpServletRequest request,
			HttpServletResponse response) throws Exception {
		String fileName = "用户信息.xls";
		response.setCharacterEncoding("UTF-8");
		response.setContentType("application/ms-excel");
		response.setHeader("Content-Disposition", "inline; filename=" + new String(fileName.getBytes(), "iso8859-1"));
		OutputStream outputStream = response.getOutputStream();
         
		@SuppressWarnings("unchecked")
		List<UserInfo> userInfoes = (List<UserInfo>) model.get("userInfoes");
		// 产生Excel表头
		Sheet sheet = workbook.createSheet("基本信息");
		sheet.setColumnWidth(0, 35*256);//设置第一列列宽
		sheet.setColumnWidth(1, 10*256);//设置第二列列宽
		sheet.setColumnWidth(2, 15*256);//设置第三列列宽
		sheet.setColumnWidth(3, 30*256);//设置第四列列宽
		
		CellStyle cellStyle = workbook.createCellStyle();
		cellStyle.setAlignment(CellStyle.ALIGN_CENTER); // 水平布局：居中
		cellStyle.setVerticalAlignment(CellStyle.VERTICAL_CENTER);// 垂直布局：居中
		
		// 标题列
		Row header = sheet.createRow(0);
		header.setRowStyle(cellStyle);
		header.setHeightInPoints(20);// 设置行高
		Cell idCell = header.createCell(0);
		idCell.setCellStyle(cellStyle);//设置单元格样式
		idCell.setCellValue("ID");//设置单元格内容
		Cell nameCell = header.createCell(1);
		nameCell.setCellStyle(cellStyle);
		nameCell.setCellValue("姓名");
		Cell mobileCell = header.createCell(2);
		mobileCell.setCellStyle(cellStyle);
		mobileCell.setCellValue("手机号");
		Cell addressCell = header.createCell(3);
		addressCell.setCellStyle(cellStyle);
		addressCell.setCellValue("家庭地址");

		int rowNumber = 1;
		for (UserInfo userInfo : userInfoes) {
			Row row = sheet.createRow(rowNumber++);
			row.setHeightInPoints(18);// 设置行高
			row.createCell(0).setCellValue(userInfo.getId());
			row.createCell(1).setCellValue(userInfo.getName());
			row.createCell(2).setCellValue(userInfo.getMobile());
			row.createCell(3).setCellValue(userInfo.getAddress());
		}
		workbook.write(outputStream);
		outputStream.flush();
		outputStream.close();
	}
}

（3）Controller定义Handler方法，指定响应Excel视图

import java.util.ArrayList;
import java.util.List;
import java.util.UUID;

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

import com.jd.vo.UserInfo;

@Controller
@RequestMapping("/userinfo")
public class UserInfoController {
     
	@RequestMapping("/excel.do")
	public ModelAndView excel() {
		ModelAndView modelAndView = new ModelAndView("excelView");
		
		List<UserInfo> userInfoes = new ArrayList<UserInfo>();
		String id = UUID.randomUUID().toString();
		userInfoes.add(new UserInfo(id, "Lucy", "18898763401", "吉林省长春市宽城区"));
		id = UUID.randomUUID().toString();
		userInfoes.add(new UserInfo(id, "Kate", "17749219035", "河南省郑州市高新区升龙又一城"));
        	modelAndView.addObject("userInfoes", userInfoes);
		return modelAndView;
	}
}

（4）配置视图解析器

<bean class="org.springframework.web.servlet.view.BeanNameViewResolver">
	<!-- order属性用于设定视图解析器的优先级，order值越小优先级越高，InternalResourceViewResolver优先级为Integer所能表示的最大值 -->
	<property name="order" value="0"></property>
</bean>

 

未完待续 > > >