2. 程式人生 > >Java筆記 #06# 自定義簡易參數校驗框架——EasyValidator

Java筆記 #06# 自定義簡易參數校驗框架——EasyValidator

阿新 • • 發佈：2019-02-04
ide lse logger 需求 diy eve rdquo names page

索引

  • 一、校驗效果演示
  • 二、校驗器定義示例
    • 定義一個最簡單的校驗器
    • 正則校驗器
  • 三、EasyValidator的實現
  • 四、更好的應用姿勢——配合註解和面向切面

“參數校驗”屬於比較無聊但是又非常硬性的需求。。。

最原始的方式就是在方法頭手動逐個校驗，但是這樣寫不太好看，而且容易造成大量重復代碼，擴展起來也不是很方便。

我簡單看了一下已有的Spring Validation，粗看下去不太合胃口。想想寫一個似乎也不難，於是嘗試自定義了一個簡單的玩具版本。

一、校驗效果演示

MyTest.java：

public
 
 class MyTest {
    /**
     * 創建一次，應用N次。
     */
    private static final EasyValidator EASY_VALIDATOR = new EasyValidator();

    public static void main(String[] args) {
        // 允許自定義各種各樣的校驗器，只需實現Validator接口即可
        EASY_VALIDATOR.addValidator(new RegexpValidator());
        EASY_VALIDATOR.addValidator(
 
new TypeValidator());

        // 示例↓
        int type = 3;
        String username = "           ";
        String password = "32";
        // 通過拋異常的方式傳遞具體錯誤信息
        EASY_VALIDATOR.check(type, "type");
        EASY_VALIDATOR.check(username, "username.regexp");
        EASY_VALIDATOR.check(password, 
 
"password.regexp");
    }
}
/*
ouput example - 1:
Exception in thread "main" org.sample.exception.ValidateException: type越界了！
ouput example - 2:
Exception in thread "main" org.sample.exception.ValidateException: 用戶名不能為空
 */

通過addValidator方法讓校驗器生效。

二、校驗器定義示例

僅需實現Validator接口就可以隨心所欲地定義各式各樣的參數校驗器。

Validator接口僅包含三個非常簡單的方法：

技術分享圖片 
public interface Validator {

    /**
     * 用於標識和查找校驗器
     */
    String getName();

    void validate(Object o);

    /**
     * 便於多級查找校驗方法，如果不支持該功能，
     * 直接內部調void validate(Object o);方法即可
     */
    void validate(Object o, String validatorName);
}
Validator.java

定義一個最簡單的校驗器

validate方法說明：校驗不通過拋異常就ok了，在異常裏傳遞具體錯誤信息。

定義不拋異常的校驗器。。是沒意義的。在“傳Result”和“傳異常”間我也權衡了一下，網上說“傳異常”沒“傳Result”性能好，但就寫代碼的角度來看，還是傳異常幹凈得多，並且更簡單，性能方面的差距估計也是微乎其微，so。。。。

public class TypeValidator implements Validator {

    private static final String NAME = "type";

    @Override
    public String getName() {
        return NAME;
    }

    @Override
    public void validate(Object o) {
        int i = Integer.parseInt(String.valueOf(o));
        // 通過拋異常的方式傳遞具體錯誤信息
        if (i < 0 || i > 10) throw new ValidateException("type越界了！");
        // 沒拋出異常代表沒問題！
    }

    @Override
    public void validate(Object o, String validatorName) {
        validate(o);
    }
}

正則校驗器

同樣可以定義一個復雜些的校驗器↓

原始版本來自Spring筆記#02#利用切面和註解校驗方法參數

這是一個專門用來校驗字符串的校驗器，思路就是用.properties文件存鍵值對（“名”-正則）然後讀到HashMap構造Pattern。根據“名”查找對應的Pattern進行正則校驗。順便提一下自定義的兩種異常：ValidatorException和ValidateException，兩個異常都繼承自運行時異常，這樣不至於把代碼搞亂，前者屬於程序員的錯誤，後者則用於拋出校驗失敗的具體信息。

public class RegexpValidator implements Validator {

    private static final String NAME = "regexp";

    private static final String FILE_NAME = File.separator + "easy-validator.properties";

