Spring Boot中java.nio.file.Path自定义转换器失效问题

问题原因 #

Spring Boot自带的PathConverter会优先处理String到Path的转换逻辑，它默认使用系统默认文件系统创建Path实例，导致你的自定义转换器被覆盖，无法生效。

解决方案 #

给自定义的转换器Bean添加最高优先级注解，确保它在默认转换器之前被调用。

修改转换器配置代码 #

在你的TestFileSystemConfiguration中，给返回转换器的Bean方法添加@Order(Ordered.HIGHEST_PRECEDENCE)注解：

import org.springframework.core.Ordered
import org.springframework.core.annotation.Order
import org.springframework.boot.context.properties.ConfigurationPropertiesBinding
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import com.google.common.jimfs.Jimfs
import java.nio.file.FileSystem
import java.nio.file.Path
import org.springframework.core.convert.converter.Converter

@Configuration
class TestFileSystemConfiguration {
    @Bean
    fun fileSystem(): FileSystem = Jimfs.newFileSystem(com.google.common.jimfs.Configuration.unix())

    @Bean
    @ConfigurationPropertiesBinding
    @Order(Ordered.HIGHEST_PRECEDENCE) // 添加此注解提升优先级
    fun fileSystemPathConverter(fileSystem: FileSystem): Converter<String, Path>
        = FileSystemPathConverter(fileSystem)

    class FileSystemPathConverter(
        val fileSystem: FileSystem,
    ) : Converter<String, Path> {
        override fun convert(source: String): Path {
            return fileSystem.getPath(source)
        }
    }
}

备选方案：使用GenericConverter #

如果上述方法仍不生效，可以改用GenericConverter实现，明确指定转换类型对，让Spring更精准地匹配你的转换器：

import org.springframework.core.Ordered
import org.springframework.core.annotation.Order
import org.springframework.boot.context.properties.ConfigurationPropertiesBinding
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import com.google.common.jimfs.Jimfs
import java.nio.file.FileSystem
import java.nio.file.Path
import org.springframework.core.convert.converter.GenericConverter

@Configuration
class TestFileSystemConfiguration {
    @Bean
    fun fileSystem(): FileSystem = Jimfs.newFileSystem(com.google.common.jimfs.Configuration.unix())

    @Bean
    @ConfigurationPropertiesBinding
    @Order(Ordered.HIGHEST_PRECEDENCE)
    fun fileSystemPathConverter(fileSystem: FileSystem): GenericConverter
        = FileSystemPathConverter(fileSystem)

    class FileSystemPathConverter(
        val fileSystem: FileSystem,
    ) : GenericConverter {
        override fun getConvertibleTypes(): Set<GenericConverter.ConvertiblePair> {
            return setOf(GenericConverter.ConvertiblePair(String::class.java, Path::class.java))
        }

        override fun convert(source: Any?, sourceType: org.springframework.core.convert.TypeDescriptor?, targetType: org.springframework.core.convert.TypeDescriptor?): Path? {
            return source?.toString()?.let { fileSystem.getPath(it) }
        }
    }
}

验证测试上下文 #

确保你的测试类正确加载了TestFileSystemConfiguration，比如通过@Import或指定@SpringBootTest的classes参数：

import org.springframework.boot.test.context.SpringBootTest
import org.springframework.context.annotation.Import

@SpringBootTest
@Import(TestFileSystemConfiguration::class)
class YourFileSystemTest {
    // 测试逻辑
}

内容的提问来源于stack exchange，提问作者Wolfgang