SpringBoot使用注解实现参数校验

最新推荐文章于 2024-05-13 15:49:53 发布
最新推荐文章于 2024-05-13 15:49:53 发布
阅读量2.9k 收藏 8
点赞数
分类专栏： Spring 文章标签： spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/JokerLJG/article/details/134713027
版权

文章目录

参数校验

Spring Boot框架默认使用Hibernate Validator作为校验器实现。参数校验使用JSR-303规范定义的校验注解来实现的。

实际上，在Spring项目中，参数校验并仅支持用在Controller层上面，其实是支持用在所有的Spring Bean上（Controller、Service、Repository等）。

配置依赖：

  1. SpringMVC项目：

    <dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.18.Final</version>
</dependency>

  2. SpringBoot项目：

    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

- Validation

javax.validation 并不是 JDK 的一部分，它是 Java EE 的一部分，它提供了基于注释和 API 的对象校验功能，即 JSR 303 规范。JSR 303 规范定义了一套用于在 JavaBean 中定义验证约束的元数据模型并提供用于编程方式和声明式验证的 API。

  • 在 JavaEE6 中，这个规范被定义为 JSR 303
  • 在 JavaEE7 中则成为了 JSR 349
  • 在 JavaEE8 中成为 JSR 380

javax.validation 包中包含了很多注解，如@NotNull、@Size、@Pattern，它们可以用来对 JavaBean 中的属性进行各种验证，以保证数据的有效性和安全性。

需要注意的是，虽然 JSR-303 规范是 Java EE 的一部分，但我们仍然可以在非 Java EE 的应用程序中使用它，例如 Spring Boot、Spring MVC 等。在使用时需要导入 javax.validation 的 jar 包或者其他支持JSR 303规范的第三方库。

- Hibernate Validator

hibernate-validator是一个流行的Java数据校验器库，它基于JSR 303规范实现了Bean Validation 2.0 API，并提供了许多常用的校验注解和校验器。

校验注解

注解通用属性

  • message：错误提示信息

    可以使用 {} 占位符来引用注解中的属性值或自定义的文本。可以在错误消息中动态地插入变量的值，使错误消息更具体和有意义。

    使用方式：

    • 自定义文本
      @Size(min = 5, max = 10, message = "用户名长度不正确")
private String username;
    • 引用注解中的属性值
      @Size(min = 5, max = 10, message = "用户名长度必须介于 {min} 到 {max} 之间")
private String username;
    • 引用配置文件配置参数的值
      @Size(min = 5, max = 10, message = "{javax.validation.constraints.Size.message}")
private String username;
      为了提供国际化和本地化支持，错误消息通常会使用特定的键（key）来标识。这些键将在校验过程中与消息资源包（message bundle）中的实际错误消息文本进行映射。

  • groups：所属的校验组

    校验组是一种逻辑分组，可以根据不同的场景或需求对校验规则进行分组。默认情况下，参数校验不属于任何校验组，即属于默认组（Default）。

  • payload：携带额外的信息负载

    这些信息负载可以在校验失败时获得。通常情况下，我们不需要使用该属性。

- Validator 内置注解

注解注解的其它属性注解描述
@Null验证对象是否为 null
@NotNull验证对象不为 null
@NotBlank验证字符串不为空，去除前后空格后长度大于 0
@NotEmpty验证对象不为 null 且不为空（如字符串、集合、数组等），去除前后空格后长度大于 0
@Sizemin：最小值
max：最大值		验证对象（字符串、集合、数组等）长度在 min 和 max 之间
@Maxvalue：最大值验证数值（byte、short、int、long 等）是否小于等于指定的最大值
@Minvalue：最小值验证数值（byte、short、int、long 等）是否大于等于指定的最小值
@DecimalMaxvalue：最大值
inclusive：是否包含边界		验证 BigDecimal 和 BigInteger 的值是否小于等于指定的最大值
@DecimalMinvalue：最小值
inclusive：是否包含边界		验证 BigDecimal 和 BigInteger 的值是否大于等于指定的最小值
@Digitsinteger：整数位数
fraction：小数位数		验证数值是否符合整数位数和小数位数要求
@Patternregexp：正则表达式验证字符串是否符合指定的正则表达式
@Email验证字符串是否符合 Email 格式
@Future验证日期是否为将来某个时间
@FutureOrPresent验证日期是否为将来某个时间或当前时间
@Past验证日期是否为过去某个时间
@PastOrPresent验证日期是否为过去某个时间或当前时间
@AssertTrue验证 boolean 类型是否为 true
@AssertFalse验证 boolean 类型是否为 false
@Positive验证数值是否为正数
@PositiveOrZero验证数值是否为正数或零
@Negative验证数值是否为负数
@NegativeOrZero验证数值是否为负数或零

