ulisesbocchio/spring-boot-jar-resources

Enables nicer resource handling from jarred resources

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.ulisesbocchio:spring-boot-jar-resources:-SNAPSHOT'
	}

	dependencies {
		implementation("com.github.ulisesbocchio:spring-boot-jar-resources:-SNAPSHOT")
	}

	<dependency>
	    <groupId>com.github.ulisesbocchio</groupId>
	    <artifactId>spring-boot-jar-resources</artifactId>
	    <version>-SNAPSHOT</version>
	</dependency>


                            
    libraryDependencies += "com.github.ulisesbocchio" % "spring-boot-jar-resources" % "-SNAPSHOT"


                            
    :dependencies [[com.github.ulisesbocchio/spring-boot-jar-resources "-SNAPSHOT"]]

Readme

spring-boot-jar-resources

When using Spring Boot out of the box, resources from classpath are jarred, and while they can be accessed through input streams, they cannot be accessed as Files. Some libraries require Files as input instead of input streams or Spring Resources. This library deals with that limitation by allowing you to do resource.getFile() on any jarred resource. It does so by extracting the files from the jar to a temporary location transparently to you.

How to use this library?

Simply add the following dependency to your project:

<dependency>
	<groupId>com.github.ulisesbocchio</groupId>
	<artifactId>spring-boot-jar-resources</artifactId>
	<version>1.3</version>
</dependency>

And the following configuration to your Spring Boot app:

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

Alternatively, provide a path to the JarResourceLoader where jarred resources will be extracted when accessed through a File handle.

new SpringApplicationBuilder()
            .sources(Application.class)
            .resourceLoader(new JarResourceLoader("/path/to/extract"))
            .run(args);

If you want to expose the path to be configurable, since version 1.2 you can do this:

public static void main(String[] args) {
        StandardEnvironment environment = new StandardEnvironment();
        new SpringApplicationBuilder()
            .sources(SpringBootJarResourcesDemoApplication.class)
            .environment(environment)
            .resourceLoader(new JarResourceLoader(environment, "resources.extract.dir"))
            .build()
            .run(args);
    }

With this you can run you app.jar this ways:

java -Dresources.extract.dir=/some/path -jar app.jar
java -jar app.jar --resources.extract.dir=/some/path
export RESOURCES_EXTRACT_DIR=/some/path && java -jar app.jar

Or put resources.extract.dir in application.properties

Basically this new constructor takes the environment from which the property (with the name provided, i.e. resources.extract.dir) will be retrieved to get the extract directory. Notice that we initialize a StandardEnvironment on the first line of the main method, that we also provide to the SpringApplicationBuilder.environment(ConfigurableEnvironment) method so that Spring can populate this object. That same environment is also passed as first argument to the JarResourceLoader constructor. This is required so that both Spring and the JarResourceLoader can share the same properties.

Demo App

For more information and sample implementation check out the Demo App

How this library works?

Internally, this library simply wraps existing resources loaded by DefaultResourceLoader with a custom JarResource implementation that deals with the details of extracting the resource from the Jar. The implementation only extracts resources from jars if they need to be extracted, i.e. if actually being inside a jar. If for some reason, such as when running within an IDE or using an absolute path to load resources, the resources are not inside a jar, then the actual file is used instead.