Spring ResponseEntity最佳实践

Question

总的来说，我对RESTful web服务是新手，正在学习web服务的Spring实现。

我特别感兴趣的是学习如何在我的大多数用例中正确地使用ResponseEntity返回类型。

/myapp/user/{id}

Answer 1

您不需要使用通用Pojo，使用RequestMapping可以为每个Http代码创建不同的响应。在这个例子中，我展示了如何控制错误并给出相应的响应。

这是具有服务规范的RestController

@RestController
public class User {

    @RequestMapping(value="/myapp/user/{id}", method = RequestMethod.GET)
    public ResponseEntity<String> getId(@PathVariable int id){

        if(id>10)
            throw new UserNotFoundException("User not found");

        return ResponseEntity.ok("" + id);
    }

    @ExceptionHandler({UserNotFoundException.class})
    public ResponseEntity<ErrorResponse> notFound(UserNotFoundException ex){

        return new ResponseEntity<ErrorResponse>(
            new ErrorResponse(ex.getMessage(), 404, "The user was not found") , HttpStatus.NOT_FOUND);
    }
}

在getId方法中有一个小的逻辑，如果customerId<10，它应该响应Customer Id作为body消息的一部分，但是当Customer大于10时，应该抛出一个异常。在这种情况下，服务应该用ErrorResponse响应。

public class ErrorResponse {

    private String message;
    private int code;
    private String moreInfo;

    public ErrorResponse(String message, int code, String moreInfo) {
        super();
        this.message = message;
        this.code = code;
        this.moreInfo = moreInfo;
    }

    public String getMessage() {

        return message;
    }

    public int getCode() {

        return code;
    }

    public String getMoreInfo() {

        return moreInfo;
    }
}

最后，我对“未找到”错误使用了一个特定的异常

public class UserNotFoundException extends RuntimeException {

    public UserNotFoundException(String message) {
        super(message);
    }
}