Ресурс classpath не найден при работе как jar

128

Эта проблема возникает как в Spring Boot 1.1.5, так и в 1.1.6 - я загружаю ресурс пути к классам с помощью аннотации @Value, которая отлично работает, когда я запускаю приложение из STS (3.6.0, Windows). Однако, когда я запускаю пакет mvn, а затем пытаюсь запустить jar, я получаю исключения FileNotFound.

Ресурс message.txt находится в src / main / resources. Я проверил банку и убедился, что она содержит файл «message.txt» на верхнем уровне (на том же уровне, что и application.properties).

Вот приложение:

@Configuration
@ComponentScan
@EnableAutoConfiguration
public class Application implements CommandLineRunner {

    private static final Logger logger = Logger.getLogger(Application.class);

    @Value("${message.file}")
    private Resource messageResource;

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

    @Override
    public void run(String... arg0) throws Exception {
        // both of these work when running as Spring boot app from STS, but
        // fail after mvn package, and then running as java -jar
        testResource(new ClassPathResource("message.txt"));
        testResource(this.messageResource);
    }

    private void testResource(Resource resource) {
        try {
            resource.getFile();
            logger.debug("Found the resource " + resource.getFilename());
        } catch (IOException ex) {
            logger.error(ex.toString());
        }
    }
}

Исключение:

c:\Users\glyoder\Documents\workspace-sts-3.5.1.RELEASE\classpath-resource-proble
m\target>java -jar demo-0.0.1-SNAPSHOT.jar

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v1.1.5.RELEASE)

2014-09-16 08:46:34.635  INFO 5976 --- [           main] demo.Application
                  : Starting Application on 8W59XV1 with PID 5976 (C:\Users\glyo
der\Documents\workspace-sts-3.5.1.RELEASE\classpath-resource-problem\target\demo
-0.0.1-SNAPSHOT.jar started by glyoder in c:\Users\glyoder\Documents\workspace-s
ts-3.5.1.RELEASE\classpath-resource-problem\target)
2014-09-16 08:46:34.640 DEBUG 5976 --- [           main] demo.Application
                  : Running with Spring Boot v1.1.5.RELEASE, Spring v4.0.6.RELEA
SE
2014-09-16 08:46:34.681  INFO 5976 --- [           main] s.c.a.AnnotationConfigA
pplicationContext : Refreshing org.springframework.context.annotation.Annotation
ConfigApplicationContext@1c77b086: startup date [Tue Sep 16 08:46:34 EDT 2014];
root of context hierarchy
2014-09-16 08:46:35.196  INFO 5976 --- [           main] o.s.j.e.a.AnnotationMBe
anExporter        : Registering beans for JMX exposure on startup
2014-09-16 08:46:35.210 ERROR 5976 --- [           main] demo.Application
                  : java.io.FileNotFoundException: class path resource [message.
txt] cannot be resolved to absolute file path because it does not reside in the
file system: jar:file:/C:/Users/glyoder/Documents/workspace-sts-3.5.1.RELEASE/cl
asspath-resource-problem/target/demo-0.0.1-SNAPSHOT.jar!/message.txt
2014-09-16 08:46:35.211 ERROR 5976 --- [           main] demo.Application
                  : java.io.FileNotFoundException: class path resource [message.
txt] cannot be resolved to absolute file path because it does not reside in the
file system: jar:file:/C:/Users/glyoder/Documents/workspace-sts-3.5.1.RELEASE/cl
asspath-resource-problem/target/demo-0.0.1-SNAPSHOT.jar!/message.txt
2014-09-16 08:46:35.215  INFO 5976 --- [           main] demo.Application
                  : Started Application in 0.965 seconds (JVM running for 1.435)

2014-09-16 08:46:35.217  INFO 5976 --- [       Thread-2] s.c.a.AnnotationConfigA
pplicationContext : Closing org.springframework.context.annotation.AnnotationCon
figApplicationContext@1c77b086: startup date [Tue Sep 16 08:46:34 EDT 2014]; roo
t of context hierarchy
2014-09-16 08:46:35.218  INFO 5976 --- [       Thread-2] o.s.j.e.a.AnnotationMBe
anExporter        : Unregistering JMX-exposed beans on shutdown
GYODER
источник

