【SSM】SSM之SpringMVC框架：自定义视图及其执行过程

一：如何自定义视图

我们之前接触到的非自定义视图有个InternalResourceView，我们也分析到当一个接收到一个请求后，程序执行到的renderMergedOutputModel()方法其实是AbstractView的子类InternalResourceView中的方法。
InternalResourceView类最终实现了一个接口View，实现了该接口的类都是Spring提供的视图，如果我们要自定义视图那么首先就要实现该接口。

1、创建一个类，实现View接口

该接口有两个抽象方法：

• getContentType()：设置响应视图的类型，InternalResourceView的这个方法继承自它的父类AbstractView；
• render()：处理最终的响应操作，InternalResourceView的这个方法也继承自它的父类AbstractView，只不过它的父类又声明了一个抽象方法renderMergedOutputModel()，并且在render()方法中调用了该方法，因此在实际运行中调用的实际是InternalResourceView中的renderMergedOutputModel()方法，在该方法中，进行了请求转发的操作。

package cn.jingpengchong.hello.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;

//要将该视图交给Spring管理并实例化,并且能够让spring根据该注解的value属性值获取该视图
@Component("toView")
public class ToView implements View {

	@Override
	//设置响应视图的类型
	public String getContentType() {
		return "text/html";
	}

	@Override
	//我们可以效仿InternalResourceView，在该方法中进行请求转发操作
	public void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response)
			throws Exception {
		request.getRequestDispatcher("/WEB-INF/jsp/hello.jsp").forward(request, response);
	}
}

2、在配置文件中配置一个该视图的解析器

该视图解析器为BeanNameViewResolver，我们可以将其优先级提高，这样的话它就会先于InternalResourceView的视图解析器InternalResourceViewResolver执行。

<bean class="org.springframework.web.servlet.view.BeanNameViewResolver">
	<property name="order" value="0"/>
</bean>

3、测试一下我们自定义的视图

将控制器HelloController中的hello()改造一下：

@RequestMapping("hello")
public String hello() {
	return "toView";
}

启动Tomcat，在浏览器进行访问，成功了！

二：自定义视图被调用的过程

1、我们知道一个请求被servlet捕获后必定会调用service方法，由service方法根据请求类别再调用doGet或doPost方法，对于DispatcherServlet也是一样。而由于DispatcherServlet没有重写其父类FrameworkServlet的service方法，因此请求必定会执行FrameworkServlet中的service()：

2、由于“HttpMethod.PATCH.matches(request.getMethod())”的返回值时false，所以调用了父类的service()方法，在其父类的service()方法中，又执行了doGet()方法：

3、由于FrameworkService类中重写了doGet()方法，所以执行到了FrameworkService类中的doGet()方法：

4、在该方法中又执行了processRequest()方法，在processRequest()方法中又执行了doService()方法：

5、我们发现doService()方法发现其是一个抽象方法，既然是一个抽象方法，那么该类的子类必定有实现该方法的，恰巧DispatcherServlet类就是FrameworkServlet类的子类，我们点开该方法的实现，发现DispatcherServlet确实实现了该方法，那么当执行doService()方法时必定是执行DispatcherServlet类中的doService()方法了，向下执行，发现确实执行到了DispatcherServlet类中的doService()方法，并且在该方法中执行了doDispatch()方法：

6、在doDispatch()方法中，通过getHandler()方法获得了一个处理器映射器，该映射器获得了将要被执行的HelloController类中的hello()方法：

7、接着向下执行，又获得了一个处理器适配器，并且将处理器映射器获得的hello()方法交给该处理器适配器执行：

8、接着向下执行，到了processDispatchResult()方法：

9、在processDispatchResult()方法中又执行了render()方法：

10、在render()方法中调用resolveViewName()方法：

11、在resolveViewName()方法中遍历该类的viewResolvers属性，此时我们发现该属性已经有值了，那么它是何时被赋值的呢？

• a.追本溯源，我们发现该属性在initStrategies()方法中被初始化：
  
• b.我们向上找，在该类中发现initStrategies()是在onRefresh()方法中被调用的：
  
• c.根据onRefresh()方法前的注解我们可以知道该方法是继承自父类的，既然我们在该类中找不到调用onRefresh()的地方，那么必定是在该类的父类FrameworkServlet中调用的，果不其然！
  
• d.那么initWebApplicationContext()方法又是在哪里被调用的呢？我们发现它是在该类的initServletBean()方法中调用的：
  
• e.那么FrameworkServlet类的initServletBean()方法是在哪里被调用的呢？我们在该类找不到调用该方法的，但是通过@Override注解可以知道它的父类有可能调用了该方法，我们进入其父类HttpServletBean中果然发现了是在init()方法中调用的该方法：
  
• e.在Servlet中，init()方法的执行时刻与servlet的配置有关，可以看到以下代码的load-on-startup结点，如果结点的值大于等于 0，则在Servlet实例化的时候执行，间隔时间由具体的值决定，值越大，则越迟执行。如果小于0或者没有配置，则在第一次请求的时候才同步执行，注意 init()方法只执行一次。我们在配置文件中发现值为1，说明init()方法在Servlet实例化的时候就已经执行了，虽然我们配置的是DispatcherServlet，但是别忘了DispatcherServlet继承了FrameworkServlet，而FrameworkServlet又继承了HttpServletBean。因此，我们可以知道DispatcherServlet 的 viewResolvers属性在Tomcat时候就被初始化了，里面存储了我们在配置文件中配置的两个视图解析器。
  
  12、由于我们给BeanNameViewResolver设置了更高的优先级，所以BeanNameViewResolver将优先被遍历，因此获得了一个视图解析器ViewResolver类的实例化对象，该对象实际上是我们配置的BeanNameViewResolver对象：
  
  13、调用获得的视图解析器BeanNameViewResolver类的实例化对象的resolveViewName()方法，并返回一个我们自定义的视图的Bean对象：
  
  14、由于此时获得了自定义的视图，所以返回的view不为null，因此将该view返回给DispatcherServlet中render()方法中声明的View类型的变量：
  
  15、调用view的render()方法，由于view是我们自定义的视图，因此跳转到我们自定义视图类ToView的render()方法中：
  
  在这里执行了请求转发，返回了hello.jsp页面！

三、自定义大有用处–以自定义Excel视图为例

1、拷贝jar包：

2、Excel视图需要继承AbstractXlsView：

package cn.jingpengchong.hello.view;

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 cn.jingpengchong.hello.pojo.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、在spring的xml配置文件中配置自定义视图解析器：

<bean class="org.springframework.web.servlet.view.BeanNameViewResolver">
	<!-- 提高该视图解析器的优先级 -->
	<property name="order" value="0"/>
</bean>

4、在Controller控制器中添加对应的方法：

@RequestMapping("/userinfo/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;
}

5、测试：
启动Tomcat，在浏览器发送请求“127.0.0.1:8080/项目名/userinfo/excel.do”，出现下图的效果：

将其保存在桌面：

打开该文件效果如下：