SpringBoot中Controller參數(shù)與返回值的用法總結(jié)

更新時間：2023年07月19日 08:46:36 作者：水能zai舟

這篇文章主要介紹了SpringBoot中Controller參數(shù)與返回值的用法，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

SpringBoot中Controller參數(shù)與返回值的用法

注解

類注解一律使用@RestController，方法注解是實際情況而定。

返回值

SpringBoot在實際后端開發(fā)中一般要為前端提供的數(shù)據(jù)是以json格式返回，其返回值類型我們大多采用以下方式

public Map<String, Object> function() {
? ? Map<String, Object> modelMap = new HashMap<>();
? ? //...我們將從數(shù)據(jù)中中獲取的值放入value
? ? modelMap.put("key", value);
? ? return modelMap;
}

接收參數(shù)

普通參數(shù)

普通參數(shù)可以使用RESTful風格返回值，路由中注明{param}，注意@PathVariable注解的使用

? ? @RequestMapping("/route/{param}")
? ? public Map<String, Object> queryAreaById(@PathVariable("param") Integer param) {
? ? ? ? Map<String, Object> modelMap = new HashMap<>();
? ? ? ? //...do something with param, save data in value
? ? ? ? modelMap.put("key", value);
? ? ? ? return modelMap;
? ? }

接收前端對象類型參數(shù)（json格式），對參數(shù)使用@RequestBody注解

? ? @RequestMapping(value = "/route", method = RequestMethod.POST)
? ? public Map<String, Object> updateArea(@RequestBody XObject xObject) {
? ? ? ? Map<String, Object> modelMap = new HashMap<>();
? ? ? ? //...do something with xObject, save data in value
? ? ? ? modelMap.put("key", value);
? ? ? ? return modelMap;
? ? }

springboot controller統(tǒng)一的接口返回值和異常處理

返回結(jié)果模型

@ApiModel("返回結(jié)果模型")
public class JsonResult<T> implements Serializable {
?? ?@ApiModelProperty("返回結(jié)果提示")
?? ?private String msg = null;
?? ?@ApiModelProperty("返回結(jié)果狀態(tài)")
?? ?private String status = null;
?? ?@ApiModelProperty("返回結(jié)果數(shù)據(jù)")
?? ?private T result = null;
?? ?public String getStatus() {
?? ??? ?return status;
?? ?}
?? ?public void setStatus(String status) {
?? ??? ?this.status = status;
?? ?}
?? ?public T getResult() {
?? ??? ?return result;
?? ?}
?? ?public void setResult(T result) {
?? ??? ?this.result = result;
?? ?}
?? ?public String getMsg() {
?? ??? ?return msg;
?? ?}
?? ?public void setMsg(String msg) {
?? ??? ?this.msg = msg;
?? ?}
?? ?public JsonResult(){
?? ?}
?? ?public JsonResult(String status, String msg, T result){
?? ? ? ?this.status = status;
?? ? ? ?this.msg = msg;
?? ? ? ?this.result = result;
? ? }
? ? public JsonResult(String status, String msg){
? ? ? ? this.status = status;
? ? ? ? this.msg = msg;
? ? }
? ? public JsonResult(ResultEnum resultEnum){
?? ??? ?this.status = resultEnum.getStatus();
?? ??? ?this.msg = resultEnum.getMsg();
?? ?}
?? ?public JsonResult(ResultEnum resultEnum, T result){
?? ??? ?this.status = resultEnum.getStatus();
?? ??? ?this.msg = resultEnum.getMsg();
?? ??? ?this.result = result;
?? ?}
}

返回編碼枚舉類模型

/**
?* @author code
?* @version 1.0
?* @Date 2021/8/9 13:55
?* @Description ${DESCRIPTION}
?*/
public enum ResultEnum {
? ? SUCCESS("ok","調(diào)用成功"),
? ? ERROR("error","調(diào)用失敗");
? ? private String status;
? ? private String msg;
? ? public String getStatus() {
? ? ? ? return status;
? ? }
? ? public void setStatus(String status) {
? ? ? ? this.status = status;
? ? }
? ? public String getMsg() {
? ? ? ? return msg;
? ? }
? ? public void setMsg(String msg) {
? ? ? ? this.msg = msg;
? ? }
? ? ResultEnum(String status,String msg){
? ? ? ? this.status = status;
? ? ? ? this.msg = msg;
? ? }
}

