如何寫出優雅的Controller層代碼

来源:https://www.cnblogs.com/wandaren/archive/2022/12/26/17006196.html
-Advertisement-
Play Games

前言 一個完整的後端請求由 4 部分組成： 介面地址（也就是 URL 地址） 請求方式（一般就是 get、set，當然還有 put、delete） 請求數據（request，有 head 跟 body） 響應數據（response） Controller 主要的工作有以下幾項： 接收請求並解析參數 ...


前言

一個完整的後端請求由 4 部分組成：

  • 介面地址（也就是 URL 地址）
  • 請求方式（一般就是 get、set，當然還有 put、delete）
  • 請求數據（request，有 head 跟 body）
  • 響應數據（response）

Controller 主要的工作有以下幾項：

  • 接收請求並解析參數
  • 調用 Service 執行具體的業務代碼（可能包含參數校驗）
  • 捕獲業務邏輯異常做出反饋
  • 業務邏輯執行成功做出響應

解決以下 3 個問題：

  • 返迴響應數據該如何統一的進行處理
  • 接收到請求，處理業務邏輯時拋出了異常又該如何處理
  • 當接收到請求時，如何優雅的校驗參數

統一返回結構

封裝Result

package com.wanqi.result;

public interface IResult {
    Integer getCode();
    String getMessage();
}

定義狀態碼

package com.wanqi.result;

public enum ResultEnum implements IResult {
    SUCCESS(2001, "介面調用成功"),
    VALIDATE_FAILED(2002, "參數校驗失敗"),
    COMMON_FAILED(2003, "介面調用失敗"),
    FORBIDDEN(2004, "沒有許可權訪問資源"),
    DATA_CONVERSION(2005, "數據轉換異常");

    private Integer code;
    private String message;

    ResultEnum(int code, String message) {
        this.code=code;
        this.message=message;
    }

    @Override
    public Integer getCode() {
        return code;
    }

    @Override
    public String getMessage() {
        return message;
    }

}

Result包裝類

package com.wanqi.result;

public class Result<T> {
    private Integer code;
    private String message;
    private T data;

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public Result() {
    }

    public Result(Integer code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    public static <T> Result<T> success(T data) {
        return new Result<>(ResultEnum.SUCCESS.getCode(), ResultEnum.SUCCESS.getMessage(), data);
    }

    public static <T> Result<T> success(String message, T data) {
        return new Result<>(ResultEnum.SUCCESS.getCode(), message, data);
    }

    public static Result<?> failed() {
        return new Result<>(ResultEnum.COMMON_FAILED.getCode(), ResultEnum.COMMON_FAILED.getMessage(), null);
    }

    public static Result<?> failed(String message) {
        return new Result<>(ResultEnum.COMMON_FAILED.getCode(), message, null);
    }
    public static Result<?> failed(Integer code,String message) {
        return new Result<>(code, message, null);
    }

    public static Result<?> failed(IResult errorResult) {
        return new Result<>(errorResult.getCode(), errorResult.getMessage(), null);
    }

    public static <T> Result<T> instance(Integer code, String message, T data) {
        Result<T> result = new Result<>();
        result.setCode(code);
        result.setMessage(message);
        result.setData(data);
        return result;
    }
}

統一包裝處理

package com.wanqi.advice;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.wanqi.exception.APIException;
import com.wanqi.result.Result;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

// 如果引入了swagger或knife4j的文檔生成組件，這裡需要僅掃描自己項目的包，否則文檔無法正常生成
@RestControllerAdvice(basePackages = "com.wanqi.controller")
public class ResponseAdvice implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        // response是Result類型不進行包裝
        return !returnType.getParameterType().isAssignableFrom(Result.class);
    }


    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
       if(returnType.getGenericParameterType().equals(String.class)){
            ObjectMapper objectMapper = new ObjectMapper();
            try {
                return objectMapper.writeValueAsString(Result.success(body));
            } catch (JsonProcessingException e) {
                throw new APIException(e.getMessage());
            }
        }
        return Result.success(body);
    }
}

