how to define not mandatory property in spring?

Question

I'm using spring 3 with PropertyPlaceholderConfigurator.

My properties code looks like as following:

@Configuration
public class MyProps {

    @Value("${prop1}")
    public String prop1;

    ...
}

If I do not have a prop1 in my .properties file the spring fails to initialize it's context.

The question is how can I define that this property is not mandatory? some annotation, configuration?

score 66 · Accepted Answer · answered Aug 02 '12 at 08:05

66

You could use a default value:

@Value("${prop1:}")
public String prop1;

and spring will inject an empty string if the property isn't defined. The syntax is ${property:defaultValue}.

answered Aug 02 '12 at 08:05

tibtof

7,687
1
29
49

31

you can also set null values: @Value("${prop1:#{null}}") – kieste May 29 '15 at 13:52

score 11 · Answer 2 · answered Aug 02 '12 at 07:55

11

I'm not sure if it is possible to make a single property optional but surely you can force the property placeholder to ignore unresolved properties:

<context:property-placeholder ignore-unresolvable="true" ... />

answered Aug 02 '12 at 07:55

adamoldak

564
4
5

In this case all the properties will be not mandatory, But I want only some selected properties be optional, and the rest be mandatory. Can I do this with some annotation? – Julias Aug 02 '12 at 09:37
you can write separate property-placeholder for that – Ajeetkumar Aug 02 '16 at 07:49

score 0 · Answer 3 · answered May 01 '21 at 22:11

To ignore all unresolvable properties rather than a specific property, you can use the below bean in your configuration class:

@Bean
public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
    PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
    configurer.setIgnoreUnresolvablePlaceholders(true);
    return configurer;
}

how to define not mandatory property in spring?

3 Answers3

Linked

Related