配置参数启动时校验
如果配置文件没有相关的配置,那么 启动时
就会出现以下异常:
Description: Binding to target com.toby.provide.ApplicationProperties@31da6b2e failed: Property: feichao.info.name Value: null Reason: 名字不能为空,请注意检查,参考值为:肥朝。
肥朝小声逼逼:提高代码稳壮性,肥朝认为最好的办法就是提前预防。实际项目中,我们在配置文件配置了各种参数。但是大家也知道,不同环境的配置参数,是会不一样的,难免会因为人为疏忽,导致某个环境的配置文件,少了一些关键参数,光靠肉眼来检查,必然是一个低效而又不可靠的方式。如果你不用该方式校验,很容易在某个特殊的场景下,才触发出坑。但是你采用这种方式,做了大量的启动时校验,一旦参数不合法,项目启动都启动不了,做到了防范于未然!
Controller
HelloDTO
@Data public class HelloDTO { @NotBlank private String name; @Size(min = 1, max = 200) private int age; }
HelloController
@RestController public class HelloController { @RequestMapping("/controllerValid") public String controllerValid(@RequestBody @Valid HelloDTO helloDTO) { return "ok"; } }
请求参数为
{ "name":"肥朝", "age" : 0 }
时,出现校验异常
javax.validation.UnexpectedTypeException: HV000030: No validator could be found for constraint 'javax.validation.constraints.Size' validating type 'java.lang.Integer'. Check configuration for 'age'
Service
HelloDTO
@Data public class HelloDTO { @NotBlank private String name; @Size(min = 1, max = 200) private int age; }
AService
public interface AService { int insertUser(HelloDTO helloDTO); }
AServiceImpl
@Service public class AServiceImpl implements AService { @Autowired private BService bService; @Override public int insertUser(HelloDTO helloDTO) { return bService.insertUser(helloDTO); } }
BService
public interface BService { int insertUser(@Valid HelloDTO helloDTO); }
BServiceImpl
@Service @Slf4j @Validated public class BServiceImpl implements BService { @Override public int insertUser(HelloDTO helloDTO) { log.info("BService insertUser..."); return 0; } }
单元测试
@RunWith(SpringRunner.class) @SpringBootTest public class AserviceTest { @Autowired private BService bService; @Test public void testInsertUser() throws Exception { HelloDTO helloDTO = new HelloDTO(); bService.insertUser(helloDTO); } }
输出校验异常信息:
javax.validation.UnexpectedTypeException: HV000030: No validator could be found for constraint 'javax.validation.constraints.Size' validating type 'java.lang.Integer'. Check configuration for 'insertUser.arg0.age'
Dubbo
Dubbo官方文档中已经写得非常详细,地址为:https://dubbo.apache.org/zh-cn/docs/user/demos/parameter-validation.html。以下Dubbo验证为官方文档中的内容。
参数验证功能是基于 JSR303 实现的,用户只需标识 JSR303 标准的验证 annotation,并通过声明 filter 来实现验证。
maven依赖
<dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>1.0.0.GA</version> </dependency> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>4.2.0.Final</version> </dependency>
示例
参数标注示例
import java.io.Serializable; import java.util.Date; import javax.validation.constraints.Future; import javax.validation.constraints.Max; import javax.validation.constraints.Min; import javax.validation.constraints.NotNull; import javax.validation.constraints.Past; import javax.validation.constraints.Pattern; import javax.validation.constraints.Size; public class ValidationParameter implements Serializable { private static final long serialVersionUID = 7158911668568000392L; @NotNull // 不允许为空 @Size(min = 1, max = 20) // 长度或大小范围 private String name; @NotNull(groups = ValidationService.Save.class) // 保存时不允许为空,更新时允许为空 ,表示不更新该字段 @Pattern(regexp = "^\\s*\\w+(?:\\.{0,1}[\\w-]+)*@[a-zA-Z0-9]+(?:[-.][a-zA-Z0-9]+)*\\.[a-zA-Z]+\\s*$") private String email; @Min(18) // 最小值 @Max(100) // 最大值 private int age; @Past // 必须为一个过去的时间 private Date loginDate; @Future // 必须为一个未来的时间 private Date expiryDate; public String getName() { return name; } public void setName(String name) { this.name = name; } public String getEmail() { return email; } public void setEmail(String email) { this.email = email; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } public Date getLoginDate() { return loginDate; } public void setLoginDate(Date loginDate) { this.loginDate = loginDate; } public Date getExpiryDate() { return expiryDate; } public void setExpiryDate(Date expiryDate) { this.expiryDate = expiryDate; } }
分组验证示例
public interface ValidationService { // 缺省可按服务接口区分验证场景,如:@NotNull(groups = ValidationService.class) @interface Save{} // 与方法同名接口,首字母大写,用于区分验证场景,如:@NotNull(groups = ValidationService.Save.class),可选 void save(ValidationParameter parameter); void update(ValidationParameter parameter); }
关联验证示例
import javax.validation.GroupSequence; public interface ValidationService { @GroupSequence(Update.class) // 同时验证Update组规则 @interface Save{} void save(ValidationParameter parameter); @interface Update{} void update(ValidationParameter parameter); }
参数验证示例
import javax.validation.constraints.Min; import javax.validation.constraints.NotNull; public interface ValidationService { void save(@NotNull ValidationParameter parameter); // 验证参数不为空 void delete(@Min(1) int id); // 直接对基本类型参数验证 }
配置
在客户端验证参数
<dubbo:reference id="validationService" interface="org.apache.dubbo.examples.validation.api.ValidationService" validation="true" />
在服务器端验证参数
<dubbo:service interface="org.apache.dubbo.examples.validation.api.ValidationService" ref="validationService" validation="true" />
验证异常信息
import javax.validation.ConstraintViolationException; import javax.validation.ConstraintViolationException; import org.springframework.context.support.ClassPathXmlApplicationContext; import org.apache.dubbo.examples.validation.api.ValidationParameter; import org.apache.dubbo.examples.validation.api.ValidationService; import org.apache.dubbo.rpc.RpcException; public class ValidationConsumer { public static void main(String[] args) throws Exception { String config = ValidationConsumer.class.getPackage().getName().replace('.', '/') + "/validation-consumer.xml"; ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(config); context.start(); ValidationService validationService = (ValidationService)context.getBean("validationService"); // Error try { parameter = new ValidationParameter(); validationService.save(parameter); System.out.println("Validation ERROR"); } catch (RpcException e) { // 抛出的是RpcException ConstraintViolationException ve = (ConstraintViolationException) e.getCause(); // 里面嵌了一个ConstraintViolationException Set<ConstraintViolation<?>> violations = ve.getConstraintViolations(); // 可以拿到一个验证错误详细信息的集合 System.out.println(violations); } } }
1.自 2.1.0
版本开始支持, 如何使用可以参考dubbo 项目中的示例代码(https://github.com/apache/incubator-dubbo-samples/tree/master/dubbo-samples-validation)
2.验证方式可扩展,扩展方式参见开发者手册中的验证扩展(http://dubbo.apache.org/zh-cn/docs/dev/impls/validation.html)
工具类方式校验
ValidationUtils
public class ValidationUtils { private static Validator validator = Validation .byProvider(HibernateValidator.class) .configure() .failFast(true) .buildValidatorFactory() .getValidator(); public static <T> void validate(T obj) { validator.validate(obj); } }
单元测试
@Test public void testValidationUtils() throws Exception { HelloDTO helloDTO = new HelloDTO(); ValidationUtils.validate(helloDTO); }
输出校验异常信息:
javax.validation.UnexpectedTypeException: HV000030: No validator could be found for constraint 'javax.validation.constraints.Size' validating type 'java.lang.Integer'. Check configuration for 'age'
总结
上述从五个方面,做了校验方式的示例,全都是基于 hibernate-validate
。你稍微搜索一下就知道,该校验方式不仅使得参数校验比
if (helloDTO.getAge() <= 0) { //... }
优雅很多,还支持 自定义注解实现校验规则
、 国际化
、 分组校验
等,这些你们项目具体用到的时候,再去看看即可。
当然提高代码稳壮性的方式还有很多,但是肥朝认为参数校验的方式,成本和效果的性价比是最高之一,你有什么提高代码稳壮性的方式?留言告诉肥朝。
写在最后
以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 码农网
猜你喜欢:- 用最低的成本,提高你的代码稳壮性
- 极限元:AI技术应用的价值是降低成本、提高效率
- PostgreSQL 查询成本模型
- 低成本“全栈”回忆录
- 研发团队资源成本优化实践
- Postgresql查询成本计算初探
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。