@Max(value)、@Min(value)、@DecimalMax(value)、@DecimalMin(Value)区别：

  • @Max、@Min接受一个Long类型的值
  • @DecimalMax、@DecimalMin接受一个字符串类型的值（BigDecimal的字符串表示形式，因此可以是小数）
  • 数字超过Long.MAX_VALUE或Long.MIN_VALUE以下或者数字是小数，@DecimalMax、@DecimalMin是唯一的选择。

- Hibernate Validator 附加注解

注解注解的其它属性注解描述
@Lengthmin：最小长度
max：最大长度		验证字符串的长度是否在指定范围内
@Rangemin：最小值
max：最大值		验证数字(BigDecimal, BigInteger, String, byte, short, int, long和原始类型的包装类 )是否在指定范围内
@UniqueElements验证集合中的元素是否唯一
@URLprotocol：协议
host：主机
port：端口
regexp：正则表达式
flags：标志		验证字符串是否符合 URL 格式要求
@Hexadecimal验证字符串是否是十六进制的格式
@ISBNtype：ISBN类型验证字符串是否是有效的ISBN码
@CreditCardNumberignoreNonDigitCharacters：是否忽略非数字字符验证字符串是否是有效的信用卡号码
@Currencyvalue：货币代码验证字符串是否是有效的货币代码
@CodePointLengthmin：最小码点长度
max：最大码点长度		验证字符串的码点长度是否在指定范围内
@Mod10Check验证字符串是否通过Mod 10算法校验
@Mod11Check验证字符串是否通过Mod 11算法校验
@LuhnCheck验证字符串是否通过Luhn算法校验
@EANtype：EAN 类型验证字符串是否是有效的 EAN（欧洲文章编号）码
@ScriptAssertlang：脚本语言
script：脚本内容
alias：脚本别名
reportOn：指定将错误报告应用于哪些属性		验证对象的属性是否满足指定的脚本表达式
@ParameterScriptAssertlang：脚本语言
script：脚本内容		验证对象的属性是否满足指定的脚本表达式，可以在脚本中引用方法参数

校验开启

@Valid和@Validated是用于Spring框架中数据校验的注解。

@Valid和@Validated

对比@Valid@Validated
校验规则JavaEE JSR-303（Bean Validation）规范定义的Spring定义的，对@Valid进行了二次封装。
所以既支持使用JSR-303规范的注解，也可以使用Spring提供的额外校验规则
使用范围用在方法、参数、字段上用在类、参数上
分组校验不支持支持
嵌套校验支持
需要在嵌套的字段上面也加上@Valid		不支持
异常处理校验失败时抛出异常MethodArgumentNotValidException校验失败时抛出异常ConstraintViolationException

校验分类

Spring支持校验范围可分为以下两类：

  • Controller校验
  • Spring Bean校验（包括Controller）

- Controller校验

Spring对Controller层的参数校验进行了专门处理，当请求到达Controller层前会先找到匹配的方法参数解析器（HandlerMethodArgumentResolver）进行参数解析，参数解析的过程中包含参数校验。

HandlerMethodArgumentResolver分析可参考：https://blog.csdn.net/JokerLJG/article/details/134754757

源码分析：

HandlerMethodArgumentResolver接口：

public interface HandlerMethodArgumentResolver {
	
	// 判断该解析器是否支持解析给定的方法参数
	boolean supportsParameter(MethodParameter parameter);
	
	// 解析给定的方法参数，并返回解析后的参数值
	Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
			NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception;
}

