Skip to content

Commit

Permalink
Support List and Publisher<Fragment> return values
Browse files Browse the repository at this point in the history 
See spring-projectsgh-33162
  • Loading branch information
@rstoyanchev
rstoyanchev committed Jul 10, 2024
1 parent f2028d2 commit 54e76c8
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 35 deletions.
49 changes: 37 additions & 12 deletions ...c/main/java/org/springframework/web/reactive/result/view/ViewResolutionResultHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package org.springframework.web.reactive.result.view;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
Expand Down Expand Up @@ -154,13 +155,21 @@ public boolean supports(HandlerResult result) {
return true;
}

Class<?> type = result.getReturnType().toClass();
ResolvableType returnType = result.getReturnType();
Class<?> type = returnType.toClass();

ReactiveAdapter adapter = getAdapter(result);
if (adapter != null) {
if (adapter.isNoValue()) {
return true;
}
type = result.getReturnType().getGeneric().toClass();

type = returnType.getGeneric().toClass();
returnType = returnType.getNested(2);

if (adapter.isMultiValue()) {
return Fragment.class.isAssignableFrom(type);
}
}

return (CharSequence.class.isAssignableFrom(type) ||
Expand All @@ -169,9 +178,19 @@ public boolean supports(HandlerResult result) {
Model.class.isAssignableFrom(type) ||
Map.class.isAssignableFrom(type) ||
View.class.isAssignableFrom(type) ||
isFragmentCollection(returnType.getNested(2)) ||
!BeanUtils.isSimpleProperty(type));
}

private boolean hasModelAnnotation(MethodParameter parameter) {
return parameter.hasMethodAnnotation(ModelAttribute.class);
}

private static boolean isFragmentCollection(ResolvableType returnType) {
Class<?> clazz = returnType.resolve(Object.class);
return (Collection.class.isAssignableFrom(clazz) && Fragment.class.equals(returnType.getNested(2).resolve()));
}

@Override
@SuppressWarnings("unchecked")
public Mono<Void> handleResult(ServerWebExchange exchange, HandlerResult result) {
Expand All @@ -181,14 +200,19 @@ public Mono<Void> handleResult(ServerWebExchange exchange, HandlerResult result)

if (adapter != null) {
if (adapter.isMultiValue()) {
throw new IllegalArgumentException("Multi-value producer: " + result.getReturnType());
}
valueMono = (result.getReturnValue() != null ?
Mono.just(FragmentRendering.fromPublisher(adapter.toPublisher(result.getReturnValue())).build()) :
Mono.empty());

valueMono = (result.getReturnValue() != null ?
Mono.from(adapter.toPublisher(result.getReturnValue())) : Mono.empty());
valueType = ResolvableType.forClass(FragmentRendering.class);
}
else {
valueMono = (result.getReturnValue() != null ?
Mono.from(adapter.toPublisher(result.getReturnValue())) : Mono.empty());

valueType = (adapter.isNoValue() ? ResolvableType.forClass(Void.class) :
result.getReturnType().getGeneric());
valueType = (adapter.isNoValue() ? ResolvableType.forClass(Void.class) :
result.getReturnType().getGeneric());
}
}
else {
valueMono = Mono.justOrEmpty(result.getReturnValue());
Expand All @@ -210,6 +234,11 @@ public Mono<Void> handleResult(ServerWebExchange exchange, HandlerResult result)
clazz = returnValue.getClass();
}

if (Collection.class.isAssignableFrom(clazz)) {
returnValue = FragmentRendering.fromCollection((Collection<Fragment>) returnValue).build();
clazz = FragmentRendering.class;
}

if (returnValue == NO_VALUE || ClassUtils.isVoidType(clazz)) {
viewsMono = resolveViews(getDefaultViewName(exchange), locale);
}
Expand Down Expand Up @@ -266,10 +295,6 @@ else if (View.class.isAssignableFrom(clazz)) {
});
}

private boolean hasModelAnnotation(MethodParameter parameter) {
return parameter.hasMethodAnnotation(ModelAttribute.class);
}

