標(biāo)題太長有木有灭抑？主要是為了把問題描述清楚扇调，免得進(jìn)錯(cuò)文章榛了。

問題詳細(xì)描述

昨天測(cè)試的同事測(cè)試接口的時(shí)候在讶，測(cè)試出來一個(gè)Date類型校驗(yàn)問題。
要求輸入的日期格式是：yyyy-MM-dd HH:mm:ss霜大，Vo中使用的注解如下：

@DateTimeFormat(pattern=”yyyy-MM-dd HH:mm:ss”)

測(cè)試同事輸入下面兩種參數(shù)都是保存成功构哺，當(dāng)輸入為“202105”參數(shù)時(shí)，保存的數(shù)據(jù)變?yōu)椤?970-01-01 08:03:22”战坤，由此發(fā)現(xiàn)這個(gè)問題曙强。

第一種日期json參數(shù).png

第二種日期json參數(shù).png

常用的三種日期格式化的注解解釋如下：

//入?yún)⒏袷交⒔?@DateTimeFormat(pattern=”yyyy-MM-dd HH:mm:ss”)

//出餐格式化注解
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
@JSONField(format = "yyyy-MM-dd HH:mm:ss") //建議這種

由于@RequestBody注解先將json字符串轉(zhuǎn)換成對(duì)應(yīng)的Vo對(duì)象，Vo對(duì)象中的字段上添加的注解再生效途茫，@DateTimeFormat只是做格式化碟嘴，無法做格式校驗(yàn)。

解決方案

用自定義注解進(jìn)行json字符串中的日期格式做校驗(yàn)囊卜。

解決思路：
1.從request對(duì)象中獲取原始json字符串入?yún)?/strong>娜扇。由于自定義注解接口ConstraintValidator的實(shí)現(xiàn)獲取到的參數(shù)值是@RequestBody注解將json字符串參數(shù)解析成Vo對(duì)象后的Date對(duì)象，不是原始json字符串值栅组，所以需要從request中獲取json原始參數(shù)值雀瓢；
2.獲取到j(luò)son入?yún)⒃贾凳褂谜齽t表達(dá)式對(duì)日期進(jìn)行格式進(jìn)行校驗(yàn)。

溫馨提示：
1.由于自定義注解中是無法直接獲取到request對(duì)象玉掸，所以需要按照各自框架獲取request對(duì)象的方式進(jìn)行獲取刃麸。
2.獲取到的原始json字符串入?yún)⒖赡馨?strong>空格、回車司浪、換行符泊业、制表符這些特殊字符，所以需要進(jìn)行特殊字符處理啊易。
3.獲取Vo對(duì)象中添加注解的屬性名吁伺。
詳細(xì)見：getFieldName(ConstraintValidatorContext context)即：【((ConstraintValidatorContextImpl) context).basePath.currentLeafNode.name】

代碼實(shí)現(xiàn)

SearchTaskVo.java

/**
 * 任務(wù)結(jié)束時(shí)間
 **/
@ApiModelProperty("任務(wù)結(jié)束時(shí)間")
@JSONField(format = "yyyy-MM-dd HH:mm:ss")
@DateFormatValidation(format = "yyyy-MM-dd HH:mm:ss", message = "與要求的日期格式[yyyy-MM-dd HH:mm:ss]不符")
private Date afcx5206;

DateFormatValidation.java

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

/**
 * 說明：日期格式校驗(yàn)
 *
 * @Author Wanghx
 * @Date 2021/5/11 10:16
 * @Version 1.0
 **/
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {DateFormatValidator.class})
public @interface DateFormatValidation {

    //驗(yàn)證失敗錯(cuò)誤提示信息，使用注解時(shí)沒有設(shè)置錯(cuò)誤信息則默認(rèn)使用信息
    String message() default "格式錯(cuò)誤";

    //驗(yàn)證格式的規(guī)則租谈，使用注解時(shí)沒有設(shè)置驗(yàn)證格式規(guī)則則默認(rèn)使用下面的格式
    String format() default "yyyy-MM-dd";

    //分組驗(yàn)證
    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

}

