Java SpringMVC 异常处理SimpleMappingExceptionResolver类详解

简介

SpringMVC 提供了多种异常处理方式，其中 SimpleMappingExceptionResolver 是一种简单而常用的方式。SimpleMappingExceptionResolver 可以将抛出的异常映射到指定的视图，从而将异常信息渲染到页面中。

配置

要使用 SimpleMappingExceptionResolver，需要在 SpringMVC 的配置文件中进行配置。可以通过 JavaConfig 或 XMLConfig 的方式配置。

JavaConfig 配置

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    @Bean
    public SimpleMappingExceptionResolver simpleMappingExceptionResolver() {
        SimpleMappingExceptionResolver resolver = new SimpleMappingExceptionResolver();
        Properties mappings = new Properties();
        mappings.setProperty("java.lang.Exception", "error");
        resolver.setExceptionMappings(mappings);
        resolver.setDefaultErrorView("error");
        return resolver;
    }
}

XMLConfig 配置

<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
    <property name="exceptionMappings">
        <props>
            <prop key="java.lang.Exception">error</prop>
        </props>
    </property>
    <property name="defaultErrorView" value="error" />
</bean>

使用

在配置文件中配置完成后，当出现异常时，SimpleMappingExceptionResolver 就会从配置文件中找到对应的视图并将异常信息渲染到页面中。

示例1

假设我们有一个 UserController，其中的一个方法可能会出现异常，我们希望对这个异常进行处理并渲染到一个叫做 error 的视图中。

@Controller
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public String getUser(@PathVariable("id") Long id, Model model) {
        User user = userService.getUserById(id);
        if (user == null) {
            throw new RuntimeException("User not found");
        }
        model.addAttribute("user", user);
        return "user";
    }
}

在上述代码中，getUser 方法可能会抛出一个 RuntimeException，我们希望对这个异常进行处理并将异常信息渲染到一个叫做 error 的视图中，可以在 SimpleMappingExceptionResolver 配置文件中添加以下配置：

mappings.setProperty("java.lang.RuntimeException", "error");

这样当 getUser 方法抛出 RuntimeException 异常时，就会将异常信息渲染到 error 视图中。

示例2

前面我们已经介绍了如何将指定异常映射到特定的视图，但是如果出现未知异常，将会怎样呢？SimpleMappingExceptionResolver 还提供了设置默认视图的方式，即将所有未映射的异常都渲染到该视图中。

我们可以在 SimpleMappingExceptionResolver 配置文件中设置默认视图：

resolver.setDefaultErrorView("defaultError");

这样当出现未映射的异常时，就会将异常信息渲染到 defaultError 视图中。

总结

SimpleMappingExceptionResolver 是一种简单而常用的 SpringMVC 异常处理方式，可以将抛出的异常映射到指定的视图，从而将异常信息渲染到页面中。配置文件使用 JavaConfig 或 XMLConfig 都可以完成配置，同时可以设置默认视图来处理未映射的异常。