Incorporate JavaScript files from the filesystem into a Spring Boot JAR application alongside Thymeleaf

Question

Incorporate JavaScript files from the filesystem into a Spring Boot JAR application alongside Thymeleaf

I have a special utility built using spring boot with an embedded tomcat packaged into an executable jar. I am trying to include some js (or maybe json) files in the same directory as the jar file and insert them into the thymeleaf template. For example:

<script type="text/javascript" src="somepath/myfile.js"></script>

Here is what I have achieved so far: In the controller:

String userDirectory = System.getProperty("user.dir");
model.addAttribute("userDir", "file://"+userDirectory+"/");

In the template:

<script type="text/javascript" th:src="${userDir + 'myfile.js'}"></script>

Currently, I can see the code inside myfile.js via Firebug's HTML view, but it does not show up in the scripts tab, and the script is not executed (any variables defined in this file are undefined).

How can I make this work?

I am aware that I could create a json file and process it through Java, but if there is a simpler and more convenient solution available, I would prefer that. Additionally, this way I can use custom javascript instead of just json.

I understand that this approach may be risky in many scenarios, but in this particular case, security is not a concern as the application does not need to be safe from any potential injections via these files.

javascript java json spring

Answer 1

Answer №1

If you want to customize the WebMvcConfigurationAdapter to include a file system folder in the resource registry, you can do so by creating a CustomWebMvcConfigurerAdapter as shown below:

@Configuration
public class CustomWebMvcConfigurerAdapter extends WebMvcConfigurerAdapter {

    @Value("${resources}")
    private String resources;

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {

        if (resources != null) {
            registry.addResourceHandler("/myresources/**").addResourceLocations("file:" + resources);
        }
        super.addResourceHandlers(registry);
    }

}

Make sure to provide the --resources parameter when running the jar file. Remember to include a trailing / in the path.

java -jar your_jar_file --resources=/path/to/resources/

Keep in mind that the resources from this path will be registered against the /myresources/ path, so adjust your template accordingly:

<script type="text/javascript" src="myresources/myfile.js"></script>

The myfile.js file should be present in the path specified by the --resources parameter.

Update #1 (Not tested but worth a try)

I recently discovered that spring boot allows customization of static locations using a property. Refer to the Spring Common Properties Appendix for more information.

The property to define in application.properties is:

spring.resources.static-locations=classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/

Add your custom locations to the above list. You can also use file resources like this:

spring.resources.static-locations=classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/,file:/tmp/resources

Answer 2

If you want to customize the WebMvcConfigurationAdapter to include a file system folder in the resource registry, you can do so by creating a CustomWebMvcConfigurerAdapter as shown below:

@Configuration
public class CustomWebMvcConfigurerAdapter extends WebMvcConfigurerAdapter {

    @Value("${resources}")
    private String resources;

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {

        if (resources != null) {
            registry.addResourceHandler("/myresources/**").addResourceLocations("file:" + resources);
        }
        super.addResourceHandlers(registry);
    }

}

Make sure to provide the --resources parameter when running the jar file. Remember to include a trailing / in the path.

java -jar your_jar_file --resources=/path/to/resources/

Keep in mind that the resources from this path will be registered against the /myresources/ path, so adjust your template accordingly:

<script type="text/javascript" src="myresources/myfile.js"></script>

The myfile.js file should be present in the path specified by the --resources parameter.

Update #1 (Not tested but worth a try)

I recently discovered that spring boot allows customization of static locations using a property. Refer to the Spring Common Properties Appendix for more information.

The property to define in application.properties is:

spring.resources.static-locations=classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/

Add your custom locations to the above list. You can also use file resources like this:

spring.resources.static-locations=classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/,file:/tmp/resources

Incorporate JavaScript files from the filesystem into a Spring Boot JAR application alongside Thymeleaf

Answer №1

Similar questions

Obtaining values from a JSON String in Android: A comprehensive guide

Update the div each time the MySQL table is refreshed

Creating a pop-up window in Shiny that activates when switching tabs

What is the best way to display an HTTP response in a dialog box using AngularJS?

The continuous progression of code execution

The input-group-btn is positioned to the right of the field, appearing to float

What steps should I take to address the error message "TypeError: express-validator is not a function

Challenges with custom geometry rotation in Three.js

scala regular expressions stackoverflow

Python nose test encountering issues with JSON response validation

What is the best way to create a regular expression that can detect a string containing a full stop ('.') in the middle and ending with a comma?

Conceal a specific div element using jQuery hide method based on its unique

Interact with a LinkButton using JavaScript on Internet Explorer 9

Modify the css to style the identical listview

Unable to fetch value in a separate class using Android Volley

creating objects dynamically through URL

Scroll down navigation bar hide on scroll offset

Root location for offline and pre-production in the Backbone boilerplate router

Add data from a dynamic table into the database

Using soapUI to extract information from a JSON Response with arrays