springboot實現restful

1.首先自定義一個接口返回的格式

這裏引入了lombok, org.projectlombok:lombok   這樣在class上加入@Data註解就不用再生成getter，setter方法了，很方便，也很節省代碼

@Data
public class ResponseResult {


    String message;

    Object data;


    public static ResponseResult success(Object data, String msg) {
        ResponseResult result = new ResponseResult();
        result.setMessage(msg);
        result.setData(data);
        return result;
    }


}

2.springboot實現restful格式,這裏採用了ResponseEntity,其中ResponseEntity 是在 org.springframework.http.HttpEntity 的基礎上添加了http status code(http狀態碼)，用於RestTemplate以及@Controller的HandlerMethod。它在Controoler中或者用於服務端響應時，做用是和@ResponseStatus與@ResponseBody結合起來的功能同樣的。用於RestTemplate時，它是接收服務端返回的http status code 和 reason的。

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


@Autowired
UserService userService


    @RequestMapping(value = "/queries", method = RequestMethod.POST)
    @ResponseBody
    public ResponseEntity<ResponseResult> findUserList(@RequestBody InputDto inputDto, HttpServletResponse response) throws AppException {
        List<User> userList=userService.findUsers();
        return ResponseEntity.ok().body(ResponseResult.success(userList, ""));

        //return ResponseEntity.badRequest().body(ResponseResult.success(userList, ""));

        //return ResponseEntity.accepted().body(null);


    }


//當查詢條件過多時，能夠採用post方式來實現，固然最好的方式是查詢的所有用get方式

}

接口返回狀況以下：錯誤碼單獨出來，body體是自定義的ResponseResult，這個能夠自行設定，也能夠不要這個對象。

 

3.restful的經常使用錯誤碼

200 OK  [GET]：服務器成功返回用戶請求的數據，該操做是冪等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數據成功。
202 Accepted - [*]：表示一個請求已經進入後臺排隊（異步任務）
204 NO CONTENT - [DELETE]：用戶刪除數據成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發出的請求有錯誤，服務器沒有進行新建或修改數據的操做，該操做是冪等的。
401 Unauthorized - [*]：表示用戶沒有權限（令牌、用戶名、密碼錯誤）。
403 Forbidden - [*] 表示用戶獲得受權（與401錯誤相對），可是訪問是被禁止的。
404 NOT FOUND - [*]：用戶發出的請求針對的是不存在的記錄，服務器沒有進行操做，該操做是冪等的。
406 Not Acceptable - [GET]：用戶請求的格式不可得（好比用戶請求JSON格式，可是隻有XML格式）。
410 Gone -[GET]：用戶請求的資源被永久刪除，且不會再獲得的。
422 Unprocesable entity - [POST/PUT/PATCH] 當建立一個對象時，發生一個驗證錯誤。
500 INTERNAL SERVER ERROR - [*]：服務器發生錯誤，用戶將沒法判斷髮出的請求是否成功。