Repository navigation
Expand file tree
/
Copy pathMultiDecoder.java
More file actions
246 lines (227 loc) · 8.67 KB
/
Copy pathMultiDecoder.java
File metadata and controls
246 lines (227 loc) · 8.67 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
/*
* Copyright © 2012 The Feign Authors (feign@commonhaus.dev)
*
* 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 feign.codec;
import feign.Experimental;
import feign.FeignException;
import feign.Request;
import feign.Response;
import feign.Util;
import java.io.IOException;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;
/**
* A {@link Decoder} that hands each response to the first decoder that accepts it.
*
* <p>Decoders come from two places. A decoder that implements {@link PredicatedDecoder} declares
* its own applicability and can simply be added; any other decoder is paired with a {@link
* DecoderPredicate} at the call site:
*
* <pre>
* Feign.builder()
* .decoder(
* MultiDecoder.builder()
* .add(new JacksonDecoder())
* .add(DecoderPredicate.xmlContentType(), new JAXBDecoder())
* .add((response, type) -> type == byte[].class, new BinaryDecoder())
* .add(DecoderPredicate.any(), new DefaultDecoder())
* .build());
* </pre>
*
* <p>Decoders are consulted in the order they were added, so the narrowest one comes first. There
* is no implicit fallback: a response no decoder accepts fails with a {@link DecodeException}
* naming what was tried. Add a decoder guarded by {@link DecoderPredicate#any()} last to act as a
* default, as above.
*
* <p>A multi-decoder is itself a {@link PredicatedDecoder}, accepting whatever any of its decoders
* accepts, so one can be added to another. That is how a library ships a set of decoders as a
* single unit: given a hypothetical {@code AcmeFeign.decoders()} returning a multi-decoder over
* that library's decoders, the whole set is added in one go:
*
* <pre>
* Feign.builder().decoders(AcmeFeign.decoders(), new JacksonDecoder());
* </pre>
*
* @see PredicatedDecoder
* @see DecoderPredicate
*/
@Experimental
public class MultiDecoder implements PredicatedDecoder {
private final List<PredicatedDecoder> decoders;
private MultiDecoder(List<PredicatedDecoder> decoders) {
this.decoders = Collections.unmodifiableList(new ArrayList<>(decoders));
}
/** Starts building a multi-decoder. */
public static Builder builder() {
return new Builder();
}
/**
* Whether any of the decoders accepts the response.
*
* @param response {@inheritDoc}
* @param type {@inheritDoc}
* @return {@inheritDoc}
*/
@Override
public boolean canDecode(Response response, Type type) {
return decoders.stream().anyMatch(decoder -> decoder.canDecode(response, type));
}
/**
* Decodes using the first decoder that accepts the response.
*
* @param response {@inheritDoc}
* @param type {@inheritDoc}
* @return {@inheritDoc}
* @throws IOException {@inheritDoc}
* @throws DecodeException when no decoder accepts the response, or the chosen one fails
* @throws FeignException {@inheritDoc}
*/
@Override
public Object decode(Response response, Type type)
throws IOException, DecodeException, FeignException {
for (PredicatedDecoder decoder : decoders) {
if (decoder.canDecode(response, type)) {
return decoder.decode(response, type);
}
}
throw new DecodeException(
response.status(), unableToDecode(response, type), response.request());
}
private String unableToDecode(Response response, Type type) {
StringBuilder message =
new StringBuilder("Unable to decode ")
.append(response.status())
.append(" response (")
.append(headers(response))
.append(") as ")
.append(type == null ? "the expected type" : type.getTypeName())
.append(". Decoders tried, in order:");
appendTo(message, "\n ");
return message
.append("\nRegister a decoder that accepts it, or add a catch-all")
.append(" (DecoderPredicate.any()) last.")
.toString();
}
/**
* Lists the decoders one per line, unfolding nested multi-decoders so that a set contributed as a
* single unit still shows what it contains.
*/
private void appendTo(StringBuilder message, String indent) {
for (PredicatedDecoder decoder : decoders) {
if (decoder instanceof MultiDecoder) {
message.append(indent).append("- MultiDecoder:");
((MultiDecoder) decoder).appendTo(message, indent + " ");
} else {
message.append(indent).append("- ").append(PairedDecoder.describe(decoder));
}
}
}
/**
* The headers a decoder is most likely to have been chosen on: what came back, and what was asked
* for. Everything else a predicate looks at belongs in that predicate's own description, which is
* listed alongside it.
*/
private static String headers(Response response) {
String contentType = header(response.headers(), Util.CONTENT_TYPE);
StringBuilder headers =
new StringBuilder(Util.CONTENT_TYPE)
.append(": ")
.append(contentType == null ? "not set" : contentType);
Request request = response.request();
String accept = request == null ? null : header(request.headers(), Util.ACCEPT);
if (accept != null) {
headers.append(", ").append(Util.ACCEPT).append(": ").append(accept);
}
return headers.toString();
}
private static String header(Map<String, Collection<String>> headers, String name) {
String values =
headers.entrySet().stream()
.filter(header -> name.equalsIgnoreCase(header.getKey()))
.map(Map.Entry::getValue)
.filter(Objects::nonNull)
.flatMap(Collection::stream)
.collect(Collectors.joining(", "));
return values.isEmpty() ? null : values;
}
@Override
public String toString() {
return "MultiDecoder"
+ decoders.stream().map(PairedDecoder::describe).collect(Collectors.toList());
}
/** Collects the decoders of a {@link MultiDecoder}. */
@Experimental
public static final class Builder {
private final List<PredicatedDecoder> decoders = new ArrayList<>();
private Builder() {}
/**
* Adds a decoder that declares its own applicability.
*
* @param decoder the decoder, consulted via {@link PredicatedDecoder#canDecode}
*/
public Builder add(PredicatedDecoder decoder) {
decoders.add(Objects.requireNonNull(decoder, "decoder cannot be null"));
return this;
}
/**
* Adds any decoder, guarded by the given predicate. Use this for decoders that do not implement
* {@link PredicatedDecoder}, including ones you do not control. The predicate is the whole
* answer: whatever the decoder may declare about itself is replaced, so this can widen a
* decoder as well as narrow it. Use {@link #narrow(DecoderPredicate, Decoder)} to keep the
* decoder's own declaration.
*
* @param predicate decides whether the decoder handles a response
* @param decoder the decoder to delegate to
*/
public Builder add(DecoderPredicate predicate, Decoder decoder) {
return add(PredicatedDecoder.of(predicate, decoder));
}
/**
* Adds a decoder, narrowed by the given predicate. If the decoder is itself a {@link
* PredicatedDecoder}, the predicate applies in addition to the decoder's own {@code canDecode}
* rather than instead of it: both have to accept the response.
*
* <pre>
* MultiDecoder.builder()
* .narrow(DecoderPredicate.status(200), new JacksonDecoder())
* .add(DecoderPredicate.any(), new DefaultDecoder())
* .build();
* </pre>
*
* @param predicate narrows what the decoder handles
* @param decoder the decoder to delegate to
*/
public Builder narrow(DecoderPredicate predicate, Decoder decoder) {
return add(PredicatedDecoder.narrowing(predicate, decoder));
}
/**
* Builds the multi-decoder.
*
* @throws IllegalStateException if no decoder was added
*/
public MultiDecoder build() {
if (decoders.isEmpty()) {
throw new IllegalStateException("at least one decoder is required");
}
return new MultiDecoder(decoders);
}
}
}