{"id":1714,"date":"2012-08-07T19:36:00","date_gmt":"2012-08-07T19:36:00","guid":{"rendered":"http:\/\/www.javacodegeeks.com\/2012\/10\/spring-profile-pattern-example.html"},"modified":"2012-10-22T06:34:43","modified_gmt":"2012-10-22T06:34:43","slug":"spring-profile-pattern-example_7","status":"publish","type":"post","link":"https:\/\/www.javacodegeeks.com\/2012\/08\/spring-profile-pattern-example_7.html","title":{"rendered":"Spring Profile pattern example"},"content":{"rendered":"
\n
Recently we were introduced with the concept of Spring Profiles<\/a>.<\/p>\n

This concept is an easy configuration differentiators for different deployment environments.<\/p>\n

The straight forward use case (which was presented) was to annotate the relevant classes so Spring would load the appropriate class according to the active profile. <\/p>\n

However, this approach might not always serve the common use case… often, the configuration keys would be the same and only the values will change per environment. <\/p>\n

In this post, I would like to present a pattern to support loading configuration data per environment, without <\/strong>the need to create\/maintain multiple classes for each profile (i.e. for each environment). <\/p>\n

Throughout the post I would take the DB connection configuration as a sample, assuming we have different DB definitions (e.g. username or connection URL) for each deployment environment. <\/p>\n

The main idea is to use one<\/strong> class for loading the configuration (i.e.. one class for DB connection definition) and inject into it the appropriate instance which holds the correct profile configuration data. <\/p>\n

For convenience and clarity, the process was divided into 3 phases: <\/p>\n

Phase 1<\/strong>: infra preparation
\nStep 1.1 – create a properties file which contains all configuration data
\nStep 1.2 – create an annotation for each profile
\nstep 1.3 – make sure the profile is loaded during context loading <\/p>\n

Phase 2<\/strong>: implementing the profile pattern
\nStep 2.1 – create a properties interface
\nStep 2.2 – create a class for each profile
\nStep 2.3 – create an abstract file which holds the entire data <\/p>\n

Phase 3<\/strong>: using the pattern
\nStep 3.1 – example for using the pattern <\/p>\n

Spring Profile pattern – phase 1: infra preparation <\/strong><\/p>\n

This phase will establish the initial infra for using Spring Profile and the configuration files. <\/p>\n

Step 1.1<\/strong> – create a properties file which contains all configuration data<\/p>\n

Assuming you have a maven style project, create a file in src\/main\/resources\/properties for each environment, e.g:<\/p>\n

my_company_dev.properties
\nmy_company_test.properties
\nmy_company_production.properties <\/p>\n

example for my_company_dev.properties content:<\/p>\n

jdbc.url=jdbc:mysql:\/\/localhost:3306\/my_project_db
\ndb.username=dev1
\ndb.password=dev1
\nhibernate.show_sql=true <\/p>\n

example for my_company_production.properties content: <\/p>\n

jdbc.url=jdbc:mysql:\/\/10.26.26.26:3306\/my_project_db
\ndb.username=prod1
\ndb.password=fdasjkladsof8aualwnlulw344uwj9l34
\nhibernate.show_sql=false <\/p>\n

Step 1.2<\/strong> – create an annotation for each profile<\/p>\n

In src.main.java.com.mycompany.annotation create annotation for each Profile, e.g : <\/p>\n

@Target(ElementType.TYPE)\r\n@Retention(RetentionPolicy.RUNTIME)\r\n@Profile(\"DEV\")\r\npublic @interface Dev {\r\n}\r\n<\/pre>\n
@Target(ElementType.TYPE)\r\n@Retention(RetentionPolicy.RUNTIME)\r\n@Profile(\"PRODUCTION\")\r\npublic @interface Production {\r\n}\r\n<\/pre>\n
Create an enum for each profile:
\npublic interface MyEnums {                    
 
<\/div> <\/div><\/p>\n
\r\npublic enum Profile{\r\nDEV,\r\nTEST,\r\nPRODUCTION\r\n}\r\n<\/pre>\n
Step 1.3<\/strong>  – make sure the profile is loaded during context loading                    <\/p>\n