如何理解SpringBoot接口接收json參數(shù)

本篇內(nèi)容主要講解“如何理解SpringBoot接口接收json參數(shù)”，感興趣的朋友不妨來(lái)看看。本文介紹的方法操作簡(jiǎn)單快捷，實(shí)用性強(qiáng)。下面就讓小編來(lái)帶大家學(xué)習(xí)“如何理解SpringBoot接口接收json參數(shù)”吧!

SpringBoot接口接收json參數(shù)

前言

通常來(lái)講，HTTP 方法會(huì)映射為 CRUD 動(dòng)作，但這并不是嚴(yán)格的限制，有時(shí)候 PUT 也可以用來(lái)創(chuàng)建新的資源，POST 也可以用來(lái)更新資源。所以在平時(shí)的 Web 開(kāi)發(fā)中，你可能?？吹絤ethod 的值是 GET 和 POST，但是我們需要養(yǎng)成一個(gè)好的編碼習(xí)慣。

前提

首先在controller上加上注解：@RestController

@RestController
@RequestMapping("/user")
@Api(tags = "user", description = "用戶控制器")
public class UserController {
    // ...
}

詳細(xì)介紹

一、GET

1）@PathVariable 獲取路徑參數(shù)。即 url/{id} 這種形式。

@GetMapping("/getDetail/{id}")
    @ApiOperation(value = "根據(jù)id獲取用戶")
    public RbacUser getDetail(@PathVariable Long id) {
        return userService.getById(id);
    }

2）@RequestParam 獲取查詢參數(shù)。即 url?name=xx 這種形式

主要有參數(shù)：

• value：參數(shù)名字，即入?yún)⒌恼?qǐng)求參數(shù)名字，如username表示請(qǐng)求的參數(shù)區(qū)中的名字為username的參數(shù)的值將傳入；

• required：是否必須，默認(rèn)是true，表示請(qǐng)求中一定要有相應(yīng)的參數(shù)，否則會(huì)報(bào)錯(cuò)；

@GetMapping("/getByAccount")
    @ApiOperation(value = "根據(jù)賬號(hào)獲取用戶")
    public RbacUser getByAccount(@RequestParam(required = false) String account) {
        return userService.getByAccount(account);
    }

3) 直接封裝DTO參數(shù)形式

@GetMapping("/find")
    @ApiOperation(value = "根據(jù)條件獲取用戶")
    public List<RbacUser> find(RbacUserDTO rbacUserDTO) {
        return userService.find(rbacUserDTO);
    }

二、DELETE

@PathVariable 獲取路徑參數(shù)。即 url/{id} 這種形式。

@DeleteMapping("/delete/{id}")
    @ApiOperation(value = "刪除用戶")
    public void delete(@PathVariable Long id) {
        userService.delete(id);
    }

三、POST/PUT/PATCH

@RequestBody 將HTTP請(qǐng)求正文插入方法中，使用適合的 HttpMessageConverter 將請(qǐng)求體寫(xiě)入某個(gè)對(duì)象。

@PostMapping("/create")
    @ApiOperation(value = "創(chuàng)建用戶")
    public RbacUser getByAccount(@RequestBody @Validated RbacUserDTO rbacUserDTO) {
        return userService.save(rbacUserDTO);
    }

• @Validated：對(duì)數(shù)據(jù)進(jìn)行校驗(yàn)，以下注解報(bào)錯(cuò)會(huì)直接返回，如果校驗(yàn)類中包含一個(gè)對(duì)象引用屬性，需要在屬性上加上@Valid注解

具體參數(shù)檢驗(yàn)請(qǐng)參看下面

Springboot restFul 參數(shù)檢驗(yàn)

概述

對(duì)請(qǐng)求參數(shù)進(jìn)行檢驗(yàn)，這在web中開(kāi)始經(jīng)常能碰到，如果用一個(gè)個(gè)if/else去做判斷，相信這樣的代碼可讀性會(huì)比較差

JSR-303 是java為bean數(shù)據(jù)合法性校驗(yàn)提供的標(biāo)準(zhǔn)框架，是Java EE6中的一項(xiàng)子規(guī)范，叫做BeanValidation。JSR303通過(guò)在Bean屬性上標(biāo)注@NotNull、@Max等標(biāo)準(zhǔn)的注解指定校驗(yàn)規(guī)則，并通過(guò)這些標(biāo)準(zhǔn)的驗(yàn)證接口對(duì)Bean進(jìn)行驗(yàn)證。

規(guī)定一些檢驗(yàn)規(guī)范即校驗(yàn)注解，如@Null, @NotNull, @Pattern，位于javax.validation.constraints包下，只提供規(guī)范 不提供實(shí)現(xiàn)。

在Spring中，有兩種方式可以驗(yàn)證輸入，一是利用Spring自帶的驗(yàn)證框架，二是利用JSR-303的實(shí)現(xiàn)，一般建議使用JSR-303的實(shí)現(xiàn)，比如Hibernate-Validator。

Hibernate-Validator 是JSR-303的實(shí)現(xiàn)。Hibernate Validator提供了JSR-303規(guī)范中所有內(nèi)置constraint的實(shí)現(xiàn)，除此之外還有一些附加的constraint，如@Email, @Length, @Range等，位于org.hibernate,validator.constraints包下。

