CODEWITHSUNDEEP
javaspringspring-boot
JellyRaptor
JellyRaptor

Reputation: 755

Enforce constraints on @Value annotated field in Spring Boot application

I have the following field annotated with @Value, specifying a default value:

@Value("${tolerance.percentage:25}")
private int tolerance;

That code correctly initializes the value of the field to the system property "tolerance.percentage" if that prop exists. If it doesn't exist, it defaults to 25.

I want to go one step further, though, by enforcing a min and max on this int field, since it represents a percentage less than 100 as a whole number, and Murphy's law means someone (probably me) can externally misconfigure the property and my app would start doing weird things at runtime, which is way too late for my liking. I would like an error to be thrown if the property is set to "101" or "-1" upon application startup. Heck, I'd even like for an error to be thrown if I try to default it to 101 in the @Value annotation, but that's not important for the purposes of this question. Here's what I tried:

//@Min and @Max don't produce the intended behavior when combined with @Value
@Min(0)
@Max(100)
@Value("${tolerance.percentage:25}")
private int tolerance;

Can I enforce a min and max on an int field that @Value is aware of?

Upvotes: 13

Views: 11423

Answers (1)

M. Deinum
M. Deinum

Reputation: 124536

Validation using regular validation API annotations is only going to work in certain circumstances.

  1. You have an implementation ('hibernate-validator') on the classpath
  2. The class they are in are used to bind externalized configuration

So instead of using @Value with those you probably want to create a class that contains the expected properties and use binding with @ConfigurationProperties. (and you might want to use @Range instead).

@ConfigurationProperties(prefix="tolerance")
public ToleranceProperties {

    @Range(min=1, max=100)
    private int percentage = 25; 

    // Here be a getter/setter
}

This combined on a @Configuration class add @ EnableConfigurationProperties(ToleranceProperties.class) and you can use it anywhere you need properties. (See typesafe configuration properties in the reference guide.

Note: You could also declare it as a @Component.

Upvotes: 10

Related Questions