Spring MVC：如何返回自定义404错误页面？

Z时代
2024-01-10
分类：问答

我正在寻找一种干净的方法，当找不到请求的资源时，在Spring 4中返回自定义的404错误页面。对不同域类型的查询应导致不同的错误页面。

这里有一些代码可以表明我的意图（Meter是一个域类）：

@RequestMapping(value = "/{number}", method = RequestMethod.GET)
public String getMeterDetails(@PathVariable("number") final Long number, final Model model) {
    final Meter result = meterService.findOne(number);
    if (result == null) {
        // here some code to return an errorpage
    }
    model.addAttribute("meter", result);
    return "meters/details";
}

我想象有几种解决问题的方法。首先，有可能创建RuntimeException像

@ResponseStatus(HttpStatus.NOT_FOUND)
public class MeterNotFoundExcption extends RuntimeException { }

然后使用异常处理程序呈现自定义错误页面（可能包含指向仪表列表的链接或适当的链接）。

但是我不喜欢使用许多小异常来污染我的应用程序。

另一种可能性是HttpServletResponse手动使用和设置状态码：


@RequestMapping(value = "/{number}", method = RequestMethod.GET)
public String getMeterDetails(@PathVariable("number") final Long number, final Model model,
final HttpServletResponse response) {
    final Meter meter = meterService.findOne(number);
    if (meter == null) {
        response.setStatus(HttpStatus.NOT_FOUND.value());
        return "meters/notfound";
    }
    model.addAttribute("meter", meter);
    return "meters/details";
}

但是，使用此解决方案，我必须为许多控制器方法（如编辑，删除）复制前5行。

有没有一种优雅的方法可以防止重复复制这些行？

回答：

解决方案比想像的要简单得多。可以使用一种通用ResourceNotFoundException定义，如下所示：

public class ResourceNotFoundException extends RuntimeException { }

那么一个人可以通过ExceptionHandler注释处理每个控制器中的错误：

class MeterController {
    // ...
    @ExceptionHandler(ResourceNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public String handleResourceNotFoundException() {
        return "meters/notfound";
    }
    // ...
    @RequestMapping(value = "/{number}/edit", method = RequestMethod.GET)
    public String viewEdit(@PathVariable("number") final Meter meter,
                           final Model model) {
        if (meter == null) throw new ResourceNotFoundException();
        model.addAttribute("meter", meter);
        return "meters/edit";
    }
}