/**
* Select a default view name when a controller did not specify it.
* Use the request path the leading and trailing slash stripped.
Expand Down
54 changes: 32 additions & 22 deletions ...FragmentResolutionResultHandlerTests.java → ...mentViewResolutionResultHandlerTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ResourceBundleMessageSource;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.web.reactive.BindingContext;
import org.springframework.web.reactive.HandlerResult;
Expand All @@ -44,42 +45,46 @@
import org.springframework.web.testfixture.server.MockServerWebExchange;

import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
import static org.junit.jupiter.api.Named.named;
import static org.springframework.web.testfixture.method.ResolvableMethod.on;

/**
* Tests for multi-view rendering through {@link ViewResolutionResultHandler}.
* Tests for {@link Fragment} rendering through {@link ViewResolutionResultHandler}.
*
* @author Rossen Stoyanchev
*/
public class FragmentResolutionResultHandlerTests {

static Stream<Arguments> arguments() {
Fragment f1 = Fragment.create("fragment1", Map.of("foo", "Foo"));
Fragment f2 = Fragment.create("fragment2", Map.of("bar", "Bar"));
return Stream.of(
Arguments.of(named("Flux",
FragmentRendering.fromPublisher(Flux.just(f1, f2).subscribeOn(Schedulers.boundedElastic()))
.headers(headers -> headers.setContentType(MediaType.TEXT_HTML))
.build())),
Arguments.of(named("List",
FragmentRendering.fromCollection(List.of(f1, f2))
.headers(headers -> headers.setContentType(MediaType.TEXT_HTML))
.build()))
);}
public class FragmentViewResolutionResultHandlerTests {

static Stream<Arguments> arguments() {
Fragment f1 = Fragment.create("fragment1", Map.of("foo", "Foo"));
Fragment f2 = Fragment.create("fragment2", Map.of("bar", "Bar"));
return Stream.of(
Arguments.of(
FragmentRendering.fromPublisher(Flux.just(f1, f2).subscribeOn(Schedulers.boundedElastic()))
.headers(headers -> headers.setContentType(MediaType.TEXT_HTML))
.build(),
on(Handler.class).resolveReturnType(FragmentRendering.class)),
Arguments.of(
FragmentRendering.fromCollection(List.of(f1, f2))
.headers(headers -> headers.setContentType(MediaType.TEXT_HTML))
.build(),
on(Handler.class).resolveReturnType(FragmentRendering.class)),
Arguments.of(
Flux.just(f1, f2).subscribeOn(Schedulers.boundedElastic()),
on(Handler.class).resolveReturnType(Flux.class, Fragment.class)),
Arguments.of(
List.of(f1, f2),
on(Handler.class).resolveReturnType(List.class, Fragment.class)));
}


@ParameterizedTest
@MethodSource("arguments")
void render(FragmentRendering rendering) {

void render(Object returnValue, MethodParameter parameter) {
Locale locale = Locale.ENGLISH;
MockServerHttpRequest request = MockServerHttpRequest.get("/").acceptLanguageAsLocales(locale).build();
MockServerWebExchange exchange = MockServerWebExchange.from(request);

HandlerResult result = new HandlerResult(
new Handler(), rendering, on(Handler.class).resolveReturnType(FragmentRendering.class),
new BindingContext());
HandlerResult result = new HandlerResult(new Handler(), returnValue, parameter, new BindingContext());

String body = initHandler().handleResult(exchange, result)
.then(Mono.defer(() -> exchange.getResponse().getBodyAsString()))
Expand All @@ -102,10 +107,15 @@ private ViewResolutionResultHandler initHandler() {
}


@SuppressWarnings("unused")
private static class Handler {

FragmentRendering rendering() { return null; }

Flux<Fragment> fragmentFlux() { return null; }

List<Fragment> fragmentList() { return null; }

}


Expand Down
10 changes: 9 additions & 1 deletion ...t/java/org/springframework/web/reactive/result/view/ViewResolutionResultHandlerTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,14 @@ void supports() {
testSupports(on(Handler.class).resolveReturnType(Mono.class, String.class));

testSupports(on(Handler.class).resolveReturnType(Rendering.class));
testSupports(on(Handler.class).resolveReturnType(FragmentRendering.class));
testSupports(on(Handler.class).resolveReturnType(Mono.class, Rendering.class));

testSupports(on(Handler.class).resolveReturnType(FragmentRendering.class));
testSupports(on(Handler.class).resolveReturnType(Flux.class, Fragment.class));
testSupports(on(Handler.class).resolveReturnType(List.class, Fragment.class));
testSupports(on(Handler.class).resolveReturnType(
Mono.class, ResolvableType.forClassWithGenerics(List.class, Fragment.class)));

testSupports(on(Handler.class).resolveReturnType(View.class));
testSupports(on(Handler.class).resolveReturnType(Mono.class, View.class));

Expand Down Expand Up @@ -436,6 +441,9 @@ private static class Handler {
Mono<Rendering> monoRendering() { return null; }

FragmentRendering fragmentRendering() { return null; }
Flux<Fragment> fragmentFlux() { return null; }
Mono<List<Fragment>> monoFragmentList() { return null; }
List<Fragment> fragmentList() { return null; }

View view() { return null; }
Mono<View> monoView() { return null; }
Expand Down

0 comments on commit 54e76c8

Please sign in to comment.