Spring Boot 读取外部 Property 文件失败问题排查与解决

本文旨在解决 Spring Boot 应用无法读取外部 Property 文件的问题。我们将深入探讨 Windows 环境下 URI 构建的特殊性，并提供正确的 PropertySource 配置方式，确保 Spring Boot 应用能够成功加载外部配置文件，从而实现灵活的配置管理。

在 Spring Boot 应用中，使用外部 Property 文件是一种常见的配置管理方式，它允许我们将配置信息与代码分离，提高应用的可维护性和灵活性。然而，在实践中，我们可能会遇到 Spring Boot 无法正确读取外部 Property 文件的问题，尤其是在 Windows 环境下。本文将深入分析该问题，并提供解决方案。

问题分析

从提供的代码片段可以看出，问题主要集中在 @PropertySource 注解的使用上。在 ConverterApplication 类中，使用了以下配置：

@SpringBootApplication
@Configuration
@PropertySource({"file:${DOCUMENT_CONVERTER_PROPERTIES}"})
public class ConverterApplication {

    public static void main(String[] args) {
        SpringApplication.run(ConverterApplication.class, args);
    }
}

这里尝试通过环境变量 DOCUMENT_CONVERTER_PROPERTIES 来指定外部 Property 文件的路径。然而，在 Windows 环境下，直接使用文件路径作为 URI 可能会导致问题。

解决方案

问题的关键在于构建正确的 URI。在 Windows 环境下，file: URI 的格式需要特别注意。正确的格式应该是 file:/// 加上绝对路径，并且路径中的反斜杠需要替换为正斜杠。

因此，建议将 @PropertySource 注解修改为以下形式：

@SpringBootApplication
@Configuration
@PropertySource({"file:///${DOCUMENT_CONVERTER_PROPERTIES}"})
public class ConverterApplication {

    public static void main(String[] args) {
        SpringApplication.run(ConverterApplication.class, args);
    }
}

同时，确保环境变量 DOCUMENT_CONVERTER_PROPERTIES 包含的是以正斜杠分隔的绝对路径，例如：F:/PROPPERTIES/converter/documentConverter.properties。

示例代码

以下是一个完整的示例，演示了如何在 Spring Boot 应用中使用外部 Property 文件：

1. 创建 Property 文件 (documentConverter.properties):

   temp.pdf.path=F:/temp/pdf
   temp.docx.path=F:/temp/docx

2. 设置环境变量 DOCUMENT_CONVERTER_PROPERTIES：

   在 Windows 系统中，设置环境变量 DOCUMENT_CONVERTER_PROPERTIES 的值为 F:/PROPPERTIES/converter/documentConverter.properties。

3. 配置 Spring Boot 应用 (ConverterApplication.java):

   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   import org.springframework.context.annotation.Configuration;
   import org.springframework.context.annotation.PropertySource;
   
   @SpringBootApplication
   @Configuration
   @PropertySource({"file:///${DOCUMENT_CONVERTER_PROPERTIES}"})
   public class ConverterApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(ConverterApplication.class, args);
       }
   }

4. 使用 Property 文件中的配置 (ConverterService.java):

   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.core.env.Environment;
   import org.springframework.stereotype.Service;
   
   @Service
   public class ConverterService {
   
       @Autowired
       private Environment environment;
   
       public String getTempPDFPath() {
           return environment.getProperty("temp.pdf.path");
       }
   
       public String getTempDocxPath() {
           return environment.getProperty("temp.docx.path");
       }
   }

5. 测试 (ConverterServiceTest.java):

   import org.junit.jupiter.api.Test;
   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.boot.test.context.SpringBootTest;
   
   import static org.junit.jupiter.api.Assertions.assertNotNull;
   
   @SpringBootTest
   public class ConverterServiceTest {
   
       @Autowired
       private ConverterService service;
   
       @Test
       void testGetPaths() {
           assertNotNull(service.getTempPDFPath());
           assertNotNull(service.getTempDocxPath());
           System.out.println("PDF Path: " + service.getTempPDFPath());
           System.out.println("Docx Path: " + service.getTempDocxPath());
       }
   }

注意事项

• 确保环境变量已正确设置，并且 Spring Boot 应用可以访问该环境变量。
• 检查 Property 文件的路径是否正确，并且文件存在且可读。
• 在 Windows 环境下，始终使用 file:/// 加上正斜杠分隔的绝对路径。
• 如果仍然遇到问题，可以尝试使用 classpath: 前缀来加载位于 classpath 下的 Property 文件，例如 @PropertyS

  

  ource("classpath:application.properties")。

总结

通过本文的分析和解决方案，我们可以有效地解决 Spring Boot 应用在 Windows 环境下无法读取外部 Property 文件的问题。关键在于理解 Windows 环境下 URI 构建的特殊性，并使用正确的 @PropertySource 注解配置。通过灵活地使用外部 Property 文件，我们可以更好地管理 Spring Boot 应用的配置，提高应用的可维护性和可扩展性。