java - Spring MVC : How to return custom 404 errorpages?

Question

当找不到请求的资源时，我正在寻找一种干净的方法来在 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 { }

然后使用异常处理程序来呈现自定义错误页面(可能包含指向仪表列表的链接或任何适当的内容)。

但我不喜欢污染我的应用程序，有很多小异常(exception)。

另一种可能性是使用 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";
}

但使用此解决方案，我必须为许多 Controller 方法(如编辑、删除)复制前 5 行。

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

Answer 1

解决方案比想象的要简单得多。可以使用一个通用的 ResourceNotFoundException 定义如下:

public class ResourceNotFoundException extends RuntimeException { }

然后可以使用 ExceptionHandler 注释在每个 Controller 中处理错误:

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";
    }
}

每个 Controller 都可以为 ResourceNotFoundException 定义自己的 ExceptionHandler。