springboot字段校验,springboot参数非空校验注解
00-1010介绍了传统方法的缺点。I、检查实体类1、实体2、控制器3、编写全局统一异常处理2、检查单个参数3、组检查1、实体2、控制器4、自定义组检查1、实体2、CustomSequenceProvider3、控制器5、自定义检查1、定义检查注释2、实现注释6、嵌套检查7。
00-1010公共字符串adduser (user用户){ if(user==null user . getid()==null user . get account()==null user . get password()==null user . getemail()==null){ return } if(stringitils . isempty(user . get account()) stringitils . isempty(user . get password()) stringitils . isempty(user . get email())){ return 不能输入空字符串；} if (user.getaccount()。length () 6 user.getaccount()。length () 11) {return 帐户长度必须是6-11个字符；} if (user.getpassword()。长度()6 user.getpassword()。length () 16) {return 密码长度必须是6-16个字符；}如果(！pattern . matches([a-za-z0-9 _-]@[a-za-z0-9 _-]( 。[a-za-z0-9 _-]) $ ，user . getemail()){ return email format }//参数验证后在这里写业务逻辑返回成功；}这个真的没有问题，布局也很整齐，但是代码太繁琐了。如果要检查几十个字段，这种方法会变得非常臃肿，真的不够优雅。下面就来说说如何用最优雅的方式解决。
目录
dependency groupid org . spring framework . boot/groupid artifactId spring-boot-starter-validation/artifactId/dependency
00-1010批注说明@AssertFalse被批注的元素必须为false@AssertTrue被批注的元素必须为true@DecimalMax(value)被批注的元素必须为数字，其值必须小于或等于指定的最大值@DecimalMin(value)被批注的元素必须为数字，其值必须大于或等于指定的最小值@Digits (integer，fraction)。带注释的元素必须是数字，并且其值必须在可接受的范围@Null内。批注的元素必须为空@NotNull。带注释的元素不能为空@Min(value)带注释的元素必须是数字。其值必须大于或等于指定的最大值@Max(value)。带注释的元素必须是一个数字，并且其值必须小于或等于指定的最大值@Size(max，min)。注释元素的长度必须在指定的范围@Past内。带注释的元素必须是过去的日期@未来。带注释的元素必须是未来日期@模式(值)。带注释的元素必须符合指定的正则表达式
使用传统方式的弊端
00-1010 @ data public class User { @ not null(message=用户id不能为空)私有长id；@NotNull(message=用户帐户不能为空)@Size(min=
6, max = 11, message = "账号长度必须是6-11个字符") private String account; @NotNull(message = "用户密码不能为空") @Size(min = 6, max = 11, message = "密码长度必须是6-16个字符") private String password; @NotNull(message = "用户邮箱不能为空") @Email(message = "邮箱格式不正确") private String email;}
2、controller
@RestControllerpublic class UserController { @PostMapping("/addUser") public void addUser(@RequestBody @Valid User user) {//业务 }}
3、编写全局统一异常处理
import org.springframework.validation.ObjectError;import org.springframework.web.bind.MethodArgumentNotValidException;import org.springframework.web.bind.annotation.ExceptionHandler;import org.springframework.web.bind.annotation.RestControllerAdvice;import javax.validation.ConstraintViolation;import javax.validation.ConstraintViolationException;import java.util.stream.Collectors;/** * 全局异常处理 * * @author master */@RestControllerAdvicepublic class ExceptionConfig { /** * 参数为实体类 * @param e * @return */ @ExceptionHandler(value = MethodArgumentNotValidException.class) public String handleValidException(MethodArgumentNotValidException e) { // 从异常对象中拿到ObjectError对象 ObjectError objectError = e.getBindingResult().getAllErrors().get(0); // 然后提取错误提示信息进行返回 return objectError.getDefaultMessage(); } /** * 参数为单个参数或多个参数 * @param e * @return */ @ExceptionHandler(value = ConstraintViolationException.class) public String handleConstraintViolationException(ConstraintViolationException e) { // 从异常对象中拿到ObjectError对象 return e.getConstraintViolations() .stream() .map(ConstraintViolation::getMessage) .collect(Collectors.toList()).get(0); }}然后我们使用apipost测试
二、针对单个参数进行校验
import org.springframework.validation.annotation.Validated;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.bind.annotation.RestController;import javax.validation.constraints.NotNull;@RestController@Validatedpublic class TestController { @GetMapping("/test") public void test(@NotNull(message = "id不能为空") Integer id) { }}然后我们使用apipost测试
三、分组校验
场景:在新增时我们需要id为空,但修改时我们又需要id不为空,总不可能搞两个类吧,这时候分组校验的用处就来了
1、entity
import lombok.Data;import javax.validation.constraints.Email;import javax.validation.constraints.NotNull;import javax.validation.constraints.Size;@Datapublic class User { public interface Insert{ } public interface Update{ } @NotNull(message = "用户id不能为空",groups = Update.class) @Null(message = "用户id必须为空",groups = Integer.class) private Long id; private String account; private String password; private String email;}2、controller
@PostMapping("/add")public void add(@RequestBody @Validated(User.Insert.class) User user) {}添加时就用User.Insert.class,修改时就用User.Update.class
四、自定义分组校验
场景:当type为1时,需要参数a不为空,当type为2时,需要参数b不为空。
1、entity
import com.example.demo.provider.CustomSequenceProvider;import lombok.Data;import org.hibernate.validator.group.GroupSequenceProvider;import javax.validation.constraints.NotEmpty;import javax.validation.constraints.Pattern;@Data@GroupSequenceProvider(value = CustomSequenceProvider.class)public class CustomGroup { /** * 类型 */ @Pattern(regexp = "[AB]" , message = "类型不必须为 AB") private String type; /** * 参数A */ @NotEmpty(message = "参数A不能为空" , groups = {WhenTypeIsA.class}) private String paramA; /** * 参数B */ @NotEmpty(message = "参数B不能为空", groups = {WhenTypeIsB.class}) private String paramB; /** * 分组A */ public interface WhenTypeIsA { } /** * 分组B */ public interface WhenTypeIsB { }}
2、CustomSequenceProvider
import com.example.demo.controller.CustomGroup;import org.hibernate.validator.spi.group.DefaultGroupSequenceProvider;import java.util.ArrayList;import java.util.List;public class CustomSequenceProvider implements DefaultGroupSequenceProvider<CustomGroup> { @Override public List<Class<?>> getValidationGroups(CustomGroup form) { List<Class<?>> defaultGroupSequence = new ArrayList<>(); defaultGroupSequence.add(CustomGroup.class); if (form != null && "A".equals(form.getType())) { defaultGroupSequence.add(CustomGroup.WhenTypeIsA.class); } if (form != null && "B".equals(form.getType())) { defaultGroupSequence.add(CustomGroup.WhenTypeIsB.class); } return defaultGroupSequence; }}
3、controller
@PostMapping("/add")public void add(@RequestBody @Validated CustomGroup user) {}
五、自定义校验
虽然官方提供的校验注解已经满足很多情况了,但还是无法满足我们业务的所有需求,比如校验手机号码,下面我就以校验手机号码来做一个示例。
1、定义校验注解
@Target({ElementType.FIELD})@Retention(RetentionPolicy.RUNTIME)@Constraint(validatedBy = PhoneValidator.class)public @interface Phone { String message() default "手机号码格式有误"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {};}注:groups和payload是必须要写的,Constraint是使用哪个类来进行校验。
2、实现注解
import javax.validation.ConstraintValidator;import javax.validation.ConstraintValidatorContext;import java.util.regex.Pattern;/** * @author master */public class PhoneValidator implements ConstraintValidator<Phone, Object> { @Override public boolean isValid(Object telephone, ConstraintValidatorContext constraintValidatorContext) { String pattern = "^1[3456789]\d{9}$"; return Pattern.matches(pattern, telephone.toString()); }}最后直接用到参数前面或者实体类变量上面即可。
六、嵌套校验
当某个对象中还包含了对象需要进行校验,这个时候我们需要用嵌套校验。
@Datapublic class TestAA { @NotEmpty(message = "id不能为空") private String id; @NotNull @Valid private Job job; @Data public class Job { @NotEmpty(message = "content不能为空") private String content; }}
七、快速失败
Spring Validation默认会校验完所有字段，然后才抛出异常。可以通过配置，开启Fali Fast模式，一旦校验失败就立即返回。
import org.hibernate.validator.HibernateValidator;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import javax.validation.Validation;import javax.validation.Validator;import javax.validation.ValidatorFactory;@Configurationpublic class FailFastConfig { @Bean public Validator validator() { ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class) .configure() // 快速失败模式 .failFast(true) .buildValidatorFactory(); return validatorFactory.getValidator(); }}
注意事项
SpringBoot 2.3.x 移除了validation依赖需要手动引入依赖。
总结
非空校验是校验的第一步, 除了非空校验,我们还需要做到以下几点:
普通参数 - 需要限定字段的长度。如果会将数据存入数据库，长度以数据库为准，反之根据业务确定。类型参数 - 最好使用正则对可能出现的类型做到严格校验。比如type的值是【012】这样的。列表(list)参数 - 不仅需要对list内的参数是否合格进行校验，还需要对list的size进行限制。比如说 100。日期，邮件，金额，URL这类参数都需要使用对于的正则进行校验。参数真实性 - 这个主要针对于 各种Id 比如说 userId、merchantId，对于这样的参数，都需要进行真实性校验参数校验越严格越好，严格的校验规则不仅能减少接口出错的概率，同时还能避免出现脏数据，从而来保证系统的安全性和稳定性。
到此这篇关于超详细讲解SpringBoot参数校验实例的文章就介绍到这了,更多相关SpringBoot参数校验内容请搜索盛行IT以前的文章或继续浏览下面的相关文章希望大家以后多多支持盛行IT！
郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。