如何使用SpringBoot參數傳遞及@RequestBody注解

這篇文章主要介紹“如何使用SpringBoot參數傳遞及@RequestBody注解”，在日常操作中，相信很多人在如何使用SpringBoot參數傳遞及@RequestBody注解問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”如何使用SpringBoot參數傳遞及@RequestBody注解”的疑惑有所幫助！接下來，請跟著小編一起來學習吧！

SpringBoot 參數傳遞及@RequestBody注解注意點

前臺正確的js書寫格式是

//點擊查詢, 執行下面這個函數
$("#searchByCriteria").click(function () {
     //var paramdata = $("#bck_qry_criteria_form").serializeJson();//serializeJson()是自定義的form 格式化為json函數
     var paramdata = {
         type:$("#bck_type").val(),
         title:$("#bck_title").val(),
         start:$("#bck_start").val(),
         end:$("#bck_end").val()
     };
     paramdata = JSON.stringify(paramdata);
     $.ajax({
         type: "post",
         data: paramdata,
         url: "/getNews",
         cache:false,
         headers : {"Content-Type" : "application/json;charset=utf-8"},
         success: function (data) {
             var code = data.code;
             var t = data.t;
             if (code == 200){alert(JSON.stringify("提交成功! 我們會盡快聯系您!"));}
             if (code == 500){alert(JSON.stringify(t));}
             //$("#input_phone").val("");//清空輸入框
         }
     })
 });

上面中傳遞的參數一定要用JSON.stringify(paramdata); 方法將參數轉換成json格式的字符串; 因為SpringBoot 中@RequestBody注解要求的必須是json格式的字符串才能注入參數, 第二就是大坑, 大坑, 大坑, 請求中必須 帶上請求頭,不然會報下面錯誤

org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'application/x-www-form-urlencoded;charset=UTF-8' not supported

后臺正確的Controller書寫格式是

其中consumes = “application/json”, 規范的講是要加的, 它規范了,前臺要傳遞json格式的參數. 但是如果你不加也是可以的, 親測不加也能封裝到參數.NewsParamsMap中屬性

@PostMapping(value = "/getNews",  consumes = "application/json")
@ResponseBody
public PageInfo<NewsList> getNewsList(@RequestBody NewsParamsMap map){
    System.out.println("這是正確的用法");
    return null;
}

NewsParamsMap 中有Integer 有Date, 前臺傳過來都是字符串, springboot,會根據名稱一一對應, 將數據轉換成相應的類型.

public class NewsParamsMap {
    private Integer type;
    private String title;
    private Date start;
    private Date end;
   ...
   set get 方法
   ...
}

RequestBody 作為參數使用

最近在接收一個要離職同事的工作，接手的項目是用SpringBoot搭建的，其中看到了這樣的寫法：

在CODE上查看代碼片 派生到我的代碼片

@RequestMapping("doThis")  
public String doThis(HttpServletRequest request,  
        @RequestParam("id") Long id, // 用戶ID  
        @RequestParam("back_url") String back_url, // 回調地址           
        @RequestBody TestEntity json_data // json數據，對于java實體類  
){//...

這個是一個請求映射方法，然后用瀏覽器輸入url：

http://127.0.0.1:8080/test/doThis?id=1&back_url=url&json_data={"code":2,"message":"test"}

在這個方法中，使用@RequestParam獲取參數，然后使用@RequestBody對json格式的參數轉換為Java類型

在運行的時候發現報錯：Required request body is missing

@RequestBody的使用需要加載MappingJackson2HttpMessageConverter，但是SpringBoot的官方文檔提到，這個是默認已經加載的了，而且json字符串和javabean也沒有書寫的錯誤

因此考慮到應該是請求Content-Type的問題，因為使用瀏覽器輸入url的方式沒有辦法定義Content-Type，因此spring無法發現request body

為了證實這個想法，自己書寫一個請求類

在CODE上查看代碼片 派生到我的代碼片

String add_url = "http://127.0.0.1:8080/test/doThis";  
   URL url = new URL(add_url);  
   HttpURLConnection connection = (HttpURLConnection)url.openConnection();  
   connection.setDoInput(true);  
   connection.setDoOutput(true);  
   connection.setRequestMethod("POST");  
   connection.setUseCaches(false);  
   connection.setInstanceFollowRedirects(true);  
   connection.setRequestProperty("Content-Type","application/json");  
   connection.connect();  
   DataOutputStream out = new DataOutputStream(connection.getOutputStream());  
   JSONObject obj = new JSONObject();  
      
   obj.put("code", -1002);       
   obj.put("message", "msg");  
   out.writeBytes(obj.toString());  
   out.flush();  
   out.close();

請求還是失敗，經過調試，發現需要去掉所有的@RequestParam注解才能成功

小結一下

1、@RequestBody需要把所有請求參數作為json解析，因此，不能包含key=value這樣的寫法在請求url中，所有的請求參數都是一個json

2、直接通過瀏覽器輸入url時，@RequestBody獲取不到json對象，需要用java編程或者基于ajax的方法請求，將Content-Type設置為application/json

到此，關于“如何使用SpringBoot參數傳遞及@RequestBody注解”的學習就結束了，希望能夠解決大家的疑惑。理論與實踐的搭配能更好的幫助大家學習，快去試試吧！若想繼續學習更多相關知識，請繼續關注億速云網站，小編會繼續努力為大家帶來更多實用的文章！