弹簧MVC Rest服务控制器与错误处理完成正确吗？

rest java spring spring-mvc

2022-09-01 18:25:53

我想知道如何正确实现应该用作REST服务的Spring控制器。特别是我想尝试使界面尽可能地RESTful。我也想利用HTTP错误代码，以便我的客户可以采取相应的行动。

我想知道如何实现我的方法，所以如果一切正常（在响应的正文中），他们会返回JSON，或者抛出一个http错误代码以及它不起作用的自定义原因（可能是来自DAO或数据库的错误）。但是，我不确定哪一个是正确的方法？返回一个字符串并添加值以返回到模型，还是返回一个HashMap并将我的东西放在那里？还是直接返回对象？但是，如果发生错误并且我无法返回所述类怎么办？是否返回空值？我发布了2-3种我可以想象的方法：

@RequestMapping(value="/addUser", method= RequestMethod.POST)
public String addUser(@RequestBody User user, HttpServletResponse response, Model model) throws Exception{

    try{
        userService.addUser(user);
        model.addAttribute("user", userService.getUser(user.getUsername(), user.getPassword()));
        return "user";
    }catch(Exception e){
        model.addAttribute("error", e.toString());
        response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.toString());
        return "error";
    }
}

或者更确切地说，是这样：

@RequestMapping(value="/addUser", method= RequestMethod.POST)
public @ResponseBody Map addUser(@RequestBody User user, HttpServletResponse response){
    Map map = new HashMap();
    try{
        userService.addUser(user);
        map.put("success", true);
        map.put("username", user.getUsername());
    }catch (KeyAlreadyExistsException e){
        map.put("success", false);
        map.put("Error", e.toString());
        response.sendError(HttpServletResponse.SC_FORBIDDEN, e.toString());
    }catch(Exception e){
        map.put("success", false);
        map.put("Error", e.toString());
        response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.toString());
    }
    finally {
        return map;
    }
}

我意识到代码不是“恰到好处的”，但我不知道如何让它成为它需要的样子。也许一些经验的回应会有所帮助？THX已经支持

答案 1

您还可以在 Rest 控制器中使用带注释的 methos 来捕获异常。@ExceptionHandler

@ExceptionHandler(Exception.class)
@ResponseBody
@ResponseStatus(value = HttpStatus.BAD_REQUEST)
public String handleException(Exception e) {
    return "return error object instead";
}

这将使您的 acutal 控制器/业务逻辑更干净。

答案 2

首先，我认为在返回JSON时应该始终返回一个对象。即使有些事情出了可怕的错误。

当出现问题时，您只需设置并返回描述错误的资源即可。response.setStatus()

public class ErrorResource implements Resource {
    private final int status;
    private final String message;

    public ErrorResource(int s, String m) {
        status = s;
        message = m;
    }

    public int getStatus() {
        return status;
    }

    public String getMessage() {
        return message;
    }
}

资源被序列化，结果将是

{"status":500, "message":"Yay!"}

使用 will 工作，但我想建议你编写一些资源类来定义要返回的对象。它们将更容易维护。不要提供任何结构，而结构是创建REST服务时非常重要的部分。MapMaps

我不认为您应该返回嵌入原始异常消息的资源。它可能会泄露您不希望任何人看到的信息。