CODEWITHSUNDEEP
spring-webfluxstatic-content
jabrena
jabrena

Reputation: 1345

How to serve static content using Webflux?

I am learning webflux and I would like to know how to serve static content on a MicroService using webflux but I didn´t find information to do it.

Upvotes: 27

Views: 15833

Answers (5)

Luke Kroon
Luke Kroon

Reputation: 1103

I struggled to host static content outside of the .jar executable. With spring boot mvc you can just create a public directory next to the .jar and it will serve the files for you. With spring webflux that is not the case. The solutions mentioned here only works if you place the static files in the resources/public folder and then build the .jar.

I got spring webflux to serve static content without including it in the jar with the following config:

spring:
  application:
    name: spring-cloud-gateway
  webflux.static-path-pattern: "/**"
  resources.static-locations: "file:public/"

Wit this you can build the webflux jar and add the static files later on deployment.

Upvotes: 0

Juan Medina
Juan Medina

Reputation: 593

Try this

RouterFunction router = resources("/**", new ClassPathResource("public/"));

UPDATE: Don't forget to specify a name of the static file in the URL when accessing it from outside, like localhost:8080/index.html

Upvotes: 17

Peter YuChen waNgamer
Peter YuChen waNgamer

Reputation: 357

Juan Medina is right. I just want to make it even more clear and provide a reference link.

In fact, you just have to add a RouterFunction bean to handle static resources. You don't have to implement your own RouterFunction because RouterFunctions.resources("/**", new ClassPathResource("static/")); gives what you want.

All I do is to add this piece of code:

@Bean
RouterFunction<ServerResponse> staticResourceRouter(){
    return RouterFunctions.resources("/**", new ClassPathResource("static/"));
}

Whatever unrecoginized requests will fall into the static router.

Upvotes: 16

No_One
No_One

Reputation: 245

Thanks wildloop worked for me with following properties:

spring.webflux.static-path-pattern: "/**"
spring.resources.static-locations: "classpath:/public-web-resources/"

Spring boot adds following log line: 

15:51:43.776 INFO  Adding welcome page: class path resource [public-web-resources/index.html] - WebMvcAutoConfiguration$WelcomePageHandlerMapping.<init>

And it works as welcome page for http://localhost:port/myapp/

Wish there was a way to invoke it on /myapp/docs

Upvotes: 3

kinjelom
kinjelom

Reputation: 6450

Spring Web Flux & public static web resources configuration

  • put public static web resources into the public-web-resources folder:

    ./src/main/public-web-resources

  • configure Spring Boot 2.0, application.yaml:

    spring.main.web-application-type: "REACTIVE"
spring.webflux.static-path-pattern: "/app/**"
spring.resources.static-locations:
  - "classpath:/public-web-resources/"

  • configure maven-resources-plugin, pom.xml:

    <build>
    <plugins>
        <plugin>
            <artifactId>maven-resources-plugin</artifactId>
            <version>3.0.1</version>
            <executions>
                <execution>
                    <id>copy-resources</id>
                    <phase>validate</phase>
                    <goals>
                        <goal>copy-resources</goal>
                    </goals>
                    <configuration>
                        <resources>
                            <resource>
                                <directory>src/main/public-web-resources</directory>
                                <filtering>true</filtering>
                            </resource>
                        </resources>
                        <outputDirectory>${basedir}/target/classes/public-web-resources</outputDirectory>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <version>2.0.0.BUILD-SNAPSHOT</version>
        </plugin>
    </plugins>
</build>

Upvotes: 7

Related Questions