    private static final Map<String, Pattern> MAP = new HashMap<>();

    static {
        // 把.properties文件裏的鍵值對讀到內存裏
        Properties prop = new Properties();
        try (InputStream input = ServiceMethodAspect.class.getClassLoader().getResourceAsStream(FILE_NAME)){
            if (input == null) {
                throw new RuntimeException("Sorry, unable to find " + FILE_NAME);
            }
            prop.load(input);
            Enumeration<?> e = prop.propertyNames();
            while (e.hasMoreElements()) {
                String key = (String) e.nextElement();
                String value = prop.getProperty(key);
                MAP.put(key, Pattern.compile(value));
            }
        } catch (IOException e) {
            throw new RuntimeException("An exception occurred while reading " + FILE_NAME, e);
        }
    }

    @Override
    public String getName() {
        return NAME;
    }

    @Override
    public void validate(Object o) {
        throw new ValidatorException("validate(Object o)方法未定義");
    }

    @Override
    public void validate(Object o, String validatorName) {
        String str = String.valueOf(o);
        if (StringUtils.isBlank(str)) {
            throw new ValidateException(PresentationUtils.english2chinese(validatorName) + "不能為空");
        } else {
            Pattern pattern = MAP.get(validatorName);
            // 程序員要確保格式已經定義
            if (pattern == null) throw new ValidatorException(validatorName + "校驗器未定義");
            // 格式檢查
            if (!pattern.matcher(str).matches()) {
                throw new ValidateException(PresentationUtils.english2chinese(validatorName) + "格式不正確");
            }
        }
    }
}

在相應路徑下的easy-validator.properties中定義正則表達式：

username=^[a-zA-Z0-9_]{4,16}$
# 用戶名：4到16位大小寫字母、數字、下劃線
password=^[a-zA-Z0-9_]{6,16}$
# 密碼：6到16位大小寫字母、數字、下劃線

三、EasyValidator的實現

EasyValidator的實現像它的名字一樣簡單。每個校驗器由getName()的返回值標識（確保唯一），允許自定義多級校驗器，命名規則為“xx.次級校驗器名.頂級校驗器名”，詳細匹配過程參考代碼實現：

/**
 * 自定義的一個簡易參數校驗器
 */
public class EasyValidator {
    /**
     * 初始化後不再更新，否則在多線程環境下有風險
     */
    private static final Map<String, Validator> MAP = new HashMap<>();

    public void addValidator(Validator validator) {
        MAP.put(validator.getName(), validator);
    }

    public void check(Object object, String validatorName) {
        Validator validator = MAP.get(getLast(validatorName));
        if (validator != null) {
            validator.validate(object, removeLast(validatorName));
        } else {
            throw new ValidatorException("validator not found, validatorName=" + validatorName);
        }
    }

    /**
     * 獲取頂級校驗器名稱，如果只有一級就原樣返回
     */
    private static String getLast(String validatorName) {
        int index = StringUtils.lastIndexOf(validatorName, ‘.‘);
        if (index == -1) return validatorName;
        return StringUtils.substring(validatorName, index + 1);
    }

    /**
     * 去掉頂級校驗器名稱，以便向下傳遞，如果只有一級就原樣返回
     */
    private static String removeLast(String validatorName) {
        int index = StringUtils.lastIndexOf(validatorName, ‘.‘);
        if (index == -1) return validatorName;
        return StringUtils.substring(validatorName, 0, index);
    }
}

四、更好的應用姿勢——配合註解和面向切面

Example代碼（因為用到了Spring的黑科技，需要添加相應依賴）：

@Aspect
@Configuration
public class ServiceMethodAspect {

    private static final Logger LOGGER = LogManager.getLogger();

    private static final ParameterNameDiscoverer DISCOVERER = new LocalVariableTableParameterNameDiscoverer();

    private static final EasyValidator EASY_VALIDATOR = new EasyValidator();

    static {
        EASY_VALIDATOR.addValidator(new RegexpValidator());
    }

    @Pointcut("execution(* org.sample.shop.common.service.impl.*.*(..))")
    public void serviceMethod() {}

