程序包 cn.taketoday.core.env

接口 Environment

所有超级接口:

PropertyResolver

所有已知子接口:

ConfigurableEnvironment

所有已知实现类:

AbstractEnvironment, StandardEnvironment

public interface Environment
extends PropertyResolver

Interface representing the environment in which the current application is running. Models two key aspects of the application environment: profiles and properties. Methods related to property access are exposed via the PropertyResolver superinterface.

A profile is a named, logical group of bean definitions to be registered with the container only if the given profile is active. Beans may be assigned to a profile whether defined in XML or via annotations; see the or the @Profile annotation for syntax details. The role of the Environment object with relation to profiles is in determining which profiles (if any) are currently active, and which profiles (if any) should be active by default.

Properties play an important role in almost all applications, and may originate from a variety of sources: properties files, JVM system properties, system environment variables, JNDI, servlet context parameters, ad-hoc Properties objects, Maps, and so on. The role of the environment object with relation to properties is to provide the user with a convenient service interface for configuring property sources and resolving properties from them.

Beans managed within an ApplicationContext may register to be EnvironmentAware or @Inject the Environment in order to query profile state or resolve properties directly.

Configuration of the environment object must be done through the ConfigurableEnvironment interface, returned from all AbstractApplicationContext subclass getEnvironment() methods. See ConfigurableEnvironment Javadoc for usage examples demonstrating manipulation of property sources prior to application context refresh().

从以下版本开始:

4.0

作者:

Chris Beams

另请参阅:

• PropertyResolver
• EnvironmentCapable
• ConfigurableEnvironment
• AbstractEnvironment
• StandardEnvironment
• cn.taketoday.context.aware.EnvironmentAware
• cn.taketoday.context.ConfigurableApplicationContext#getEnvironment
• cn.taketoday.context.ConfigurableApplicationContext#setEnvironment
• cn.taketoday.context.support.AbstractApplicationContext#createEnvironment

字段概要

字段

修饰符和类型	字段	说明
static final String	DEFAULT_PROFILE	Name of reserved default profile name: "default".
static final String	DEFAULT_PROPERTIES_FILE
static final String	DEFAULT_YAML_FILE
static final String	DEFAULT_YML_FILE
static final String	ENVIRONMENT_BEAN_NAME	Name of the Environment bean in the factory.
static final String	KEY_ACTIVE_PROFILES	Name of property to set to specify active profiles: "context.profiles.active".
static final String	KEY_DEFAULT_PROFILES	Name of property to set to specify profiles active by default: "context.profiles.default".
static final String	KEY_IGNORE_GETENV	System property that instructs to ignore system environment variables, i.e. to never attempt to retrieve such a variable via System.getenv().
static final String	SYSTEM_ENVIRONMENT_BEAN_NAME	Name of the System environment bean in the factory.
static final String	SYSTEM_PROPERTIES_BEAN_NAME	Name of the System properties bean in the factory.

方法概要

修饰符和类型	方法	说明
boolean	acceptsProfiles(Profiles profiles)	Return whether the active profiles match the given Profiles predicate.
default boolean	acceptsProfiles(String... profiles)	Return whether one or more of the given profiles is active or, in the case of no explicit active profiles, whether one or more of the given profiles is included in the set of default profiles.
String[]	getActiveProfiles()	Return the set of profiles explicitly made active for this environment.
String[]	getDefaultProfiles()	Return the set of profiles to be active by default when no active profiles have been set explicitly.

从接口继承的方法 cn.taketoday.core.env.PropertyResolver

containsProperty, getFlag, getFlag, getProperty, getProperty, getProperty, getProperty, getRequiredProperty, getRequiredProperty, resolvePlaceholders, resolveRequiredPlaceholders

字段详细资料

ENVIRONMENT_BEAN_NAME

static final String ENVIRONMENT_BEAN_NAME

Name of the Environment bean in the factory.

从以下版本开始:

4.0

另请参阅:

• 常量字段值

SYSTEM_PROPERTIES_BEAN_NAME

static final String SYSTEM_PROPERTIES_BEAN_NAME

Name of the System properties bean in the factory.

从以下版本开始:

4.0

另请参阅:

• System.getProperties()
• 常量字段值

SYSTEM_ENVIRONMENT_BEAN_NAME

