Spring Boot @ConfigurationProperties注解使用示例-6ren

Spring Boot @ConfigurationProperties注解使用示例

转载作者：知者更新时间：2024-03-12 08:01:10

Spring Boot @ConfigurationProperties 是外部化配置的注解。要将属性值从属性文件注入到类中，我们可以在类级别添加 @ConfigurationProperties，并使用诸如 @Component 之类的构造型注解，或者将 @ConfigurationProperties 添加到 @Configuration 类中的 @Bean 方法中。 @ConfigurationProperties 用于绑定和验证来自属性文件（如 .properties 文件）的外部属性。 @ConfigurationProperties 具有以下可选元素。
ignoreInvalidFields：忽略无效字段的布尔值。
ignoreUnknownFields：忽略未知字段的布尔值。
prefix：绑定到此对象的属性的前缀。
value：绑定到此对象的属性的前缀。

要使用 @ConfigurationProperties 从属性文件中注入值，我们的类必须创建类属性的 setter 方法。在这里，我们将通过示例详细讨论使用 @ConfigurationProperties。

使用@ConfigurationProperties 的步骤

找到使用 @ConfigurationProperties 注解的步骤。
1. 创建一个使用 @ConfigurationProperties 和 @Component 注解的类。在这里，我们的类中有字符串和整数属性。
Team.java

package com.concretepage;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties
public class Team {
	private String team;
	private int teamSize;
	private String teamLeader;
        
        //Setters and Getters

	public String toString() {
		return "Team:" + team + " - " + teamSize + " - " + teamLeader;
	}
}

创建类字段的 setter 方法必须与 @ConfigurationProperties 一起使用。
2.teamSize等多个单词的属性名可以绑定属性文件中的teamSize或team-size或team_size等属性名。找到属性文件。
myteam.properties

team=XYZ Team
team-size=3
team-leader=Mahesh

3. 在配置类中，使用 @PropertySource 注解导入 .properties 文件。
AppConfig.java

package com.concretepage;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:myteam.properties")
public class AppConfig {
 
}

以上所有属性值都将绑定到 Team 类，因此我们可以根据需要将该类注入任何其他类并获取值。
4. 现在运行应用程序。
MySpringBootApp.java

package com.concretepage;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;

@SpringBootApplication
public class MySpringBootApp {
	public static void main(String[] args) {
		final ApplicationContext ctx = SpringApplication.run(MySpringBootApp.class, args);
		final Team team = ctx.getBean(Team.class);
		System.out.println("--- Team ---");
		System.out.println(team);
	}
}

输出

--- Team ---
Team:XYZ Team - 3 - Mahesh

使用带前缀的 @ConfigurationProperties

我们可以在 @ConfigurationProperties 注解中使用前缀元素。如果属性文件的属性以前缀开头，则可以在 @ConfigurationProperties 中进行配置。找到属性文件。
myteam.properties

app.team=XYZ Team
app.team-size=3
app.team-leader=Mahesh

我们可以看到属性以前缀 app 开头。我们需要在 @ConfigurationProperties 中配置它以在 Team 类中注入这些值。
Team.java

@Component
@ConfigurationProperties(prefix="app")
public class Team {
	private String team;
	private int teamSize;
	private String teamLeader;
        
        //Setters and Getters

	public String toString() {
		return "Team:" + team + " - " + teamSize + " - " + teamLeader;
	}
}

将@ConfigurationProperties 与@Bean 一起使用

我们可以将 @ConfigurationProperties 与 @Bean 以及 @Component 注解一起使用。在上面的例子中，我们使用了 @ConfigurationProperties 和 @Component。在这里，我们将创建一个使用 @ConfigurationProperties 和 @Bean 的示例。
我们需要在方法级别使用 @ConfigurationProperties 和 @Bean。找到例子。
AppConfig.java

package com.concretepage;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource({"classpath:myteam.properties", "classpath:project-util.properties"})
public class AppConfig {
  @Bean
  @ConfigurationProperties(prefix="project")  
  public Project getProject() {
	return new Project();
  }
}

Project.java

package com.concretepage;
public class Project {
	private String projectName;
	private int size;
	private String manager;

        //Setters and getters       
   
	public String toString() {
		return "Project:" + projectName + " - " + size + " - " + manager;
	}	
}

project-util.properties

project.project-name=PQR Project
project.size=10
project.manager=John

将@ConfigurationProperties 与对象、列表、映射和数组属性一起使用

在上面的示例中，我们已经看到了如何将简单属性与类绑定。现在我们将提供使用 @ConfigurationProperties 绑定 Object、List、Map 和 Array 属性的示例。
myteam.properties

app.team=XYZ Team
app.team-size=3
app.team-leader=Mahesh