返回結(jié)果工具類

/**
?* @author code
?* @version 1.0
?* @Date 2021/7/22 15:50
?* @Description ${DESCRIPTION}
?*/
@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel("數(shù)據(jù)返回結(jié)果")
public class ResultUtil<T> {
? ? public static JsonResult success(){
? ? ? ? return new JsonResult(ResultEnum.SUCCESS);
? ? }
? ? public static JsonResult success(String msg){
? ? ? ? return new JsonResult(ResultEnum.SUCCESS.getStatus(),msg);
? ? }
? ? public static <T> JsonResult<T> success(T result){
? ? ? ? return new JsonResult<T>(ResultEnum.SUCCESS, result);
? ? }
? ? public static JsonResult error(){
? ? ? ? return new JsonResult(ResultEnum.ERROR);
? ? }
? ? public static JsonResult error(String msg){
? ? ? ? return new JsonResult(ResultEnum.ERROR.getStatus(),msg);
? ? }
? ? public static <T> JsonResult error(T result){
? ? ? ? return new JsonResult<T>(ResultEnum.ERROR, result);
? ? }
}

controller統(tǒng)一處理返回值

/**
?* @author code
?* @version 1.0
?* @Date 2021/8/9 15:30
?* @Description ${統(tǒng)一返回值}
?*/
@RestControllerAdvice
public class ControllerHandleAdvice implements ResponseBodyAdvice<Object> {
? ? private final static Logger logger = LoggerFactory.getLogger(ControllerHandleAdvice.class);
? ? @Override
? ? public boolean supports(MethodParameter methodParameter, Class<?extends HttpMessageConverter<?>> converterType){
? ? ? ? return true;
? ? }
? ? @Override
? ? public Object beforeBodyWrite(Object body, MethodParameter methodParameter, MediaType mediaType, Class<?extends HttpMessageConverter<?>> converterType, ServerHttpRequest request, ServerHttpResponse response){
? ? ? ? if(body instanceof String){
? ? ? ? ? ? String msg = (String) body;
? ? ? ? ? ? return ResultUtil.success(msg);
? ? ? ? } else if(null == body) {
? ? ? ? }
? ? ? ? return body;
? ? }
}

controller統(tǒng)一異常處理

/**
?* @author code
?* @version 1.0
?* @Date 2021/8/9 10:56
?* @Description ${統(tǒng)一異常返回值}
?*/
@RestControllerAdvice
public class ControllerExceptionHandleAdvice {
? ? private final static Logger logger = LoggerFactory.getLogger(ControllerExceptionHandleAdvice.class);
? ? @ExceptionHandler
? ? public JsonResult handler(HttpServletRequest request, HttpServletResponse response,Exception e){
? ? ? ? logger.info("restful請求異常");
? ? ? ? JsonResult jsonResult = new JsonResult();
? ? ? ? if(e instanceof NullPointerException){
? ? ? ? ? ? logger.error("空指針異常");
? ? ? ? ? ? jsonResult.setStatus("error");
? ? ? ? ? ? jsonResult.setResult("空指針異常");
? ? ? ? }else if(e instanceof IllegalArgumentException){
? ? ? ? ? ? logger.error("請求參數(shù)類型不匹配");
? ? ? ? ? ? jsonResult.setStatus("error");
? ? ? ? ? ? jsonResult.setResult("請求參數(shù)類型不匹配");
? ? ? ? }else if(e instanceof SQLException){
? ? ? ? ? ? logger.error("數(shù)據(jù)庫訪問異常");
? ? ? ? ? ? jsonResult.setStatus("error");
? ? ? ? ? ? jsonResult.setResult("數(shù)據(jù)庫訪問異常");
? ? ? ? }else {
? ? ? ? ? ? logger.error("訪問異常"+e.getMessage());
? ? ? ? ? ? jsonResult.setStatus("error");
? ? ? ? ? ? jsonResult.setResult("服務訪問異常"+e.getMessage());
? ? ? ? }
? ? ? ? return jsonResult;
? ? }
}