Ответы:

201

resource.getFile()ожидает, что сам ресурс будет доступен в файловой системе, то есть он не может быть вложен в файл jar. Вот почему он работает, когда вы запускаете свое приложение в STS, но не работает, когда вы создали свое приложение и запустили его из исполняемого файла jar. Вместо использования getFile()для доступа к содержимому ресурса я бы рекомендовал использовать getInputStream(). Это позволит вам читать содержимое ресурса независимо от того, где он находится.

Энди Уилкинсон
источник
6
В моем случае мне нужно указать путь к файлу хранилища ключей (для https-коннектора tomcat). Я хочу обернуть файл jks в свою банку. Согласно вышеупомянутому решению это невозможно. Вы знакомы с дополнительным способом сделать это?
Моди
1
У меня очень похожее требование, и нет API, позволяющего установить хранилище ключей как часть jar. @Modi, удалось найти какое-то решение?
Робин Варгезе,
Вы имеете в виду вариант использования хранилища ключей? Вы используете Spring Boot с Tomcat?
Моди
@RobinVarghese, вы нашли решение своей проблемы? У меня есть аналогичный вариант использования, который нужно решить. Цените, если у вас есть предложения.
Horizon7
В случае, если tomcat требуется местоположение хранилища ключей для включения https, его можно использовать, classpath:filenameчтобы файл хранилища ключей можно было прочитать из банка.
Horizon7,
60

Если вы используете фреймворк Spring, то читать ClassPathResourceв фреймворке SpringString довольно просто :FileCopyUtils

String data = "";
ClassPathResource cpr = new ClassPathResource("static/file.txt");
try {
    byte[] bdata = FileCopyUtils.copyToByteArray(cpr.getInputStream());
    data = new String(bdata, StandardCharsets.UTF_8);
} catch (IOException e) {
    LOG.warn("IOException", e);
}
анубхава
источник
Есть ли ограничение относительно того, где должен находиться файл? Может быть где-нибудь в пути к классам? Может ли оно быть в корне проекта?
Стефан
Это может быть где угодно в пути к классам.
анубхава
45

Если вы хотите использовать файл:

ClassPathResource classPathResource = new ClassPathResource("static/something.txt");

InputStream inputStream = classPathResource.getInputStream();
File somethingFile = File.createTempFile("test", ".txt");
try {
    FileUtils.copyInputStreamToFile(inputStream, somethingFile);
} finally {
    IOUtils.closeQuietly(inputStream);
}
Джэ Иль Ли
источник
7

когда проект весенней загрузки работает как банка и вам нужно прочитать какой-то файл в пути к классам, я реализую его с помощью кода ниже

Resource resource = new ClassPathResource("data.sql");
BufferedReader reader = new BufferedReader(new InputStreamReader(resource.getInputStream()));
reader.lines().forEach(System.out::println);
zhuguowei
источник
3

Я создал класс ClassPathResourceReader способом java 8, чтобы легко читать файлы из пути к классам

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.stream.Collectors;

import org.springframework.core.io.ClassPathResource;

public final class ClassPathResourceReader {

    private final String path;

    private String content;

    public ClassPathResourceReader(String path) {
        this.path = path;
    }

    public String getContent() {
        if (content == null) {
            try {
                ClassPathResource resource = new ClassPathResource(path);
                BufferedReader reader = new BufferedReader(new InputStreamReader(resource.getInputStream()));
                content = reader.lines().collect(Collectors.joining("\n"));
                reader.close();
            } catch (IOException ex) {
                throw new RuntimeException(ex);
            }
        }
        return content;
    }
}

Использование:

String content = new ClassPathResourceReader("data.sql").getContent();
Tiago
источник
2

Я тоже столкнулся с этим ограничением и создал эту библиотеку, чтобы решить эту проблему: spring-boot-jar-resources. В основном это позволяет вам зарегистрировать пользовательский ResourceLoader с помощью Spring Boot, который прозрачно извлекает ресурсы пути к классам из JAR по мере необходимости.

