SpringBoot命令参数设置和获取

一、定义

SpringBoot 中命令参数可以分为:SpringBoot特定的命令行参数和通用的JVM系统属性

SpringBoot特定的命令行参数格式:--[参数名称] ,放于jar包后面

通用的JVM系统属性参数格式:-D[参数名称] ,放于jar包前面

二、区别

--spring.profiles.active和-Dspring.profiles.active都是用于设置Spring Boot应用程序的活动配置文件的参数,但它们在使用方式和作用范围上有所不同。

--spring.profiles.active是Spring Boot特定的命令行参数,仅在启动Spring Boot应用程序时生效,用于可以直接传递给SpringApplication的run方法在启动应用程序时指定活动配置文件。您可以通过在命令行中使用--spring.profiles.active=profile来设置它,其中profile是要激活的配置文件的名称。例如:java -jar myapp.jar --spring.profiles.active=dev。这种方式适用于直接在命令行中指定活动配置文件。

-Dspring.profiles.active这是一个系统属性,可用于任何Java应用程序,用于在应用程序运行时设置活动配置文件。您可以在启动命令中使用-Dspring.profiles.active=profile来设置它,其中profile是要激活的配置文件的名称。例如:java -jar -Dspring.profiles.active=dev myapp.jar。这种方式适用于在启动命令中设置系统属性。

总之,--spring.profiles.active是Spring Boot特定的命令行参数,用于设置活动配置文件,而-Dspring.profiles.active是通用的JVM系统属性,用于在运行时设置活动配置文件。您可以根据具体的使用场景选择适合的方式来设置活动配置文件。

三、数据获取方式

3.1  获取`--spring.profiles.active`参数的值

在Spring Boot应用程序中,可以通过多种方式获取`--spring.profiles.active`参数的值:

1. 使用`Environment`对象:

可以通过`Environment`对象获取活动配置文件的值。在Spring Boot中,`Environment`是一个接口,它提供了访问应用程序属性和配置的方法。可以通过注入`Environment`对象来获取活动配置文件的值,如下所示:

```java

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.core.env.Environment;

import org.springframework.stereotype.Component;

@Component

public class MyComponent {

    @Autowired

    private Environment environment;

    public void printActiveProfile() {

        String activeProfile = environment.getProperty("spring.profiles.active");

        System.out.println("Active profile: " + activeProfile);

    }

}

```

在上面的示例中,通过注入`Environment`对象,可以使用`getProperty`方法获取`spring.profiles.active`的值。

2. 使用`@Value`注解:

可以使用`@Value`注解将活动配置文件的值直接注入到一个变量中,如下所示:

```java

import org.springframework.beans.factory.annotation.Value;

import org.springframework.stereotype.Component;

@Component

public class MyComponent {

    @Value("${spring.profiles.active}")

    private String activeProfile;

    public void printActiveProfile() {

        System.out.println("Active profile: " + activeProfile);

    }

}

```

在上面的示例中,通过`@Value`注解将`${spring.profiles.active}`的值注入到`activeProfile`变量中。

3. 使用`@ConfigurationProperties`注解:

可以使用`@ConfigurationProperties`注解将活动配置文件的值绑定到一个自定义的配置类中,如下所示:

```java

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

import org.springframework.stereotype.Component;

@Component

@ConfigurationProperties(prefix = "spring.profiles")

public class MyConfig {

    private String active;

    public String getActive() {

        return active;

    }

    public void setActive(String active) {

        this.active = active;

    }

}

```

4、 使用`@Profile`注解:

可以在Spring组件(如Bean、配置类、方法)上使用`@Profile`注解来指定特定的活动配置文件。当应用程序启动时,Spring会根据`--spring.profiles.active`参数的值来选择相应的组件。例如:

```java

@Configuration

@Profile("dev")

public class DevConfiguration {

    // Configuration for dev profile

}

@Configuration

@Profile("prod")

public class ProdConfiguration {

    // Configuration for prod profile

}

```

在上述示例中,`DevConfiguration`类仅在`dev`配置文件激活时才会被加载,`ProdConfiguration`类仅在`prod`配置文件激活时才会被加载。

5. 使用`ApplicationContext`对象:

可以通过`ApplicationContext`对象获取活动配置文件的值。`ApplicationContext`是Spring应用程序的核心接口,它提供了访问应用程序上下文的方法。可以通过注入`ApplicationContext`对象来获取活动配置文件的值,如下所示:

```java

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.context.ApplicationContext;

import org.springframework.stereotype.Component;

@Component

public class MyComponent {

    @Autowired

    private ApplicationContext applicationContext;

    public void printActiveProfile() {

        String activeProfile = applicationContext.getEnvironment().getProperty("spring.profiles.active");

        System.out.println("Active profile: " + activeProfile);

    }

}

```

3.2  获取`-Dspring.profiles.active`参数的值

1、使用`System.getProperty()`方法获取`-Dspring.profiles.active`参数值

示例代码:

```java

public class MyApp {

    public static void main(String[] args) {

        String activeProfile = System.getProperty("spring.profiles.active");

        System.out.println("Active profile: " + activeProfile);

    }

}

```

2、使用`Environment`对象获取`

在Spring Boot应用程序中,可以通过依赖注入`Environment`对象,并使用`getProperty()`方法获取活动配置文件的值。

示例代码:

```java

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.core.env.Environment;

import org.springframework.stereotype.Component;

@Component

public class MyComponent {

    @Autowired

    private Environment environment;

    public void printActiveProfile() {

        String activeProfile = environment.getProperty("spring.profiles.active");

        System.out.println("Active profile: " + activeProfile);

    }

}

```

3、System.getProperty()无法获取值的原因

如果您使用`System.getProperty()`方法无法获取`-Dspring.profiles.active`参数的值,可能有以下几个原因:

1. 参数未正确设置:请确保在启动应用程序时正确设置了`-Dspring.profiles.active`参数。您可以在命令行中使用类似于`java -jar myapp.jar -Dspring.profiles.active=dev`的方式设置参数。如果参数未正确设置,`System.getProperty()`方法将返回`null`。

2. 参数名称错误:请确保您在调用`System.getProperty()`方法时使用了正确的参数名称。参数名称应该是`spring.profiles.active`,而不是`-Dspring.profiles.active`。在调用`System.getProperty()`方法时,只需要传递参数名称即可,不需要包含`-D`前缀。

3. 安全性限制:某些环境可能会限制应用程序访问系统属性。例如,在某些安全配置下,应用程序可能无法获取系统属性。请确保您的应用程序在合适的环境下具有访问系统属性的权限。


注意:在命令行中,参数的顺序很重要。-Dspring.profiles.active=dev应该位于执行JAR包的命令之前,而不是之后。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容