• Springboot教程一使用合理的参数校验拦截判断请求参数是否规范化合理化参数校验

    目录

    前言

    SpringBoot自带的校验规则

    实现案例关键性代码

    校验规则

    业务上使用功能的校验规则仅仅针对特定业务场景

    工具类的校验代码如下

    还有一个是自定义实现的拦截校验放到下一篇里面讲解

    前言

    这一篇主要说的是，使用SpringBoot里面自带的一些参数校验插件，只要使用功能SpringBoot，基本是web或者微服务的功能，部署到服务器上，基本上都是做业务操作的，结案是业务操作，那就是有一定的，需要参数格式化校验以及规范化处理。

    主要参数校验主要有以下几个方法的。这些是一些基本的参数，如果要是使用其他的参数还是需要自定义实现类的。

    SpringBoot自带的校验规则

    @NotBlank: 判断字符串是否为 null 或者是空串(去掉首尾空格)。
    @NotEmpty: 判断字符串是否 null 或者是空串。
    @Length: 判断字符的长度(最大或者最小)
    @Min: 判断数值最小值
    @Max: 判断数值最大值
    @Email: 判断邮箱是否合法

    实现案例关键性代码

    import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;
    1.     @RequestMapping(value = "/handleZeroRate", method = RequestMethod.GET)
    2.     @ApiOperation(value = "90天内的定时任务")
    3.     public ApiResponse handleZeroRate(@Valid String handleStr, BindingResult  bindingResult) {
    4.         ApiResponse response = ApiResponseBuilder.newSuccessResponse();
    5.         try {
    6.             if(bindingResult.hasErrors()){
    7.                 Map map = new HashMap(2);
    8.                 map.put("定时任务参数入参不合法:",handleStr);
    9.                 response.setData((JSONObject) JSONObject.toJSON(map));
    10.                 return  response;
    11.             }
    12.             filterPushTimeTaskFacade.performTasks();
    13.             Map map = new HashMap(2);
    14.             map.put("运行结果完成", "定时任务成功完成");
    15.             response.setData((JSONObject) JSONObject.toJSON(map));
    16.         } catch (Exception ex) {
    17.             return ApiResponseBuilder.newErrorResponse(ex);
    18.         }
    19.         return response;
    20.     }

    校验规则

    主要是不需要判断是否是空了，一个简单地校验规则，复杂的话，需要自己实现一下了

     

    业务上使用功能的校验规则仅仅针对特定业务场景

    关键性代码块如下。此处是使用工具类来进行校验输入的日期格式化是否正常合法的。

    if (DateParseUtils.invalid(date, DateUtils.FORMAT_PATTERN_YYYY_MM_DD)) {
    ResponseBuilder.errorRes(response, WebCodeEnum.ERROR_DATE_PARAM);
    return;
}
    1.  @GetMapping("/target")
    2.     public void target(String date, HttpServletResponse response) throws IOException {
    3.         if (DateParseUtils.invalid(date, DateUtils.FORMAT_PATTERN_YYYY_MM_DD)) {
    4.             ResponseBuilder.errorRes(response, WebCodeEnum.ERROR_DATE_PARAM);
    5.             return;
    6.         }
    7.         List dataList = exportDataService.packageDataList(date);
    8.         // 过滤00:00:00-07:00:00
    9.         List resultList = dataList.stream().filter(data -> data.getOrder() != 1).collect(Collectors.toList());;
    10.         try {
    11.             response.setContentType("application/vnd.ms-excel");
    12.             response.setCharacterEncoding("utf-8");
    13.             String fileName = URLEncoder.encode("中台舆情生产观察指标-" + date, "UTF-8");
    14.             response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
    15.             // 这里需要设置不关闭流
    16.             EasyExcel.write(response.getOutputStream(), TimeTargetData.class).autoCloseStream(Boolean.FALSE).sheet(date + "指标数据").doWrite(resultList);
    17.         } catch (Exception e) {
    18.             ResponseBuilder.errorRes(response, WebCodeEnum.ERROR, e.getMessage());
    19.         }
    20.     }

    工具类的校验代码如下

    业务上经常使用的是工具类来替换这个校验规则，主要是针对日期或者字符串以及对象啥的进行一层层判断。其实并不太好维护，因为规则可能不断叠加的。这么多的ifelse要写到什么时候呢？

    1. @Slf4j
    2. public class DateParseUtils extends DateUtils {
    3.  
    4.     /**
    5.      * 判断日期字符串格式是否符合格式化要求
    6.      * @param dateStr 日期字符串
    7.      * @param format 格式化方式
    8.      * @return true-符合，false-不符合
    9.      */
    10.     public static boolean valid(String dateStr, String format) {
    11.         if (StringUtils.isBlank(dateStr)) {
    12.             return false;
    13.         }
    14.         try {
    15.             return parseDate(dateStr, format) != null;
    16.         } catch (Exception e) {
    17.             log.error("错误的日期格式:{}，格式化方式为:{}", dateStr, format);
    18.             return false;
    19.         }
    20.     }
    21.  
    22.     /**
    23.      * 判断日期字符串格式是否不符合格式化要求
    24.      * @param dateStr 日期字符串
    25.      * @param format 格式化方式
    26.      * @return true-不符合，false-符合
    27.      */
    28.     public static boolean invalid(String dateStr, String format) {
    29.         return !valid(dateStr, format);
    30.     }
    31.  
    32.     /**
    33.      * 按日期格式解析日期字符串
    34.      * @param dateStr 日期字符串
    35.      * @param format 日期格式
    36.      * @return {@code LocalDate}
    37.      */
    38.     public static LocalDate parseDate(String dateStr, String format) {
    39.         DateTimeFormatter formatter = DateTimeFormatter.ofPattern(format);
    40.         return LocalDate.parse(dateStr, formatter);
    41.     }
    42.  
    43.     /**
    44.      * 按日期时间格式解析日期字符串
    45.      * @param dateTimeStr 日期时间字符串
    46.      * @param format 日期格式
    47.      * @return {@code Instant}
    48.      */
    49.     public static Instant parseDateTime(String dateTimeStr, String format) {
    50.         DateTimeFormatter formatter = DateTimeFormatter.ofPattern(format);
    51.         return LocalDateTime.parse(dateTimeStr, formatter).atZone(ZoneId.systemDefault()).toInstant();
    52.     }
    53.  
    54.     /**
    55.      * 按日期格式解析日期字符串
    56.      * @param dateStr 日期时间字符串
    57.      * @param format 日期格式
    58.      * @return {@code Date}
    59.      */
    60.     public static Date parseDateStr(String dateStr, String format) {
    61.         return Date.from(parseDateTime(dateStr, format));
    62.     }
    63.  
    64.     /**
    65.      * 根据时间戳转换成日期格式
    66.      * @param timestamp 时间戳
    67.      * @return 日期
    68.      */
    69.     public static Date parseTimestamp(Long timestamp) {
    70.         if (timestamp == null) {
    71.             return null;
    72.         }
    73.         if (timestamp < 9999999999L) {
    74.             return new Date(timestamp * 1000);
    75.         }
    76.         return new Date(timestamp);
    77.     }
    78.  
    79.     /**
    80.      * 按日期格式解析日期字符串
    81.      * @param dateStr 日期字符串
    82.      * @param timeStr 时间字符串
    83.      * @param format 日期格式
    84.      * @return {@code Date}
    85.      */
    86.     public static Date parseDateTimeStr(String dateStr, String timeStr, String format) {
    87.         if (StringUtils.isBlank(dateStr)) {
    88.             return null;
    89.         }
    90.         if (StringUtils.isBlank(timeStr.trim())) {
    91.             timeStr = "00:00:00";
    92.         }
    93.         return Date.from(parseDateTime(dateStr.split(" ")[0] + StringUtils.SPACE + timeStr.trim(), format));
    94.     }
    95.  
    96.     /**
    97.      * 解析日期字符串
    98.      * @param dateStr 日期字符串
    99.      * @return {@code Date}
    100.      */
    101.     public static Date parseDateStr(String dateStr) {
    102.         if (StringUtils.isBlank(dateStr)) {
    103.             return null;
    104.         }
    105.         if (dateStr.length() == FORMAT_PATTERN_DEFAULT.length()) {
    106.             return parseDateStr(dateStr, FORMAT_PATTERN_DEFAULT);
    107.         } else if (dateStr.length() == FORMAT_PATTERN_YYYY_MM_DD.length()) {
    108.             return parseDateStr(dateStr + " 00:00:00", FORMAT_PATTERN_DEFAULT);
    109.         }
    110.         return null;
    111.     }
    112.  
    113.     /**
    114.      * 解析日期时间字符串
    115.      * @param dateStr 日期字符串
    116.      * @param timeStr 时间字符串
    117.      * @return {@code Date}
    118.      */
    119.     public static Date parseDateTimeStr(String dateStr, String timeStr) {
    120.         if (StringUtils.isBlank(timeStr)) {
    121.             return parseDateStr(dateStr);
    122.         } else {
    123.             return parseDateStr(dateStr + StringUtils.SPACE + timeStr);
    124.         }
    125.     }
    126.  
    127.     /**
    128.      * 返回指定日期最大时间值
    129.      * @param dateStr 指定日期
    130.      * @return 指定日期最大时间值
    131.      */
    132.     public static LocalDateTime atEndOfDay(String dateStr) {
    133.         return atEndOfDay(dateStr, FORMAT_PATTERN_YYYY_MM_DD);
    134.     }
    135.  
    136.     /**
    137.      * 返回指定日期最小时间值
    138.      * @param dateStr 指定日期
    139.      * @return 指定日期最小时间值
    140.      */
    141.     public static LocalDateTime atStartOfDay(String dateStr) {
    142.         return atStartOfDay(dateStr, FORMAT_PATTERN_YYYY_MM_DD);
    143.     }
    144.  
    145.     /**
    146.      * 返回指定日期最大时间值
    147.      * @param dateStr 指定日期
    148.      * @param format 格式化类型
    149.      * @return 指定日期最大时间值
    150.      */
    151.     public static LocalDateTime atEndOfDay(String dateStr, String format) {
    152.         return parseDate(dateStr, format).atStartOfDay().with(LocalTime.MAX);
    153.     }
    154.  
    155.     /**
    156.      * 返回指定日期最小时间值
    157.      * @param dateStr 指定日期
    158.      * @param format 格式化类型
    159.      * @return 指定日期最小时间值
    160.      */
    161.     public static LocalDateTime atStartOfDay(String dateStr, String format) {
    162.         return parseDate(dateStr, format).atStartOfDay();
    163.     }
    164. }

    还有一个是自定义实现的拦截校验放到下一篇里面讲解

  • 相关阅读:
    ruoyi系统启动
    Java多线程-线程的状态和线程常用方法
    C - Songs Compression
    pod 创建自定义库失败后解决方案
    大学物理·第7章恒定磁场
    HTTP协议详解：基本概念与工作流程
    【yolo算法道路井盖检测】
    计控实验（三）——最少拍控制器
    成功拿下阿里一面HashMap追魂二十三问
    使用Maxent模型预测适生区
  • 原文地址：https://blog.csdn.net/m0_59252007/article/details/125891510