尚硅谷SpringMVC学习笔记第10-13节（文件上传和下载、拦截器、异常处理器、注解配置SpringMVC）

10、文件上传和下载

10.1、文件下载

使用ResponseEntity实现下载文件的功能

/**
 * @descriDateption
 * ResponseEntity:可以作为控制器方法的返回值，表示响应到浏览器的完整的响应报文
 *
 * 文件表单的请求方式必须为post
 * 1.form表单的请求方式必须为post
 * 2.form表单必须设置属性enctype="multipart/form=data"
 */
@Controller
public class FileUpAndDownController {
  
    @RequestMapping("/test/down")
    public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws
            IOException {
//获取ServletContext对象
        ServletContext servletContext = session.getServletContext();
//获取服务器中文件的真实路径
        String realPath = servletContext.getRealPath("img");//地址是img/1.jpg，可以用拼接，因为不确定分隔符是 / 还是 \
        realPath = realPath + File.separator + "1.jpg";
//创建输入流
        InputStream is = new FileInputStream(realPath);
//创建字节数组，is.available()获取输入流所对应文件的字节数
        byte[] bytes = new byte[is.available()];
//将流读到字节数组中
        is.read(bytes);
//创建HttpHeaders对象设置响应头信息
        MultiValueMap<String, String> headers = new HttpHeaders();
//设置要下载方式以及下载文件的名字
        headers.add("Content-Disposition", "attachment;filename=1.jpg");
//设置响应状态码
        HttpStatus statusCode = HttpStatus.OK;
//创建ResponseEntity对象
        ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes, headers, statusCode);
//关闭输入流
        is.close();
        return responseEntity;
    }

}

10.2、文件上传
文件上传要求form表单的请求方式必须为post，并且添加属性enctype=“multipart/form-data”
SpringMVC中将上传的文件封装到MultipartFile对象中，通过此对象可以获取文件相关信息
上传步骤：
①添加依赖

 <!-- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.3.1</version>
        </dependency>

②在SpringMVC的配置文件中添加配置

 <!--配置文件上传解析器-->
 <!--必须通过文件解析器的解析才能将文件转换为MultipartFile对象-->
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">

③控制器方法：

@RequestMapping("/test/up")
    public String testUp(MultipartFile photo, HttpSession session) throws IOException {
        //获取上传的文件的文件名
        String fileName = photo.getOriginalFilename();//没有配文件上传解析器，会报错：
        //HTTP Status 500 - Request processing failed; nested exception is java.lang.NullPointerException
        //获取上传的文件的后缀名
        String hzName = fileName.substring(fileName.lastIndexOf("."));
        //获取uuid
        String uuid = UUID.randomUUID().toString();
        //拼接一个新的文件名
        fileName = uuid + hzName;
        //获取ServletContext对象
        ServletContext servletContext = session.getServletContext();
        //获取当前工程photo目录的真实路径
        String photoPath = servletContext.getRealPath("photo");
        //创建photoPath所对应的File对象
        File file = new File(photoPath);
        //判断file所对应目录是否存在
        if(!file.exists()){
            file.mkdir();
        }
        String finalPath = photoPath + File.separator + fileName;
        //上传文件
        photo.transferTo(new File(finalPath));
        return "success";
    }

11、拦截器

11.1、拦截器的配置

SpringMVC中的拦截器用于拦截控制器方法的执行
SpringMVC中的拦截器需要实现HandlerInterceptor
SpringMVC的拦截器必须在SpringMVC的配置文件中进行配置：

11.2、拦截器的三个抽象方法

SpringMVC中的拦截器有三个抽象方法：
preHandle：控制器方法执行之前执行preHandle()，其boolean类型的返回值表示是否拦截或放行，返
回true为放行，即调用控制器方法；返回false表示拦截，即不调用控制器方法
postHandle：控制器方法执行之后执行postHandle()
afterCompletion：处理完视图和模型数据，渲染视图完毕之后执行afterCompletion()

 <mvc:interceptors>
