/* * Copyright 2002-2017 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.bind.support; import java.util.List; import java.util.Map; import java.util.TreeMap; import java.util.stream.Collectors; import reactor.core.publisher.Mono; import org.springframework.beans.MutablePropertyValues; import org.springframework.http.codec.multipart.FormFieldPart; import org.springframework.http.codec.multipart.Part; import org.springframework.util.CollectionUtils; import org.springframework.util.MultiValueMap; import org.springframework.web.bind.WebDataBinder; import org.springframework.web.server.ServerWebExchange; /** * Specialized {@link org.springframework.validation.DataBinder} to perform data * binding from URL query params or form data in the request data to Java objects. * * @author Rossen Stoyanchev * @since 5.0 */ public class WebExchangeDataBinder extends WebDataBinder { /** * Create a new instance, with default object name. * @param target the target object to bind onto (or {@code null} if the * binder is just used to convert a plain parameter value) * @see #DEFAULT_OBJECT_NAME */ public WebExchangeDataBinder(Object target) { super(target); } /** * Create a new instance. * @param target the target object to bind onto (or {@code null} if the * binder is just used to convert a plain parameter value) * @param objectName the name of the target object */ public WebExchangeDataBinder(Object target, String objectName) { super(target, objectName); } /** * Bind query params, form data, and or multipart form data to the binder target. * @param exchange the current exchange. * @return a {@code Mono<Void>} when binding is complete */ public Mono<Void> bind(ServerWebExchange exchange) { return getValuesToBind(exchange) .doOnNext(values -> doBind(new MutablePropertyValues(values))) .then(); } /** * Protected method to obtain the values for data binding. By default this * method delegates to {@link #extractValuesToBind(ServerWebExchange)}. */ protected Mono<Map<String, Object>> getValuesToBind(ServerWebExchange exchange) { return extractValuesToBind(exchange); } /** * Combine query params and form data for multipart form data from the body * of the request into a {@code Map<String, Object>} of values to use for * data binding purposes. * * @param exchange the current exchange * @return a {@code Mono} with the values to bind */ public static Mono<Map<String, Object>> extractValuesToBind(ServerWebExchange exchange) { MultiValueMap<String, String> queryParams = exchange.getRequest().getQueryParams(); Mono<MultiValueMap<String, String>> formData = exchange.getFormData(); Mono<MultiValueMap<String, Part>> multipartData = exchange.getMultipartData(); return Mono.when(Mono.just(queryParams), formData, multipartData) .map(tuple -> { Map<String, Object> result = new TreeMap<>(); tuple.getT1().forEach((key, values) -> addBindValue(result, key, values)); tuple.getT2().forEach((key, values) -> addBindValue(result, key, values)); tuple.getT3().forEach((key, values) -> addBindValue(result, key, values)); return result; }); } private static void addBindValue(Map<String, Object> params, String key, List<?> values) { if (!CollectionUtils.isEmpty(values)) { values = values.stream() .map(value -> value instanceof FormFieldPart ? ((FormFieldPart) value).value() : value) .collect(Collectors.toList()); params.put(key, values.size() == 1 ? values.get(0) : values); } } }