Ulises
источник
2
to get list of data from src/main/resources/data folder --
first of all mention your folder location in properties file as - 
resourceLoader.file.location=data

inside class declare your location. 

@Value("${resourceLoader.file.location}")
    @Setter
    private String location;

    private final ResourceLoader resourceLoader;

public void readallfilesfromresources() {
       Resource[] resources;

        try {
            resources = ResourcePatternUtils.getResourcePatternResolver(resourceLoader).getResources("classpath:" + location + "/*.json");
            for (int i = 0; i < resources.length; i++) {
                try {
                InputStream is = resources[i].getInputStream();
                byte[] encoded = IOUtils.toByteArray(is);
                String content = new String(encoded, Charset.forName("UTF-8"));
                }
            }
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
}
Джейшри Панчоли
источник
1

Джерси нужно распаковать по банкам.

<build>  
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <requiresUnpack>
                    <dependency>
                        <groupId>com.myapp</groupId>
                        <artifactId>rest-api</artifactId>
                    </dependency>
                </requiresUnpack>
            </configuration>
        </plugin>
    </plugins>
</build>  
utkusonmez
источник
0
in spring boot :

1) if your file is ouside jar you can use :        

@Autowired
private ResourceLoader resourceLoader;

**.resource(resourceLoader.getResource("file:/path_to_your_file"))**

2) if your file is inside resources of jar you can `enter code here`use :

**.resource(new ClassPathResource("file_name"))**
Мерзук МЕНХУР
источник
0

Основываясь на ответе Энди, я использовал следующее, чтобы получить входные потоки всех YAML в каталоге и подкаталогах в ресурсах (обратите внимание, что переданный путь не начинается с /):

private static Stream<InputStream> getInputStreamsFromClasspath(
        String path,
        PathMatchingResourcePatternResolver resolver
) {
    try {
        return Arrays.stream(resolver.getResources("/" + path + "/**/*.yaml"))
                .filter(Resource::exists)
                .map(resource -> {
                    try {
                        return resource.getInputStream();
                    } catch (IOException e) {
                        return null;
                    }
                })
                .filter(Objects::nonNull);
    } catch (IOException e) {
        logger.error("Failed to get definitions from directory {}", path, e);
        return Stream.of();
    }
}
aksh1618
источник
0

Я также застрял в подобной ситуации, но не совсем похож, хотел прочитать файл JSON из папки ресурсов. Src / main / resources Следовательно, написал код примерно так, как показано ниже.

Здесь перечислены различные способы чтения файла из пути к классам в Spring Boot Application.

@Value ("classpath: test.json") частный ресурс ресурса;

File file = resource.getFile();

@Value("classpath:test.json")

частный ресурсный ресурс;

File file = resource.getFile();

Теперь этот код работает полностью нормально, когда я запускаю его с помощью mvn: spring-boot: run, но как только я создаю и упаковываю приложение с помощью maven и запускаю его как простой исполняемый файл jar, я получаю исключение. Давайте продолжим и найдем решение прямо сейчас.

Использование InputStream - это то, что я нашел в моем случае: -

@Value("classpath:test.json")
    Resource resourceFile;

private void testResource(Resource resource) {
        try {
            InputStream resourcee = resource.getInputStream();
            String text = null;
            try (final Reader reader = new InputStreamReader(resourcee)) {
                text = CharStreams.toString(reader);
            }
            System.out.println(text);

        } catch (IOException e) {
            e.printStackTrace();
        }
    }

Spring работает по концепции Fat Jar, поэтому это действительно сложно, так как он ведет себя по-разному в Eclipse и когда вы работаете как jar.

Санджай-Dev
источник
0

Что касается исходного сообщения об ошибке

не может быть преобразован в абсолютный путь к файлу, потому что он не находится в файловой системе

Следующий код может быть полезен для поиска решения проблемы пути:

Paths.get("message.txt").toAbsolutePath().toString();

С его помощью вы можете определить, где приложение ожидает недостающий файл. Вы можете выполнить это в основном методе вашего приложения.

SJX
источник