How to inject java.nio.file.Path dependency using @ConfigurationProperties

Question

I'm using Spring Boot and have the following Component class:

@Component
@ConfigurationProperties(prefix="file")
public class FileManager {

    private Path localDirectory;

    public void setLocalDirectory(File localDirectory) {
        this.localDirectory = localDirectory.toPath();
    }

...

}

And the following yaml properties file:

file:
     localDirectory: /var/data/test

I would like to remove the reference of java.io.File (of setLocalDirectory) by replacing with java.nio.file.Path. However, I receive a binding error when I do this. Is there way to bind the property to a Path (e.g. by using annotations)?

hooknc · Accepted Answer · 2022-07-21 16:31:11Z

8

To add to jst's answer, the Spring Boot annotation @ConfigurationPropertiesBinding can be used for Spring Boot to recognize the converter for property binding, as mentioned in the documentation under Properties Conversion:

@Component
@ConfigurationPropertiesBinding
public class StringToPathConverter implements Converter<String, Path> {

  @Override
  public Path convert(String pathAsString) {
    return Paths.get(pathAsString);
  }
}

edited Jul 21, 2022 at 16:31

hooknc

5,0055 gold badges37 silver badges65 bronze badges

answered Sep 17, 2018 at 8:56

Sebastian

7008 silver badges13 bronze badges

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

Comments

jst · Accepted Answer · 2015-06-25 19:10:20Z

6

I don't know if there is a way with annotations, but you could add a Converter to your app. Marking it as a @Component with @ComponentScan enabled works, but you may have to play around with getting it properly registered with the ConversionService otherwise.

@Component
public class PathConverter implements Converter<String,Path>{

 @Override
 public Path convert(String path) {
     return Paths.get(path);
 }

When Spring sees you want a Path but it has a String (from your application.properties), it will lookup in its registry and find it knows how to do it.

answered Jun 25, 2015 at 19:10

jst

1,7671 gold badge13 silver badges15 bronze badges

1 Comment

James Over a year ago

I put this into a @Configuration class and made the Converter<String, Path> a bean (@Bean). That took care of registration using Spring Boot

mkdev · Accepted Answer · 2019-03-28 16:43:10Z

2

I took up james idea and defined the converter within the spring boot configuration:

@SpringBootConfiguration
public class Configuration {
    public class PathConverter implements Converter<String, Path> {

        @Override
        public Path convert(String path) {
            return Paths.get(path);
        }
    }

    @Bean
    @ConfigurationPropertiesBinding
    public PathConverter getStringToPathConverter() {
        return new PathConverter();
    }
}

edited Mar 28, 2019 at 16:43

answered Mar 28, 2019 at 16:20

mkdev

1,0441 gold badge10 silver badges13 bronze badges

Collectives™ on Stack Overflow

How to inject java.nio.file.Path dependency using @ConfigurationProperties

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related