|
| 1 | +/* |
| 2 | + * Copyright 2002-present the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package org.springframework.test.json; |
| 18 | + |
| 19 | +import java.io.IOException; |
| 20 | +import java.lang.reflect.Type; |
| 21 | +import java.nio.charset.StandardCharsets; |
| 22 | +import java.util.List; |
| 23 | +import java.util.stream.StreamSupport; |
| 24 | + |
| 25 | +import org.springframework.core.ResolvableType; |
| 26 | +import org.springframework.http.HttpHeaders; |
| 27 | +import org.springframework.http.HttpInputMessage; |
| 28 | +import org.springframework.http.MediaType; |
| 29 | +import org.springframework.http.converter.GenericHttpMessageConverter; |
| 30 | +import org.springframework.http.converter.HttpMessageConverter; |
| 31 | +import org.springframework.http.converter.HttpMessageNotReadableException; |
| 32 | +import org.springframework.http.converter.SmartHttpMessageConverter; |
| 33 | +import org.springframework.mock.http.MockHttpInputMessage; |
| 34 | +import org.springframework.mock.http.MockHttpOutputMessage; |
| 35 | +import org.springframework.util.Assert; |
| 36 | +import org.springframework.util.function.SingletonSupplier; |
| 37 | + |
| 38 | +/** |
| 39 | + * Default {@link JsonConverterDelegate} based on {@link HttpMessageConverter}s. |
| 40 | + * |
| 41 | + * @author Stephane Nicoll |
| 42 | + * @author Rossen Stoyanchev |
| 43 | + * @since 7.0 |
| 44 | + */ |
| 45 | +final class DefaultJsonConverterDelegate implements JsonConverterDelegate { |
| 46 | + |
| 47 | + private static final MediaType JSON = MediaType.APPLICATION_JSON; |
| 48 | + |
| 49 | + private final List<HttpMessageConverter<?>> messageConverters; |
| 50 | + |
| 51 | + |
| 52 | + DefaultJsonConverterDelegate(Iterable<HttpMessageConverter<?>> messageConverters) { |
| 53 | + this.messageConverters = StreamSupport.stream(messageConverters.spliterator(), false).toList(); |
| 54 | + Assert.notEmpty(this.messageConverters, "At least one message converter needs to be specified"); |
| 55 | + } |
| 56 | + |
| 57 | + |
| 58 | + @Override |
| 59 | + public <T> T read(String content, ResolvableType targetType) throws IOException{ |
| 60 | + HttpInputMessage message = new MockHttpInputMessage(content.getBytes(StandardCharsets.UTF_8)); |
| 61 | + message.getHeaders().add(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE); |
| 62 | + return read(message, MediaType.APPLICATION_JSON, targetType); |
| 63 | + } |
| 64 | + |
| 65 | + /** |
| 66 | + * Convert the given {@link HttpInputMessage} whose content must match the |
| 67 | + * given {@link MediaType} to the requested {@code targetType}. |
| 68 | + * @param message an input message |
| 69 | + * @param mediaType the media type of the input |
| 70 | + * @param targetType the target type |
| 71 | + * @param <T> the converted object type |
| 72 | + * @return a value of the given {@code targetType} |
| 73 | + */ |
| 74 | + @SuppressWarnings("unchecked") |
| 75 | + <T> T read(HttpInputMessage message, MediaType mediaType, ResolvableType targetType) |
| 76 | + throws IOException, HttpMessageNotReadableException { |
| 77 | + |
| 78 | + Class<?> contextClass = targetType.getRawClass(); |
| 79 | + SingletonSupplier<Type> javaType = SingletonSupplier.of(targetType::getType); |
| 80 | + for (HttpMessageConverter<?> messageConverter : this.messageConverters) { |
| 81 | + if (messageConverter instanceof GenericHttpMessageConverter<?> genericMessageConverter) { |
| 82 | + Type type = javaType.obtain(); |
| 83 | + if (genericMessageConverter.canRead(type, contextClass, mediaType)) { |
| 84 | + return (T) genericMessageConverter.read(type, contextClass, message); |
| 85 | + } |
| 86 | + } |
| 87 | + else if (messageConverter instanceof SmartHttpMessageConverter<?> smartMessageConverter) { |
| 88 | + if (smartMessageConverter.canRead(targetType, mediaType)) { |
| 89 | + return (T) smartMessageConverter.read(targetType, message, null); |
| 90 | + } |
| 91 | + } |
| 92 | + else { |
| 93 | + Class<?> targetClass = (contextClass != null ? contextClass : Object.class); |
| 94 | + if (messageConverter.canRead(targetClass, mediaType)) { |
| 95 | + HttpMessageConverter<T> simpleMessageConverter = (HttpMessageConverter<T>) messageConverter; |
| 96 | + Class<? extends T> clazz = (Class<? extends T>) targetClass; |
| 97 | + return simpleMessageConverter.read(clazz, message); |
| 98 | + } |
| 99 | + } |
| 100 | + } |
| 101 | + throw new IllegalStateException("No converter found to read [%s] to [%s]".formatted(mediaType, targetType)); |
| 102 | + } |
| 103 | + |
| 104 | + /** |
| 105 | + * Convert the given raw value to the given {@code targetType} by writing |
| 106 | + * it first to JSON and reading it back. |
| 107 | + * @param value the value to convert |
| 108 | + * @param targetType the target type |
| 109 | + * @param <T> the converted object type |
| 110 | + * @return a value of the given {@code targetType} |
| 111 | + */ |
| 112 | + @Override |
| 113 | + public <T> T map(Object value, ResolvableType targetType) throws IOException { |
| 114 | + MockHttpOutputMessage outputMessage = writeToJson(value, ResolvableType.forInstance(value)); |
| 115 | + return read(fromHttpOutputMessage(outputMessage), JSON, targetType); |
| 116 | + } |
| 117 | + |
| 118 | + @SuppressWarnings({ "rawtypes", "unchecked" }) |
| 119 | + private MockHttpOutputMessage writeToJson(Object value, ResolvableType valueType) throws IOException { |
| 120 | + MockHttpOutputMessage outputMessage = new MockHttpOutputMessage(); |
| 121 | + Class<?> valueClass = value.getClass(); |
| 122 | + SingletonSupplier<Type> javaType = SingletonSupplier.of(valueType::getType); |
| 123 | + for (HttpMessageConverter<?> messageConverter : this.messageConverters) { |
| 124 | + if (messageConverter instanceof GenericHttpMessageConverter genericMessageConverter) { |
| 125 | + Type type = javaType.obtain(); |
| 126 | + if (genericMessageConverter.canWrite(type, valueClass, JSON)) { |
| 127 | + genericMessageConverter.write(value, type, JSON, outputMessage); |
| 128 | + return outputMessage; |
| 129 | + } |
| 130 | + } |
| 131 | + else if (messageConverter instanceof SmartHttpMessageConverter smartMessageConverter) { |
| 132 | + if (smartMessageConverter.canWrite(valueType, valueClass, JSON)) { |
| 133 | + smartMessageConverter.write(value, valueType, JSON, outputMessage, null); |
| 134 | + return outputMessage; |
| 135 | + } |
| 136 | + } |
| 137 | + else if (messageConverter.canWrite(valueClass, JSON)) { |
| 138 | + ((HttpMessageConverter<Object>) messageConverter).write(value, JSON, outputMessage); |
| 139 | + return outputMessage; |
| 140 | + } |
| 141 | + } |
| 142 | + throw new IllegalStateException("No converter found to convert [%s] to JSON".formatted(valueType)); |
| 143 | + } |
| 144 | + |
| 145 | + private static HttpInputMessage fromHttpOutputMessage(MockHttpOutputMessage message) { |
| 146 | + MockHttpInputMessage inputMessage = new MockHttpInputMessage(message.getBodyAsBytes()); |
| 147 | + inputMessage.getHeaders().addAll(message.getHeaders()); |
| 148 | + return inputMessage; |
| 149 | + } |
| 150 | + |
| 151 | +} |
0 commit comments