controller層如何同時(shí)接收兩個(gè)實(shí)體類

更新時(shí)間：2023年11月03日 09:23:27 作者：Tine.

這篇文章主要介紹了controller層如何同時(shí)接收兩個(gè)實(shí)體類問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

controller層同時(shí)接收兩個(gè)實(shí)體類

以前以為controller層只能使用@RequestBody注解接收一個(gè)實(shí)體類，其實(shí)可以接受兩個(gè)實(shí)體

1.此處在controller層用兩個(gè)實(shí)體進(jìn)行接受，一個(gè)是自定義實(shí)體，一個(gè)是mybatis-plus的分頁page實(shí)體，無需寫@RequestBody注解

2.在postman測(cè)試的時(shí)候使用body-form-data表單形式傳入?yún)?shù)測(cè)試

size，current為page實(shí)體中的屬性

typeId為自定義實(shí)體中屬性

Controller層的處理

一個(gè)完整的后端請(qǐng)求包括什么？

接口地址（URL地址）。
請(qǐng)求方式（GET、POST、DELETE、PUT）
請(qǐng)求數(shù)據(jù)（request、head、body）
響應(yīng)數(shù)據(jù)（response）

一、Controller層參數(shù)接收

@RestController
@RequestMapping("/product/product-info")
public class ProductInfoController {

    @Autowired
    ProductInfoService productInfoService;

    @GetMapping("/findById")
    public ProductInfoQueryVo findById(Integer id) {
    	...
    }

    @PostMapping("/page")
    public IPage findPage(Page page, ProductInfoQueryVo vo) {
    	// 傳入的參數(shù)為一個(gè)實(shí)體類。
        // 只要前端傳來的JSON能通過屬性映射到實(shí)體類的屬性就可以。
        ...
    }
}

@RestController：@RestController = @Controller + ResponseBody。加上這個(gè)注解，springboot就會(huì)吧這個(gè)類當(dāng)成controller進(jìn)行處理，然后把所有返回的參數(shù)放到ResponseBody中.。
@RequestMapping：請(qǐng)求的前綴，也就是所有該Controller下的請(qǐng)求都需要加上/product/product-info的前綴。
@GetMapping(“/findById”)：標(biāo)志這是一個(gè)get請(qǐng)求，并且需要通過/findById地址才可以訪問到。
@PostMapping(“/page”)：表示是個(gè)post請(qǐng)求。
參數(shù)：至于參數(shù)部分，只需要寫上ProductInfoQueryVo，前端過來的json請(qǐng)求便會(huì)通過映射賦值到對(duì)應(yīng)的對(duì)象中，例如請(qǐng)求這么寫，productId就會(huì)自動(dòng)被映射到vo對(duì)應(yīng)的屬性當(dāng)中。

二、統(tǒng)一實(shí)體類

為了防止不同的請(qǐng)求所造成的返回的數(shù)據(jù)不同，而造成前端的接收比較麻煩，后端要和前端進(jìn)行統(tǒng)一類。

一般包括狀態(tài)碼 1/0;

傳遞的信息message(“xxx操作是否成功”);

以及數(shù)據(jù)Object data；

package com.chang.common;

import lombok.Data;
import java.util.HashMap;
import java.util.Map;

/*
    通用返回結(jié)果類，服務(wù)端響應(yīng)的數(shù)據(jù)會(huì)被封裝成為此對(duì)象。
    此類是一個(gè)通用結(jié)果類，服務(wù)端響應(yīng)的所有結(jié)果最終都會(huì)包裝成此種類型返回給前端頁面。
	加上泛型。
 */
@Data
public class R<T> {

    private Integer code; //編碼：1成功，0和其它數(shù)字為失敗

    private String msg; //錯(cuò)誤信息

    private T data; //數(shù)據(jù)

    private Map map = new HashMap(); //動(dòng)態(tài)數(shù)據(jù)

    public static <T> R<T> success(T object) {
        R<T> r = new R<T>();
        r.data = object; // 對(duì)應(yīng)一些員工數(shù)據(jù)什么的。
        r.code = 1;
        return r;
    }

