Spring Boot: @ConfigurationProperties tutorial

In my previous post, I explained how to inject a property from 'application.properties' file using @Value annotation. Spring boot provides more elegant way, where you can map the properties to a model class using '@ConfigurationProperties' anotation.

application.properties

appName="ChatServer_beta"
appVersion="1.5Beta"
servers[0].serverIp="5.6.7.8"
servers[0].serverEnvironemnt="Testing"
servers[1].serverIp="1.2.3.4"
servers[1].serverEnvironemnt="Development"

We can map above properties to below model class.

@Configuration

@ConfigurationProperties

public class Service {

         private String appName;

         private String appVersion;

         private List<Server> servers;

        

         ....

         ....

         ....

}

Find the below working application.

Server.java

package com.sample.myApp.model;

public class Server {
 private String serverIp;
 private String serverEnvironemnt;

 public String getServerIp() {
  return serverIp;
 }

 public void setServerIp(String serverIp) {
  this.serverIp = serverIp;
 }

 public String getServerEnvironemnt() {
  return serverEnvironemnt;
 }

 public void setServerEnvironemnt(String serverEnvironemnt) {
  this.serverEnvironemnt = serverEnvironemnt;
 }

}

Service.java

package com.sample.myApp.model;

import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConfigurationProperties
public class Service {
 private String appName;
 private String appVersion;
 private List<Server> servers;

 public String getAppName() {
  return appName;
 }

 public void setAppName(String appName) {
  this.appName = appName;
 }

 public String getAppVersion() {
  return appVersion;
 }

 public void setAppVersion(String appVersion) {
  this.appVersion = appVersion;
 }

 public List<Server> getServers() {
  return servers;
 }

 public void setServers(List<Server> servers) {
  this.servers = servers;
 }

}

Application.java

package com.sample.myApp;

import java.util.List;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

import com.sample.myApp.model.Server;
import com.sample.myApp.model.Service;

@SpringBootApplication
public class Application {
 public static void main(String[] args) {
  ConfigurableApplicationContext applicationContext = SpringApplication.run(Application.class, args);

  Service service = applicationContext.getBean(Service.class);
  String appName = service.getAppName();
  String appVersion = service.getAppVersion();

  System.out.println("*******************************************");
  System.out.printf("Application Name : %s\n", appName);
  System.out.printf("Application Version %s\n", appVersion);

  System.out.println("Servers Information");
  
  List<Server> servers = service.getServers();

  for (Server server : servers) {
   System.out.printf("Environment : %s\n", server.getServerEnvironemnt());
   System.out.printf("Server Ip : %s\n", server.getServerIp());
  }

  System.out.println("*******************************************");
  applicationContext.close();

 }

}

When you ran 'Application.java', you can able to see below messages in the console.

*******************************************
Application Name : "ChatServer_beta"
Application Version "1.5Beta"
Servers Information
Environment : "Testing"
Server Ip : "5.6.7.8"
Environment : "Development"
Server Ip : "1.2.3.4"
*******************************************

Previous                                                 Next                                                 Home