欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

SpringBoot中controller深層詳細講解

 更新時間:2023年02月02日 16:39:03   作者:ldcaws  
這篇文章主要介紹了SpringBoot在Controller層接收參數(shù)的常用方法,本文通過實例代碼給大家介紹的非常詳細,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下

在基于spring框架的項目開發(fā)中,必然會遇到controller層,它可以很方便的對外提供數(shù)據(jù)接口服務(wù),也是非常關(guān)鍵的出口,所以非常有必要進行規(guī)范統(tǒng)一,使其既簡潔又優(yōu)雅。

controller層的職責(zé)為負責(zé)接收和響應(yīng)請求,一般不負責(zé)具體的邏輯業(yè)務(wù)的實現(xiàn)。controller主要工作如下:

  • 接收請求并解析參數(shù);
  • 調(diào)用service層執(zhí)行具體的業(yè)務(wù)邏輯(可能包含參數(shù)校驗);
  • 捕獲業(yè)務(wù)異常做出反饋;
  • 業(yè)務(wù)邏輯執(zhí)行成功做出響應(yīng);

目前controller層代碼會存在的問題:

  • 參數(shù)校驗過多地耦合了業(yè)務(wù)代碼,違背了單一職責(zé)原則;
  • 可能在多個業(yè)務(wù)邏輯中拋出同一個異常,導(dǎo)致代碼重復(fù);
  • 各種異常反饋和成功響應(yīng)格式不統(tǒng)一,接口對接不友好;

優(yōu)雅寫法一:統(tǒng)一返回結(jié)構(gòu)

統(tǒng)一返回值類型,無論項目前后端是否分離都是非常必要的,方便對接接口的前端開發(fā)人員更加清晰地知道這個接口的調(diào)用是否成功,不能僅僅簡單地看返回值是否為 null 就判斷成功與否,因為有些接口的設(shè)計就是如此。

統(tǒng)一返回結(jié)構(gòu),通過狀態(tài)碼就能清楚的知道接口的調(diào)用情況:

@Data
public class ResponseData<T> {
    private Boolean status = true;
    private int code = 200;
    private String message;
    private T data;
    public static ResponseData ok(Object data) {
        return new ResponseData(data);
    }
    public static ResponseData ok(Object data,String message) {
        return new ResponseData(data,message);
    }
    public static ResponseData fail(String message,int code) {
        ResponseData responseData= new ResponseData();
        responseData.setCode(code);
        responseData.setMessage(message);
        responseData.setStatus(false);
        responseData.setData(null);
        return responseData;
    }
    public ResponseData() {
        super();
    }
    public ResponseData(T data) {
        super();
        this.data = data;
    }
    public ResponseData(T data,String message) {
        super();
        this.data = data;
        this.message=message;
    }
}
@AllArgsConstructor
@Data
public enum ResponseCode {
    SYS_FAIL(1, "操作失敗"),
    SYS_SUCESS(200, "操作成功"),
    SYSTEM_ERROR_CODE_403(403, "權(quán)限不足"),
    SYSTEM_ERROR_CODE_404(404, "未找到請求資源"),
	;
	private int code;
    private String msg;
}

統(tǒng)一返回結(jié)構(gòu)后,就可以在controller中使用了,但是每個controller都這么寫,都是很重復(fù)的工作,所以還可以繼續(xù)想辦法處理統(tǒng)一返回結(jié)構(gòu)。

優(yōu)雅寫法二:統(tǒng)一包裝處理

Spring 中提供了一個類 ResponseBodyAdvice ,能幫助我們實現(xiàn)上述需求:

ResponseBodyAdvice 是對 Controller 返回的內(nèi)容在 HttpMessageConverter 進行類型轉(zhuǎn)換之前攔截,進行相應(yīng)的處理操作后,再將結(jié)果返回給客戶端。這樣就可以把統(tǒng)一包裝處理的工作放到這個類里面,其中supports判斷是否要交給beforeBodyWrite 方法執(zhí)行,true為需要,false為不需要,beforeBodyWrite 是對response的具體處理。

@RestControllerAdvice(basePackages = "com.example.demo")
public class ResponseAdvice implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        // 如果不需要進行封裝的,可以添加一些校驗手段,比如添加標記排除的注解
        return true;
    }
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        // 提供一定的靈活度,如果body已經(jīng)被包裝了,就不進行包裝
        if (body instanceof Result) {
            return body;
        }
        return Result.success(body);
    }
}

這樣即能實現(xiàn)對controller返回的數(shù)據(jù)進行統(tǒng)一,又不需要對原有代碼進行大量的改動了。

優(yōu)雅寫法三:參數(shù)校驗