#Object properties
app.company.name=ABC Ltd
app.company.ceo=Narendra
app.company.location=Delhi

#List properties
app.employees[0].name=Amar
app.employees[0].designation=Developer
app.employees[0].age=25
app.employees[1].name=Akbar
app.employees[1].designation=Tester
app.employees[1].age=23
app.employees[2].name=Anthony
app.employees[2].designation=Designer
app.employees[2].age=27

#Map Properties
app.technologies.BACKEND=Java
app.technologies.FRONTEND=Angular
app.technologies.DATABASE=Oracle

#Array Properties
app.clients[0]=A Client
app.clients[1]=B Client
app.clients[2]=C Client

AppConfig.java

@Configuration
@PropertySource({"classpath:myteam.properties", "classpath:project-util.properties"})
public class AppConfig {
  ------
}

Team.java

@Component
@ConfigurationProperties(prefix="app")
public class Team {
	private String team;
	private int teamSize;
	private String teamLeader;
	private Company company;	
	private List<Employee> employees;
	private Map<String, String> technologies;
	private String[] clients;

        //Setters and Getters

	public String toString() {
		return "Team:" + team + " - " + teamSize + " - " + teamLeader;
	}
}

1。对象属性

myteam.properties

#Object properties
app.company.name=ABC Ltd
app.company.ceo=Narendra
app.company.location=Delhi

Team.java

@Component
@ConfigurationProperties(prefix="app")
public class Team {
        ------
	private Company company;

	public Company getCompany() {
		return company;
	}
	public void setCompany(Company company) {
		this.company = company;
	}
        ------
}

Company.java

package com.concretepage;
public class Company {
	private String name;
	private String ceo;
	private String location;

        //Setters and Getters

	public String toString() {
		return "Company:" + name + " - " + ceo + " - " + location;
	}
}

2。列出属性

myteam.properties

#List properties
app.employees[0].name=Amar
app.employees[0].designation=Developer
app.employees[0].age=25
app.employees[1].name=Akbar
app.employees[1].designation=Tester
app.employees[1].age=23
app.employees[2].name=Anthony
app.employees[2].designation=Designer
app.employees[2].age=27

Team.java

@Component
@ConfigurationProperties(prefix="app")
public class Team {
        ------
        private List<Employee> employees;

	public List<Employee> getEmployees() {
		return employees;
	}
	public void setEmployees(List<Employee> employees) {
		this.employees = employees;
	}
        ------
}

Employee.java

package com.concretepage;
public class Employee {
	private String name;
	private String designation;
	private int age;

        //Setters and Getters

	public String toString() {
		return "Employee:" + name + " - " + designation + " - " + age;
	}	
}

3 Map属性

myteam.properties

#Map Properties
app.technologies.BACKEND=Java
app.technologies.FRONTEND=Angular
app.technologies.DATABASE=Oracle

Team.java

@Component
@ConfigurationProperties(prefix="app")
public class Team {
        ------
	private Map<String, String> technologies;

	public Map<String, String> getTechnologies() {
		return technologies;
	}
	public void setTechnologies(Map<String, String> technologies) {
		this.technologies = technologies;
	}
        ------
}

4。数组属性

myteam.properties

#Array Properties
app.clients[0]=A Client
app.clients[1]=B Client
app.clients[2]=C Client

Team.java

@Component
@ConfigurationProperties(prefix="app")
public class Team {
        ------
	private String[] clients;

	public String[] getClients() {
		return clients;
	}
	public void setClients(String[] clients) {
		this.clients = clients;
	}
        ------
}

现在让我们运行演示应用程序。
MySpringBootApp.java

package com.concretepage;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;

@SpringBootApplication
public class MySpringBootApp {
	public static void main(String[] args) {
		final ApplicationContext ctx = SpringApplication.run(MySpringBootApp.class, args);
		final Team team = ctx.getBean(Team.class);
		System.out.println("--- Team ---");
		System.out.println(team);
		System.out.println("--- Team Employee---");
		team.getEmployees().forEach(e -> System.out.println(e));
		System.out.println("--- Technologies ---");
		System.out.println(team.getTechnologies().size());
		team.getTechnologies().forEach(((t, v) -> System.out.println(t + " - " + v)));
		System.out.println("--- Company ---");
		System.out.println(team.getCompany());
		System.out.println("--- Clients ---");
		for (String c : team.getClients()) {
			System.out.println(c);
		}
		System.out.println("--- Project ---");
		final Project project = ctx.getBean(Project.class);
		System.out.println(project);
	}
}

输出

--- Team ---
Team:XYZ Team - 3 - Mahesh
--- Team Employee---
Employee:Amar - Developer - 25
Employee:Akbar - Tester - 23
Employee:Anthony - Designer - 27
--- Technologies ---
3
FRONTEND - Angular
DATABASE - Oracle
BACKEND - Java
--- Company ---
Company:ABC Ltd - Narendra - Delhi
--- Clients ---
A Client
B Client
C Client
--- Project ---
Project:PQR Project - 10 - John