DateFormatValidator.java

import org.hibernate.validator.internal.engine.constraintvalidation.ConstraintValidatorContextImpl;
import org.hibernate.validator.internal.engine.constraintvalidation.ConstraintViolationCreationContext;
import org.hibernate.validator.internal.engine.path.NodeImpl;
import org.hibernate.validator.internal.engine.path.PathImpl;

import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.*;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * 說明：日期格式校驗(yàn)
 *
 * @Author Wanghx
 * @Date 2021/4/30 10:17
 * @Version 1.0
 **/
public class DateFormatValidator extends BaseRestService implements ConstraintValidator<DateFormatValidation, Date> {
    private DateFormatValidation dateFormatValidation;

    @Override
    public void initialize(DateFormatValidation constraintAnnotation) {
        this.dateFormatValidation = constraintAnnotation;
    }


    @Override
    public boolean isValid(Date value, ConstraintValidatorContext context) {
        //如果 value 為空則不進(jìn)行格式驗(yàn)證箱蝠，為空驗(yàn)證可以使用 @NotBlank @NotNull @NotEmpty 等注解來進(jìn)行控制，職責(zé)分離
        if (value == null) {
            return true;
        }
        //獲取規(guī)定的格式
        String format = dateFormatValidation.format();

        //驗(yàn)證日期的格式是否正確
        try {
            //獲取原始json參數(shù)值
            String originalValue = getOriginalValueByFieldName(getFieldName(context));
            //用長度進(jìn)行比較
            if (ValidateUtil.isNotEmpty(originalValue) && originalValue.length() != format.length()) {
                return false;
            }
            //校驗(yàn)字符串日期格式
            if (!verifyFormatDateStr(originalValue, format)) {
                return false;
            }

            //用日期格式化驗(yàn)證
            SimpleDateFormat simpleDateFormat = new SimpleDateFormat(format);
            simpleDateFormat.format(value);
        } catch (Exception e) {
            return false;
        }
        return true;
    }


    /**
     * 校驗(yàn)字符串日期格式
     *
     * @param dateStr
     * @param format
     * @return
     */
    private boolean verifyFormatDateStr(String dateStr, String format) {
        boolean resultFlag = false;
        //允許的日期格式
        List<String> formatList = Arrays.asList(DatePattern.PATTEN_DATETIME, DatePattern.PATTEN_DATETIME_SERIAL, DatePattern.PATTEN_DATE, DatePattern.PATTEN_DATE_yyyyMMdd);
        Map<String, String> allDateFormat = getAllDateFormat();
        if (ValidateUtil.isNotEmpty(dateStr) && ValidateUtil.isNotEmpty(format) && formatList.contains(format)) {
            String regex = allDateFormat.get(format);//根據(jù)format拼接的正則表達(dá)式
            resultFlag = Pattern.compile(regex).matcher(dateStr).matches();
        }
        return resultFlag;
    }

    /**
     * 獲取日期格式的正則表達(dá)式垦垂，根據(jù)具體業(yè)務(wù)需要可新增
     *
     * @return
     */
    private Map<String, String> getAllDateFormat() {
        String yyyy = "((1|2)[0-9]{3})";
        String MM = "(0[1-9]|1[012])";
        String dd = "(0[1-9]|[12][0-9]|3[01])";
        String HH = "((0|1)[0-9]|2[0-3])";
        String mm = "([0-5][0-9])";
        String ss = "([0-5][0-9])";

        Map<String, String> resultMap = new HashMap<String, String>();
        resultMap.put(DatePattern.PATTEN_DATETIME, yyyy + "-" + MM + "-" + dd + " " + HH + ":" + mm + ":" + ss);
        resultMap.put(DatePattern.PATTEN_DATETIME_SERIAL, yyyy + MM + dd + HH + mm + ss);
        resultMap.put(DatePattern.PATTEN_DATE, yyyy + "-" + MM + "-" + dd);
        resultMap.put(DatePattern.PATTEN_DATE_yyyyMMdd, yyyy + MM + dd);
        return resultMap;
    }

