摘要:在接口服務開發中,難免會校驗傳入方的參數校驗,尤其在請求時,驗證字符長度,字符類型是否滿足數據庫中字段的最大長度及類型,如果不符合條件應及時攔截并返回,避免后續的流程。
公司轉java開發也有一段時間了,在實際開發過程中還是會遇到一些問題的,本篇主要記錄下接口服務中參數驗證相關的開發過程和一些知識點。
在接口服務開發中,難免會校驗傳入方的參數校驗,尤其在post請求時,驗證字符長度,字符類型是否滿足數據庫中字段的最大長度及類型,如果不符合條件應及時攔截并返回,避免后續的流程。
hibernate validator constraint 注解先了解下提供的注解,基本上常用的都提供了,在代碼編寫時還是比較方便的,一個注解解決了驗證邏輯。
/**Bean Validation 中內置的 constraint**/ @Null //被注釋的元素必須為 null @NotNull //被注釋的元素必須不為 null @AssertTrue //被注釋的元素必須為 true @AssertFalse //被注釋的元素必須為 false @Min(value) //被注釋的元素必須是一個數字,其值必須大于等于指定的最小值 @Max(value) //被注釋的元素必須是一個數字,其值必須小于等于指定的最大值 @DecimalMin(value) //被注釋的元素必須是一個數字,其值必須大于等于指定的最小值 @DecimalMax(value) //被注釋的元素必須是一個數字,其值必須小于等于指定的最大值 @Size(max=, min=) //被注釋的元素的大小必須在指定的范圍內 @Digits (integer, fraction) //被注釋的元素必須是一個數字,其值必須在可接受的范圍內 @Past //被注釋的元素必須是一個過去的日期 @Future //被注釋的元素必須是一個將來的日期 @Pattern(regex=,flag=) //被注釋的元素必須符合指定的正則表達式 /**Hibernate Validator 附加的 constraint**// @NotBlank(message =) //驗證字符串非null,且長度必須大于0 @Email //被注釋的元素必須是電子郵箱地址 @Length(min=,max=) //被注釋的字符串的大小必須在指定的范圍內 @NotEmpty //被注釋的字符串的必須非空 @Range(min=,max=,message=) //被注釋的元素必須在合適的范圍內簡單使用 驗證字段添加需要的注解
/** * 訂單號 */ @Range(min=1,message = "不是正確的訂單號") private Long e_order_id; /** * 產品code */ @NotBlank(message = "不是正確的產品code") private String product_code;BindingResult接收
在controller中,我們通過BindingResult來接收對應的驗證信息
@ApiOperation(value = "修改訂單狀態", notes = "若找不到結果則返回 null。") @RequestMapping(value = "/status", method = RequestMethod.PUT) @ResponseBody public String PutOrderStatus(@RequestBody @Validated @NotNull OrderStatusReq req, BindingResult bindingResult) { String validResult = assertParameterValid(bindingResult); if (validResult != null) { return validResult; } return iOrderStatusService.putOrderStatus(req).toString(); }
protected String assertParameterValid(BindingResult bindingResult) { if (bindingResult.hasErrors()) { FieldError error = bindingResult.getFieldError(); return new Response<>(BusinessReturnCode.VALIDATION_FAILURE, String.format("[%s] %s.", error.getField(), error.getDefaultMessage()), null).toString(); } return null; }枚舉Enum校驗
可惜的是,Hibernate validation中沒有提供枚舉相關的校驗,而實際業務場景中會有很多校驗類型、狀態等,這里我們只能自定義了。
首先我們需要自定義一個annotation來標記你的驗證字段,因為Validator框架里面的基礎annotation已經不夠用。
然后自定義一個Validator(繼承ConstraintValidator),并將annotation類型給到ConstraintValidator的泛型列表,相當于做了一個綁定。然后implement ConstraintValidator的兩個方法,在isValid方法里面用要驗證的枚舉驗證參數。
可以看下一個簡單的demo:
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) @Constraint(validatedBy = {EnumValidAnnotation.EnumValidtor.class}) @Documented public @interface EnumValidAnnotation { String message() default "枚舉不在范圍內"; Class>[] groups() default {}; Class extends Payload>[] payload() default {}; Class>[] target() default {}; public class EnumValidtor implements ConstraintValidator{ Class>[] cls; //枚舉類 @Override public void initialize(EnumValidAnnotation constraintAnnotation) { cls = constraintAnnotation.target(); } @Override public boolean isValid(Integer value, ConstraintValidatorContext context) { System.out.println("枚舉值" + value); if (cls.length > 0) { for (Class> cl : cls) { try { if (cl.isEnum()) { //枚舉類驗證 Object[] objs = cl.getEnumConstants(); Method method = cl.getMethod("getCode"); for (Object obj : objs) { Object code = method.invoke(obj); if (value.equals(code)) { return true; } } } } catch (NoSuchMethodException e) { e.printStackTrace(); } catch (IllegalAccessException e) { e.printStackTrace(); } catch (InvocationTargetException e) { e.printStackTrace(); } } } return false; } }
這樣的話在你要驗證的字段上加上對應的注解即可:
/** * 更新類型 */ @EnumValidAnnotation(target = OrderStatusEnum.class) private int stype;總結
java中注解還是挺有意思的,類似c#中的attribute,但java中各種框架、方法的注解真的很多,不一直使用或做對應的筆記真的很容易忘記,還是需要多多積累和記錄的。
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/73964.html
摘要:前言最近在開發某個模塊的功能時,里面包含大量對請求參數判空和驗證的步驟且參數繁多,存在大量的重復判斷,驗證影響代碼的美觀遂決定優化這部分代碼。 前言 最近在開發某個模塊的功能時,里面包含大量對請求參數判空和驗證的步驟且參數繁多,存在大量的重復判斷,驗證影響代碼的美觀遂決定優化這部分代碼。SpringBoot自帶了參數驗證框Hibernate Validator,下面是自己的學習筆記。 ...
摘要:前言最近在開發某個模塊的功能時,里面包含大量對請求參數判空和驗證的步驟且參數繁多,存在大量的重復判斷,驗證影響代碼的美觀遂決定優化這部分代碼。 前言 最近在開發某個模塊的功能時,里面包含大量對請求參數判空和驗證的步驟且參數繁多,存在大量的重復判斷,驗證影響代碼的美觀遂決定優化這部分代碼。SpringBoot自帶了參數驗證框Hibernate Validator,下面是自己的學習筆記。 ...
摘要:可能有人認為數據校驗模塊并不是那么的重要,因為硬編碼都可以做。我以數據綁定為引子引出了數據校驗這一塊,是想表明它的重要性。關于數據校驗這塊,最新的是,也就是我們常說的。 每篇一句 吾皇一日不退役,爾等都是臣子 對Spring感興趣可掃碼加入wx群:Java高工、架構師3群(文末有二維碼) 前言 前幾篇文章在講Spring的數據綁定的時候,多次提到過數據校驗。可能有人認為數據校驗模塊...
摘要:創建工程將框架代碼包解壓后放到工作目錄。方便起見,本教程使用為例。添加創建一個,負責響應相關的業務請求。添加標注在中,對輸入參數進行校驗通常使用標注。在本教程,我們將實現的增和查的工作。創建用戶用戶名重啟并提交創建請求。 環境準備 系統:MacOS 開發:IntelliJ IDEA 語言:Java8 其它:Mysql、Redis 腳手架代碼 Spring提供了一個創建項目腳手架的官...
摘要:所以就有今天的話題利用注解對進行校驗。利用注解對進行校驗,主要是利用框架,實現了的接口關于校驗的接口,直接使用非常方便,省時省力。 最近寫業務代碼,因為頁面復雜,導致對應的Bean屬性非常多,而產品大佬又提出各種校驗要求。 emmmmmm......如果寫if條件來校驗,那簡直是又臭又長。 所以就有今天的話題——利用注解對Bean進行校驗。 利用注解對Bean進行校驗,主要是利用hib...
閱讀 2742·2021-11-24 10:23
閱讀 1153·2021-11-17 09:33
閱讀 2503·2021-09-28 09:41
閱讀 1409·2021-09-22 15:55
閱讀 3641·2019-08-29 16:32
閱讀 1903·2019-08-29 16:25
閱讀 1056·2019-08-29 11:06
閱讀 3421·2019-08-29 10:55