    public static <T> R<T> error(String msg) {
        R r = new R();
        r.msg = msg;
        r.code = 0;
        return r;
    }

    /**
     * 操作map的動(dòng)態(tài)數(shù)據(jù)
     * @param key
     * @param value
     * @return
     */
    public R<T> add(String key, Object value) {
        this.map.put(key, value);
        return this;
    }
}

數(shù)據(jù)的封裝的變化：

{
  "productId": 1,
  "productName": "泡腳",
  "productPrice": 100.00,
  "productDescription": "中藥泡腳加按摩",
  "productStatus": 0,
}

經(jīng)過封裝后就變成了

{
  "code": 1000,
  "msg": "請(qǐng)求成功",
  "data": {
    "productId": 1,
    "productName": "泡腳",
    "productPrice": 100.00,
    "productDescription": "中藥泡腳加按摩",
    "productStatus": 0,
  }
}

然后前后端分離交互的后端的Controller的返回值就需要統(tǒng)一一下了。

R<Xxx>

    @PostMapping("/findByVo")
    public ResultVo findByVo(@Validated ProductInfoVo vo) {
        ProductInfo productInfo = new ProductInfo();
        BeanUtils.copyProperties(vo, productInfo);
        return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
    }

一般情況下，查詢Get操作的返回值為R<List> 或者R
return new R.success(list);
刪除、修改、增加的操作為R
return new R.success(“Xxx操作成功/失?。?rdquo;);

當(dāng)然也可通過枚舉類來進(jìn)行狀態(tài)碼的統(tǒng)一約定。因?yàn)槭敲杜e類，會(huì)有g(shù)et方法，而不會(huì)有set方法。

@Getter
public enum ResultCode implements StatusCode{
    SUCCESS(1000, "請(qǐng)求成功"),
    FAILED(1001, "請(qǐng)求失敗"),
    VALIDATE_ERROR(1002, "參數(shù)校驗(yàn)失敗"),
    RESPONSE_PACK_ERROR(1003, "response返回包裝失敗");

    private int code;
    private String msg;

    ResultCode(int code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

三、參數(shù)校驗(yàn)

在SpringBoot中，使用@Validate注解進(jìn)行校驗(yàn)。

首先添加Maven依賴。

<dependency>
       <groupId>javax.validation</groupId>
       <artifactId>validation-api</artifactId>
</dependency>

然后就可以在實(shí)體類字段的屬性上面使用了。

message：當(dāng)不符合校驗(yàn)條件的時(shí)候，IDEA會(huì)報(bào)告給我們什么信息。

String類型的判斷用@NotBlank, 可防止空字符串。

@Data
public class ProductInfoVo {
    @NotNull(message = "商品名稱不允許為空")
    private String productName;

    @Min(value = 0, message = "商品價(jià)格不允許為負(fù)數(shù)") //設(shè)置最小值
    private BigDecimal productPrice;

    private Integer productStatus;
}

測(cè)試：

1.寫Controller層方法。

    @PostMapping("/findByVo")
    public ProductInfo findByVo(@Validated ProductInfoVo vo) {
        ProductInfo productInfo = new ProductInfo();
        BeanUtils.copyProperties(vo, productInfo);
        return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
    }

2.傳遞數(shù)據(jù)。

productName : 泡腳
productPrice : -1
productStatus : 1

3.觀看控制臺(tái)的輸出。

{
  "timestamp": "2020-04-19T03:06:37.268+0000",
  "status": 400,
  "error": "Bad Request",
  "errors": [
    {
      "codes": [
        "Min.productInfoVo.productPrice",
        "Min.productPrice",
        "Min.java.math.BigDecimal",
        "Min"
      ],
      "arguments": [
        {
          "codes": [
            "productInfoVo.productPrice",
            "productPrice"
          ],
          "defaultMessage": "productPrice",
          "code": "productPrice"
        },
        0
      ],
      "defaultMessage": "商品價(jià)格不允許為負(fù)數(shù)",
      "objectName": "productInfoVo",
      "field": "productPrice",
      "rejectedValue": -1,
      "bindingFailure": false,
      "code": "Min"
    }
  ],
  "message": "Validation failed for object\u003d\u0027productInfoVo\u0027. Error count: 1",
  "trace": "org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors\nField error in object \u0027productInfoVo\u0027 on field \u0027productPrice\u0027: rejected value [-1]; codes [Min.productInfoVo.productPrice,Min.productPrice,Min.java.math.BigDecimal,Min]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [productInfoVo.productPrice,productPrice]; arguments []; default message [productPrice],0]; default message [商品價(jià)格不允許為負(fù)數(shù)]\n\tat xxxxx
  "path": "/leilema/product/product-info/findByVo"
}

4.優(yōu)化異常處理。

我們看到代碼拋出了org.springframework.validation.BindException的綁定異常，因此我們的思路就是AOP攔截所有controller，然后異常的時(shí)候統(tǒng)一攔截起來，進(jìn)行封裝！完美！

為了響應(yīng)上面我們定義的狀態(tài)碼，我們可以使用SpringMVC的注解@ExceptionHandler

Spring mvc給我們提供了一個(gè)@RestControllerAdvice來增強(qiáng)所有@RestController，然后使用@ExceptionHandler注解，就可以攔截到對(duì)應(yīng)的異常。

@RestControllerAdvice(basePackages = {"com.bugpool.leilema"})
public class ControllerResponseAdvice implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        // response是ResultVo類型，或者注釋了NotControllerResponseAdvice都不進(jìn)行包裝
        return !methodParameter.getParameterType().isAssignableFrom(ResultVo.class);
    }

