使用可执行 Jar 时找不到 Spring-Boot 资源

Posted 2023-02-26

【中文标题】使用可执行 Jar 时找不到 Spring-Boot 资源

【英文标题】：Spring-Boot Resource Not Found when using executeable Jar

【发布时间】：2014-11-28 21:03:27

【问题描述】：

我再次遇到一个奇怪的问题，希望这里有人可以提供帮助。

我有一个 spring boot 后端模块，在 eclipse 中运行良好，并且在 application.java 中启动 main 时应用程序是可执行的。一切都很好。

我的应用程序使用 src/main/resources 文件夹中包含的 csv 文件将示例数据导入数据库。如前所述，在 Eclipse 中启动时一切正常。

现在我想将它作为可执行 jar 执行，应用程序开始启动，然后无法启动，因为它找不到 csv 文件。它打印出来的路径、查找文件的位置是正确的，并且 csv 文件在包含的 jar 中。

模块的 Pom 如下所示：

<project>
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>at.company.bbsng</groupId>
        <artifactId>bbsng-import</artifactId>
        <version>0.1.0-SNAPSHOT</version>
    </parent>

    <artifactId>bbsng-import-backend</artifactId>
    <name>bbsng-import-backend</name>

    <properties>
        <start-class>at.company.bbsng.dataimport.Application</start-class>
    </properties>


    <dependencies>

        <!-- SPRING ... -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-batch</artifactId>
            <!-- EXCLUDE LOGBACK AND USE LOG4J -->
            <exclusions>
                <exclusion>
                    <artifactId>spring-boot-starter-logging</artifactId>
                    <groupId>org.springframework.boot</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- COMMONS ... -->

        ...

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

csv 文件的路径在属性文件中配置如下：

# EXAMPLE PATH
csv.path=config/csv/

java配置文件部分如下：

  ...

  @Value("$csv.path")
  private String csvExamplePath;

  @Bean
  public Resource addressResource() 
    return new ClassPathResource(csvExamplePath + CSV_ADDRESS);
  

    ...

在jar中，文件位于路径

\config\csv\

堆栈跟踪：

Caused by: java.io.FileNotFoundException: class path resource [config/csv/Company.csv] cannot be resolved to absolute file path because it does not reside in th
e file system: jar:file:/C:/Development/Projekte/bbsng/trunk/import/backend/target/bbsng-import-backend-0.1.0-SNAPSHOT.jar!/config/csv/Company.csv
        at org.springframework.util.ResourceUtils.getFile(ResourceUtils.java:207)
        at org.springframework.core.io.AbstractFileResolvingResource.getFile(AbstractFileResolvingResource.java:52)
        at at.compax.bbsng.dataimport.app.source.company.CompanyGenerator.init(CompanyGenerator.java:28)
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(Unknown Source)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
        at java.lang.reflect.Method.invoke(Unknown Source)
        at org.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor$LifecycleElement.invoke(InitDestroyAnnotationBeanPostProcessor.java

再次，应用程序从 eclipse 启动时按预期工作，只有可执行 jar 抱怨缺少 csv 文件，jar 中已经存在什么。

任何线索都会很棒。

【参考方案1】：

好的，我已经找到了真正的问题和解决方案。

首先，应用程序使用 csv 文件的正确路径，但是在使用我在以下链接下找到的可执行 jar 时还有另一个问题。 ***-Link

在我提出可执行 jar 问题之前，我使用以下解决方案来获取 CSV 文件（问题是 getFile()）：

final List<String> resourceLines = FileReadUtils.readLines(specialisationResource.getFile());
for (final String line : resourceLines) 
  data.add(getNewTransientSpecialisation(line));

但是在可执行的 jar 中我不能将我的资源用作文件，我需要将它用作流，请参阅上面提供的链接。所以我需要更改我的代码。如果您更喜欢使用原生 java，您可以执行以下操作：

final InputStream inputStream = specialisationResource.getInputStream();
final BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(inputStream));

String line;
while ((line = bufferedReader.readLine()) != null) 
    data.add(getNewTransientSpecialisation(line));

我更喜欢使用框架并使用 apache commons，如下所示：

final List<String> resourceLines = IOUtils.readLines(specialisationResource.getInputStream());
for (final String line : resourceLines) 
    data.add(getNewTransientSpecialisation(line));

所以请记住，不要使用 File() 来获取资源，始终使用流确实从一开始就避免这个问题 :-)

希望对某人有所帮助。

【讨论】：

你能看看这个吗，我有类似的问题***.com/questions/37713335/…

什么是specialisationResource？

Specialisation 只是一个实体，SpecialisationResource 只是从 Spring Resource 扩展而来。

这里的重点是，不要使用resource.getFile()，使用resource.getInputStream

【参考方案2】：

我也遇到了这个限制，并创建了这个库来解决这个问题：spring-boot-jar-resources

它基本上允许您使用 Spring Boot 注册一个自定义 ResourceLoader，它可以根据需要透明地从 JAR 中提取类路径资源：

new SpringApplicationBuilder()
        .sources(Application.class)
        .resourceLoader(new JarResourceLoader())
        .run(args);

使用该 ResourceLoader，您可以在任何类路径资源上执行 resource.getFile()。

【讨论】：

我希望有一种方法可以在 Spring 本地执行此操作，而无需依赖另一个外部库。

【参考方案3】：

现在我需要从 JAR 中将 xmlFiles 查找到资源文件夹中，并面临此处已经描述的类似问题。我想分享我的发现以及我是如何实现它的，也许它会有所帮助。

在一个 jar 中，我在 src/main/resources 下有“db-input”文件夹，其中包含用于 DB-Input 的 xml-Files 的任意编号。我的应用程序是基于 Spring 的：

@Component
public class DatabaseInitializer implements InitializingBean 
    @Autowired DomainConfigurationRepository repository;
    @Autowired MarshallerService marshallerService;
    @Autowired ApplicationContext context;

    @Override
    public void afterPropertiesSet() throws Exception 
        final Resource[] resources = context.getResources("classpath*:db-input/*");
        final Set<String> filePaths = findInputFileNames(resources);
        final Set<DomainConfiguration> configurations = createConfigurations(filePaths);
        repository.save(configurations);
    

    private  Set<DomainConfiguration> createConfigurations(final Set<String> filePaths) throws Exception 
        final Set<DomainConfiguration> configurations = new HashSet<>();
        for(final String path : filePaths)
            final Resource resource = context.getResource(path);
            final DomainConfigurationXO xoConfiguration = marshallerService.unmarshal(resource.getInputStream());
            final DomainConfiguration configuration = PopulationUtils.getPopulatedConfiguration(xoConfiguration);
            configurations.add(configuration);
        
        return configurations;
    

    public Set<String> findInputFileNames(final Resource[] inputDirectoryResources) throws IOException 
        return Arrays.stream(inputDirectoryResources)
                .map(resource -> extractURI(resource))
                .collect(Collectors.toSet());
    

    private String extractURI(Resource resource)
        try 
            return resource.getURI().toString();
         catch (IOException e) 
            throw new RuntimeException(e);