下面以HandlerMethodArgumentResolver的其中一个实现类来分析。
RequestResponseBodyMethodProcessor类：

	@Override
	public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
			NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {

		parameter = parameter.nestedIfOptional();
		Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
		String name = Conventions.getVariableNameForParameter(parameter);

		if (binderFactory != null) {
			WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);
			if (arg != null) {
				validateIfApplicable(binder, parameter);
				if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
					throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());
				}
			}
			if (mavContainer != null) {
				mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
			}
		}

		return adaptArgumentIfNecessary(arg, parameter);
	}

	protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) {
		// 遍历方法参数上的注解
		Annotation[] annotations = parameter.getParameterAnnotations();
		for (Annotation ann : annotations) {
			// 如果注解是Validated或注解以Valid开头时，进行参数校验
			Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class);
			if (validatedAnn != null || ann.annotationType().getSimpleName().startsWith("Valid")) {
				Object hints = (validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(ann));
				Object[] validationHints = (hints instanceof Object[] ? (Object[]) hints : new Object[] {hints});
				binder.validate(validationHints);
				break;
			}
		}
	}
  • 获取方法参数上的所有注解，遍历注解
  • 当注解是Validated或注解以Valid开头时，进行参数校验

- Spring Bean校验

Spring Bean校验底层是通过AOP的方式实现的，通过MethodValidationPostProcessor动态注册AOP切面（以Validated注解为切点），然后使用MethodValidationInterceptor对切点方法织入增强。

注意：Spring Bean校验对Controller及其他Spring Bean都适用。

MethodValidationPostProcessor类：

	public void afterPropertiesSet() {
		// 为所有`@Validated`标注的Bean创建切面
		Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true);
		// 创建Advisor进行增强
		this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator));
	}

	// 创建Advice，本质就是一个方法拦截器（拦截Bean的所有方法）
	protected Advice createMethodValidationAdvice(@Nullable Validator validator) {
		return (validator != null ? new MethodValidationInterceptor(validator) : new MethodValidationInterceptor());
	}

MethodValidationInterceptor类：

	@Override
	@SuppressWarnings("unchecked")
	public Object invoke(MethodInvocation invocation) throws Throwable {
		// 无需增强的方法，直接跳过
		if (isFactoryBeanMetadataMethod(invocation.getMethod())) {
			return invocation.proceed();
		}
		// 获取校验分组信息
		Class<?>[] groups = determineValidationGroups(invocation);
		
		ExecutableValidator execVal = this.validator.forExecutables();
		Method methodToValidate = invocation.getMethod();
		Set<ConstraintViolation<Object>> result;
		// 方法参数校验
		try {
			result = execVal.validateParameters(invocation.getThis(), methodToValidate, invocation.getArguments(), groups);
		} catch (IllegalArgumentException ex) {
			methodToValidate = BridgeMethodResolver.findBridgedMethod(ClassUtils.getMostSpecificMethod(invocation.getMethod(), invocation.getThis().getClass()));
			result = execVal.validateParameters(invocation.getThis(), methodToValidate, invocation.getArguments(), groups);
		}
		if (!result.isEmpty()) {
			throw new ConstraintViolationException(result);
		}
		Object returnValue = invocation.proceed();
		// 方法返回值校验
		result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups);
		if (!result.isEmpty()) {
			throw new ConstraintViolationException(result);
		}
		return returnValue;
	}
  • 方法参数校验：当方法参数上有@Valid或参数校验注解（@NotNull、@NotBlank、@Length等）时，会进行校验。
  • 方法返回值校验：当方法参数上有@Valid或参数校验注解（@NotNull、@NotBlank、@Length等）时，会进行校验。

校验使用

校验分类校验范围
Controller方法参数对象校验Controller适用
Spring Bean方法返回值对象校验Controller及其他Spring Bean都适用
Spring Bean方法参数对象校验Controller及其他Spring Bean都适用

注意：下面的示例中，项目做了全局异常处理。

- Controller：参数对象校验

对Controller方法参数对象进行校验。

@Data
public class User {

