[Recipe] Enabling Spring Profiles Through Property

Problem: 

Activate a profile using properties file.

Solution Summary: 

We can use the property 'spring.profiles.active' within a properties file to activate a profile and is the most preferred approach. 

We will define this property in a file called application.properties and then import this properties file using @PropertySource on the Java configuration class. If you are using Spring Boot, then you don't have to import this file as Spring Boot automatically import a file names application.properties.

Solution: 

Code: Bean Components

JJWriter.java

This class has not changed.

package com.javajee.spring;

public interface JJWriter {

    public void write();

}

 

JJDatabaseWriter.java

package com.javajee.spring;

import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;

@Component("writer")
@Profile({"default","dbprofile"})
public class JJDatabaseWriter implements JJWriter {

    public void write() {
        System.out.println("Writing to Database!!!");
    }
    
    @Override
    public String toString(){
        return "Writing to Database!!!";
    }
}

 

JJFileWriter.java

package com.javajee.spring;

import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;

@Component("writer")
@Profile("fileprofile")
public class JJFileWriter implements JJWriter {

    public void write() {
        System.out.println("Writing to File!!!");
    }
    
    @Override
    public String toString(){
        return "Writing to File!!!";
    }

}

 

Code: Defining Property

Create a properties file 'application.properties' in classpath with the property 'spring.profiles.active':

spring.profiles.active=dbprofile

 

Code: Java Config File

DemoConfig.java

package com.javajee.spring;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:/application.properties")
@ComponentScan(basePackages="com.javajee.spring")
public class DemoConfig {

}

 

Code: Test Class

JJWriterMain.java

package com.javajee.spring;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.support.AbstractApplicationContext;

public class JJWriterMain {

    public static void main(String[] args) {

        AbstractApplicationContext context = new AnnotationConfigApplicationContext(DemoConfig.class);

        JJWriter writer = context.getBean("writer", JJWriter.class);

        writer.write();
        
        context.close();
    }
}

Now change the profiles within properties file to test. If you use a profile that does not exist, you get a error that the bean could not be found. If you remove the profile property, then you can test the default profile.

Recipe Tags: 

Search the Web

Custom Search

Searches whole web. Use the search in the right sidebar to search only within javajee.com!!!

Quick Notes Finder Tags

Activities (1) advance java (1) agile (3) App Servers (6) archived notes (2) Arrays (1) Best Practices (12) Best Practices (Design) (3) Best Practices (Java) (7) Best Practices (Java EE) (1) BigData (3) Chars & Encodings (6) coding problems (2) Collections (15) contests (3) Core Java (All) (52) course plan (2) Database (12) Design patterns (8) dev tools (3) downloads (2) eclipse (9) Essentials (1) examples (14) Exceptions (4) exercises (6) Getting Started (18) Groovy (2) hadoop (4) hibernate (77) hibernate interview questions (6) History (1) Hot book (4) http monitoring (2) Inheritance (4) intellij (1) java 8 notes (4) Java 9 (1) Java Concepts (7) Java Core (4) java ee exercises (1) java ee interview questions (2) Java Elements (16) Java Environment (1) Java Features (4) java interview points (4) java interview questions (4) javajee initiatives (1) javajee thoughts (3) Java Performance (6) Java Programmer 1 (4) Java Programmer 2 (2) Javascript Frameworks (1) Java SE Professional (1) JSP (1) linked list (3) maven (1) Multithreading (16) NFR (1) No SQL (1) Object Oriented (9) OCPJP (4) OCPWCD (1) OOAD (3) Operators (4) Overloading (2) Overriding (2) Overviews (1) policies (1) programming (1) Quizzes (17) references (2) resources (1) restful web service (3) Searching (1) security (10) Servlets (8) Servlets and JSP (31) Sorting (1) source code management (1) spring (4) spring boot (1) Spring Examples (1) Spring Features (1) spring jpa (1) Stack (1) Streams & IO (3) Strings (11) SW Developer Tools (2) testing (1) user interface (1) vxml (8) web services (1) Web Technologies (1) Web Technology Books (1) youtube (1)