<!--bean和ref标签所配置的拦截器默认对DispatcherServlet处理的所有的请求进行拦截-->
        <bean class="com.atguigu.interceptor.FirstInterceptor"/>   <!--由SpringMVC加载所以不需要id标识符-->
        <ref bean="firstInterceptor"></ref>
        <mvc:interceptor>
            <!--配置需要拦截的请求的请求路径，/**表示所有请求-->
            <mvc:mapping path="/**"/>
            <!--配置需要排除拦截的请求的请求路径-->
            <mvc:exclude-mapping path="/abc"/>
            <!--配置拦截器-->
            <ref bean="firstInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

<mvc:interceptors>
        <ref bean="firstInterceptor"></ref>
        <ref bean="secondInterceptor"></ref>
 </mvc:interceptor>

11.3、多个拦截器的执行顺序

①若每个拦截器的preHandle()都返回true
此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关：
preHandle()会按照配置的顺序执行，而postHandle()和afterCompletion()会按照配置的反序执行
②若某个拦截器的preHandle()返回了false
preHandle()返回false和它之前的拦截器的preHandle()都会执行，postHandle()都不执行，返回false
的拦截器之前的拦截器的afterCompletion()会执行

12、异常处理器

12.1、基于配置的异常处理

SpringMVC提供了一个处理控制器方法执行过程中所出现的异常的接口：HandlerExceptionResolver
HandlerExceptionResolver接口的实现类有：DefaultHandlerExceptionResolver和
SimpleMappingExceptionResolver
SpringMVC提供了自定义的异常处理器SimpleMappingExceptionResolver，使用方式：

<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
        <property name="exceptionMappings">
            <props >
            <!--properties的键表示处理器方法执行过程中出现的异常 properties的值表示若出现指定异常时，
            设置一个新的视图名称，跳转到指定页面 -->
                <!--key设置要处理的异常，value设置出现该异常时要跳转的页面所对应的逻辑视图-->
                <prop key="java.lang.ArithmeticException">error</prop>
            </props>
        </property>
        <!--exceptionAttribute属性设置一个属性名，将出现的异常信息在请求域中进行共享 -->
        <!--设置共享在请求域中的异常信息的属性名-->
        <property name="exceptionAttribute" value="ex"></property>
    </bean>

12.2、基于注解的异常处理

//@ControllerAdvice将当前类标识为异常处理的组件 
@ControllerAdvice 
public class ExceptionController { 

	//@ExceptionHandler用于设置所标识方法处理的异常 
	@ExceptionHandler(ArithmeticException.class) 
	//ex表示当前请求处理中出现的异常对象 
	public String handleArithmeticException(Exception ex, Model model){ 
		model.addAttribute("ex", ex); 
		return "error"; 
} 
}

13、注解配置SpringMVC

使用配置类和注解代替web.xml和SpringMVC配置文件的功能

13.1、创建初始化类，代替web.xml

在Servlet3.0环境中，容器会在类路径中查找实现javax.servlet.ServletContainerInitializer接口的类，
如果找到的话就用它来配置Servlet容器。 Spring提供了这个接口的实现，名为
SpringServletContainerInitializer，这个类反过来又会查找实现WebApplicationInitializer的类并将配
置的任务交给它们来完成。Spring3.2引入了一个便利的WebApplicationInitializer基础实现，名为
AbstractAnnotationConfigDispatcherServletInitializer，当我们的类扩展了
AbstractAnnotationConfigDispatcherServletInitializer并将其部署到Servlet3.0容器的时候，容器会自
动发现它，并用它来配置Servlet上下文。

public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer{
    //设置一个配置类代替Spring的文件
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }

    //设置一个配置类代替SpringMVC的文件
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{WebConfig.class};
    }

    //设置SpringMVC的前端控制器DispatcherServlet的url-pattern
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    protected Filter[] getServletFilters(){
        //创建编码过滤器
        CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
        characterEncodingFilter.setEncoding("UTF-8");
        characterEncodingFilter.setForceEncoding(true);
        //创建处理请求方式的过滤器
        HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
        return new Filter[]{characterEncodingFilter,hiddenHttpMethodFilter};
    }
}

13.2、创建SpringConfig配置类，代替spring的配置文件

@Configuration 
public class SpringConfig { 
	//ssm整合之后，spring的配置信息写在此类中 
}

13.3、创建WebConfig配置类，代替SpringMVC的配置文件

@Configuration 
//扫描组件 
@ComponentScan("com.atguigu.mvc.controller") 
//开启MVC注解驱动 
@EnableWebMvc 
public class WebConfig implements WebMvcConfigurer { 
//使用默认的servlet处理静态资源 
@Override 
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer 
configurer) { 
configurer.enable(); 
}
//配置文件上传解析器 
@Bean 
public CommonsMultipartResolver multipartResolver(){ 
return new CommonsMultipartResolver(); 
}
//配置拦截器 
@Override 
public void addInterceptors(InterceptorRegistry registry) { 
FirstInterceptor firstInterceptor = new FirstInterceptor(); 
registry.addInterceptor(firstInterceptor).addPathPatterns("/**"); 
}
//配置视图控制 
/*@Override 
public void addViewControllers(ViewControllerRegistry registry) { 
registry.addViewController("/").setViewName("index"); 
}*/ 
//配置异常映射 
/*@Override 
public void 
configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) { 
SimpleMappingExceptionResolver exceptionResolver = new 
SimpleMappingExceptionResolver(); 
Properties prop = new Properties(); 
prop.setProperty("java.lang.ArithmeticException", "error"); 
//设置异常映射 
exceptionResolver.setExceptionMappings(prop); 
//设置共享异常信息的键 
exceptionResolver.setExceptionAttribute("ex"); 
resolvers.add(exceptionResolver); 
}*/ 
//配置生成模板解析器 
@Bean 
public ITemplateResolver templateResolver() { 
WebApplicationContext webApplicationContext = 
ContextLoader.getCurrentWebApplicationContext(); 
// ServletContextTemplateResolver需要一个ServletContext作为构造参数，可通过 
WebApplicationContext 的方法获得 
ServletContextTemplateResolver templateResolver = new 
ServletContextTemplateResolver( 
webApplicationContext.getServletContext()); 
templateResolver.setPrefix("/WEB-INF/templates/"); 
templateResolver.setSuffix(".html"); 
templateResolver.setCharacterEncoding("UTF-8"); 
templateResolver.setTemplateMode(TemplateMode.HTML); 
return templateResolver; 
}
//生成模板引擎并为模板引擎注入模板解析器 
@Bean 
public SpringTemplateEngine templateEngine(ITemplateResolver 
templateResolver) { 
SpringTemplateEngine templateEngine = new SpringTemplateEngine(); 
templateEngine.setTemplateResolver(templateResolver); 
return templateEngine; 
}
//生成视图解析器并未解析器注入模板引擎 
@Bean 
public ViewResolver viewResolver(SpringTemplateEngine templateEngine) { 
ThymeleafViewResolver viewResolver = new ThymeleafViewResolver(); 
viewResolver.setCharacterEncoding("UTF-8"); 
viewResolver.setTemplateEngine(templateEngine); 
return viewResolver; 
} 
}

13.4、测试功能

@RequestMapping("/") 
public String index(){ 
	return "index"; 
}