SpringMVC - 异常/文件篇
目录
指路：SpringMVC - 方法/参数篇
指路：SpringMVC - 入门篇
1 异常处理
SpringMVC框架常用@ExceptionHandler注解处理异常。
1.1 @ExceptionHandler 注解
@ExceptionHandler可以将一个方法指定为异常处理方法。- 被注解的方法，其返回值可以是
ModelAndView、String或void，方法名随意，方法参数可以是Exception及其子类对象、HttpServletRequest、HttpServletResponse等。系统会自动为这些方法参数赋值。 - 对于异常处理注解的用法，也可以直接将异常处理方法注解于
Controller之中.
1.2 实现步骤
1.2.1 自定义异常类
/**
* 异常类
*
* @author murphy
*/
public class UserException extends Exception {
public UserException() {
}
public UserException(String message) {
super(message);
}
}
// ----------------------------------------------------
/**
* 用户ID异常
*
* @author murphy
*/
public class UserIdException extends UserException {
public UserIdException() {
}
public UserIdException(String message) {
super(message);
}
}
// ----------------------------------------------------
/**
* 用户姓名异常
*
* @author murphy
*/
public class UserNameException extends UserException {
public UserNameException() {
}
public UserNameException(String message) {
super(message);
}
}
编写控制器
/**
* 异常控制器
* 测试异常处理的控制器
* @author murphy
*/
@Controller
@RequestMapping("ex")
public class ExController {
@RequestMapping("test01/{id}/{name}")
public ModelAndView test01(@PathVariable("id") Integer userId,@PathVariable("name") String userName) throws UserNameException, UserIdException {
ModelAndView mv = new ModelAndView();
if (userId <= 1000) {
throw new UserIdException("userId不合法！必须在1000以上");
}
if ("test".equals(userName)){
throw new UserNameException("userName不合法！不能使用test");
}
// System.out.println(10/0);
mv.setViewName("ok");
return mv;
}
@ExceptionHandler(value = {UserIdException.class, UserNameException.class, Exception.class})
public ModelAndView exHandler(Exception ex) {
ModelAndView mv = new ModelAndView();
mv.addObject("e",ex.getMessage());
if (ex instanceof UserIdException) {
mv.setViewName("idError");
} else if (ex instanceof UserNameException) {
mv.setViewName("nameError");
} else {
mv.setViewName("error");
}
return mv;
}
}
编写error.jsp、idError.jsp、nameError.jsp页面
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Error</title>
</head>
<body>
<h2>出错啦！</h2>
</body>
</html>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Error</title>
</head>
<body>
<h2>出错啦！</h2>
<h5>userId Error !</h5>
</body>
</html>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Error</title>
</head>
<body>
<h2>出错啦！</h2>
<h5>userName Error !</h5>
</body>
</html>
测试：
http://localhost:8080/ex/test01/100/test1
http://localhost:8080/ex/test01/1004/test
http://localhost:8080/ex/test01/1001/test1
1.3 优化
- 一般将异常处理方法专门定义在一个类中，作为全局的异常处理类。
- 使用注解
@ControllerAdvice，就是“控制器增强”，是给控制器对象增强功能的。使用@ControllerAdvice修饰的类中可以使用@ExceptionHandler。 - 当使用
@RequestMapping注解修饰的方法抛出异常时，会执行@ControllerAdvice修饰的类中的异常处理方法。 @ControllerAdvice注解所在的类需要进行包扫描，否则无法创建对象。
<context:component-scan base-package="com.murphy.exceptions"/>
定义全局异常处理类：
/**
* 自定义全局异常处理类
*
* @author murphy
*/
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(value = UserIdException.class)
public ModelAndView exHandlerId(Exception ex) {
ModelAndView mv = new ModelAndView();
mv.addObject("e",ex.getMessage());
mv.setViewName("idError");
return mv;
}
@ExceptionHandler(value = UserNameException.class)
public ModelAndView exHandlerName(Exception ex) {
ModelAndView mv = new ModelAndView();
mv.addObject("e",ex.getMessage());
mv.setViewName("nameError");
return mv;
}
@ExceptionHandler(value = Exception.class)
public ModelAndView exHandler(Exception ex) {
ModelAndView mv = new ModelAndView();
mv.addObject("e",ex.getMessage());
mv.setViewName("error");
return mv;
}
}
2 拦截器
- SpringMVC中的拦截器（
Interceptor）是非常重要的，它的主要作用是拦截指定的用户请求，并进行相应的预处理与后处理。 - 拦截的时间点在“处理器映射器
HandlerMapping根据用户提交的请求映射出了所要执行的处理器类，并且也找到了要执行该处理器类的处理器适配器，在处理器适配器HandlerAdaptor执行处理器之前”。 - 在处理器映射器映射出所要执行的处理器类时，已经将拦截器与处理器组合为了一个处理器执行链
HandlerExecutionChain，并返回给了前端控制器。
自定义拦截器，需要实现HandlerInterceptor接口。而该接口中含有三个方法：
2.1 自定义拦截器
-
preHandle(request,response, Object handler)：该方法在处理器方法执行之前执行。其返回值为
boolean，若为true，则紧接着会执行处理器方法，且会将afterCompletion()方法放入到一个专门的方法栈中等待执行。 -
postHandle(request,response, Object handler,modelAndView)：该方法在处理器方法执行之后执行。处理器方法若最终未被执行，则该方法不会执行。由于该方法是在处理器方法执行完后执行，且该方法参数中包含
ModelAndView，所以该方法可以修改处理器方法的处理结果数据，且可以修改跳转方向。 -
afterCompletion(request,response, Object handler, Exception ex)：当
preHandle()方法返回true时，会将该方法放到专门的方法栈中，等到对请求进行响应的所工作完成之后才执行该方法。即该方法是在前端控制器渲染（数据填充）了响应页面之后执行的，此时对ModelAndView再操作也对响应无济于事。afterCompletion最后执行的方法，清除资源，例如在Controller方法中加入数据
/**
* 自定义拦截器
*
* @author murphy
*/
public class MyInterceptor implements HandlerInterceptor {
/**
* 执行时机：控制器方法执行之前，ModelAndView返回之前
* 使用场景：登录验证
* @param request
* @param response
* @param handler
* @return true：继续执行控制器方法，表示放行 ｜ false：不会继续执行控制器方法，表示拦截
* @throws Exception
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("preHandle - ");
return true;
}
/**
* 执行时间：控制器方法执行之后，在ModelAndView返回之前，有机会修改返回值
* 使用场景：日志记录，记录登录的IP、时间
* @param request
* @param response
* @param handler
* @param modelAndView
* @throws Exception
*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("postHandler - ");
}
/**
* 执行时间：控制器方法执行之后，在ModelAndView返回之后，没有机会修改返回值
* 使用场景：全局资源的一些操作
* @param request
* @param response
* @param handler
* @param ex
* @throws Exception
*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("afterCompletion - ");
}
}
2.2 配置拦截器
在springmvc.xml中添加如下配置
<!-- 配置拦截器 -->
<mvc:interceptors>
<!-- 这里可以同时配置多个拦截器，配置的顺序就是拦截器的拦截顺序 -->
<mvc:interceptor>
<!-- 拦截器要拦截的请求路径 拦截所有用/** -->
<mvc:mapping path="/**"/>
<!-- 指定干活的拦截器 -->
<bean class="com.murphy.interceptor.MyInterceptor" id="myInterceptor"></bean>
</mvc:interceptor>
<mvc:interceptor>
<mvc:mapping path="/**"/>
<bean class="com.murphy.interceptor.MyInterceptor2" id="myInterceptor2"></bean>
</mvc:interceptor>
</mvc:interceptors>
如果有多个拦截器的时候:
preHandle：按照配置前后顺序执行
postHandle：按照配置前后逆序执行
afterCompletion：按照配置前后逆序执行
3 文件上传和下载
- Spring MVC为文件上传提供了直接支持，这种支持是通过即插即用的
MultipartResolver实现. - Spring中有一个
MultipartResolver的实现类：CommonsMultipartResolver。 - 在SpringMVC上下文中默认没有装配
MultipartResolver，因此默认情况下不能处理文件上传工作。 - 如果想使用Spring的文件上传功能，则需要先在上下文中配置
MultipartResolver。
3.1 文件上传
- 添加依赖
<!-- 文件上传 -->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.4</version>
</dependency>
springmvc.xml文件中配置MultipartResolver：
<!-- 文件上传 -->
<bean class="org.springframework.web.multipart.commons.CommonsMultipartResolver" id="multipartResolver"></bean>
fileHandle.jsp页面表单
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>文件操作</title>
</head>
<body>
<form action="/file/upload" method="post" enctype="multipart/form-data">
请选择文件：<input type="file" name="myFile"/><br/>
<button type="submit">上传文件</button>
</form>
</body>
</html>
- 配置Java代码 (注意要创建文件夹保存上传之后的文件)
/**
* 文件操作的控制器
*
* @author murphy
*/
@Controller
@RequestMapping("file")
public class FileController {
/**
* 文件上传
* @param myFile
* @param request
* @return
*/
@RequestMapping("upload")
public String upload(@RequestParam("myFile") MultipartFile myFile, HttpServletRequest request) {
// 获取文件的原始名称
String originalFilename = myFile.getOriginalFilename();
// 实际开发中需要将文件重新命名进行存储
// 存储到服务器的文件名称 = 随机的字符串 + 根据实际名称获取到源文件的后缀
String fileName = UUID.randomUUID().toString().replace("-","") + originalFilename.substring(originalFilename.lastIndexOf("."));
System.out.println(fileName);
// 文件的存储路径
String realPath = request.getServletContext().getRealPath("/uploadFile") + "/";
// 真正的文件上传到服务器的指定位置
try {
myFile.transferTo(new File(realPath + fileName));
System.out.println("上传成功" + realPath + fileName);
} catch (IOException e) {
e.printStackTrace();
}
return "ok";
}
@RequestMapping("hello")
public String hello() {
return "fileHandle";
}
}
优化：如果需要限定文件的大小和类型：
<!-- 配置拦截器 -->
<mvc:interceptors>
<mvc:interceptor>
<mvc:mapping path="/**"/>
<bean class="com.murphy.interceptor.FileInterceptor" id="fileInterceptor"></bean>
</mvc:interceptor>
</mvc:interceptors>
<!-- 文件上传 -->
<bean class="org.springframework.web.multipart.commons.CommonsMultipartResolver" id="multipartResolver">
<!-- 文件上传的大小限制，以字节B为单位 5M-1024*1024*5B -->
<property name="maxUploadSize" value="5242880"/>
<!-- 默认的编码格式 -->
<property name="defaultEncoding" value="UTF-8"/>
</bean>
/**
* 文件后缀处理的拦截器
*
* @author murphy
*/
public class FileInterceptor implements HandlerInterceptor {
/**
* 在文件上传之前判定文件后缀是否合法 - 只能上传图片
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 判断是否是文件上传的请求
boolean flag = true;
if (request instanceof MultipartHttpServletRequest) {
MultipartHttpServletRequest multipartRequest = (MultipartHttpServletRequest) request;
Map<String, MultipartFile> fileMap = multipartRequest.getFileMap();
// 遍历文件
Iterator<String> iterator = fileMap.keySet().iterator();
while (iterator.hasNext()) {
String key = iterator.next();
MultipartFile file = multipartRequest.getFile(key);
String originalFilename = file.getOriginalFilename();
String hz = originalFilename.substring(originalFilename.lastIndexOf("."));
// 判断后缀是否合法
if (!hz.toLowerCase().equals(".png") && !hz.toLowerCase().equals(".jpg")) {
request.getRequestDispatcher("/jsp/fileTypeError.jsp").forward(request,response);
flag = false;
}
}
}
return flag;
}
}
上传文件类型错误跳转的页面fileError.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>FileError</title>
</head>
<body>
<h3>文件上传类型出错啦！后缀必须是 .jpg 或者 .png</h3>
</body>
</html>
3.2 文件下载
- 前端页面
<form action="/file/download" method="post" enctype="multipart/form-data">
<button type="submit">下载图片 - 254192c4d5fd425b8de6d99269e0e64d.png</button>
</form>
- 配置处理类方法
@RequestMapping("download")
public ResponseEntity<byte[]> download(HttpServletRequest request) throws IOException {
// 指定文件的路径
String path = request.getServletContext().getRealPath("/uploadFile") + "/254192c4d5fd425b8de6d99269e0e64d.png";
// 创建响应的头信息的对象
HttpHeaders headers = new HttpHeaders();
// 标记以流的方式作出响应
headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
// 以附件的形式响应给用户
headers.setContentDispositionFormData("attachment", URLEncoder.encode("254192c4d5fd425b8de6d99269e0e64d.png","utf-8"));
File file = new File(path);
ResponseEntity<byte[]> resp = new ResponseEntity<>(FileUtils.readFileToByteArray(file),headers, HttpStatus.CREATED);
return resp;
}
582
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