Controller層

package com.wanqi.controller;

import com.wanqi.pojo.TestDTO;
import com.wanqi.pojo.UserDTO;
import org.hibernate.validator.constraints.*;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;

@RestController
public class TestController {

    @PostMapping("/test")
    public TestDTO test(@RequestBody TestDTO testDTO) {
        return testDTO;
    }

    @PostMapping("/test1")
    public String test1(@RequestBody TestDTO testDTO) {
        return testDTO.getName();
    }
}

image.png

image.png

不統一處理返回

自定義註解

package com.wanqi.advice;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotControllerResponseAdvice {
}

在增強過濾方法上過濾包含這個註解的方法

@RestControllerAdvice(basePackages = "com.wanqi.controller")
public class ResponseAdvice implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        // response是Result類型，或者註釋了NotControllerResponseAdvice都不進行包裝
        return !(returnType.getParameterType().isAssignableFrom(Result.class)
                || returnType.hasMethodAnnotation(NotControllerResponseAdvice.class));
    }
.....

controller

  • 在不需要統一處理的方法上使用@NotControllerResponseAdvice註解即可
package com.wanqi.controller;

import com.wanqi.advice.NotControllerResponseAdvice;
import com.wanqi.pojo.TestDTO;
import com.wanqi.pojo.UserDTO;
import com.wanqi.result.Result;
import org.hibernate.validator.constraints.*;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;

@Validated
@RestController
public class TestController {

    @GetMapping("/health")
    @NotControllerResponseAdvice
    public String health() {
        return "success";
    }

    @GetMapping("/health1")
    public Result health1() {
        return Result.success("dddd");
    }
}

image.pngimage.png

自定義異常與統一攔截異常

自定義異常

package com.wanqi.exception;

import com.wanqi.result.ResultEnum;

//自定義異常
public class APIException extends RuntimeException {
    private int code;
    private String msg;

    public int getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }

    public APIException(String message) {
        super(message);
        this.code = ResultEnum.DATA_CONVERSION.getCode();
        this.msg = ResultEnum.DATA_CONVERSION.getMessage();
    }
}

統一攔截異常

package com.wanqi.advice;

import com.wanqi.exception.APIException;
import com.wanqi.result.IResult;
import com.wanqi.result.Result;
import com.wanqi.result.ResultEnum;
import org.springframework.util.StringUtils;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolationException;

//統一攔截異常
@RestControllerAdvice(basePackages = "com.wanqi")
public class ControllerExceptionAdvice {

    /**
     * 捕獲 {@code APIException} 異常
     */
    @ExceptionHandler({APIException.class})
    public Result<?> handleBusinessException(APIException ex) {
        return Result.failed(ex.getMessage());
    }

    /**
     * {@code @RequestBody} 參數校驗不通過時拋出的異常處理
     */
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public Result<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
        BindingResult bindingResult = ex.getBindingResult();
        StringBuilder sb = new StringBuilder("校驗失敗:");
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");
        }
        String msg = sb.toString();
        if (StringUtils.hasText(msg)) {
            return Result.failed(new IResult() {
                @Override
                public Integer getCode() {
                    return ResultEnum.VALIDATE_FAILED.getCode();
                }
                @Override
                public String getMessage() {
                    return msg;
                }
            });
        }
        return Result.failed(ResultEnum.VALIDATE_FAILED);
    }

    /**
     * {@code @PathVariable} 和 {@code @RequestParam} 參數校驗不通過時拋出的異常處理
     */
    @ExceptionHandler({ConstraintViolationException.class})
    public Result<?> handleConstraintViolationException(ConstraintViolationException ex) {
        if (StringUtils.hasText(ex.getMessage())) {
            return Result.failed(ResultEnum.VALIDATE_FAILED.getCode(), ex.getMessage());
        }
        return Result.failed(ResultEnum.VALIDATE_FAILED);
    }

    /**
     * 頂級異常捕獲並統一處理，當其他異常無法處理時候選擇使用
     */
    @ExceptionHandler({Exception.class})
    public Result<?> handle(Exception ex) {
        return Result.failed(ex.getMessage());
    }

}

