最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

SpringBoot中controller深層詳細(xì)講解

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

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

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

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

目前controller層代碼會(huì)存在的問題:

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

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

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

統(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, "未找到請(qǐng)求資源"),
	;
	private int code;
    private String msg;
}

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

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

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

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

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

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

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

Java API 的規(guī)范 JSR303 定義了校驗(yàn)的標(biāo)準(zhǔn) validation-api ,其中一個(gè)比較出名的實(shí)現(xiàn)是 hibernate validation。

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

對(duì) @PathVariable 和 @RequestParam 參數(shù)進(jìn)行校驗(yàn)需要在入?yún)⑻幝暶骷s束的注解,如果校驗(yàn)失敗,會(huì)拋出 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ù)校驗(yàn):post和put 請(qǐng)求的參數(shù)推薦使用 @RequestBody 請(qǐng)求體參數(shù);

對(duì) @RequestBody 參數(shù)進(jìn)行校驗(yàn)需要在 DTO 對(duì)象中加入校驗(yàn)條件后,再搭配 @Validated 即可完成自動(dòng)校驗(yàn)。如果校驗(yàn)失敗,會(huì)拋出 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);
    }
}

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

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

原來拋出的異常會(huì)有如下問題:

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

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

統(tǒng)一攔截異常的是為了可以與前面定義下來的統(tǒng)一包裝返回結(jié)構(gòu)能對(duì)應(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ù)校驗(yàn)不通過時(shí)拋出的異常處理
     */
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public Result<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
        BindingResult bindingResult = ex.getBindingResult();
        StringBuilder sb = new StringBuilder("校驗(yàn)失敗:");
        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ù)校驗(yàn)不通過時(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);
    }
    /**
     * 頂級(jí)異常捕獲并統(tǒng)一處理,當(dāng)其他異常無法處理時(shí)候選擇使用
     */
    @ExceptionHandler({Exception.class})
    public Result<?> handle(Exception ex) {
        return Result.failed(ex.getMessage());
    }
}

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

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

相關(guān)文章

  • springboot中如何通過main方法調(diào)用service或dao

    springboot中如何通過main方法調(diào)用service或dao

    這篇文章主要介紹了springboot中如何通過main方法調(diào)用service或dao,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2022-02-02
  • 詳解Springboot自定義異常處理

    詳解Springboot自定義異常處理

    本篇文章主要介紹了詳解Springboot自定義異常處理,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧
    2017-04-04
  • IDEA搭建Maven模塊化項(xiàng)目的實(shí)現(xiàn)

    IDEA搭建Maven模塊化項(xiàng)目的實(shí)現(xiàn)

    本文主要介紹了IDEA搭建Maven模塊化項(xiàng)目的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2023-05-05
  • 基于Java實(shí)現(xiàn)中文分詞系統(tǒng)的示例代碼

    基于Java實(shí)現(xiàn)中文分詞系統(tǒng)的示例代碼

    這篇文章主要為大家詳細(xì)介紹了如何利用Java語言實(shí)現(xiàn)一個(gè)簡易的中文分詞系統(tǒng),文中的示例代碼講解詳細(xì),感興趣的小伙伴可以嘗試一下
    2022-07-07
  • 使用Java自帶的mail?API實(shí)現(xiàn)郵件發(fā)送功能全過程

    使用Java自帶的mail?API實(shí)現(xiàn)郵件發(fā)送功能全過程

    電子郵件的應(yīng)用非常廣泛,例如在某網(wǎng)站注冊了一個(gè)賬戶,自動(dòng)發(fā)送一封歡迎郵件,通過郵件找回密碼,自動(dòng)批量發(fā)送活動(dòng)信息等,下面這篇文章主要給大家介紹了關(guān)于如何使用Java自帶的mail?API實(shí)現(xiàn)郵件發(fā)送功能的相關(guān)資料,需要的朋友可以參考下
    2023-04-04
  • vue+springboot+shiro+jwt實(shí)現(xiàn)登錄功能

    vue+springboot+shiro+jwt實(shí)現(xiàn)登錄功能

    這篇文章主要介紹了vue+springboot+shiro+jwt實(shí)現(xiàn)登錄功能,本文通過示例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下
    2022-04-04
  • SpringBoot 使用Mybatis分頁插件實(shí)現(xiàn)詳解

    SpringBoot 使用Mybatis分頁插件實(shí)現(xiàn)詳解

    這篇文章主要介紹了SpringBoot 使用Mybatis分頁插件實(shí)現(xiàn)詳解,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2019-10-10
  • java使用RandomAccessFile類基于指針讀寫文件實(shí)例代碼

    java使用RandomAccessFile類基于指針讀寫文件實(shí)例代碼

    這篇文章主要介紹了java使用RandomAccessFile類基于指針讀寫文件實(shí)例代碼,具有一定參考價(jià)值,需要的朋友可以了解下。
    2017-10-10
  • 詳解Java編程中向量(Vector)的應(yīng)用

    詳解Java編程中向量(Vector)的應(yīng)用

    這篇文章主要介紹了Java中的向量(Vector)的應(yīng)用,Vector也是Java中比較常用的一個(gè)類,需要的朋友可以參考下
    2015-10-10
  • Java學(xué)習(xí)筆記:基本輸入、輸出數(shù)據(jù)操作實(shí)例分析

    Java學(xué)習(xí)筆記:基本輸入、輸出數(shù)據(jù)操作實(shí)例分析

    這篇文章主要介紹了Java學(xué)習(xí)筆記:基本輸入、輸出數(shù)據(jù)操作,結(jié)合實(shí)例形式分析了Java輸入、輸出數(shù)據(jù)相關(guān)函數(shù)使用技巧與操作注意事項(xiàng),需要的朋友可以參考下
    2020-04-04

最新評(píng)論

汨罗市| 云南省| 黄大仙区| 大同县| 潮州市| 澜沧| 建德市| 亚东县| 那曲县| 林西县| 黎川县| 遂宁市| 民和| 鄂托克前旗| 巴林左旗| 若尔盖县| 浦县| 锦屏县| 麻城市| 马尔康县| 林州市| 阿城市| 通榆县| 台州市| 弋阳县| 游戏| 新宾| 迭部县| 申扎县| 灌云县| 宝兴县| 衡阳市| 曲阜市| 界首市| 四子王旗| 白玉县| 馆陶县| 常宁市| 娱乐| 宝山区| 新源县|