spring-boot-starter-web包里面已經(jīng)有了hibernate-vlidator包，不需要額外引用hibernate validator依賴。

同時(shí)Spring為了給開(kāi)發(fā)者提供便捷，對(duì)Hibernate-Validator進(jìn)行了二次封裝，封裝了LocalValidatorFactorBean作為validator的實(shí)現(xiàn)，這個(gè)類兼容了Spring的Validation體系和Hibernate的Validation體系，LocalValidatorFactorBean已經(jīng)成為了Validator的默認(rèn)實(shí)現(xiàn)。

說(shuō)明：JSR-349是JSR-303的升級(jí)版，添加了一些新特性

如下圖，是spring boot 2.1.1中hibernate依賴情況：

常用注解

簡(jiǎn)單應(yīng)用舉例

需要檢驗(yàn)的Bean定義：

public class StudentBean implements Serializable{
    @NotBlank(message = "用戶名不能為空")
    private String name;
    @Min(value = 18, message = "年齡不能小于18歲")
    private Integer age;
    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手機(jī)號(hào)格式錯(cuò)誤")
    private String phoneNum;
    @Email(message = "郵箱格式錯(cuò)誤")
    private String email;
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    public Integer getAge() {
        return age;
    }
 
    public void setAge(Integer age) {
        this.age = age;
    }
 
    public String getPhoneNum() {
        return phoneNum;
    }
 
    public void setPhoneNum(String phoneNum) {
        this.phoneNum = phoneNum;
    }
 
    public String getEmail() {
        return email;
    }
 
    public void setEmail(String email) {
        this.email = email;
    }
}

返回錯(cuò)誤字段定義：

public class ArgumentsInvalidResponseBean {
    private String argumentName;
    private String exceptionMsg;
 
    public ArgumentsInvalidResponseBean() {
    }
 
    public ArgumentsInvalidResponseBean(String argumentName, String exceptionMsg) {
        this.argumentName = argumentName;
        this.exceptionMsg = exceptionMsg;
    }
 
    public String getArgumentName() {
        return argumentName;
    }
    public void setArgumentName(String argumentName) {
        this.argumentName = argumentName;
    }
 
    public String getExceptionMsg() {
        return exceptionMsg;
    }
    public void setExceptionMsg(String exceptionMsg) {
        this.exceptionMsg = exceptionMsg;
    }
}

全局異常處理：

@ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public List<ArgumentsInvalidResponseBean> methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException ex){
        System.out.println("===================methodArgumentNotValidExceptionHandler Occur============");
 
        List<ArgumentsInvalidResponseBean> argumentsInvalidResponseBeanList = new ArrayList<>();
        for (FieldError error : ex.getBindingResult().getFieldErrors()){
            ArgumentsInvalidResponseBean bean = new ArgumentsInvalidResponseBean();
            bean.setArgumentName(error.getField());
            bean.setExceptionMsg(error.getDefaultMessage());
 
            argumentsInvalidResponseBeanList.add(bean);
        }
        return argumentsInvalidResponseBeanList;
    }

測(cè)試代碼：

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Valid @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

在PostMan中測(cè)試：

注意這里，年齡和郵箱是有錯(cuò)誤的，運(yùn)行后查看返回值，具體如下：

自定義校驗(yàn)

新建注解類 MyConstraint：

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = MyConstraintValidator.class)
public @interface MyConstraint {
    String message() default "這是一個(gè)自定義注解，檢測(cè)輸入是否大寫(xiě)";
    Class<?>[] groups() default {};
 
    Class<? extends Payload>[] payload() default {};
}

實(shí)現(xiàn)MyConstraintValidator:

public class MyConstraintValidator implements ConstraintValidator<MyConstraint, String> {
    @Override
    public void initialize(MyConstraint constraintAnnotation) {
        System.out.println("+++++++++++++myConstraint init");
    }
 
    @Override
    public boolean isValid(String o, ConstraintValidatorContext constraintValidatorContext) {
        if (!o.equals(o.toUpperCase())){
            System.out.println("輸入信息必須是大寫(xiě)");
            return false;
        }
        return true;
    }
}

當(dāng)輸入信息不是全大寫(xiě)字符時(shí)，則檢驗(yàn)不通過(guò)

使用：

在上面StudentBean中加入檢驗(yàn)

  @MyConstraint
  private String className;

測(cè)試：

結(jié)果如下：

這時(shí)說(shuō)明自定義檢驗(yàn)可以工作了

拋出BindException而非MethodArgumentNotValidException

當(dāng)請(qǐng)求中 Content-Type為“application/x-www-form-urlencoded”時(shí)，Spring會(huì)把數(shù)據(jù)解析成 web form data而非json，會(huì)使用 FormHttpMessageConverter來(lái)轉(zhuǎn)換post的body 并且異常轉(zhuǎn)為BindException。

如果我們想要Spring把POST數(shù)據(jù)認(rèn)為是json并且使用MappingJackson2HttpMessageConverter來(lái)解析數(shù)據(jù)，可以把Content-Type設(shè)置成 application/json

到此，相信大家對(duì)“如何理解SpringBoot接口接收json參數(shù)”有了更深的了解，不妨來(lái)實(shí)際操作一番吧！這里是億速云網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！