    @NotNull(message = "userId不能为空")
    public String userId;
}

  • 使用@Valid+校验注解：

    方法参数上加@Valid，参数对象中使用校验注解

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {

    @PostMapping("test11")
    public User test11(@RequestBody @Valid User user) {
        return user;
    }
}

    请求

    curl 'http://127.0.0.1:8888/valid/test11' -H 'Content-Type: application/json' -d '{}'

    结果

    {
    "code": 501,
    "msg": "userId不能为空",
    "data": null
}

  • 使用@Validated+校验注解：

    方法参数上加@Validated，参数对象中使用校验注解

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {

    @PostMapping("test12")
    public User test12(@RequestBody @Validated User user) {
        return user;
    }
}

    请求

    curl 'http://127.0.0.1:8888/valid/test12' -H 'Content-Type: application/json' -d '{}'

    结果

    {
    "code": 501,
    "msg": "userId不能为空",
    "data": null
}

- Spring Bean：方法返回值对象校验

对Spring Bean（包括Controller）方法返回值对象进行校验。

注意：方法返回值对象校验时，注解放到方法前面或整个方法上面都是相同的效果。

@Data
public class User {

    @NotNull(message = "userId不能为空")
    public String userId;
}

  • 使用@Validated+@Valid+校验注解

    Spring Bean类上加@Validated，方法返回值上加@Valid，返回值对象中使用校验注解。

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {

    @Autowired
    private ValidService validService;
    
    @PostMapping("test13")
    public User test13(@RequestBody User user) {
        return validService.test13(user);
    }
}

@Validated
@Service
public class ValidService {

    public @Valid User test13(User user) {
        return user;
    }
}

    请求

    curl 'http://127.0.0.1:8888/valid/test13' -H 'Content-Type: application/json' -d '{}'

    结果

    {
    "code": 501,
    "msg": "userId不能为空",
    "data": null
}

  • 使用@Validated+校验注解

    Spring Bean类上加@Validated，方法返回值上直接使用校验注解。

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {
    @Autowired
    private ValidService validService;
    
    @PostMapping("test14")
    public @NotNull User test14(@RequestBody User user) {
        return validService.test14(user);
    }
}

@Validated
@Service
public class ValidService {

    public @NotNull User test14(User user) {
        return null;
    }
}

    请求

    curl 'http://127.0.0.1:8888/valid/test14' -H 'Content-Type: application/json' -d '{}'

    结果

    {
    "code": 501,
    "msg": "不能为null",
    "data": null
}

- Spring Bean：方法参数对象校验

对Spring Bean（包括Controller）方法参数对象进行校验。

@Data
public class User {

    @NotNull(message = "userId不能为空")
    public String userId;
}

  • 使用@Validated+@Valid+校验注解

    Spring Bean类上加@Validated，方法参数上加@Valid，参数对象中使用校验注解。

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {

    @Autowired
    private ValidService validService;
    
    @PostMapping("test15")
    public User test15(@RequestBody User user) {
        return validService.test15(user);
    }
}

@Validated
@Service
public class ValidService {

    public User test15(@Valid User user) {
        return user;
    }
}

    请求

    curl 'http://127.0.0.1:8888/valid/test15' -H 'Content-Type: application/json' -d '{}'

    结果

    {
    "code": 501,
    "msg": "userId不能为空",
    "data": null
}

  • 使用@Validated+校验注解

    Spring Bean类上加@Validated，方法参数上直接中使用校验注解。

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {

    @Autowired
    private ValidService validService;
    
    @PostMapping("test16")
    public User test16(@RequestBody User user) {
        return validService.test16(null);
    }
}

@Validated
@Service
public class ValidService {

    public User test16(@NotNull User user) {
        return user;
    }
}

    请求

    curl 'http://127.0.0.1:8888/valid/test16' -H 'Content-Type: application/json' -d '{}'

    结果

    {
    "code": 501,
    "msg": "不能为null",
    "data": null
}

分组校验

@Data
public class User {

    @NotNull(message = "userId不能为空")
    public String userId;

    @NotNull(message = "userName不能为空", groups = {AddGroup.class})
    public String userName;

    @NotNull(message = "age不能为空", groups = {UpdateGroup.class})
    public String age;
}

- Controller：方法参数分组校验

对Controller方法参数对象进行分组校验。

  • 使用@Validated+@Valid+校验注解

    方法参数上加@Validated，并指定分组value属性，参数对象中的字段加校验注解并指定分组groups属性。

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {

    @PostMapping("test17")
    public User test17(@RequestBody @Validated({AddGroup.class}) User user) {
        return user;
    }

    @PostMapping("test18")
    public User test18(@RequestBody @Validated({UpdateGroup.class}) User user) {
        return user;
    }
}

    请求

    curl 'http://127.0.0.1:8888/valid/test17' -H 'Content-Type: application/json' -d '{}'