    /**
     * 獲取添加注解的字段名稱
     *
     * @param context
     * @return
     */
    private String getFieldName(ConstraintValidatorContext context) {
        String fieldName = "";
        if (context != null) {
            List<ConstraintViolationCreationContext> constraintViolationCreationContexts = ((ConstraintValidatorContextImpl) context).getConstraintViolationCreationContexts();
            if (ValidateUtil.isNotEmpty(constraintViolationCreationContexts)) {
                ConstraintViolationCreationContext constraintViolationCreationContext = constraintViolationCreationContexts.get(0);
                PathImpl path = constraintViolationCreationContext.getPath();
                if (path != null) {
                    NodeImpl node = path.makeLeafNodeIterable();
                    if (node != null) {
                        fieldName = node.getName();
                    }
                }
            }
        }

        return fieldName;
    }


    /**
     * 根據(jù)字段名稱獲取json原始值
     *
     * @param fieldName
     * @return
     */
    private String getOriginalValueByFieldName(String fieldName) throws Exception {
        String resultStr = "";//結(jié)果值
        if (!StringUtil.isBlank(fieldName)) {
            //獲取request對(duì)象，【注：根據(jù)各自項(xiàng)目獲取request對(duì)象即可】
            HttpServletRequest request = getRequest();
            //獲取json參數(shù)原始值牙瓢，并封裝到Map集合中
            Map<String, Object> reqPostParamsMap = new HashMap<String, Object>();
            if (request != null) {
                //未清洗的json原始值
                String reqPostStr = getRequestPostStr(request);
                //清洗json原始值
                if (!StringUtil.isBlank(reqPostStr)) {
                    reqPostStr = reqPostStr.substring(reqPostStr.indexOf("{"), reqPostStr.indexOf("}"));
                    //去除字符串中的空格劫拗、回車、換行符矾克、制表符這些特殊字符
                    Pattern p = Pattern.compile("\\s*|\t|\r|\n");
                    Matcher m = p.matcher(reqPostStr);
                    reqPostStr = m.replaceAll("");
                    //去除前后{}和"
                    reqPostStr = reqPostStr.substring(2, reqPostStr.length() - 1);
                    //將json字符串參數(shù)解析后封裝成Map
                    String[] reqPostParamList = reqPostStr.split("\",\"");
                    for (String reqPostParam : reqPostParamList) {
                        String[] keyAndValue = reqPostParam.split("\":\"");
                        if (keyAndValue.length >= 2) {
                            reqPostParamsMap.put(keyAndValue[0], keyAndValue[1]);
                        }
                    }
                }
            }
            //根據(jù)字段名稱獲取對(duì)應(yīng)的原始值
            Object o = reqPostParamsMap.get(fieldName);
            if (o != null) {
                resultStr = o.toString();
            }
        }
        return resultStr;
    }


    /**
     * 獲取 post 請(qǐng)求的 byte[] 數(shù)組
     *
     * @param request
     * @return
     * @throws IOException
     */
    private static byte[] getRequestPostBytes(HttpServletRequest request)
            throws IOException {
        int contentLength = request.getContentLength();
        if (contentLength < 0) {
            return null;
        }
        byte buffer[] = new byte[contentLength];
        for (int i = 0; i < contentLength; ) {

            int readlen = request.getInputStream().read(buffer, i,
                    contentLength - i);
            if (readlen == -1) {
                break;
            }
            i += readlen;
        }
        return buffer;
    }

    /**
     * 獲取 post 請(qǐng)求內(nèi)容
     *
     * @param request
     * @return
     * @throws IOException
     */
    private static String getRequestPostStr(HttpServletRequest request)
            throws IOException {
        byte buffer[] = getRequestPostBytes(request);
        String charEncoding = request.getCharacterEncoding();
        if (charEncoding == null) {
            charEncoding = "UTF-8";
        }
        return new String(buffer, charEncoding);
    }
}

測(cè)試驗(yàn)證結(jié)果

自定義注解日期格式校驗(yàn)測(cè)試結(jié)果.png

至此問題解決~
文章中有何隱藏問題歡迎留言交流~
有好的解決方案歡迎留言~