关于SpringBoot的@ConfigurationProperties注解和松散绑定、数据校验
作者:Java笔记虾 发布时间:2023-11-03 15:37:41
@ConfigurationProperties
源码分析
@ConfigurationProperties
主要作用就是将prefix属性指定的前缀配置项的值绑定到这个JavaBean上 ,通过指定的前缀,来绑定配置文件中的配置,通过如下源码可以看出, 如果你想绑定和验证一些外部属性,可以将它添加到类定义或@Configuration
类中的@Bean
方法上。
标注在类上
@Data //使用该注解需要导入Lombok依赖
@Component
@ConfigurationProperties(prefix = "userinfo")
public class UserInfo {
private String userId;
private String name;
}
application.yml文件配置内容
userInfo:
userId: 1001
name: lucy
接下来通过控制器方法来返回这个对象,查看数据是否绑定
@RestController
public class HelloController {
@Autowired
private UserInfo userInfo;
@GetMapping("/user")
public UserInfo getUserInfo(){
return userInfo;
}
}
标注在方法上
上面源码中说到可以将它添加到@Configuration
类中的@Bean
方法上,所以下面来看看标注在方法上是如何使用的!
比如我们用到druid数据源的操作,这个数据源是属于第三方的,所以我们不能操作源码,不能再源码里面找到它的对象来给他添加注解,但我们可以在yml文件中给他配置,来拿到它的属性。
首先添加所需的依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.2.11</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
接着在yml文件中配置数据源
spring:
datasource:
druid:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/test?serverTimezone=UTC
username: root
password: root
创建一个配置类,然后在类方法上添加注解,并通过prefix绑定数据
@SpringBootConfiguration
public class DatasourceConfig {
@Bean
@ConfigurationProperties(prefix = "spring.database.druid")
public DataSource database(){
return new DruidDataSource();
}
}
通过控制器方法来检验绑定效果
@RestController
public class HelloController {
@Autowired
private DataSource dataSource;
@GetMapping("/datasource")
public void getDataSource(){
System.out.println(dataSource);
}
}
访问//localhost/datasource
,查看控制台输出!!!
松散绑定
我们在使用 @ConfigurationProperties
注解的时候,@ConfigurationProperties(prefix = “userinfo”)
,这里给prefix的属性值与yml文件中的属性名称不一致,但是依旧绑定成功了!原因是什么呢?
这就需要提到Spring的松散绑定属性规则。因此使用以下方式书写都能与类的属性名称匹配。
userInfo:
userId: 1001 # 驼峰命名方式
#user_id: 1002 #下划线方式
#user-id: 1003 #烤肉串方式
#USER_ID: 1004 # 常量方式
name: lucycd
需要注意的是,prefix的属性值必须全部为小写,就像下图所示,就会报错:前缀必须是规范形式。
运行程序,也会在控制台提示你:配置属性名称“userInfo
”无效;无效字符:“I”
数据校验
Spring Boot中有很多配置文件,配置文件中我们可以自定义一些对应的属性值。那么这些属性值是否合法呢?我们如何来校验?在Java中有一种JSR303规范,我们可以针对一些对应的数值来进行校验。按照规范来进行书写,如果不符合要求就说明校验失败,反之,则成功!
SpringBoot也给出了强大的数据校验功能,可以有效的避免此类问题的发生。在JAVA EE的JSR303规范中给出了具体的数据校验标准,开发者可以根据自己的需要选择对应的校验框架,此处使用Hibernate提供的校验框架来作为实现进行数据校验。
导入验证包和校验实现包
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
</dependency>
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
添加注解@Validated
给属性添加验证规则
@Data
@Component
@ConfigurationProperties(prefix = "userinfo")
@Validated
public class UserInfo {
@Max(value = 1000,message = "userid超出范围了!")
@Min(value = 0,message = "userid不能小于0!")
private String userId;
@Size(min = 2,max = 5,message = "name长度应该在2-5之间")
private String name;
}
这里我们先输入不符合规范的数据,来验证数据是否能够校验成功
userInfo:
userId: 1001
name: lucycd
编写一个控制器方法来检验
@RestController
public class HelloController {
@Autowired
private UserInfo userInfo;
@GetMapping("/user")
public UserInfo getUserInfo(){
return userInfo;
}
}
运行程序,查看控制台,校验成功!!!
同样,将数据修改为符合规则的数据,程序就可以成功运行了!!!
当然,这里的校验规则还有许多,@NotNull
、@NotEmpty
、@Email
等等,可以根据实际情况选择合适的注解。
来源:https://javazhiyin.blog.csdn.net/article/details/128928271
猜你喜欢
- 项目结构:效果图一:效果图二:效果图三:关于闹钟:Alarm hongten v1.0 使用说明: &nbs
- 一、延迟加载resultMap可以实现高级映射(使用association、collection实现一对一及一对多映射),associati
- 前言在工作中遇到这样一个问题:开发过程中将数据库的账号、密码等信息配置在了一个单独的properties配置文件中(使用明文)。但运维人员要
- 本文实例讲述了Java Swing中JTable渲染器与编辑器用法。分享给大家供大家参考,具体如下:JTable的内容、外观、事件响应在很大
- 改进思考正常实现流程应该为继承ClassLoader虚拟类,并重写其loadClass方法和findClass方法,并在loadClass方
- 一,块作用域首先在深入学习控制结构之前,需要先了解块(block)的概念。块:即复合语句,是指由一对大括号括起来的若干条简单的 Java 语
- 最近都在忙着写一个网站项目,今天做一个分页功能的时候,遇到了分页效果实现不了的问题,查了好久的资料,后来终于是成功解决啦,记录一下1.在po
- 输入方法第一种输入方法:scannerimport java.util.Scanner; // 导入java.util.Scannerpub
- 本文以Java程序代码为例展示如何通过格式转换的方式将PPT幻灯片文档转为HTML文件。这里的PPT幻灯片可以是.ppt/.pptx/.pp
- Spring Boot如何实现配置文件的自动加载和刷新?在使用Spring Boot开发应用程序时,配置文件是非常重要的组成部分。在不同的环
- 简介MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改
- 前端开发工程师和关注前端开发的开发者们在2015年中肯定被腾讯的JSSDk引爆过,搞APP的、搞前端的甚至是是搞后端的都跑过来凑热闹,一时之
- 一,下载Zookeeper,地址为http://archive.apache.org/dist/zookeeper/,找到你要下载的版本,我
- 创建一个简单的项目:<?xml version="1.0" encoding="UTF-8"?
- 快速排序过程没有既不浪费空间又可以快一点的排序算法呢?那就是“快速排序”!光听这个名字是不是就觉得很高端呢。假设我们现在对“52 39 67
- MAC设置JDK环境变量1、sudo vim ~/.bash_profile2、设置内容 (写自己的JDK路径,有两种方式查看)JAVA_H
- 在Spring Boot的众多Starter POMs中有一个特殊的模块,它不同于其他模块那样大多用于开发业务功能或是连接一些其他外部资源。
- 什么是RabbitMQ?RabbitMQ是由erlang语言开发的一个基于AMQP(Advanced Message Queuing Pro
- 本文实例讲述了C#异步调用的方法。分享给大家供大家参考。具体如下:using System;using System.Collections
- 最近在做一个资源共享的项目中,采用了Struts2.1.8+Spr