從Spring控制器方法發送Json響應的最佳做法

Question

我想從Spring控制器返回一個字符串（json字符串）作爲對它接收的AJAX調用的響應，響應可能會根據我是否具有@Valid窗體而有所不同提交。這是我如何處理它，並想知道這是否被認爲是最佳做法？ 請注意我正在使用@RestController，因此@ResonseBody應用所有方法。

@RequestMapping(value = "/save" , method = RequestMethod.POST) 
public String saveScheduledAlert(@Valid ScheduledAlertForm scheduledAlertForm, BindingResult bindingResult) { 
    StringBuilder jsonString = new StringBuilder(); 
    if(bindingResult.hasErrors()){ 
     jsonString.append("{\"success\" : \"false\""); 
     for(ObjectError error : bindingResult.getAllErrors()) 
      jsonString.append(",\"").append(((FieldError) error).getField()).append("\":\"").append(error.getDefaultMessage()).append("\""); 
    } else { 
     //save the data 
     jsonString.append("{\"success\" : \"true\""); 
    } 

    jsonString.append("}"); 
    return jsonString.toString(); 


} 

Answer 1

所以基本上你想要做的是產生2層的POJO

public class RestWrapperDTO { 
    protected boolean success; 
    public boolean isSuccess() { 
     return success; 
    } 
    public void setSuccess(boolean value) { 
     success = value 
    } 
} 

和其他錯誤DTO

public class RestErrorDTO extends RestWrapperDTO { 
    private Map<String, String> errors; 

    public Map<String, String> getErrors() { 
     return errors; 
    } 
    public void setErrors(Map<String, String> value) { 
     errors = value 
    } 
} 

和控制器

@RequestMapping(value = "/save" , method = RequestMethod.POST) 
public RestWrapperDTO saveScheduledAlert(@Valid ScheduledAlertForm scheduledAlertForm, BindingResult bindingResult) { 
    StringBuilder jsonString = new StringBuilder(); 

    if(bindingResult.hasErrors()){ 
     RestErrorDTO errorDTO = new RestErrorDTO(); 
     // fill map with errors here 
     return errorDTO; 
    } else { 
     RestWrapperDTO wrapperDTO = new RestWrapperDTO(); 
     wrapperDTO.setSuccess(true); 
     return wrapperDTO; 
    } 
} 

它不是最充分的代碼，bu t將其應該幫助你：d

如果您使用的是簡單的註解@Controller - 你是什麼 尋找的是@ResponseBody -annotation

，或者如果您使用的不是這個@RestController已經可以

你可以簡單地返回一個帶有Seri​​alizable接口的對象 - 一個簡單的POJO和一個 和spring將處理其餘的。

如需進一步讀數：

• https://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html#mvc-ann-responsebody
• How exactly works the Spring @ResponseBody annotation in this RESTful application example?
• 對於@RestController次要解釋Difference between spring @Controller and @RestController annotation

Answer 2

創建POJO如下給出：

public class SuccessPOJO{ 
private String success; 

..... 
getters and setters 
..... 
} 

現在您可以設置成功消息的值並返回此SuccessPOJO對象。在瀏覽器中，您將收到帶有成功消息的JSON格式化對象！