关于参数校验下列哪些说法符合阿里巴巴java开发手册,Java校验
一.导言二如何优雅地检查参数2.1官方指导2.2使用说明
00-1010检查一个方法的参数,最简单的暴力写法是这样的:
Public static void utila (string a,bigdecimal b){ if(string utils . isempty(a)){ system . out . println( a不能为空);返回;} if(b==null){ system . out . println( b不能为空);返回;} if (b.compareTo(BigDecimal。零)!=1){ system . out . println( b的取值范围不正确);返回;} System.out.println(做点什么);}从功能角度来说这样做完全没有问题。
但从代码的长期可维护性来看,代码复用率低,一旦检查规则多了,维护起来就很困难,怎么看都显得笨拙。对于有点追求的工程师来说,这么大的肿块还是挺不能接受的。
虽然有前置条件(com.google)等一些解决方案,但是很难适应所有场景,使用起来也不是很普及。
00-1010语义清晰的优雅方法级验证(参数验证和返回值验证)是Spring官方推荐的。
目录
Spring正式在SpringBoot文档中,关于参数验证的解决方案如下:
@ service @ validated public class my bean { public archive findbycodeadauthor(@ size(min=8,max=10) string code,author author) {.}} Spring Boot官网文档《37. Validation》
也就是说,使用了JSR-303规范,并直接使用注释来检查参数。
(JSR-303是JAVA EE 6中的一个子规范,叫做Bean验证,官方参考实现是Hibernate Validator)
一、引子
2.2.1.注解简介
对于简单类型参数(非Bean),直接在参数之前,使用注释添加约束规则。评论如下:
@AssertTrue / @AssertFalse
验证字段:布尔型
注意:验证该值是否为真/假。
@DecimalMax / @DecimalMin
适用字段:bigdecimal、biginteger、string、byte、short、int、long
注意:验证值是否小于等于指定的十进制值,注意小数的精度问题。
@Digits
适用字段:bigdecimal、biginteger、string、byte、short、int、long
注意:验证值的数字组成是合法的。
描述:integer:指定整数部分的位数。Fraction:指定小数部分的位数。
@Future / @Past
适用字段:日期、日历
注意:验证该值是否在当前时间之后/之前。
属性描述:公共
@Max / @Min
适用字段:bigdecimal、biginteger、string、byte、short、int、long
注意:验证该值是否小于或等于指定的整数值。
属性描述:公共
注意:建议在Stirng,Integer类型中使用,不要在int类型中使用,因为表单提交值“”不能转换为int。
@NotNull / @Null
验证字段:引用数据类型
备注:验证
值是否为非空 / 空
属性说明:公共
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为Null或者是EMPTY.
@NotBlank 与 @NotEmpty 的区别:空格(" ")对于 NotEmpty 是合法的,而 NotBlank 会抛出校验异常
@Pattern
验证适用字段:String
注解说明:验证值是否配备正则表达式
属性说明:regexp:正则表达式flags: 指定Pattern.Flag 的数组,表示正则表达式的相关选项。
@Size
验证适用字段:String,Collection,Map,数组
注解说明:验证值是否满足长度要求
属性说明:max:指定最大长度,min:指定最小长度。
@Length(min=, max=):专门应用于String类型
@Valid
验证适用字段:递归的对关联对象进行校验
注解说明:如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验(是否进行递归验证)
属性说明:无
@Range(min=, max=) 被指定的元素必须在合适的范围内
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
@URL(protocol=,host=, port=,regexp=, flags=)
2.2.2使用
1.引入依赖
<!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator --> <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> <version>6.1.5.Final</version> </dependency>
2.在对应字段上添加注解,方法被调用时,如果传入的实际参数与约束规则不符,会直接抛出 ConstraintViolationException ,表明参数校验失败。
import javax.validation.constraints.Max;import javax.validation.constraints.Min;import javax.validation.constraints.NotEmpty; /** * @Author: wangxia * @Date: 2021/10/20 16:30 */public class TestPerson { @NotEmpty(message = "用户名不能为空") private String username; @Min(value = 0,message = "年龄不能小于0岁") @Max(value =150,message = "年龄不能大于150岁") private int age; public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public int getAge() { return age; } public void setAge(int age) { this.age = age; }}
3..对于Bean类型的参数,在Bean内部的各个字段上面追加约束注解,然后在方法的参数前面添加 @Validated或@Valid注解即可。示例:
@RequestMapping("/")@RestControllerpublic class TestValidatController { @PostMapping("/testValid") public String testValid(@Validated @RequestBody TestPerson testPerson){ return "测试成功"; } }
4.优雅捕获异常,这一步可以省略,但是请求时会直接返回,400的异常提示,不太优雅。
@ControllerAdvice@ResponseBody public class MethodArgumentNotValidHandel { @ExceptionHandler(value=MethodArgumentNotValidException.class) public JSONObject MethodArgumentNotValidHandler(HttpServletRequest request, MethodArgumentNotValidException exception) throws Exception { JSONObject result=new JSONObject(); result.put("code","fail"); JSONObject errorMsg=new JSONObject(); for (FieldError error : exception.getBindingResult().getFieldErrors()) { errorMsg.put(error.getField(),error.getDefaultMessage()); } result.put("msg",errorMsg); return result; } }
添加优雅捕获的异常提示:
未添加优雅捕获的异常提示:
到此这篇关于Java实现优雅的参数校验方法详解的文章就介绍到这了,更多相关Java参数校验内容请搜索盛行IT以前的文章或继续浏览下面的相关文章希望大家以后多多支持盛行IT!
郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。