Spring MVC Controller返回值及异常的统一处理方法

下面我将为你详细讲解“Spring MVC Controller返回值及异常的统一处理方法”的完整攻略。

一、Controller返回值的处理

在Spring MVC框架中，Controller负责处理客户端的HTTP请求并响应相应的结果给客户端。当客户端请求到达Controller之后，Controller需要根据业务逻辑处理数据，并根据结果返回响应结果给客户端。

1.1 Controller返回String类型

在Controller方法中，如果直接返回一个String类型的结果，则Spring MVC框架将会根据该字符串进行解析，寻找备选的视图(view)名称，并返回与视图名称匹配的视图。例如：

@Controller
public class MyController {

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

}

在上述代码中，当请求路径为“/hello”的请求被发送到MyController的hello方法时，hello方法将返回一个String类型的值“hello”。Spring MVC会将其解析为视图名称“hello”，并返回与之匹配的视图，即视图文件名为“hello.jsp”的视图。

1.2 Controller返回JSON类型

在Web应用程序中，经常需要采用AJAX异步请求获取数据，此时通常使用JSON格式来表示响应数据。Spring MVC框架提供了多种方式实现Controller返回JSON数据。例如：

• 使用@ResponseBody注解，将Java对象转换为JSON格式后返回给客户端：

@Controller
public class MyController {

    @RequestMapping("/user")
    @ResponseBody
    public User getUser() {
        User user = new User();
        user.setName("Tom");
        user.setAge(18);
        return user;
    }

}

在上述代码中，当请求路径为“/user”的请求被发送到MyController的getUser方法时，getUser方法将返回一个Java对象user，Spring MVC会自动将其转换为JSON格式，然后发回给客户端。

• 使用ResponseEntity对象封装响应数据并返回：

@Controller
public class MyController {

    @RequestMapping("/user")
    public ResponseEntity<User> getUser() {
        User user = new User();
        user.setName("Tom");
        user.setAge(18);
        return ResponseEntity.ok(user);
    }

}

在上述代码中，getUser方法将创建一个ResponseEntity对象，该对象封装了响应数据（User对象）以及HTTP状态码等信息。然后，将该对象作为返回值返回给客户端。

二、异常处理

在Web应用程序中，异常的处理非常关键。如果出现异常并不进行处理，则可能会导致程序崩溃，或暴露敏感信息给攻击者。因此，在编写Web应用程序时，需要考虑异常的处理。

在Spring MVC框架中，可以通过@ControllerAdvice注解和@ExceptionHandler注解来实现全局异常处理。

2.1 使用@ControllerAdvice注解

@ControllerAdvice注解是Spring MVC框架提供的一种全局异常处理注解，使用该注解可以统一处理所有Controller中抛出的异常。例如：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ModelAndView handleException(Exception e) {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("exception", e);
        modelAndView.setViewName("error");
        return modelAndView;
    }

}

在上述代码中，GlobalExceptionHandler类使用@ControllerAdvice注解标注，其中handleException方法使用@ExceptionHandler(Exception.class)注解来指定要处理的异常类型。当Controller方法抛出Exception异常时，handleException方法将会自动被调用，处理该异常并返回错误视图。

2.2 使用@ExceptionHandler注解

@ExceptionHandler注解是一种局部异常处理注解，使用该注解可以针对某个Controller中的异常进行单独处理。例如：

@Controller
public class MyController {

    @RequestMapping("/user/{id}")
    public String getUser(@PathVariable("id") Long id) throws UserNotFoundException {
        User user = userService.getUserById(id);
        if (user == null) {
            throw new UserNotFoundException("User not found with id " + id);
        }
        return "user";
    }

    @ExceptionHandler(UserNotFoundException.class)
    public ModelAndView handleException(UserNotFoundException e) {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("exception", e);
        modelAndView.setViewName("error");
        return modelAndView;
    }

}

在上述代码中，MyController中的getUser方法抛出了UserNotFoundException异常，而handleException方法使用@ExceptionHandler(UserNotFoundException.class)注解来处理该异常。当getUser方法抛出UserNotFoundException异常时，handleException方法将会自动被调用，处理该异常并返回错误视图。

2.3 示例说明

下面我来举例说明全局异常处理和局部异常处理的不同使用情况。

2.3.1 全局异常处理示例

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ModelAndView handleException(Exception e) {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("exception", e);
        modelAndView.setViewName("error");
        return modelAndView;
    }

}

在上述代码中，使用@ControllerAdvice注解标注了一个全局异常处理类GlobalExceptionHandler。然后，在该类中定义了handleException方法来处理所有Controller方法抛出的Exception异常。在该方法中，将异常信息存储到modelAndView对象中，并设置错误视图为“error.jsp”。当Controller方法抛出Exception异常时，该方法将自动被调用处理该异常，并返回错误视图。

在这种方式下，如果Web应用程序中的多个Controller方法需要统一处理相同的异常，则只需要将异常处理逻辑集中到一个全局异常处理类中即可，无需在每个Controller中都重复编写异常处理逻辑。

2.3.2 局部异常处理示例

@Controller
public class MyController {

    @RequestMapping("/user/{id}")
    public String getUser(@PathVariable("id") Long id) throws UserNotFoundException {
        User user = userService.getUserById(id);
        if (user == null) {
            throw new UserNotFoundException("User not found with id " + id);
        }
        return "user";
    }

    @ExceptionHandler(UserNotFoundException.class)
    public ModelAndView handleException(UserNotFoundException e) {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("exception", e);
        modelAndView.setViewName("error");
        return modelAndView;
    }

}

在上述代码中，定义了一个MyController类，并在其中定义了一个getUser方法用来处理“/user/{id}”路径的请求。在该方法中，如果根据id查询不到对应的用户，则抛出UserNotFoundException异常。此时，将使用@ExceptionHandler(UserNotFoundException.class)注解来标识handleException方法来处理UserNotFoundException异常。在该方法中，将异常信息存储到modelAndView对象中，并设置错误视图为“error.jsp”。当getUser方法抛出UserNotFoundException异常时，该方法将自动被调用处理该异常，并返回错误视图。

在这种方式下，如果Web应用程序中的某些Controller方法需要单独处理某些异常，则可以使用该方式单独为某个Controller方法定义异常处理逻辑，而不必将所有的异常处理逻辑集中到一个全局异常处理类中。