Java API 的規(guī)范 JSR303 定義了校驗的標準 validation-api ,其中一個比較出名的實現(xiàn)是 hibernate validation。

@PathVariable 和 @RequestParam 參數(shù)校驗:get請求的參數(shù)接收一般依賴這兩個注解,但是處于 url 有長度限制和代碼的可維護性,超過 5 個參數(shù)盡量用實體來傳參;

對 @PathVariable 和 @RequestParam 參數(shù)進行校驗需要在入?yún)⑻幝暶骷s束的注解,如果校驗失敗,會拋出 MethodArgumentNotValidException 異常。

@RestController
@RequestMapping("/test")
public class TestController {
    private TestService testService;
	@Autowired
    public void setTestService(TestService prettyTestService) {
        this.testService = prettyTestService;
    }
    @GetMapping("/{num}")
    public Integer num(@PathVariable("num") @Min(1) @Max(20) Integer num) {
        return num * num;
    }
    @GetMapping("/email")
    public String email(@RequestParam @NotBlank @Email String email) {
        return email;
    }
}

@RequestBody 參數(shù)校驗:post和put 請求的參數(shù)推薦使用 @RequestBody 請求體參數(shù);

對 @RequestBody 參數(shù)進行校驗需要在 DTO 對象中加入校驗條件后,再搭配 @Validated 即可完成自動校驗。如果校驗失敗,會拋出 ConstraintViolationException 異常。

@Data
public class TestDTO {
    @NotBlank
    private String userName;
    @NotBlank
    @Length(min = 6, max = 20)
    private String password;
    @NotNull
    @Email
    private String email;
}
@RestController
@RequestMapping("/test")
public class TestController {
    private TestService testService;
	@Autowired
    public void setTestService(TestService testService) {
        this.testService = testService;
    }
    @PostMapping("/testValidation")
    public void testValidation(@RequestBody @Validated TestDTO testDTO) {
        this.testService.save(testDTO);
    }
}

自定義校驗規(guī)則:有些時候 JSR303 標準中提供的校驗規(guī)則不滿足復(fù)雜的業(yè)務(wù)需求,也可以自定義校驗規(guī)則;

優(yōu)雅寫法四:自定義異常與統(tǒng)一攔截異常

原來拋出的異常會有如下問題:

  • 拋出的異常不夠具體,只是簡單地把錯誤信息放到了 Exception 中;
  • 拋出異常后,Controller 不能具體地根據(jù)異常做出反饋;
  • 雖然做了參數(shù)自動校驗,但是異常返回結(jié)構(gòu)和正常返回結(jié)構(gòu)不一致;

自定義異常是為了后面統(tǒng)一攔截異常時,對業(yè)務(wù)中的異常有更加細顆粒度的區(qū)分,攔截時針對不同的異常作出不同的響應(yīng)。

統(tǒng)一攔截異常的是為了可以與前面定義下來的統(tǒng)一包裝返回結(jié)構(gòu)能對應(yīng)上,還有就是希望無論系統(tǒng)發(fā)生什么異常,Http 的狀態(tài)碼都要是 200 ,盡可能由業(yè)務(wù)來區(qū)分系統(tǒng)的異常。

//自定義異常
public class ForbiddenException extends RuntimeException {
    public ForbiddenException(String message) {
        super(message);
    }
}
//自定義異常
public class BusinessException extends RuntimeException {
    public BusinessException(String message) {
        super(message);
    }
}
//統(tǒng)一攔截異常
@RestControllerAdvice(basePackages = "com.example.demo")
public class ExceptionAdvice {
    /**
     * 捕獲 {@code BusinessException} 異常
     */
    @ExceptionHandler({BusinessException.class})
    public Result<?> handleBusinessException(BusinessException ex) {
        return Result.failed(ex.getMessage());
    }
    /**
     * 捕獲 {@code ForbiddenException} 異常
     */
    @ExceptionHandler({ForbiddenException.class})
    public Result<?> handleForbiddenException(ForbiddenException ex) {
        return Result.failed(ResultEnum.FORBIDDEN);
    }
    /**
     * {@code @RequestBody} 參數(shù)校驗不通過時拋出的異常處理
     */
    @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(ResultEnum.VALIDATE_FAILED.getCode(), msg);
        }
        return Result.failed(ResultEnum.VALIDATE_FAILED);
    }
    /**
     * {@code @PathVariable} 和 {@code @RequestParam} 參數(shù)校驗不通過時拋出的異常處理
     */
    @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);
    }
    /**
     * 頂級異常捕獲并統(tǒng)一處理,當(dāng)其他異常無法處理時候選擇使用
     */
    @ExceptionHandler({Exception.class})
    public Result<?> handle(Exception ex) {
        return Result.failed(ex.getMessage());
    }
}

