/* * Copyright 2002-2016 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.springframework.web.reactive.function.server; import java.net.URI; import java.time.ZoneId; import java.time.ZonedDateTime; import java.time.format.DateTimeFormatter; import java.util.Arrays; import java.util.Collections; import java.util.LinkedHashMap; import java.util.LinkedHashSet; import java.util.Locale; import java.util.Map; import java.util.Set; import java.util.function.BiFunction; import java.util.function.Supplier; import java.util.stream.Collectors; import java.util.stream.Stream; import org.reactivestreams.Publisher; import reactor.core.publisher.Flux; import reactor.core.publisher.Mono; import org.springframework.core.Conventions; import org.springframework.http.CacheControl; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpMethod; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.codec.HttpMessageWriter; import org.springframework.http.server.reactive.ServerHttpResponse; import org.springframework.util.Assert; import org.springframework.util.ObjectUtils; import org.springframework.web.reactive.function.BodyInserter; import org.springframework.web.reactive.function.BodyInserters; import org.springframework.web.reactive.result.view.ViewResolver; import org.springframework.web.server.ServerWebExchange; /** * Default {@link ServerResponse.BodyBuilder} implementation. * * @author Arjen Poutsma */ class DefaultServerResponseBuilder implements ServerResponse.BodyBuilder { private final HttpStatus statusCode; private final HttpHeaders headers = new HttpHeaders(); public DefaultServerResponseBuilder(HttpStatus statusCode) { this.statusCode = statusCode; } @Override public ServerResponse.BodyBuilder header(String headerName, String... headerValues) { for (String headerValue : headerValues) { this.headers.add(headerName, headerValue); } return this; } @Override public ServerResponse.BodyBuilder headers(HttpHeaders headers) { if (headers != null) { this.headers.putAll(headers); } return this; } @Override public ServerResponse.BodyBuilder allow(HttpMethod... allowedMethods) { this.headers.setAllow(new LinkedHashSet<>(Arrays.asList(allowedMethods))); return this; } @Override public ServerResponse.BodyBuilder allow(Set allowedMethods) { this.headers.setAllow(allowedMethods); return this; } @Override public ServerResponse.BodyBuilder contentLength(long contentLength) { this.headers.setContentLength(contentLength); return this; } @Override public ServerResponse.BodyBuilder contentType(MediaType contentType) { this.headers.setContentType(contentType); return this; } @Override public ServerResponse.BodyBuilder eTag(String eTag) { if (eTag != null) { if (!eTag.startsWith("\"") && !eTag.startsWith("W/\"")) { eTag = "\"" + eTag; } if (!eTag.endsWith("\"")) { eTag = eTag + "\""; } } this.headers.setETag(eTag); return this; } @Override public ServerResponse.BodyBuilder lastModified(ZonedDateTime lastModified) { ZonedDateTime gmt = lastModified.withZoneSameInstant(ZoneId.of("GMT")); String headerValue = DateTimeFormatter.RFC_1123_DATE_TIME.format(gmt); this.headers.set(HttpHeaders.LAST_MODIFIED, headerValue); return this; } @Override public ServerResponse.BodyBuilder location(URI location) { this.headers.setLocation(location); return this; } @Override public ServerResponse.BodyBuilder cacheControl(CacheControl cacheControl) { String ccValue = cacheControl.getHeaderValue(); if (ccValue != null) { this.headers.setCacheControl(cacheControl.getHeaderValue()); } return this; } @Override public ServerResponse.BodyBuilder varyBy(String... requestHeaders) { this.headers.setVary(Arrays.asList(requestHeaders)); return this; } @Override public Mono build() { return build((exchange, handlerStrategies) -> exchange.getResponse().setComplete()); } @Override public Mono build(Publisher voidPublisher) { Assert.notNull(voidPublisher, "'voidPublisher' must not be null"); return build((exchange, handlerStrategies) -> Mono.from(voidPublisher).then(exchange.getResponse().setComplete())); } @Override public Mono build( BiFunction> writeFunction) { Assert.notNull(writeFunction, "'writeFunction' must not be null"); return Mono.just(new WriterFunctionServerResponse(this.statusCode, this.headers, writeFunction)); } @Override public > Mono body(P publisher, Class elementClass) { return body(BodyInserters.fromPublisher(publisher, elementClass)); } @Override public Mono body(BodyInserter inserter) { Assert.notNull(inserter, "'inserter' must not be null"); return Mono .just(new BodyInserterServerResponse(this.statusCode, this.headers, inserter)); } @Override public Mono render(String name, Object... modelAttributes) { Assert.hasLength(name, "'name' must not be empty"); return render(name, toModelMap(modelAttributes)); } @Override public Mono render(String name, Map model) { Assert.hasLength(name, "'name' must not be empty"); Map modelMap = new LinkedHashMap<>(); if (model != null) { modelMap.putAll(model); } return Mono .just(new RenderingServerResponse(this.statusCode, this.headers, name, modelMap)); } private Map toModelMap(Object[] modelAttributes) { if (ObjectUtils.isEmpty(modelAttributes)) { return null; } return Arrays.stream(modelAttributes) .filter(val -> !ObjectUtils.isEmpty(val)) .collect(Collectors.toMap(Conventions::getVariableName, val -> val)); } private static abstract class AbstractServerResponse implements ServerResponse { private final HttpStatus statusCode; private final HttpHeaders headers; protected AbstractServerResponse(HttpStatus statusCode, HttpHeaders headers) { this.statusCode = statusCode; this.headers = readOnlyCopy(headers); } private static HttpHeaders readOnlyCopy(HttpHeaders headers) { HttpHeaders copy = new HttpHeaders(); copy.putAll(headers); return HttpHeaders.readOnlyHttpHeaders(copy); } @Override public final HttpStatus statusCode() { return this.statusCode; } @Override public final HttpHeaders headers() { return this.headers; } protected void writeStatusAndHeaders(ServerHttpResponse response) { response.setStatusCode(this.statusCode); HttpHeaders responseHeaders = response.getHeaders(); if (!this.headers.isEmpty()) { this.headers.entrySet().stream() .filter(entry -> !responseHeaders.containsKey(entry.getKey())) .forEach(entry -> responseHeaders .put(entry.getKey(), entry.getValue())); } } } private static final class WriterFunctionServerResponse extends AbstractServerResponse { private final BiFunction> writeFunction; public WriterFunctionServerResponse(HttpStatus statusCode, HttpHeaders headers, BiFunction> writeFunction) { super(statusCode, headers); this.writeFunction = writeFunction; } @Override public Mono writeTo(ServerWebExchange exchange, HandlerStrategies strategies) { writeStatusAndHeaders(exchange.getResponse()); return this.writeFunction.apply(exchange, strategies); } } private static final class BodyInserterServerResponse extends AbstractServerResponse { private final BodyInserter inserter; public BodyInserterServerResponse(HttpStatus statusCode, HttpHeaders headers, BodyInserter inserter) { super(statusCode, headers); this.inserter = inserter; } @Override public Mono writeTo(ServerWebExchange exchange, HandlerStrategies strategies) { ServerHttpResponse response = exchange.getResponse(); writeStatusAndHeaders(response); return this.inserter.insert(response, new BodyInserter.Context() { @Override public Supplier>> messageWriters() { return strategies.messageWriters(); } }); } } private static final class RenderingServerResponse extends AbstractServerResponse { private final String name; private final Map model; public RenderingServerResponse(HttpStatus statusCode, HttpHeaders headers, String name, Map model) { super(statusCode, headers); this.name = name; this.model = Collections.unmodifiableMap(model); } @Override public Mono writeTo(ServerWebExchange exchange, HandlerStrategies strategies) { ServerHttpResponse response = exchange.getResponse(); writeStatusAndHeaders(response); MediaType contentType = exchange.getResponse().getHeaders().getContentType(); Locale acceptLocale = exchange.getRequest().getHeaders().getAcceptLanguageAsLocale(); Locale locale = (acceptLocale != null ? acceptLocale : Locale.getDefault()); Stream viewResolverStream = strategies.viewResolvers().get(); return Flux.fromStream(viewResolverStream) .concatMap(viewResolver -> viewResolver.resolveViewName(this.name, locale)) .next() .otherwiseIfEmpty(Mono.error(new IllegalArgumentException("Could not resolve view with name '" + this.name +"'"))) .then(view -> view.render(this.model, contentType, exchange)); } } }