将@ConfigurationProperties 与@EnableConfigurationProperties 一起使用

假设我们有一个用 @ConfigurationProperties 注解的类，但它没有用 @Component 注解，或者它不是 Spring bean。在这种情况下，要使用 @ConfigurationProperties 从属性文件中注入值，我们将 @EnableConfigurationProperties 注解与 @SpringBootApplication 结合使用，并将 @ConfigurationProperties 注解类指定为 @EnableConfigurationProperties。
找到例子。这里我们从 Team.java 中删除 @Component。
Team.java

@ConfigurationProperties(prefix="app")
public class Team {
	private String team;
	private int teamSize;
	private String teamLeader;
	private Company company;	
	private List<Employee> employees;
	private Map<String, String> technologies;
	private String[] clients;

        //Setters and Getters

	public String toString() {
		return "Team:" + team + " - " + teamSize + " - " + teamLeader;
	}
}

现在要启用 @ConfigurationProperties，我们需要将 @EnableConfigurationProperties 注解与 @SpringBootApplication 结合使用，并为其指定上面的类。
MySpringBootApp.java

package com.concretepage;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.ApplicationContext;

@SpringBootApplication
@EnableConfigurationProperties(Team.class)
public class MySpringBootApp {
	public static void main(String[] args) {
		final ApplicationContext ctx = SpringApplication.run(MySpringBootApp.class, args);
                ------
	}
}

将@Validated 与@ConfigurationProperties 一起使用

使用 @ConfigurationProperties 从属性文件注入到类的值可以使用 Spring @Validated 注解进行验证。
Team.java

package com.concretepage;

import java.util.List;
import java.util.Map;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.format.annotation.NumberFormat;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

@Component
@ConfigurationProperties(prefix="app")
@Validated
public class Team {
	@NotBlank
	private String team;
	@NumberFormat
	private int teamSize;
	@Size(max=30)
	private String teamLeader;
	@NotNull
	private Company company;	
	@NotEmpty
	private List<Employee> employees;
	@NotEmpty	
	private Map<String, String> technologies;
	private String[] clients;


        //Setters and Getters

	public String toString() {
		return "Team:" + team + " - " + teamSize + " - " + teamLeader;
	}
}

Maven

找到我们示例中使用的 Maven。
pom.xml

<parent>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-parent</artifactId>
	<version>2.1.5.RELEASE</version>
	<relativePath />
</parent>
<dependencies>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter</artifactId>
	</dependency>
	<dependency>
		<groupId>org.hibernate.validator</groupId>
		<artifactId>hibernate-validator</artifactId>
		<version>6.0.16.Final</version>
	</dependency>
</dependencies>

YAML 文件

找到与我们示例中使用的属性文件等效的 YAML 文件。
application.yml

app:
  team:XYZ Team
  team-size:3
  team-leader:Mahesh
  employees:
    - name:Amar
      designation:Developer
      age:25
    - name:Akbar
      designation:Tester
      age:23
    - name:Anthony
      designation:Designer
      age:27
  technologies:
    BACKEND:Java
    FRONTEND:Angular
    DATABASE:Oracle
  clients:
    - A Client
    - B Client
    - C Client
  company:
    name:ABC Ltd
    ceo:Narendra
    location:Delhi
project:
  project-name:PQR Project
  size:10
  manager:John

文章推荐： Java Comparator.nullsLast方法介绍

文章推荐： Java ResourceBundle类介绍

文章推荐： Java LocalDate日期格式化使用示例

文章推荐： Spring @Configuration注解使用示例