static final String SYSTEM_ENVIRONMENT_BEAN_NAME

Name of the System environment bean in the factory.

从以下版本开始:

4.0

另请参阅:

• System.getenv()
• 常量字段值

DEFAULT_YML_FILE

static final String DEFAULT_YML_FILE

另请参阅:

• 常量字段值

DEFAULT_YAML_FILE

static final String DEFAULT_YAML_FILE

另请参阅:

• 常量字段值

DEFAULT_PROPERTIES_FILE

static final String DEFAULT_PROPERTIES_FILE

另请参阅:

• 常量字段值

KEY_IGNORE_GETENV

static final String KEY_IGNORE_GETENV

System property that instructs to ignore system environment variables, i.e. to never attempt to retrieve such a variable via System.getenv().

The default is "false", falling back to system environment variable checks if an environment property (e.g. a placeholder in a configuration String) isn't resolvable otherwise. Consider switching this flag to "true" if you experience log warnings from getenv calls coming from TODAY.

另请参阅:

• AbstractEnvironment.suppressGetenvAccess()
• 常量字段值

KEY_ACTIVE_PROFILES

static final String KEY_ACTIVE_PROFILES

Name of property to set to specify active profiles: "context.profiles.active". Value may be comma delimited.

Note that certain shell environments such as Bash disallow the use of the period character in variable names. Assuming that SystemEnvironmentPropertySource is in use, this property may be specified as an environment variable as CONTEXT_PROFILES_ACTIVE.

另请参阅:

• ConfigurableEnvironment.setActiveProfiles(java.lang.String...)
• 常量字段值

KEY_DEFAULT_PROFILES

static final String KEY_DEFAULT_PROFILES

Name of property to set to specify profiles active by default: "context.profiles.default". Value may be comma delimited.

Note that certain shell environments such as Bash disallow the use of the period character in variable names. Assuming that SystemEnvironmentPropertySource is in use, this property may be specified as an environment variable as CONTEXT_PROFILES_DEFAULT.

另请参阅:

• ConfigurableEnvironment.setDefaultProfiles(java.lang.String...)
• 常量字段值

DEFAULT_PROFILE

static final String DEFAULT_PROFILE

Name of reserved default profile name: "default". If no default profile names are explicitly and no active profile names are explicitly set, this profile will automatically be activated by default.

另请参阅:

• ConfigurableEnvironment.setDefaultProfiles(java.lang.String...)
• ConfigurableEnvironment.setActiveProfiles(java.lang.String...)
• KEY_DEFAULT_PROFILES
• KEY_ACTIVE_PROFILES
• 常量字段值

方法详细资料

getActiveProfiles

String[] getActiveProfiles()

Return the set of profiles explicitly made active for this environment. Profiles are used for creating logical groupings of bean definitions to be registered conditionally, for example based on deployment environment. Profiles can be activated by setting "context.profiles.active" as a system property or by calling ConfigurableEnvironment.setActiveProfiles(String...).

If no profiles have explicitly been specified as active, then any default profiles will automatically be activated.

另请参阅:

• getDefaultProfiles()
• ConfigurableEnvironment.setActiveProfiles(java.lang.String...)
• KEY_ACTIVE_PROFILES

getDefaultProfiles

String[] getDefaultProfiles()

Return the set of profiles to be active by default when no active profiles have been set explicitly.

另请参阅:

• getActiveProfiles()
• ConfigurableEnvironment.setDefaultProfiles(java.lang.String...)
• KEY_DEFAULT_PROFILES

acceptsProfiles

default boolean acceptsProfiles(String... profiles)

Return whether one or more of the given profiles is active or, in the case of no explicit active profiles, whether one or more of the given profiles is included in the set of default profiles. If a profile begins with '!' the logic is inverted, i.e. the method will return true if the given profile is not active. For example, env.acceptsProfiles("p1", "!p2") will return true if profile 'p1' is active or 'p2' is not active.

抛出:

IllegalArgumentException - if called with zero arguments or if any profile is null, empty, or whitespace only

另请参阅:

• getActiveProfiles()
• getDefaultProfiles()
• acceptsProfiles(Profiles)

acceptsProfiles

boolean acceptsProfiles(Profiles profiles)

Return whether the active profiles match the given Profiles predicate.