forked from OpenFeign/feign
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEncoder.java
More file actions
98 lines (93 loc) · 3.16 KB
/
Encoder.java
File metadata and controls
98 lines (93 loc) · 3.16 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
/**
* Copyright 2012-2020 The Feign 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 feign.codec;
import java.lang.reflect.Type;
import feign.RequestTemplate;
import feign.Util;
import static java.lang.String.format;
/**
* Encodes an object into an HTTP request body. Like {@code javax.websocket.Encoder}. {@code
* Encoder} is used when a method parameter has no {@code @Param} annotation. For example: <br>
* <p/>
*
* <pre>
* @POST
* @Path("/")
* void create(User user);
* </pre>
*
* Example implementation: <br>
* <p/>
*
* <pre>
* public class GsonEncoder implements Encoder {
* private final Gson gson;
*
* public GsonEncoder(Gson gson) {
* this.gson = gson;
* }
*
* @Override
* public void encode(Object object, Type bodyType, RequestTemplate template) {
* template.body(gson.toJson(object, bodyType));
* }
* }
* </pre>
*
* <p>
* <h3>Form encoding</h3>
* <p>
* If any parameters are found in {@link feign.MethodMetadata#formParams()}, they will be collected
* and passed to the Encoder as a map.
*
* <p>
* Ex. The following is a form. Notice the parameters aren't consumed in the request line. A map
* including "username" and "password" keys will passed to the encoder, and the body type will be
* {@link #MAP_STRING_WILDCARD}.
*
* <pre>
* @RequestLine("POST /")
* Session login(@Param("username") String username, @Param("password") String password);
* </pre>
*/
public interface Encoder {
/** Type literal for {@code Map<String, ?>}, indicating the object to encode is a form. */
Type MAP_STRING_WILDCARD = Util.MAP_STRING_WILDCARD;
/**
* Converts objects to an appropriate representation in the template.
*
* @param object what to encode as the request body.
* @param bodyType the type the object should be encoded as. {@link #MAP_STRING_WILDCARD}
* indicates form encoding.
* @param template the request template to populate.
* @throws EncodeException when encoding failed due to a checked exception.
*/
void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException;
/**
* Default implementation of {@code Encoder}.
*/
class Default implements Encoder {
@Override
public void encode(Object object, Type bodyType, RequestTemplate template) {
if (bodyType == String.class) {
template.body(object.toString());
} else if (bodyType == byte[].class) {
template.body((byte[]) object, null);
} else if (object != null) {
throw new EncodeException(
format("%s is not a type supported by this encoder.", object.getClass()));
}
}
}
}