curl 'http://127.0.0.1:8888/valid/test18' -H 'Content-Type: application/json' -d '{}'

    结果

    {
    "code": 501,
    "msg": "userName不能为空",
    "data": null
}

{
    "code": 501,
    "msg": "age不能为空",
    "data": null
}

嵌套校验

@Data
public class User {

    @NotNull(message = "userId不能为空")
    public String userId;

    @Valid
    public Sex sex;
}

@Data
public class Sex {

    @NotNull(message = "sexName不能为空")
    public String sexName;
}

- Controller：方法参数嵌套校验

对Controller方法参数对象进行嵌套校验。

  • 使用@Validated+@Valid+校验注解

    方法参数上加@Validated，参数对象中的字段加@Valid，字段对象内再使用校验注解。

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {

    @PostMapping("test19")
    public User test19(@RequestBody @Validated User user) {
        return user;
    }
}

    请求

    curl 'http://127.0.0.1:8888/valid/test19' -H 'Content-Type: application/json' -d '{
  "userId": "userId_a7699554a547",
  "sex": {}
}'

    结果

    {
    "code": 501,
    "msg": "sexName不能为空",
    "data": null
}

  • 使用@Valid+@Valid+校验注解

    方法参数上加@Valid，参数对象中的字段加@Valid，字段对象内再使用校验注解。

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {

    @PostMapping("test20")
    public User test20(@RequestBody @Valid User user) {
        return user;
    }
}

    请求

    curl 'http://127.0.0.1:8888/valid/test20' -H 'Content-Type: application/json' -d '{
  "userId": "userId_a7699554a547",
  "sex": {}
}'

    结果

    {
    "code": 501,
    "msg": "sexName不能为空",
    "data": null
}

- Spring Bean：方法返回值嵌套校验

对Spring Bean（包括Controller）方法返回值对象进行嵌套校验。

  • 使用@Validated+@Valid+@Valid+校验注解

    Spring Bean类上加@Validated，方法返回值上加@Valid，返回值对象中字段加@Valid，字段内使用校验注解。

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {

    @Autowired
    private ValidService validService;

    @PostMapping("test21")
    public User test21(@RequestBody User user) {
        return validService.test21(user);
    }
}

@Validated
@Service
public class ValidService {

    public @Valid User test21(User user) {
        return user;
    }
}

    请求

    curl 'http://127.0.0.1:8888/valid/test21' -H 'Content-Type: application/json' -d '{
  "userId": "userId_a7699554a547",
  "sex": {}
}'

    结果

    {
    "code": 501,
    "msg": "sexName不能为空",
    "data": null
}

- Spring Bean：方法参数嵌套校验

对Spring Bean（包括Controller）方法参数对象进行嵌套校验。

  • 使用@Validated+@Valid+@Valid+校验注解

    Spring Bean类上加@Validated，方法参数上加@Valid，参数对象中字段加@Valid，字段内使用校验注解。

    代码

    @RestController
@RequestMapping("valid")
public class ValidController {

    @Autowired
    private ValidService validService;
    
    @PostMapping("test22")
    public User test22(@RequestBody User user) {
        return validService.test22(user);
    }
}

@Validated
@Service
public class ValidService {

    public User test22(@Valid User user) {
        return user;
    }
}

    curl 'http://127.0.0.1:8888/valid/test22' -H 'Content-Type: application/json' -d '{
  "userId": "userId_a7699554a547",
  "sex": {}
}'

    结果

    {
    "code": 501,
    "msg": "sexName不能为空",
    "data": null
}

自定义注解

自定义参数校验工具的步骤：

  1. 自定义注解
  2. 自定义Validator

1. 自定义注解

