快捷導(dǎo)航

SpringBoot接口正確接收時(shí)間參數(shù)的幾種方式

更新時(shí)間：2023年09月06日 11:02:12 作者：全棧小白.

這篇文章主要給大家介紹了關(guān)于SpringBoot接口正確接收時(shí)間參數(shù)的相關(guān)資料,文中通過代碼示例介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用springboot具有一定的參考借鑒價(jià)值,需要的朋友可以參考下

嘮嗑部分

在做Java開發(fā)時(shí)，肯定會(huì)碰到傳遞時(shí)間參數(shù)的情況吧，比如用戶的出生日期、活動(dòng)的開始，結(jié)束日期等等，這些參數(shù)往往是由前端傳遞過來的，那么在SpringBoot項(xiàng)目中，該如何正確的接收日期參數(shù)呢，這便是我們今日所說的內(nèi)容

首先我們來回顧一下常用的幾種傳參方式

1、Params參數(shù)

Params參數(shù)也稱路徑傳參，參數(shù)是路徑的一部分，如：http://127.0.0.1:8888/date/receiveParamOfParams/2023-05-22

2、Query參數(shù)

Query參數(shù)通常使用?進(jìn)行傳遞，多個(gè)參數(shù)使用&分割，如：http://127.0.0.1:8888/date/receiveParamOfQuery?bothDate=2023-05-22

3、請求體參數(shù)

請求體參數(shù)也是我們常用的json傳參

那么為什么要回顧傳參方式呢，難道說傳參方式不同，接收日期參數(shù)的方式也不一樣嗎？是的沒錯(cuò)

言歸正傳

日期是引用數(shù)據(jù)類型，在參數(shù)傳遞過程中是無法直接傳遞引用數(shù)據(jù)類型的參數(shù)的，對(duì)于日期時(shí)間而言，只能是傳遞指定格式的時(shí)間字符串，由框架幫我們轉(zhuǎn)化為時(shí)間類型，對(duì)于SpringBoot來說，我們需要了解兩個(gè)注解

@DateTimeFormat：將前端傳遞過來的時(shí)間格式的字符串轉(zhuǎn)化為Java中的時(shí)間格式(引用數(shù)據(jù)類型)

@JsonFormat：將前端傳遞過來的時(shí)間格式的字符串轉(zhuǎn)化為Java中的時(shí)間格式(引用數(shù)據(jù)類型)、將Java中的時(shí)間格式(引用數(shù)據(jù)類型)以指定的格式轉(zhuǎn)成Json字符串

注意：@JsonFormat注解是由jackson提供的，而@DateTimeFormat注解是由Spring提供的

那下面就讓我們分別說一下幾種傳遞方式吧

Params參數(shù)

這種參數(shù)傳遞時(shí)間比較麻煩，大體思路是首先將時(shí)間格式的字符串以字符串傳遞過來，我們自行轉(zhuǎn)化為時(shí)間

@PostMapping("/date/receiveParamOfParams/{date}")
public CommonResult receiveParamOfParams(@PathVariable("date") String date){
    CommonResult r = CommonResult.success(null);
    DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd");
    if (StringUtils.hasLength(date)) {
        try {
            LocalDate localDate = LocalDate.parse(date, formatter);
            r.setData(localDate);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    return r;
}

Query參數(shù)

如果單個(gè)接收的話，也可以根據(jù)Params參數(shù)一樣，先以字符串接收，自己轉(zhuǎn)化為時(shí)間即可

在SpringBoot中，如果我們以JavaBean的形式接收Query參數(shù)，Spring會(huì)自動(dòng)的映射

@PostMapping("/date/receiveParamOfQuery")
public CommonResult receiveParamOfQuery(DateReq req){
    CommonResult r = CommonResult.success(null);
    r.setData(req);
    return r;
}

DateReq

@Data
public class DateReq {
    private LocalDate bothDate;
    private LocalDateTime startDateTime;
}

運(yùn)行結(jié)果

注意哈，報(bào)錯(cuò)了，意思是不能夠?qū)⒁粋€(gè)字符串解析為LocalDate類型，此時(shí)我們需要在字段上加@DateTimeFormat注解

@Data
public class DateReq {
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    private LocalDate bothDate;
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime startDateTime;
}

運(yùn)行看結(jié)果

請求體傳參(json傳參)

@PostMapping("/date/receiveParamOfJson")
public CommonResult receiveParamOfJson(@RequestBody DateReq req){
    CommonResult r = CommonResult.success(null);
    r.setData(req);
    return r;
}

DateReq實(shí)體類如上哈

運(yùn)行結(jié)果

又報(bào)錯(cuò)了，SpringBoot默認(rèn)的json解析器是jackson，它無法將時(shí)間字符串解析為時(shí)間類型，那么對(duì)于json傳參而言，@DateTimeFormat注解就失去它的作用了

@Data
public class DateReq {
    @JsonFormat(pattern = "yyyy-MM-dd")
    private LocalDate bothDate;
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime startDateTime;
}

運(yùn)行看結(jié)果