|
| 1 | +/* |
| 2 | + * Copyright 2002-2017 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 | + * http://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 | +package org.springframework.http.codec.json; |
| 17 | + |
| 18 | +import java.io.IOException; |
| 19 | +import java.io.UncheckedIOException; |
| 20 | +import java.lang.annotation.Annotation; |
| 21 | +import java.util.Map; |
| 22 | + |
| 23 | +import com.fasterxml.jackson.core.JsonFactory; |
| 24 | +import com.fasterxml.jackson.core.JsonParser; |
| 25 | +import com.fasterxml.jackson.core.JsonProcessingException; |
| 26 | +import com.fasterxml.jackson.databind.JavaType; |
| 27 | +import com.fasterxml.jackson.databind.ObjectMapper; |
| 28 | +import com.fasterxml.jackson.databind.ObjectReader; |
| 29 | +import com.fasterxml.jackson.databind.exc.InvalidDefinitionException; |
| 30 | +import com.fasterxml.jackson.databind.util.TokenBuffer; |
| 31 | +import org.reactivestreams.Publisher; |
| 32 | +import reactor.core.publisher.Flux; |
| 33 | +import reactor.core.publisher.Mono; |
| 34 | + |
| 35 | +import org.springframework.core.MethodParameter; |
| 36 | +import org.springframework.core.ResolvableType; |
| 37 | +import org.springframework.core.codec.CodecException; |
| 38 | +import org.springframework.core.codec.DecodingException; |
| 39 | +import org.springframework.core.io.buffer.DataBuffer; |
| 40 | +import org.springframework.http.codec.HttpMessageDecoder; |
| 41 | +import org.springframework.http.server.reactive.ServerHttpRequest; |
| 42 | +import org.springframework.http.server.reactive.ServerHttpResponse; |
| 43 | +import org.springframework.lang.Nullable; |
| 44 | +import org.springframework.util.Assert; |
| 45 | +import org.springframework.util.MimeType; |
| 46 | + |
| 47 | +/** |
| 48 | + * Base class providing support methods for Jackson 2.9 decoding. |
| 49 | + * |
| 50 | + * @author Sebastien Deleuze |
| 51 | + * @author Rossen Stoyanchev |
| 52 | + * @since 5.0 |
| 53 | + */ |
| 54 | +public abstract class AbstractJackson2Decoder extends Jackson2CodecSupport implements HttpMessageDecoder<Object> { |
| 55 | + |
| 56 | + /** |
| 57 | + * Constructor with a Jackson {@link ObjectMapper} to use. |
| 58 | + */ |
| 59 | + protected AbstractJackson2Decoder(ObjectMapper mapper, MimeType... mimeTypes) { |
| 60 | + super(mapper, mimeTypes); |
| 61 | + } |
| 62 | + |
| 63 | + @Override |
| 64 | + public boolean canDecode(ResolvableType elementType, @Nullable MimeType mimeType) { |
| 65 | + JavaType javaType = objectMapper().getTypeFactory().constructType(elementType.getType()); |
| 66 | + // Skip String: CharSequenceDecoder + "*/*" comes after |
| 67 | + return (!CharSequence.class.isAssignableFrom(elementType.resolve(Object.class)) && |
| 68 | + objectMapper().canDeserialize(javaType) && supportsMimeType(mimeType)); |
| 69 | + } |
| 70 | + |
| 71 | + @Override |
| 72 | + public Flux<Object> decode(Publisher<DataBuffer> input, ResolvableType elementType, |
| 73 | + @Nullable MimeType mimeType, @Nullable Map<String, Object> hints) { |
| 74 | + |
| 75 | + Flux<TokenBuffer> tokens = tokenize(input, true); |
| 76 | + return decodeInternal(tokens, elementType, mimeType, hints); |
| 77 | + } |
| 78 | + |
| 79 | + @Override |
| 80 | + public Mono<Object> decodeToMono(Publisher<DataBuffer> input, ResolvableType elementType, |
| 81 | + @Nullable MimeType mimeType, @Nullable Map<String, Object> hints) { |
| 82 | + |
| 83 | + Flux<TokenBuffer> tokens = tokenize(input, false); |
| 84 | + return decodeInternal(tokens, elementType, mimeType, hints).singleOrEmpty(); |
| 85 | + } |
| 86 | + |
| 87 | + private Flux<TokenBuffer> tokenize(Publisher<DataBuffer> input, boolean tokenizeArrayElements) { |
| 88 | + try { |
| 89 | + JsonFactory factory = objectMapper().getFactory(); |
| 90 | + JsonParser nonBlockingParser = factory.createNonBlockingByteArrayParser(); |
| 91 | + Jackson2Tokenizer tokenizer = new Jackson2Tokenizer(nonBlockingParser, |
| 92 | + tokenizeArrayElements); |
| 93 | + return Flux.from(input) |
| 94 | + .flatMap(tokenizer) |
| 95 | + .doFinally(t -> tokenizer.endOfInput()); |
| 96 | + } |
| 97 | + catch (IOException ex) { |
| 98 | + return Flux.error(new UncheckedIOException(ex)); |
| 99 | + } |
| 100 | + |
| 101 | + } |
| 102 | + |
| 103 | + private Flux<Object> decodeInternal(Flux<TokenBuffer> tokens, |
| 104 | + ResolvableType elementType, @Nullable MimeType mimeType, |
| 105 | + @Nullable Map<String, Object> hints) { |
| 106 | + |
| 107 | + Assert.notNull(tokens, "'tokens' must not be null"); |
| 108 | + Assert.notNull(elementType, "'elementType' must not be null"); |
| 109 | + |
| 110 | + MethodParameter param = getParameter(elementType); |
| 111 | + Class<?> contextClass = (param != null ? param.getContainingClass() : null); |
| 112 | + JavaType javaType = getJavaType(elementType.getType(), contextClass); |
| 113 | + Class<?> jsonView = (hints != null ? (Class<?>) hints.get(Jackson2CodecSupport.JSON_VIEW_HINT) : null); |
| 114 | + |
| 115 | + ObjectReader reader = (jsonView != null ? |
| 116 | + objectMapper().readerWithView(jsonView).forType(javaType) : |
| 117 | + objectMapper().readerFor(javaType)); |
| 118 | + |
| 119 | + return tokens.map(tokenBuffer -> { |
| 120 | + try { |
| 121 | + return reader.readValue(tokenBuffer.asParser()); |
| 122 | + } |
| 123 | + catch (InvalidDefinitionException ex) { |
| 124 | + throw new CodecException("Type definition error: " + ex.getType(), ex); |
| 125 | + } |
| 126 | + catch (JsonProcessingException ex) { |
| 127 | + throw new DecodingException("JSON decoding error: " + ex.getOriginalMessage(), ex); |
| 128 | + } |
| 129 | + catch (IOException ex) { |
| 130 | + throw new DecodingException("I/O error while parsing input stream", ex); |
| 131 | + } |
| 132 | + }); |
| 133 | + } |
| 134 | + |
| 135 | + |
| 136 | + // HttpMessageDecoder... |
| 137 | + |
| 138 | + @Override |
| 139 | + public Map<String, Object> getDecodeHints(ResolvableType actualType, ResolvableType elementType, |
| 140 | + ServerHttpRequest request, ServerHttpResponse response) { |
| 141 | + |
| 142 | + return getHints(actualType); |
| 143 | + } |
| 144 | + |
| 145 | + @Override |
| 146 | + protected <A extends Annotation> A getAnnotation(MethodParameter parameter, Class<A> annotType) { |
| 147 | + return parameter.getParameterAnnotation(annotType); |
| 148 | + } |
| 149 | +} |
0 commit comments