Add environment abstraction and support bean definition profiles [SPR-7508]

[spring-projects-issues]

Chris Beams opened SPR-7508 and commented

---

Sub-tasks:

• Support nested beans elements [SPR-7513] #12170 Support nested beans elements
• Support beans element 'profile' attribute [SPR-7514] #12171 Support beans element 'profile' attribute
• Create EnvironmentAwarePropertyPlaceholderConfigurer [SPR-7515] #12173 Create EnvironmentAwarePropertyPlaceholderConfigurer
• Add reference documentation for beans element 'profile' attribute [SPR-7533] #12191 Add reference documentation for beans element 'profile' attribute
• Add reference documentation for @Profile annotation [SPR-7534] #12192 Add reference documentation for @Profile annotation
• Add reference documentation for nested beans elements [SPR-7774] #12430 Add reference documentation for nested beans elements
• Support @Profile annotation [SPR-7775] #12431 Support @Profile annotation
• Support Environment and PropertySource [SPR-7776] #12432 Support Environment and PropertySource
• Add reference documentation for Environment and PropertySource [SPR-7777] #12433 Add reference documentation for Environment and PropertySource
• Support 'default' profile [SPR-7778] #12434 Support 'default' profile
• Resolve remaining SPR-7508 TODO items [SPR-8031] #12686 Resolve remaining SPR-7508 TODO items
• Support @Profile as a meta-annotation [SPR-8035] #12690 Support @Profile as a meta-annotation

Issue Links:

• Conditional Bean Definitions [SPR-5261] #9935 Conditional Bean Definitions ("supersedes")

5 votes, 9 watchers

[spring-projects-issues]

Dave Syer commented

Does anyone else except me dislike the names of the System properties used by Spring (springProfiles, defaultSpringProfile)? They are camel case, whereas the convention for java.util.Properties names is lower case and period separated (especially System properties it would seem - start a JVM and list the standard ones to see what I mean).

[spring-projects-issues]

Sam Brannen commented

Dave,

I agree: we should go with the convention, not camel case.

For example, what about something like the following?

• springProfiles --> spring.profiles
• defaultSpringProfile --> spring.profile.default

[spring-projects-issues]

Oliver Drotbohm commented

+1 for . notation

[spring-projects-issues]

Chris Beams commented

Thanks all for pointing this out. Yes, obviously it should be dot notation.

I've updated to:

• spring.profile.active
• spring.profile.default

While it may be the most 'correct' approach to fully qualify here with org.springframework.profile, I'm currently thinking that saving keystrokes is worth the tradeoff. A naming collision with spring.profile.* is highly unlikely anyway.

Currently, there may be only one default profile, but any number of active profiles may be specified. For this reason, it may be best to use a plural 'profiles' (spring.profiles.active), but (a) I dislike the asymmetry with spring.profile.default remaining singular - this makes things harder to remember and errors are more likely. (b) it's conceivable that we would allow for multiple default profiles in the future, so wouldn't want to be stuck with the singular naming. I see the choices as being:

• spring.profile.active
• spring.profile.default

or

• spring.profiles.active
• spring.profiles.default

Generally speaking, we use singular package names (.beans being a notable exception). This is enough to sway me into saying we should leave profile singular (as is now the case in my latest commit).

[spring-projects-issues]

James Ward commented

Is there some way to set the default profiles from a Maven build? I'd like to set the default to my "dev" profile for running "mvn test" so that the developer doesn't have to remember to run "mvn -Dspring.profiles.active=dev test".

Thanks!

[spring-projects-issues]

Stevo Slavić commented

@James See maven surefire plugin system properties example

e.g.

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-surefire-plugin</artifactId>
  <configuration>
    <systemPropertyVariables>
      <spring.profiles.active>test</spring.profiles.active>
    </systemPropertyVariables>
  </configuration>
</plugin>

[spring-projects-issues]

James Ward commented

Exactly what I needed! Tested and works great! Thanks Stevo!

BTW: I used:
<systemPropertyVariables>
<spring.profiles.default>dev</spring.profiles.default>
</systemPropertyVariables>

[spring-projects-issues]

Chris Beams commented

Completed in M1; see http://blog.springsource.com/2011/02/11/spring-framework-3-1-m1-released/