定义一个IPV4地址的校验注解。

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Documented
@Target({ METHOD, FIELD, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(Ipv4.List.class)
@Constraint(validatedBy = {Ipv4Validator.class})
public @interface Ipv4 {

    String message() default "not is Ipv4";

    Class<?>[] groups() default {};

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

    @Target({ METHOD, FIELD, PARAMETER, TYPE_USE })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        Ipv4[] value();
    }
}

2. 自定义Validator

定义一个校验器，用于验证是否为IPV4地址。

import cn.hutool.core.lang.Validator;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class Ipv4Validator implements ConstraintValidator<Ipv4, String> {
    
    @Override
    public void initialize(Ipv4 constraintAnnotation) {
        ConstraintValidator.super.initialize(constraintAnnotation);
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 对象为空验证通过
        if (value == null) {
            return true;
        }
        return Validator.isIpv4(value);
    }
}

使用示例：

代码

@Validated
@RestController
@RequestMapping("valid")
public class ValidController {

	@GetMapping("test23")
    public String test23(@Ipv4(message = "ip不是IPV4地址") String ip) {
        return ip;
    }
}

请求

curl 'http://127.0.0.1:8888/valid/test23?ip=1.1.1'

结果

{
    "code": 501,
    "msg": "ip不是IPV4地址",
    "data": null
}
骑个小蜗牛
关注
  • 0
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Boot 参数校验的具体实现方式
08-25
Spring Boot 参数校验的具体实现方式 ...Spring Boot 参数校验的具体实现方式可以通过使用 Hibernate Validator 和自定义校验规则来实现，而这些技术可以帮助我们更好地校验参数，从而提高应用程序的安全性和可靠性。
SpringBoot中通过实现WebMvcConfigurer参数校验的方法示例
08-25
Spring Boot提供了多种方式来进行参数校验，其中包括使用JSR303/JSR349提供的`javax.validation`规范。本文将深入探讨如何通过实现`WebMvcConfigurer`接口来实现参数校验，以简化代码并提高代码的可读性和复用性。 ...
SpringBoot 这样做参数校验才足够优雅
weixin_43494537的博客
04-25 236
当我们想提供可靠的 API 接口，对参数的校验，以保证最终数据入库的正确性，是 必不可少 的活。比如下图就是 我们一个项目里 新增一个菜单校验 参数的函数，写了一大堆的 if else 进行校验，非常的不优雅，比起枯燥的CRUD来说，参数校验更是枯燥。这只是一个创建菜单的校验，只需要判断菜单，菜单url 以及菜单的父类id是否为空，上级菜单是否挂载正确，这样已经消耗掉了30，40行代码了，更不要说，管理后台创建商品这种参数贼多的接口。估计要写几百行校验代码了。/*** 验证参数是否正确*/
spring常用注解（六）@Valid和@Validated校验
w_t_y_y的博客
04-29 1621
Valid注解可以作用于：方法、属性（包括枚举中的常量）、构造函数、方法的形参上。
JSR303数据校验 —— @Valid嵌套校验、集合校验
weixin_48568302的博客
05-13 421
@Valid嵌套校验、搭配@Validated集合校验
springboot @Valid注解对嵌套类型的校验功能
08-27
主要介绍了springboot~@Valid注解对嵌套类型的校验,主要介绍 @Valid在项目中的使用，需要的朋友可以参考下
SpringBoot参数校验注解
凡梦千华的博客
01-23 391
SpringBoot参数校验注解
spring注解校验
weixin_44049042的博客
10-15 1451
spring注解校验 在使用springboot 进行快速开发的时候,参数传递的地方都少不了参数校验。在web开发中，前后端都要进行参数校验,前端的参数校验是为了用户体验，后端的参数校验是为了安全.使用注解验证比较方便. 常用的校验注解： @AssertFalse 所注解的元素必须是Boolean类型，且值为false @AssertTrue 所注解的元素必须是Boolean类型，且值为true @DecimalMax 所注解的元素必须是数字，且值小于等于给定的值 @DecimalMin 所注解的元素必须
Spring注解校验
灿阳寒月的博客
06-12 305
Spring注解校验
Spring校验注解
qq_33007465的博客
10-25 2787
注解 含义 @NotNull 值不能为空 @Null 值必须为空 @Pattern(regex=) 字符串必须匹配正则表达式 @Size 集合或者数组元素的数量必须在min和max之间 @CreditCardNumber(ignoreNonDigitCharacters=) 字符串必须是信用卡号，按照美国的标准验证 @Email 字符串必须是Email格式 @Length(min,max) 校验字符串的长度 @NotBlank 字符串不能为空串 @NotEmp...
springboot validator枚举值校验功能实现
08-25
Hibernate Validator 是一个常用的校验框架，可以帮助我们轻松地实现参数校验功能。 在实现枚举值校验功能时，我们可以定义一个枚举类，例如 EnumValue.java。这个枚举类中，我们可以定义两个主要参数：enumClass ...
Springboot使用@Valid 和AOP做参数校验及日志输出问题
08-25
本文将详细介绍如何使用@Valid 和AOP实现参数校验及日志输出。 一、问题背景 在项目中，对接前端时经常会遇到一些问题。例如，需要频繁地请求前端参数，根据请求参数写大量的if...else语句，代码散布在Controller...
springboot+dubbo+validation 进行rpc参数校验的实现方法
08-25
在本文中，我们将深入探讨如何利用这些技术实现在SpringBoot应用中对Dubbo RPC调用进行参数校验。 首先，我们需要了解项目的基本结构。在示例中，我们有三个主要模块：test-rest作为前端消费者，它是一个SpringBoot...
springboot中参数校验（validation）注解自定义
相逢一笑
02-16 8269
在进行参数验证的时候，往往存在现有的约束注解不能满足的情况，此时就需要我们自己定义validation注解了，下面来介绍一下如何自己定义一个验证注解。 有关参数校验的使用可详见《springboot中参数校验（validation）使用》 如何自定义一个validation注解？ 自己定义validation注解需要使用@Constraint。@Constraint注解中是这样进行描述的： ...
Spring注解校验记录
一支穿云箭
06-25 361
一、spring注解作用二、自定义注解三、使用spring注解进行网关传入对象/参数的校验git:      https://github.com/KingBoyWorld/kingboy-springboot-web/tree/feature_validate/src/mainps：文章来自对大牛的学习，是转载记录的。四、代码实践五、参考学习/转载地址https://blog.csdn.net/...
Spring 注解验证-关于@Valid
weixin_30357231的博客
05-18 97
在我们做spring mvc项目的时候，经常要对Controller中传入实体内容进行验证，费时还费力，SO,spring mvc 验证参数注解@Valid 注解，更方便了我们专注于业务的处理 官方参考地址https://github.com/spring-guides/gs-validating-form-input.git，大家clone下来的时候记得改下地址（附上阿里大法地...
SpringBoot非官方教程 | 第十九篇： 验证表单信息
晓风的博客
05-03 1092
转载请标明出处： http://blog.csdn.net/forezp/article/details/71023817 本文出自方志朋的博客 这篇文篇主要简述如何在springboot中验证表单信息。在springmvc工程中，需要检查表单信息，表单信息验证主要通过注解的形式。构建工程创建一个springboot工程，由于用到了 web 、thymeleaf、validator、
SpringBoot嵌套分组校验
l_mmf的博客
04-26 1215
SpringBoot嵌套以及分组校验运用
SpringBoot使用注解校验参数
Maple的博客
08-30 1894
SpringBoot使用注解校验参数
springboot参数校验注解JsonFormat
最新发布
06-08
在Spring Boot中，`@JsonFormat`是一个JSON数据格式校验的注解，主要用于处理日期、时间、货币等复杂数据类型，当它们被序列化或反序列化为JSON时，可以指定特定的格式。这个注解通常与Jackson库一起使用。 `@JsonFormat`的基本用法如下： ```java import com.fasterxml.jackson.annotation.JsonFormat; public class YourClass { @JsonFormat(pattern = "yyyy-MM-dd", timezone = "UTC") private Date dateField; // 其他字段... // getters and setters } ``` 在这个例子中，`dateField`将会按照"yyyy-MM-dd"的ISO 8601日期格式进行序列化和反序列化，并且会使用"UTC"时区。 注解中的属性包括： - `pattern`：用于指定日期、时间或数字的格式模式。 - `timezone`：指定时区，如"UTC"。 - `locale`：可选，指定日期和数字的本地化规则。 - `max` 和 `min`：可选，用于设置格式化的最大值和最小值，如日期范围。 使用`@JsonFormat`能够确保数据在API交互中的正确性和一致性，尤其是在处理国际化或者跨时区场景时非常有用。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值