Kotlin中Spring WebFlux响应式函数式路由：Rest与Web端点配置问题

问题描述 #

已成功配置Spring WebFlux的REST端点，但访问Web端点/index时抛出以下错误：

java.lang.IllegalArgumentException: Could not resolve view with name 'index'

堆栈信息：

at org.springframework.web.reactive.function.server.DefaultRenderingResponseBuilder$DefaultRenderingResponse.lambda$writeToInternal$1(DefaultRenderingResponseBuilder.java:197) ~[spring-webflux-6.0.7.jar:6.0.7]
Suppressed: reactor.core.publisher.FluxOnAssembly$OnAssemblyException: 
Error has been observed at the following site(s):
    *__checkpoint ⇢ Handler com.springinaction.router.config.WebConfiguration$$Lambda$524/0x0000000800519368@46b9842f [DispatcherHandler]
    *__checkpoint ⇢ HTTP GET "/index" [ExceptionHandlingWebHandler]
Original Stack Trace:

尝试过两种路由配置方式，均出现相同错误，目标是让路由正确解析/templates目录下的index.html文件：

尝试的配置1 #

@Bean
fun router(): RouterFunction<*> {
    return resources("/**", ClassPathResource("/templates/"))
        .andOther(
            route(GET("/index"), HandlerFunction {
                ServerResponse
                    .ok()
                    .render("index")
            })
            .andOther (
                route(
                    GET("/hello"), HandlerFunction {
                        ServerResponse
                            .ok()
                            .contentType(MediaType.TEXT_HTML)
                            .bodyValue("Hello Router World")
                    }
                )
            )
        )
}

尝试的配置2 #

@Bean
fun router(): RouterFunction<*> {
    return router {
        GET("/hello") {
            ServerResponse
                .ok()
                .contentType(MediaType.TEXT_HTML)
                .bodyValue("Hello Router World")
        }
        GET("/index") {
            ServerResponse
                .ok()
                .render("index")
        }
    }
}

问题根源 #

使用render("index")时，Spring WebFlux会通过视图解析器查找对应视图模板，但未配置合适的视图解析器（如Thymeleaf），或静态资源路由配置错误，导致无法定位index.html。

解决步骤 #

1. 选择静态资源映射或模板引擎渲染 #

根据index.html类型选择对应方案：

场景1：index.html是静态HTML文件

无需使用render方法，直接通过资源路由映射即可：

@Bean
fun router(): RouterFunction<*> {
    return router {
        // REST端点
        GET("/hello") {
            ServerResponse.ok()
                .contentType(MediaType.TEXT_HTML)
                .bodyValue("Hello Router World")
        }
        // 映射/index到templates/index.html
        GET("/index") {
            ServerResponse.ok()
                .contentType(MediaType.TEXT_HTML)
                .bodyValue(ClassPathResource("/templates/index.html"))
        }
        // 通用静态资源路由，匹配/templates下所有文件
        resources("/**", ClassPathResource("/templates/"))
    }
}

也可以简化配置，让资源路由自动匹配：

@Bean
fun router(): RouterFunction<*> {
    return router {
        GET("/hello") {
            ServerResponse.ok()
                .contentType(MediaType.TEXT_HTML)
                .bodyValue("Hello Router World")
        }
        // 访问/{filename}会自动查找/templates/{filename}.html
        resources("/{filename}", ClassPathResource("/templates/"))
    }
}

场景2：index.html是动态模板（如Thymeleaf）

需先添加Thymeleaf依赖，以build.gradle.kts为例：

dependencies {
    implementation("org.springframework.boot:spring-boot-starter-webflux")
    implementation("org.springframework.boot:spring-boot-starter-thymeleaf")
}

此时原有的render("index")配置即可生效，Spring会自动通过Thymeleaf视图解析器查找/templates/index.html并渲染。

2. 确认文件路径 #

确保index.html放置在项目src/main/resources/templates/目录下，路径无拼写错误。

内容的提问来源于stack exchange，提问作者Saher Al-Sous