參數校驗

  • 使用hibernate-validator，@Validated註解參數校驗
        <!-- https://mvnrepository.com/artifact/org.hibernate/hibernate-validator -->
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>6.2.5.Final</version>
        </dependency>

@RequestBody 參數校驗

  • Post、Put 請求的參數推薦使用 @RequestBody 請求體參數。
  • 對 @RequestBody 參數進行校驗需要在對象中加入校驗條件後，再搭配 @Validated 即可完成自動校驗。

UserDTO

package com.wanqi.pojo;


import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.NotNull;

public class UserDTO {

    private Long userId;
    @NotNull
    @Length(min = 2,max = 10)
    private String userName;
    @NotNull
    @Length(min = 6,max = 20)
    private String account;
    @NotNull
    @Length(min = 8,max = 20)
    private String password;

    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        this.userId = userId;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getAccount() {
        return account;
    }

    public void setAccount(String account) {
        this.account = account;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "UserDTO{" +
                "userId=" + userId +
                ", userName='" + userName + '\'' +
                ", account='" + account + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

controller

package com.wanqi.controller;

import com.wanqi.pojo.TestDTO;
import com.wanqi.pojo.UserDTO;
import org.hibernate.validator.constraints.*;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;

@Validated
@RestController
public class TestController {
	// 使用@Valid或者@Validated
    @PostMapping("/user")
    public UserDTO user(@RequestBody @Validated UserDTO userDTO) {
      return userDTO;
    }
}

image.png

@PathVariable 和 @RequestParam 參數校驗

  • Get 請求的參數接收一般依賴這兩個註解，但是處於 url 有長度限制和代碼的可維護性，超過 5 個參數儘量用實體來傳參。
  • 對 @PathVariable 和 @RequestParam 參數進行校驗需要在入參聲明約束的註解。

controller

package com.wanqi.controller;

import com.wanqi.pojo.TestDTO;
import com.wanqi.pojo.UserDTO;
import org.hibernate.validator.constraints.*;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;

@Validated
@RestController
public class TestController {

    @GetMapping("/{num}")
    public Integer detail(@PathVariable("num") @Min(value = 1 ,message = "不能小於1") @Max(20) Integer num) {
        return num * num;
    }

    @GetMapping("/getByEmail")
    public String getByAccount(@RequestParam @NotBlank @Email String email) {
        return email;
    }
}

image.pngimage.png

自定義校驗規則

自定義校驗規則需要做兩件事情：

  • 自定義註解類，定義錯誤信息和一些其他需要的內容
  • 註解校驗器，定義判定規則

自定義註解類

package com.wanqi.validator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = MobileValidator.class)
public @interface Mobile {
    /**
     * 是否允許為空
     */
    boolean required() default true;

    /**
     * 校驗不通過返回的提示信息
     */
    String message() default "不是一個手機號碼格式";

    /**
     * Constraint要求的屬性，用於分組校驗和擴展，留空就好
     */
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

註解校驗器，實現ConstraintValidator介面

package com.wanqi.validator;

import org.springframework.util.StringUtils;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class MobileValidator implements ConstraintValidator<Mobile, CharSequence> {

    private boolean required = false;

    private final Pattern pattern = Pattern.compile("^1[34578][0-9]{9}$"); // 驗證手機號

    /**
     * 在驗證開始前調用註解里的方法，從而獲取到一些註解里的參數
     *
     * @param constraintAnnotation annotation instance for a given constraint declaration
     */
    @Override
    public void initialize(Mobile constraintAnnotation) {
        this.required = constraintAnnotation.required();
    }

    /**
     * 判斷參數是否合法
     *
     * @param value   object to validate
     * @param context context in which the constraint is evaluated
     */
    @Override
    public boolean isValid(CharSequence value, ConstraintValidatorContext context) {
        if (this.required) {
            // 驗證
            return isMobile(value);
        }
        if (StringUtils.hasText(value)) {
            // 驗證
            return isMobile(value);
        }
        return true;
    }

    private boolean isMobile(final CharSequence str) {
        Matcher m = pattern.matcher(str);
        return m.matches();
    }
}

使用

package com.wanqi.controller;


import com.wanqi.validator.Mobile;
import org.hibernate.validator.constraints.*;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;


@Validated
@RestController
public class TestController {

