Validation on loading JSON property with Spring Boot

Question

I have a Spring boot application where I am reading a JSON property file with @ConfigurationProperties annotation:

@Component
@ConfigurationProperties(prefix = "my-config")
@RefreshScope
public class MyConfig {

    private List<Service> services;

    private List<Consumer> consumers;

    ...

Here I would like to add validation while Spring Boot load the property file if something is null or minimum value in the array/list is 1 etc..

I know Spring Boot is using Jackson in the background to perform marshall/unmarshalling between JSON and POJO. I cannot find anything in Jackson which enforce this validation.

Different forums suggest the standard JSR-303 validation however it only works with Rest APIs and not while loading the properties.

Take a look at @Valid when creating objects with jackson without controller question. There is an example how to enable validation during deserialisation process. You just need to register deserialiser in Spring ObjectMapper instance which is used for deserialisation. — Michał Ziober
– Michał Ziober, Commented Sep 19, 2019 at 18:47

Luke · Accepted Answer · 2019-09-19 15:37:51Z

1

you can validate your properties with JSR-303 annotations like that:

@Validated
@Component
@ConfigurationProperties(prefix = "my-config")
@RefreshScope
public class MyConfig {

    @NotNull
    @NotEmpty
    @Size(min = 1, max = 5)
    private List<Service> services;

    private List<Consumer> consumers;
...

and so on.

@Validated enable validation every time annotated field get a value

answered Sep 19, 2019 at 15:37

Luke

5063 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

adesai Over a year ago

Thanks Luke - it works! I was missing @Validated annotation :)

Luke Over a year ago

You are wellcome :D

Collectives™ on Stack Overflow

Validation on loading JSON property with Spring Boot

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related