通過上述寫法,可以發(fā)現(xiàn) Controller 的代碼變得非常簡潔優(yōu)雅,可以清楚知道每個參數(shù)、每個DTO的校驗規(guī)則,可以明確返回的結(jié)構(gòu),包括異常情況。

到此這篇關(guān)于SpringBoot中controller深層詳細講解的文章就介紹到這了,更多相關(guān)SpringBoot controller內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • ShardingSphere結(jié)合MySQL實現(xiàn)分庫分表的項目實踐

    ShardingSphere結(jié)合MySQL實現(xiàn)分庫分表的項目實踐

    在實際開發(fā)中,如果表的數(shù)據(jù)過大我們需要把一張表拆分成多張表,本文主要介紹了使用ShardingSphere實現(xiàn)MySQL分庫分表,具有一定的參考價值,感興趣的可以了解一下
    2024-03-03
  • 在controller中如何設(shè)置接收參數(shù)的默認值

    在controller中如何設(shè)置接收參數(shù)的默認值

    這篇文章主要介紹了在controller中如何設(shè)置接收參數(shù)的默認值,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教
    2022-03-03
  • SpringBoot深入探究四種靜態(tài)資源訪問的方式

    SpringBoot深入探究四種靜態(tài)資源訪問的方式

    這一節(jié)詳細的學(xué)習(xí)一下SpringBoot的靜態(tài)資源訪問相關(guān)的知識點。像這樣的知識點還挺多,比如SpringBoot2的Junit單元測試等等。本章我們來了解靜態(tài)資源訪問的四種方式
    2022-05-05
  • Java中綴表達式轉(zhuǎn)后綴表達式實現(xiàn)方法詳解

    Java中綴表達式轉(zhuǎn)后綴表達式實現(xiàn)方法詳解

    這篇文章主要介紹了Java中綴表達式轉(zhuǎn)后綴表達式實現(xiàn)方法,結(jié)合實例形式分析了Java中綴表達式轉(zhuǎn)換成后綴表達式的相關(guān)算法原理與具體實現(xiàn)技巧,需要的朋友可以參考下
    2019-03-03
  • Java 數(shù)組迭代你會用嗎

    Java 數(shù)組迭代你會用嗎

    Java 數(shù)組是我們學(xué)習(xí)或工作中常用到的數(shù)據(jù)結(jié)構(gòu),我們會經(jīng)常寫數(shù)組迭代的代碼,本文介紹三種數(shù)組迭代的方式,感興趣的可以了解一下
    2021-09-09
  • Spring?Security中自定義cors配置及原理解析

    Spring?Security中自定義cors配置及原理解析

    在Spring框架中,通過自定義CORS配置可根據(jù)實際情況調(diào)整URL的協(xié)議、主機、端口等,以適應(yīng)"同源安全策略",配置原理涉及CorsConfigurer和CorsFilter,自定義配置需要注意@Configuration注解、方法名以及可能的@Autowired注解
    2024-10-10
  • Jmeter后置處理器實現(xiàn)過程及方法應(yīng)用

    Jmeter后置處理器實現(xiàn)過程及方法應(yīng)用

    這篇文章主要介紹了Jmeter后置處理器實現(xiàn)過程及方法應(yīng)用,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下
    2020-09-09
  • JDBC中Fetchsize的實現(xiàn)

    JDBC中Fetchsize的實現(xiàn)

    fetchsize是指在執(zhí)行數(shù)據(jù)庫查詢時,每次從數(shù)據(jù)庫中獲取的記錄條數(shù),它對內(nèi)存使用和網(wǎng)絡(luò)傳輸效率有重要影響,在MyBatis中,可以通過全局設(shè)置或語句級別設(shè)置fetchsize,來控制查詢操作的內(nèi)存使用和提升性能,合理的fetchsize設(shè)置能有效減少網(wǎng)絡(luò)往返次數(shù)和防止內(nèi)存溢出
    2024-09-09
  • Java中Volatile關(guān)鍵字能保證原子性嗎

    Java中Volatile關(guān)鍵字能保證原子性嗎

    這篇文章主要介紹了Java中Volatile關(guān)鍵字能保證原子性嗎,文章圍繞主題展開詳細的內(nèi)容介紹,具有一定的參考價值,需要的小伙伴可以參考一下
    2022-08-08
  • Java編程常見內(nèi)存溢出異常與代碼示例

    Java編程常見內(nèi)存溢出異常與代碼示例

    這篇文章主要介紹了Java編程常見內(nèi)存溢出異常與代碼示例,具有一定參考價值,需要的朋友可以了解下。
    2017-11-11

最新評論