SpringBoot Controller接收參數(shù)的幾種常用方式

更新時(shí)間：2023年07月19日 09:03:07 作者：猴猴小扣

這篇文章主要介紹了SpringBoot Controller接收參數(shù)的幾種常用方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

SpringBoot Controller接收參數(shù)的常用方式

在Controller中加入@RestController，效果等于@Controller + @ResponseBody。

1 請(qǐng)求路徑參數(shù)

直接把表單里面的參數(shù)寫(xiě)進(jìn) Controller 相應(yīng)方法的形參中去，這個(gè)獲取參數(shù)的方法適合get提交，而不適合post提交。

@PathVariable獲取(這個(gè)當(dāng)然不分get和post了，是url提取嘛)

    @RequestMapping("/userInfo/{id}")
    public String userInfo(@PathVariable String id) {
        System.out.println(id);
        return id;
    }

http://localhost:8080/userInfo/142857

@RequestParam獲取查詢參數(shù)，如url?id=1428571

當(dāng)請(qǐng)求參數(shù)名與方法形參變量名相同時(shí)，可不加@RequestParam注解
@RequestParam注解的required屬性默認(rèn)為true，若參數(shù)不是必須傳遞需改為false

    @RequestMapping("/userInfo")
    public String userInfo(@RequestParam(name = "id") String id) {
        System.out.println(id);
        return id;
    }

http://localhost:8080/userInfo?id=12345671

2 實(shí)體參數(shù)

通過(guò)建立一個(gè)bean來(lái)獲取參數(shù)：

package com.example.helloworld.model;
public class User {
    private String id;
    private String name;
    private Notebook notebook;
    User(String id, String name) {
        this.id  = id;
        this.name = name;
        this.notebook = new Notebook();
    }
    public String getName() {
        return name;
    }
}

@RequestMapping("/userInfo")
    public String userInfo(User user) {
        System.out.println(user.getName());
        return user.getName();
    }

http://localhost:8080/problemBook?id=142857&time=2022-01-01 00:00:00

3 日期參數(shù)

http://localhost:8080/problemBook?id=142857&time=2022-01-01 00:00:00

@RequestMapping("/problemBook")
    public String problemBook(String id, @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") LocalDateTime time) {
        System.out.println(id);
        System.out.println(time);
        return "OK";
    }

但“yyyy-MM-dd”就識(shí)別有問(wèn)題……

4 Json Body參數(shù)

通常用于Post請(qǐng)求。

[外鏈圖片轉(zhuǎn)存失敗,源站可能有防盜鏈機(jī)制,建議將圖片保存下來(lái)直接上傳(img-UC3GsHzo-1685868352014)(【SpringBoot】SpringBoot-Controller接收參數(shù)的常用方式/image-20230604162017983.png)]

使用RequestBody注解。

@PostMapping("/finishProblem")
    public String finishProblem(@RequestBody User user) {
        System.out.println(user.getName());
        return "OK";
    }

也可以使用一個(gè)map接收：

    @PostMapping("/finishProblem")
    public String finishProblem(@RequestBody Map<String, String> params) {
        System.out.println(params.get("uid"));
        System.out.println(params.get("problemId"));
        return "OK";
    }

5 返回結(jié)果

@ResponseBody用于Controller類或者方法上，將方法返回值直接響應(yīng)，若返回值類型是實(shí)體對(duì)象或者集合，將轉(zhuǎn)為json格式相應(yīng)。

為了有統(tǒng)一的返回方式，定義統(tǒng)一響應(yīng)結(jié)果Result。

package com.example.helloworld.controller;
/**
 * code response狀態(tài)碼
 * obj 返回給前端的數(shù)據(jù)
 * message 附加信息,說(shuō)明具體情況
 */
public class Result {
    public int code;
    public String message;
    public Object data;
    public Result(int code, String message, Object data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }
    public static Result success(Object data) {
        return new Result(200, "success", data);
    }
    public static Result success() {
        return new Result(200, "success", null);
    }
    public static Result error(String message) {
        return new Result(404, message, null);
    }
}