Recurso do caminho de classe não encontrado ao executar como jar

128

Tendo esse problema no Spring Boot 1.1.5 e 1.1.6 - estou carregando um recurso de caminho de classe usando uma anotação @Value, que funciona perfeitamente quando executo o aplicativo no STS (3.6.0, Windows). No entanto, quando executo um pacote mvn e tento executar o jar, recebo exceções FileNotFound.

O recurso, message.txt, está em src / main / resources. Inspecionei o jar e verifiquei que ele contém o arquivo "message.txt" no nível superior (mesmo nível de application.properties).

Aqui está o aplicativo:

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

A exceção:

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
fonte

Respostas:

201

resource.getFile()espera que o próprio recurso esteja disponível no sistema de arquivos, ou seja, não pode ser aninhado dentro de um arquivo jar. É por isso que funciona quando você executa o aplicativo no STS, mas não funciona depois que você cria o aplicativo e o executa a partir do jar executável. Em vez de usar getFile()para acessar o conteúdo do recurso, recomendo o uso getInputStream(). Isso permitirá que você leia o conteúdo do recurso, independentemente de onde ele esteja localizado.

Andy Wilkinson
fonte
6
No meu caso, preciso fornecer um caminho para o arquivo keystore (por causa de um conector https do tomcat). Quero agrupar o arquivo jks dentro do meu jar. De acordo com a solução acima, não é possível. Você está familiarizado com outras maneiras de fazer isso?
Modi
1
Eu tenho um requisito muito semelhante e não há APIs que permitam definir o keystore como parte do jar. @Modi, você conseguiu encontrar alguma solução?
Robin Varghese
Você quer dizer o caso de uso do armazenamento de chaves? Você está usando o Spring Boot com Tomcat?
Modi
@RobinVarghese você encontrou alguma solução para o seu problema. Eu tenho um caso de uso semelhante a ser resolvido. Aprecie se você tem alguma sugestão.
horizon7
Caso o tomcat precise do local do keystore para ativar https, pode-se usar classpath:filenamepara que o arquivo keystore possa ser lido de dentro do jar.
horizon7
60

Se você estiver usando o Spring framework, então a leitura de ClassPathResourceum Stringé bastante simples usando o Spring frameworkFileCopyUtils :

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
fonte
Existe uma restrição de onde o arquivo deve ficar? Pode estar em qualquer lugar do caminho da classe? Pode estar na raiz do projeto?
Stephane
Pode estar em qualquer lugar no caminho de classe.
Anubhava 29/09/19
45

Se você deseja usar um arquivo:

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
fonte
7

quando o projeto de inicialização do Spring é executado como um jar e precisa ler algum arquivo no caminho de classe, eu o implemento abaixo do código

Resource resource = new ClassPathResource("data.sql");
BufferedReader reader = new BufferedReader(new InputStreamReader(resource.getInputStream()));
reader.lines().forEach(System.out::println);
zhuguowei
fonte
3

Criei uma classe ClassPathResourceReader em uma maneira java 8 para facilitar a leitura de arquivos do classpath

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

Utilização:

String content = new ClassPathResourceReader("data.sql").getContent();
Tiago
fonte
2

Também encontrei essa limitação e criei esta biblioteca para solucionar o problema: spring-boot-jar-resources Basicamente, você pode registrar um ResourceLoader personalizado com o Spring Boot que extrai os recursos do caminho de classe do JAR conforme necessário, de forma transparente.

Ulises
fonte
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
fonte
1

Jersey precisa ser frascos desembalados.

<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
fonte
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
fonte
0

Com base na resposta de Andy, usei o seguinte para obter fluxos de entrada de todos os YAMLs em um diretório e subdiretórios em recursos (observe que o caminho passado não começa com /):

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
fonte
0

Eu também coloquei uma situação semelhante, mas não exatamente semelhante, queria ler um arquivo JSON na pasta resources.src / main / resources Por isso, escrevi um código parecido com este abaixo.

Existem várias maneiras listadas aqui para ler um arquivo do caminho de classe no Spring Boot Application.

@Value ("caminho da classe: test.json") private Resource;

File file = resource.getFile();

@Value("classpath:test.json")

recurso privado;

File file = resource.getFile();

Agora, esse código funciona completamente bem quando eu o executo usando, mvn: spring-boot: run, mas assim que estou construindo e empacotando o aplicativo usando o maven e executando-o como um simples jar executável, estou recebendo uma exceção. Vamos em frente e descubra a solução agora.

Usando InputStream é o que eu encontrei a resposta no meu caso: -

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

O Spring trabalha com o conceito de Jarra gorda, portanto, é realmente difícil, pois se comporta de maneira diferente no Eclipse e enquanto você corre como jarra.

Sanjay-Dev
fonte
0

Em relação à mensagem de erro original

não pode ser resolvido para o caminho absoluto do arquivo porque ele não reside no sistema de arquivos

O código a seguir pode ser útil para encontrar a solução para o problema do caminho:

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

Com isso, você pode determinar onde o aplicativo espera o arquivo ausente. Você pode executar isso no método principal do seu aplicativo.

SJX
fonte