    @GetMapping("/phone")
    public String phone(@RequestParam @Mobile String phone) {
        return phone;
    }
}

image.png


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 不規則圖形背景排版高階技巧 -- 酷炫的六邊形網格背景圖
    今天，收到一個很有意思的提問，如何實現類似如下的背景效果圖： 嗯？核心主體是由多個六邊形網格疊加形成。 那麼我們該如何實現它呢？使用純 CSS 能夠實現嗎？ 當然可以，下麵我們就將嘗試如何使用 CSS 去實現這樣一個背景效果。 如何繪製六邊形？ 首先，看到這樣一個圖形，如果想要使用一個標簽完成整個背 ...
  • 如何做好一款管理後臺框架
    序 2020 年 10 月 17 日，我正式發佈了 Fantastic-admin 這款基於 Vue 的中後臺管理系統框架。在這兩年多的時間里，我陸續寫了幾篇我在開發這套框架中的一些心得和技術總結： 2020 年《我是如何設計後臺框架里那些錦上添花的動畫效果》 2020 年《一勞永逸，解決基於 ke ...
  • Java基礎類String學習分析
    1 String不可變性 String類被聲明為 final，因此它不可被繼承。 內部使用char數組存儲數據，該數組被聲明為final，這意味著value數組初始化之後就不能再指向其它數組。 String內部沒有改變value數組的方法 String類中所有修改String值的方法，如果內容沒有改 ...
  • MATLAB·學習 | music:祝你生日快樂
    ​ 一、前言 本篇文章內容為個人學習分享，讀代碼須知以下 樂理的基本知識，以及十二平均律（波的頻率與音高的標準），個人推薦在維基百科中搜索十二平均律表。 二、整體思想 在主函數中，將一些簡單的樂譜按照節拍，按鍵，基調，半音改變經行拆解。 然後我個人學習時，以440hz為標準的do依次類推，得到的基礎 ...
  • day09-功能實現08
    家居網購項目實現08 以下皆為部分代碼，詳見 https://github.com/liyuelian/furniture_mall.git 19.功能18-添加家居到購物車 19.1需求分析/圖解 會員登錄後，可以添加家居到購物車 完成購物車的設計和實現 每添加一個家居，購物車的數量+1並顯示 1 ...
  • 利用WordPress搭建屬於自己的網站
    怎麼用WordPress給自己搭建了一個網站？可能很多人都想擁有屬於自己的網站，這篇文章就找你怎麼利用WordPress搭建屬於自己的網站。如果你也正好有搭建個人網站的想法，那麼本文會給你一個參考，我儘量寫的比較詳細，給自己做一個記錄，也給大家一個參考。 寫在前面 在教程之前，先給大家show 一下 ...
  • 用了這麼多年的 SpringBoot 你知道什麼是 SpringBoot 的 Web 類型推斷嗎？
    用了這麼多年的 SpringBoot 那麼你知道什麼是 SpringBoot 的 web 類型推斷嗎？ 估計很多小伙伴都不知道，畢竟平時開發做項目的時候做的都是普通的 web 項目並不需要什麼特別的瞭解，不過抱著學習的心態，阿粉今天帶大家看一下什麼是 SpringBoot 的 web 類型推斷。 S ...
  • 【深入淺出 Yarn 架構與實現】4-3 RM 管理 NodeManager
    本篇繼續對 RM 中管理 NodeManager 的部分進行深入的講解。主要有三個部分：檢查 NM 是否存活；管理 NM 的黑白名單；響應 NM RPC 請求。 ...
一周排行
    -Advertisement-
    Play Games
  • .NET 6 Entity Framework Core Db First（1） 創建模型
    .Net8.0 Blazor Hybird 桌面端 (WPF/Winform) 實測可以完整運行在 win7sp1/win10/win11. 如果用其他工具打包,還可以運行在mac/linux下, 傳送門BlazorHybrid 發佈為無依賴包方式 安裝 WebView2Runtime 1.57 M ...
  • 資料庫升級PostgreSql+Garnet
    目錄前言PostgreSql安裝測試額外Nuget安裝Person.cs模擬運行Navicate連postgresql解決方案Garnet為什麼要選擇Garnet而不是RedisRedis不再開源Windows版的Redis是由微軟維護的Windows Redis版本老舊，後續可能不再更新Garne ...
  • 如何基於surging架設流媒體視頻推流（視頻講解）
    C#TMS系統代碼-聯表報表學習 領導被裁了之後很快就有人上任了，幾乎是無縫銜接，很難讓我不想到這早就決定好了。我的職責沒有任何變化。感受下來這個系統封裝程度很高，我只要會調用方法就行。這個系統交付之後不會有太多問題，更多應該是做小需求，有大的開發任務應該也是第二期的事，嗯？怎麼感覺我變成運維了？而 ...
  • EAV模型（實體-屬性-值）的設計和低代碼的處理方案（2）--數據的查詢處理
    我在隨筆《EAV模型（實體-屬性-值）的設計和低代碼的處理方案（1）》中介紹了一些基本的EAV模型設計知識和基於Winform場景下低代碼（或者說無代碼）的一些實現思路，在本篇隨筆中，我們來分析一下這種針對通用業務，且只需定義就能構建業務模塊存儲和界面的解決方案，其中的數據查詢處理的操作。 ...
  • C# 程式集、模塊和類型概念及關係
    對某個遠程伺服器啟用和設置NTP服務(Windows系統) 打開註冊表 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W32Time\TimeProviders\NtpServer 將 Enabled 的值設置為 1，這將啟用NTP伺服器功 ...
  • Django信號與擴展：深入理解與實踐
    title: Django信號與擴展：深入理解與實踐 date: 2024/5/15 22:40:52 updated: 2024/5/15 22:40:52 categories: 後端開發 tags: Django 信號 松耦合 觀察者 擴展 安全 性能 第一部分：Django信號基礎 Djan ...
  • Django3.2安裝源碼xadmin2步驟以及遇到的問題
    使用xadmin2遇到的問題&解決 環境配置： 使用的模塊版本： 關聯的包 Django 3.2.15 mysqlclient 2.2.4 xadmin 2.0.1 django-crispy-forms >= 1.6.0 django-import-export >= 0.5.1 django-r ...
  • 原創->CommonsCollections1-DefaultMap鏈
    今天我打算整點兒不一樣的內容，通過之前學習的TransformerMap和LazyMap鏈，想搞點不一樣的，所以我關註了另外一條鏈DefaultedMap鏈，主要調用鏈為： 調用鏈詳細描述： ObjectInputStream.readObject() DefaultedMap.readObject ...
  • 05-應用級開發者 AI 時代破局點
    後端應用級開發者該如何擁抱 AI GC？就是在這樣的一個大的浪潮下，我們的傳統的應用級開發者。我們該如何選擇職業或者是如何去快速轉型，跟上這樣的一個行業的一個浪潮? 0 AI金字塔模型 越往上它的整個難度就是職業機會也好，或者說是整個的這個運作也好,它的難度會越大,然後越往下機會就會越多,所以這是一 ...
  • Java面試題：讓依賴註入變得簡單，面對@Autowired和@Resource，該如何選擇？
    @Autowired是Spring框架提供的註解，@Resource是Java EE 5規範提供的註解。 @Autowired預設按照類型自動裝配，而@Resource預設按照名稱自動裝配。 @Autowired支持@Qualifier註解來指定裝配哪一個具有相同類型的bean，而@Resourc... ...
所有分類