Cách phản hồi với mã trạng thái HTTP trong lớp Spring MVC @RestController @ResponseBody trả về một đối tượng?

Question

Tôi đang cố gắng để có một @RestController mất @PathVariable trả về một đối tượng cụ thể ở định dạng JSON, cùng với mã trạng thái thích hợp. Cho đến nay, mã này sẽ trả về đối tượng ở định dạng JSON vì nó đang sử dụng Spring 4 được xây dựng trong thư viện Jackson theo mặc định.

Tuy nhiên tôi không biết cách tạo nó để người dùng nói rằng chúng tôi muốn biến api, sau đó là dữ liệu JSON, sau đó mã lỗi (Hoặc mã thành công tùy thuộc vào mọi thứ đều ổn). đầu ra ví dụ sẽ là:

Vui lòng nhập giá trị api như tham số (LƯU Ý này có thể ở JSON cũng như nếu cần thiết)

{ "id": 2, "api": "3000105000" ... } (LƯU Ý này sẽ là đối tượng phản ứng JSON)

Status mã 400 (OR mã trạng thái thích hợp)

---

url với tham số trông giống như

này 012.

http://localhost:8080/gotech/api/v1/api/3000105000 

Code tôi có cho đến nay:

@RestController 
@RequestMapping(value = "/api/v1") 
public class ClientFetchWellDataController { 

    @Autowired 
    private OngardWellService ongardWellService; 

    @RequestMapping(value = "/wells/{apiValue}", method = RequestMethod.GET) 
    @ResponseBody 
    public OngardWell fetchWellData(@PathVariable String apiValue){ 
     try{ 
      OngardWell ongardWell = new OngardWell(); 
      ongardWell = ongardWellService.fetchOneByApi(apiValue); 

      return ongardWell; 
     }catch(Exception ex){ 
      String errorMessage; 
      errorMessage = ex + " <== error"; 
      return null; 
     } 
    } 
} 

Answer 1

Một @RestController là không thích hợp cho việc này. Nếu bạn cần trả lại các loại phản hồi khác nhau, hãy sử dụng ResponseEntity<?> nơi bạn có thể đặt mã trạng thái một cách rõ ràng.

body của số ResponseEntity sẽ được xử lý theo cách tương tự như giá trị trả lại của bất kỳ phương thức được chú thích nào là @ResponseBody.

@RequestMapping(value = "/wells/{apiValue}", method = RequestMethod.GET) 
public ResponseEntity<?> fetchWellData(@PathVariable String apiValue){ 
    try{ 
     OngardWell ongardWell = new OngardWell(); 
     ongardWell = ongardWellService.fetchOneByApi(apiValue); 

     return new ResponseEntity<>(ongardWell, HttpStatus.OK); 
    }catch(Exception ex){ 
     String errorMessage; 
     errorMessage = ex + " <== error"; 
     return new ResponseEntity<>(errorMessage, HttpStatus.BAD_REQUEST); 
    } 
} 

---

Lưu ý rằng bạn không cần @ResponseBody trên một phương pháp @RequestMapping trong một lớp chú thích @RestController.

Answer 2

Cách thành ngữ sẽ là sử dụng trình xử lý ngoại lệ thay vì bắt ngoại lệ trong phương thức xử lý yêu cầu thông thường của bạn. Loại ngoại lệ xác định mã phản hồi. (403 đối với lỗi bảo mật, 500 đối với trường hợp ngoại lệ nền tảng không mong muốn, bất kể bạn thích gì)

@ExceptionHandler(MyApplicationException.class) 
@ResponseStatus(HttpStatus.BAD_REQUEST) 
public String handleAppException(MyApplicationException ex) { 
    return ex.getMessage(); 
} 

@ExceptionHandler(Exception.class) 
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) 
public String handleAppException(Exception ex) { 
    return ex.getMessage(); 
}