How to pass JVM arguments in SpringBOOT

Question

I would like to pass JVM arguments in the main spring boot class where we will be starting the spring boot application.

Could you please share how to set JVM arguments in spring boot application?

I tried the below options and there is no luck

System.setProperty("http.proxyHost", "X.X.X.X");
System.setProperty("http.proxyPort", "8080");

or you can use this for spring boot

bootRun {
    systemProperties "property1": "value1", "property2": "value2"
}

score 35 · Answer 1 · answered Nov 10 '15 at 16:53

35

Add JVM arguments with -DargumentName i.e.

-DargumentName="value1"

Then in your spring application, you can retrieve the value by doing:

@Value("${argumentName}")
private String myVariable

Hope this helps!

answered Nov 10 '15 at 16:53

Kabir

860
5
11

How to add it in eclipse? – Thirumal Jun 05 '19 at 16:07

score 16 · Answer 2 · answered Nov 10 '15 at 20:51

Spring Boot has a pretty sophisticated environment variable and config properties management. You can do something as simple as this to pass foo with value "bar" via command line.

java -jar app.jar --foo="bar"

If you have not already, the link below has everything you need as far as ways of externalization of configuration in a Spring Boot application:

http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html

Update:

If you are running a Spring Boot application, you should always run it using the pattern below:

$ java -jar <jar-name> [--key1="value1"]... [--keyN="valueN"]

And not using the command line suggested in some of the other comments here.

score 7 · Answer 3 · answered May 11 '17 at 06:43

7

JVM arguments you might add in app.conf file:

export JAVA_OPTS='-Dyour_param=1234'

source: SPRING DOCS

answered May 11 '17 at 06:43

Krzysztof Szewczyk

1,752
1
21
25

score 5 · Answer 4 · edited Nov 10 '15 at 17:12

5

You can set system properties with the -D switch when you start your application

java -DsomeProperty=123 your.package.name.YourMainClassName

Later in your code you can obtain a property value simply by calling

System.getPropetry("someProperty")

edited Nov 10 '15 at 17:12

Steven

5,654
1
16
19

answered Nov 10 '15 at 17:00

Nikita Magonov

171
4

score 5 · Answer 5 · edited Apr 27 '17 at 06:29

5

You can run your app like this:

$ java -server -Dmyproperty=blabla -jar myapp.jar

and you can access the value of myproperty in code.

edited Apr 27 '17 at 06:29

Pang

9,564
146
81
122

answered Apr 27 '17 at 06:03

Sourabh Kanojiya

121
2
5

1

what does `-D` mean ? – pheromix Jan 16 '19 at 09:11
4

Remark: providing the options after `-jar myapp.jar` will not take them into account. – Rémi.B Jul 10 '19 at 12:30

score 4 · Answer 6 · answered Apr 27 '17 at 08:03

4

You can run your app like this:

$ java -jar app.jar --someProperty=123

in application call:

import org.springframework.core.env.Environment;
@Autowired
private Environment env;

String someProperty= env.getProperty("someProperty");

answered Apr 27 '17 at 08:03

maciej

51
2

is this safe from a security point of view? – Ion Utale Dec 14 '20 at 11:29

score 3 · Answer 7 · answered Nov 10 '15 at 21:58

You have to use the @Value annotation. For example

@Value("#{systemProperties.test}")

You can use it directly in a bean property, I have an example using in a parameter of a method.

@SpringBootApplication
public class ReviewsMicroserviceApplication {

    public static void main(String[] args) {
        ApplicationContext ctx =  SpringApplication.run(ReviewsMicroserviceApplication.class, args);
        System.out.println(ctx.getBean("value"));
    }

    @Bean
    public String value(@Value("#{systemProperties.test}")String value){
        return value;
    }
}

In order to execute the program you need to add the test property to the JVM properties.

 -Dtest="hallo reos"

score 2 · Answer 8 · answered Aug 23 '22 at 08:47

When I run Spring Boot Apps with the Maven Plugin I have to set properties with -Dspring-boot.run.jvmArguemtns=xxx but this not really sets System-Properties but Spring-Properties (defined in application.xml)

here the command to start a spring boot app with properties:

mvn spring-boot:run -D"spring-boot.run.jvmArguments=-Dserver.port=8399 -Dactivemq.url=http://localhost:61616"

score 0 · Answer 9 · answered Dec 16 '21 at 01:27

package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

@SpringBootApplication
public class DemoApplication {

    @Autowired
    MyFantasticClass myFantasticClass;
    
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
    
    @Bean
    CommandLineRunner commandLineRunner() {
        return args -> {
            System.out.println(myFantasticClass.getMyFantasticProperty());
        };
    }
}

@Component
class MyFantasticClass{
    @Value("${myFantasticProperty}")
    String myFantasticProperty;
    
    String getMyFantasticProperty() {
        return myFantasticProperty;
    }
}

score 0 · Answer 10 · answered Feb 28 '23 at 09:30

0

I was reading this answer that explains application.properties and I started using application.properties to set up my environment-related variables

bootstrap.properties:

slack.channel=test

bootstrap.yml:

slack: 
  channel: ${slack.channel}

answered Feb 28 '23 at 09:30

Khaled AbuShqear

1,230
14
24

score 0 · Answer 11 · answered Mar 01 '23 at 17:16

If you want your local environment to be always in UTF-8, then the easiest way is to define this inside your POM:

<properties>
    <spring-boot.run.jvmArguments>-Dfile.encoding=UTF-8</spring-boot.run.jvmArguments>
</properties>

You can also add multiple arguments inside it like this:

<properties>
    <spring-boot.run.jvmArguments>-Duser.timezone=UTC -Dfile.encoding=UTF-8</spring-boot.run.jvmArguments>
</properties>

Please note that this only works when you run the Spring Boot application in your local environment with following command:

mvn spring-boot:run

If you are using command line java to run your Spring Boot application, then you should either save the parameter as an environment variable or run Java with the argument like the other answers have mentioned.

How to pass JVM arguments in SpringBOOT

11 Answers11

Linked