    @Override
    public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest request, ServerHttpResponse response) {
        // String類型不能直接包裝
        if (returnType.getGenericParameterType().equals(String.class)) {
            ObjectMapper objectMapper = new ObjectMapper();
            try {
                // 將數(shù)據(jù)包裝在ResultVo里后轉(zhuǎn)換為json串進(jìn)行返回
                return objectMapper.writeValueAsString(new ResultVo(data));
            } catch (JsonProcessingException e) {
                throw new APIException(ResultCode.RESPONSE_PACK_ERROR, e.getMessage());
            }
        }
        // 否則直接包裝成ResultVo返回
        return new ResultVo(data);
    }
}

@RestControllerAdvice(basePackages = {“com.bugpool.leilema”})自動(dòng)掃描了所有指定包下的controller，在Response時(shí)進(jìn)行統(tǒng)一處理
重寫supports方法，也就是說，當(dāng)返回類型已經(jīng)是ResultVo了，那就不需要封裝了，當(dāng)不等與ResultVo時(shí)才進(jìn)行調(diào)用beforeBodyWrite方法，跟過濾器的效果是一樣的
最后重寫我們的封裝方法beforeBodyWrite，注意除了String的返回值有點(diǎn)特殊，無法直接封裝成json，我們需要進(jìn)行特殊處理，其他的直接new ResultVo(data);就ok了

當(dāng)然也有其他例子。

package com.chang.common;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;


import java.sql.SQLIntegrityConstraintViolationException;

/**
 * 全局異常處理,對(duì)于指定的Controller的請(qǐng)求都要進(jìn)行異常捕獲and處理。
 */
@ControllerAdvice(annotations = {RestController.class, Controller.class})
@ResponseBody
@Slf4j
public class GlobalExceptionHandler {

    /**
     * 異常處理方法： 處理這種異常
     * @return
     */
    @ExceptionHandler(SQLIntegrityConstraintViolationException.class)
    public R<String> exceptionHandler(SQLIntegrityConstraintViolationException ex){
        log.error(ex.getMessage());

        if(ex.getMessage().contains("Duplicate entry")){
            String[] split = ex.getMessage().split(" ");
            // 這里是根據(jù)爆出的異常信息來進(jìn)行分配的。
            String msg = split[2] + "已存在";
            return R.error(msg);
        }

        return R.error("未知錯(cuò)誤");
    }


    /**
     * 異常處理方法： 處理這種異常
     * @return
     */
    @ExceptionHandler(CustomException.class)
    public R<String> exceptionHandler(CustomException ex){
        log.error(ex.getMessage());


        return R.error(ex.getMessage());
    }
}