    @Around("serviceMethod()")
    public ServiceResult work(ProceedingJoinPoint jp) {
        // 參數校驗
        Method method = ((MethodSignature) jp.getSignature()).getMethod();
        Parameter[] parameter = method.getParameters(); // 便於獲取註解對象
        String[] parameterName = DISCOVERER.getParameterNames(method);
        Object[] parameterValue = jp.getArgs(); 
        String currentValidatorName;
        try {
            // 逐個參數進行校驗，先嘗試獲取Validator註解值，註解不存在用參數名作為校驗器名
            for (int i = 0; i != parameter.length; ++i) {
                if (parameter[i].getAnnotation(Validator.class) != null) {
                    currentValidatorName = parameter[i].getAnnotation(Validator.class).value();
                } else {
                    currentValidatorName = parameterName[i];
                }
                LOGGER.info("check: object={}, validatorName={}", parameterValue[i], currentValidatorName); // 偶爾出現校驗異常有日誌可查 TODO 用戶信息
                EASY_VALIDATOR.check(parameterValue[i], currentValidatorName);
            }
            return (ServiceResult) jp.proceed();
        } catch (ValidateException e) {
            return ServiceResult.fail(e.getMessage());
        } catch (Throwable throwable) {
            // 錯誤日誌
            LOGGER.error(new DetailedInfo(jp.getArgs(), throwable.getMessage()), throwable);
            return ServiceResult.error();
        }
    }

    private class DetailedInfo {

        private Object[] args;

        private String message;

        DetailedInfo(Object[] args, String message) {
            this.args = args;
            this.message = message;
        }

        @Override
        public String toString() {
            return "DetailedInfo{" +
                    "args=" + Arrays.toString(args) +
                    ", message=‘" + message + ‘\‘‘ +
                    ‘}‘;
        }
    }
}

Example代碼之應用註解：

    @Override
    public ServiceResult<User> getUser(@Validator("username.regexp") String username, @Validator("password.regexp") String password) {
        return ServiceUtils.daoOperation(() -> {
            User user = userDAO.getUser(username, password);
            return user != null ? ServiceResult.ok(user) : new ServiceResult<>(LOGIN_FAIL);
        }, Connection.TRANSACTION_READ_COMMITTED);
    }

註解的實現依然和Spring筆記#02#利用切面和註解校驗方法參數裏的差不多，只不過換了個名字。。。

Java筆記 #06# 自定義簡易參數校驗框架——EasyValidator

相關推薦

Java筆記 #06# 自定義簡易參數校驗框架——EasyValidator

ide lse logger 需求 diy eve rdquo names page 索引 一、校驗效果演示 二、校驗器定義示例 定義一個最簡單的校驗器 正則校驗器 三、EasyValidator的實現 四、更好的應用姿勢—&md

在Echarts 柱形圖的單擊事件中寫入自定義的參數

cnblogs img ges == innerhtml .com echart 通過 code

修改MySQL高可用模塊接收自定義VIP參數

mysql 高可用 mha 但凡是MySQL DBA肯定都聽說過MHA個高可用方案，而且很多公司都是通過對MHA做二次開發來實現MySQL高可用的。如果MHA不結合VIP的話，每次主庫切換都需要程序修改連數據庫的配置，這樣比較麻煩。而采用MHA+VIP的方式時可以在主庫切換的過程中讓VIP

NPC腳本界面自定義美化參數說明

div post 添加 自己 log 是否 移動 enme 腳本 覺得NPC對話界面太單調了 可以自己定義： 在[@main]下面加上 #ACT OPENMERCHANTBIGDLG 參數（WIL文件序號 圖片序號 是否可以移動（0，1） 顯示位置（0=左上角，1=右

自定義header參數時的命名要求

劃線 remote 參數 sta clu nor invalid forward sendfile HTTP頭是可以包含英文字母([A-Za-z])、數字([0-9])、連接號(-)hyphens, 也可義是下劃線(_)。在使用nginx的時候應該避免使用包含下劃線的HTT

MVC路由學習：自定義路由參數（用戶看不到參數名），重新定義路由規則