spring-boot - 需要知道spring-boot-starter-parent和spring-boot-parent的区别
有人可以解释一下 spring-boot-parent 和 spring-boot-starter-parent 之间的区别吗，正如我在下面附加的 GIT HUB 代码链接之一中看到的，他们为 spr
spring-boot - Spring Boot 应用程序卡在 Spring Boot Logo 上
我有与 jersey 框架集成的 Spring Boot 应用程序。现在，当我尝试运行该应用程序时，它只是停留在 Spring 启动徽标上，之后没有任何 react 。我也尝试添加 -X ，但徽标
spring-boot - Spring Boot AutoConfigure 与 Spring Boot 执行器
我指的是 Spring Boot 关于的文档自动配置和执行器模块: 自动配置: Spring Boot AutoConfiguration attempts to automatically
spring-boot - 找不到org.springframework.boot :spring-boot-starter-log4j
我正在尝试将 apache log4j 集成到我的 Spring boot 应用程序中。这是我的 build.gradle 文件: build.gradle buildscript { rep
spring-boot - Spring Boot Maven 插件 - spring-boot :run and production
使用 Spring Boot Maven 插件的以下命令在生产中启动 Spring Boot 应用程序是否是一个好主意或实践？ mvn spring-boot:run 最佳答案不，这是个坏主意。您
spring-boot - 如何隔离spring boot app redis和spring boot session global redis
据我所知，spring boot 和 spring session 为我们提供了一站式自动配置，但是当我的应用程序使用 session redis 和应用程序缓存 redis 时，不是同一个 redi
spring-boot - 适用于旧版本Java的Spring Boot
我希望使用Spring Boot创建一个新的Web应用程序。不幸的是，我的服务器在技术堆栈方面相当有限。它安装了Java 5。谁能告诉我spring boot是否可以在Java 1.5上运行以及什么
spring-boot - 使用CrudRepository中的外键进行Spring Boot
我有3个实体 CarWash(设置Wash) Wash(car_wash_id FK到CarWash) WashComment(wash_id FK到Wash) 有什么办法可以写这个查询 @Qu
spring-boot - 如何正确传播gRPC错误Spring-boot
我一直在关注this文章。我正在尝试在Spring-boot应用程序中优雅地处理gRPC错误，的主要目标是能够在gRPC客户端中获取错误状态。在上面的文章之后，我坚持为异常添加拦截器。如何在Spr
spring-boot - 自定义log4j插件和Spring Boot
我有一个要使用的自定义log4j布局插件。在IntelliJ中运行或与./gradlew bootRun一起运行时，插件可以正常工作。不使用./gradlew bootJar构建启动jar。启用-D
spring-boot - 给定范围内的随机服务器端口spring boot
我想在给定范围 (5001-5100) 的随机端口上启动 Spring Cloud 应用程序(Spring Boot 1.5.14，Spring Cloud Edgware.SR4)。我知道我们可以使
spring-boot - 如何在没有 spring boot gradle 插件的情况下在 gradle 中使用 spring boot
任何人都可以向我展示或指出不使用 spring boot gradle 插件的 spring boot gradle 项目。我正在寻找类似不使用 gradle 插件的 spring boot sta
spring-boot - spring-boot-starter-web 和 spring-boot-starter-webflux 的区别？
我当时尝试包含上述依赖项之一，但找不到任何区别: spring boot starter web:我可以看到 Flux 和 Mono 类并制作一个响应式(Reactive)休息 Controller
spring-boot - Spring Boot 1.X 和 Spring Boot 2.0 的区别
我们一直在为我们的应用程序使用 Springboot 1.X。现在准备开始一些新的应用程序，想知道我们是应该使用 SpringBoot2.0 还是坚持使用 SpringBoot 1.X？对一种方式
spring-boot - Spring Boot : When application. 属性和 application.yml 由 spring boot 应用程序加载
我希望记录应用程序正在加载 application-profile.propeties 或 application.yml。怎么做。在哪种方法中，我可以听取它并检测它是成功加载还是失败。最佳答案您
spring-boot - Spring Boot : error when add spring-boot-starter-data-jpa dependency
当我在 pom.xml 中添加简单的 spring-boot-starter-data-jpa 依赖项时，在 pom.xml 文件中出现错误。如果我删除该依赖项，则不会再有错误。我不确定为什么会发生这
spring-boot - Spring Boot : When application. 属性和 application.yml 由 spring boot 应用程序加载
我希望记录应用程序正在加载 application-profile.propeties 或 application.yml。怎么做。在哪种方法中，我可以听取它并检测它是成功加载还是失败。最佳答案您
spring-boot - Spring Boot Devtools 重启不会自动与 Spring Boot 1.5.4 一起使用
我在网上看了很多关于 spring-boot-devtools 的文章和问题，但仍然无法弄清楚为什么它对我不起作用。每次运行我的应用程序时，我都会得到以下信息: 17:54:28.057 [main]
spring-boot - Spring Boot 在使用 solrj 而不是 spring-boot-starter-data-solr 时爆炸
我正在尝试将现有的 Spring 应用程序移植到 Spring Boot。我不使用 spring-boot-starter-data-solr 启动器，但是我的类路径上有 apache solrj (
spring-boot - 为什么 Spring Boot 1.4 改变了它的 jar 布局来定位 BOOT-INF 下的应用程序类？
(这主要是一个历史问题。Pivotal 建议所有论坛讨论都在 StackOverflow 上进行，这就是我在这里问它的原因。) Spring Boot 项目用来证明将应用程序的类和依赖项从可执行 ja

知者

个人简介

我是一名优秀的程序员,十分优秀！

作者热门文章

滴滴打车优惠券免费领取

全站热门文章

首页

博学

6Ren·AI

商城