Nie znaleziono zasobu Classpath podczas uruchamiania jako jar

128

Mam ten problem zarówno w Spring Boot 1.1.5, jak i 1.1.6 - ładuję zasób classpath za pomocą adnotacji @Value, która działa dobrze, gdy uruchamiam aplikację z poziomu STS (3.6.0, Windows). Jednak gdy uruchamiam pakiet mvn, a następnie próbuję uruchomić jar, pojawiają się wyjątki FileNotFound.

Zasób, message.txt, znajduje się w src / main / resources. Sprawdziłem jar i upewniłem się, że zawiera plik „message.txt” na najwyższym poziomie (na tym samym poziomie co application.properties).

Oto aplikacja:

@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());
        }
    }
}

Wyjątek:

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
źródło

Odpowiedzi:

201

resource.getFile()oczekuje, że sam zasób będzie dostępny w systemie plików, tj. nie może być zagnieżdżony w pliku jar. Dlatego działa, gdy uruchamiasz aplikację w STS, ale nie działa po zbudowaniu aplikacji i uruchomieniu jej z wykonywalnego pliku jar. Zamiast używać getFile()do uzyskiwania dostępu do zawartości zasobu, polecam getInputStream()zamiast tego. Umożliwi to odczytanie zawartości zasobu niezależnie od tego, gdzie się znajduje.

Andy Wilkinson
źródło
6
W moim przypadku muszę podać ścieżkę do pliku kluczy (ze względu na łącznik tomcat https). Chcę umieścić plik jks w moim jar. Zgodnie z powyższym rozwiązaniem nie jest to możliwe. Czy znasz dodatkowy sposób na zrobienie tego?
Modi
1
Mam bardzo podobne wymaganie i nie ma interfejsu API, który pozwoliłby ustawić magazyn kluczy jako część słoika. @Modi, czy udało Ci się znaleźć jakieś rozwiązanie?
Robin Varghese
Czy masz na myśli przypadek użycia magazynu kluczy? Czy używasz Spring Boot z Tomcat?
Modi
@RobinVarghese czy znalazłeś jakieś rozwiązanie swojego problemu. Mam do rozwiązania podobny przypadek użycia. Doceń, jeśli masz jakieś sugestie.
horyzont7
W przypadku, gdy Tomcat potrzebuje lokalizacji magazynu kluczy, aby włączyć https, można użyć, classpath:filenameaby plik kluczy mógł zostać odczytany z pliku jar.
horyzont 7
60

Jeśli używasz frameworka Spring, czytanie ClassPathResourcedo a Stringjest całkiem proste przy użyciu frameworka SpringFileCopyUtils :

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);
}
anubhava
źródło
Czy istnieje ograniczenie co do tego, gdzie plik musi się znajdować? Czy może znajdować się w dowolnym miejscu na ścieżce klas? Czy to może być źródło projektu?
Stephane
Może znajdować się w dowolnym miejscu w ścieżce klas.
anubhava,
45

Jeśli chcesz użyć pliku:

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);
}
Jae-il Lee
źródło
7

kiedy projekt rozruchu wiosennego działa jako jar i trzeba odczytać jakiś plik w ścieżce klas, implementuję go za pomocą poniższego kodu

Resource resource = new ClassPathResource("data.sql");
BufferedReader reader = new BufferedReader(new InputStreamReader(resource.getInputStream()));
reader.lines().forEach(System.out::println);
zhuguowei
źródło
3

Utworzyłem klasę ClassPathResourceReader w java 8 sposób, aby tworzyć łatwe do odczytania pliki ze ścieżki klas

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;
    }
}

Wykorzystanie:

String content = new ClassPathResourceReader("data.sql").getContent();
Tiago
źródło
2

Napotkałem również to ograniczenie i utworzyłem tę bibliotekę, aby rozwiązać problem: spring-boot-jar-resources Zasadniczo pozwala ona zarejestrować niestandardowy ResourceLoader za pomocą Spring Boot, który w razie potrzeby wyodrębnia zasoby ścieżki klas z JAR, w razie potrzeby.

Ulises
źródło
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);
        }
}
Jayshree Pancholi
źródło
1

Jersey musi być rozpakowany w słoikach.

<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
źródło
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"))**
Merzouk MENHOUR
źródło
0

Opierając się na odpowiedzi Andy'ego, użyłem poniższego, aby uzyskać strumienie wejściowe wszystkich YAML w katalogu i podkatalogach w zasobach (zauważ, że przekazana ścieżka nie zaczyna się od /):

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
źródło
0

Utknąłem też w podobnej sytuacji, ale nie do końca podobnej, chciałem odczytać plik JSON z folderu zasobów. Src / main / resources Stąd napisałem kod podobny do tego poniżej.

Są tu wymienione różne sposoby odczytu pliku ze ścieżki klas rom w aplikacji Spring Boot.

@Value ("ścieżka klasy: test.json") prywatny zasób zasobu;

File file = resource.getFile();

@Value("classpath:test.json")

zasób zasobów prywatnych;

File file = resource.getFile();

Teraz ten kod działa całkowicie dobrze po uruchomieniu go za pomocą mvn: spring-boot: run, ale gdy tylko buduję i pakuję aplikację za pomocą maven i uruchamiam ją jako prosty plik wykonywalny jar, pojawia się wyjątek. Przejdźmy dalej i znajdźmy teraz rozwiązanie.

Za pomocą InputStream znalazłem odpowiedź w moim przypadku: -

@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();
        }
    }

Wiosna działa na koncepcję Fat Jar, dlatego jest naprawdę trudna, ponieważ zachowuje się inaczej w Eclipse i gdy biegasz jako słoik.

Sanjay-Dev
źródło
0

W odniesieniu do pierwotnego komunikatu o błędzie

nie można przekształcić w bezwzględną ścieżkę do pliku, ponieważ nie znajduje się on w systemie plików

Poniższy kod może być pomocny w znalezieniu rozwiązania problemu ze ścieżką:

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

Dzięki temu można określić, gdzie aplikacja oczekuje brakującego pliku. Możesz to wykonać w głównej metodzie swojej aplikacji.

SJX
źródło