route sys 工具 str optional href clas local amp 一，項目有需求將項目地址中的參數名不顯示給用戶看 在MVC定義一個方法： 　　　　public ActionResult GetUserInfo(string Name, str

java創建自定義類的數組

out char string 我想 想是 應該 字母 開始 鄰接矩陣 今天在學圖論的最小生成樹，開始一直在想是用鄰接矩陣還是關聯矩陣來表示圖，但是發現這樣都會有好多空間浪費。於是我就自定義一個邊的類，裏面包含了權值，關聯的端點1，端點2，和圖的表示字母。發現我想創建11條

自定義spring參數註解 - 打破@RequestBody單體限制

hand 動態 except builder 替換 true delattr actor 對象 本文主要描述怎樣自定義類似@RequestBody這樣的參數註解來打破@RequestBody的單體限制。 目錄1 @RequestBody的單體限制2 自定義spring的

jsr-303 參數校驗—自定義校驗註解

nbsp 們的 else spa efault ssa password 為什麽 ini 1、為什麽要自定義？ 通過上篇學習，了解到很多常用註解了，但是呢，總是有那麽些需求.... 2、案例分析(手機號格式) 2.1、需要驗證的實體 Bean pu

Spring boot中自定義Json參數解析器

分享圖片 star 搭建 convert ner 方法註入 DDU handler format 轉載請註明出處。。。 一、介紹 用過springMVC/spring boot的都清楚，在controller層接受參數，常用的都是兩種接受方式，如下 1 /** 2

Java參數校驗工具validation實踐

jar包依賴 pos jar包 compile mpi 創建 pri nal void 介紹 　　在項目開發當中，數據校驗是你必須要考慮和面對的事情，為此要寫上一大串的代碼進行校驗，這樣就會導致代碼冗余和一些管理的問題。 例如下面的代碼： 1 public void pu

簡單易用的參數校驗北京PK10平臺出租和版本校驗方式（java）

else runtime boot java pri conf utils 短信 con 步驟是：配置數據校驗規則（多條）>>>>在控制器上添加校驗註解>>>>使用攔截器攔截校驗參數(獲取註解，初始化校驗規則（第一次），取出參

js 參數校驗器

福建 整數 pan 移動端 環境 web value sem fin //校驗器 var validate = { //校驗當前運行環境是否是手機端 isWap:function(){ var sUserAgent= navigator.u

為List<T>中的T進行參數校驗

res ini obj ret name 請求 數據 參數綁定 $.ajax 1、現在前端發送了一個POST請求，他的Data是一個數組，而不是對象（jsonObj的值兩側是中括號）。 var jsonObj = [{‘id‘:11, ‘name‘:‘叵‘}, {‘id‘

我的編碼習慣 - 參數校驗和國際化規範

sage 畫蛇添足 for factor 演示 false lis clas undle 原文出處：曉風輕 導讀：程序員你為什麽這麽累？ 今天我們說說參數校驗和國際化，這些代碼沒有什麽技術含量，卻大量充斥在業務代碼上，很可能業務代碼只有幾行，參數校驗代碼卻有十幾行，非常

自定義@interface及groups校驗

groups @interface一、自定義annotation摘自：http://elim.iteye.com/blog/1812584@Target({ElementType.FIELD, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME)

015 參數校驗

warn 因此 enc value spring quest pri message 現在 一 . 概述 　　前臺的js校驗我們總是不可相信的,因此後臺的校驗就是最後一道防線,做為一個mvc框架springmvc也提供了一整套的校驗框架. 二 . 參數驗證 　　spr

jsr-303 參數校驗-學習（轉）

stirng 取消 案例分析 信息 included 什麽 bean alias 進行 1、是什麽？ JSR303 是一套 JavaBean 參數校驗的標準，它定義了很多常用的校驗註解，比如： --------------------------------

vuejs組件參數校驗

特性 聲明 數組 字符 是否 校驗 顯示 code 對象 父組件向子組件傳遞一些參數，那麽子組件有權對這些參數進行一個校驗，這個就是組件參數校驗 需求：父組件傳遞過來的必須是個字符串，這個要怎麽去校驗呢 <div id=‘root‘> 　　&

Spring基礎系列-參數校驗

nsh 們的 res 誤報 內部 主頁 定位 person big 原創作品，可以轉載，但是請標註出處地址：https://www.cnblogs.com/V1haoge/p/9953744.html Spring中使用參數校驗 概述 ? JSR 303中提出了Bean V