Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,23 @@ public class Example {

NB: you may also need to add `SOAPErrorDecoder` if SOAP Faults are returned in response with error http codes (4xx, 5xx, ...)

#### Fastjson2

[fastjson2](./fastjson2) includes an encoder and decoder you can use with a JSON API.

Add `Fastjson2Encoder` and/or `Fastjson2Decoder` to your `Feign.Builder` like so:

```java
public class Example {
public static void main(String[] args) {
GitHub github = Feign.builder()
.encoder(new Fastjson2Encoder())
.decoder(new Fastjson2Decoder())
.target(GitHub.class, "https://api.github.com");
}
}
```

### Contract

#### JAX-RS
Expand Down
22 changes: 22 additions & 0 deletions fastjson2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Fastjson2 Codec
===================

This module adds support for encoding and decoding JSON via Fastjson2.

Add `Fastjson2Encoder` and/or `Fastjson2Decoder` to your `Feign.Builder` like so:

```java
GitHub github = Feign.builder()
.encoder(new Fastjson2Encoder())
.decoder(new Fastjson2Decoder())
.target(GitHub.class, "https://api.github.com");
```

If you want to customize, provide it to the `Fastjson2Encoder` and `Fastjson2Decoder`:

```java
GitHub github = Feign.builder()
.encoder(new Fastjson2Encoder(new JSONWriter.Feature[]{JSONWriter.Feature.WriteNonStringValueAsString})
.decoder(new Fastjson2Decoder(new JSONReader.Feature[]{JSONReader.Feature.EmptyStringAsNull}))
.target(GitHub.class, "https://api.github.com");
```
54 changes: 54 additions & 0 deletions fastjson2/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--

Copyright 2012-2024 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.

-->
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>io.github.openfeign</groupId>
<artifactId>parent</artifactId>
<version>13.3-SNAPSHOT</version>
</parent>

<artifactId>feign-fastjson2</artifactId>
<name>Feign Fastjson2</name>
<description>Feign Fastjson2</description>

<properties>
<main.basedir>${project.basedir}/..</main.basedir>
</properties>

<dependencies>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>feign-core</artifactId>
</dependency>

<dependency>
<groupId>com.alibaba.fastjson2</groupId>
<artifactId>fastjson2</artifactId>
</dependency>

<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>feign-core</artifactId>
<type>test-jar</type>
<scope>test</scope>
</dependency>
</dependencies>
</project>
61 changes: 61 additions & 0 deletions fastjson2/src/main/java/feign/fastjson2/Fastjson2Decoder.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*
* Copyright 2012-2024 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.fastjson2;

import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONException;
import com.alibaba.fastjson2.JSONReader;
import feign.FeignException;
import feign.Response;
import feign.Util;
import feign.codec.Decoder;
import java.io.IOException;
import java.io.Reader;
import java.lang.reflect.Type;
import static feign.Util.ensureClosed;

/**
* @author changjin wei(魏昌进)
*/
public class Fastjson2Decoder implements Decoder {

private final JSONReader.Feature[] features;

public Fastjson2Decoder() {
this(new JSONReader.Feature[0]);
}

public Fastjson2Decoder(JSONReader.Feature[] features) {
this.features = features;
}

@Override
public Object decode(Response response, Type type) throws IOException, FeignException {
if (response.status() == 404 || response.status() == 204)
return Util.emptyValueOf(type);
if (response.body() == null)
return null;
Reader reader = response.body().asReader(response.charset());
try {
return JSON.parseObject(reader, type, features);
} catch (JSONException e) {
if (e.getCause() != null && e.getCause() instanceof IOException) {
throw IOException.class.cast(e.getCause());
}
throw e;
} finally {
ensureClosed(reader);
}
}
}
44 changes: 44 additions & 0 deletions fastjson2/src/main/java/feign/fastjson2/Fastjson2Encoder.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
* Copyright 2012-2024 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.fastjson2;

import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONWriter;
import feign.RequestTemplate;
import feign.Util;
import feign.codec.EncodeException;
import feign.codec.Encoder;
import java.lang.reflect.Type;

/**
* @author changjin wei(魏昌进)
*/
public class Fastjson2Encoder implements Encoder {

private final JSONWriter.Feature[] features;

public Fastjson2Encoder() {
this(new JSONWriter.Feature[0]);
}

public Fastjson2Encoder(JSONWriter.Feature[] features) {
this.features = features;
}

@Override
public void encode(Object object, Type bodyType, RequestTemplate template)
throws EncodeException {
template.body(JSON.toJSONBytes(object, features), Util.UTF_8);
}
}
187 changes: 187 additions & 0 deletions fastjson2/src/test/java/feign/fastjson2/FastJsonCodecTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
/*
* Copyright 2012-2024 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.fastjson2;

import static feign.Util.UTF_8;
import static feign.assertj.FeignAssertions.assertThat;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import com.alibaba.fastjson2.TypeReference;
import org.junit.jupiter.api.Test;
import feign.Request;
import feign.RequestTemplate;
import feign.Response;
import feign.Util;

/**
* @author changjin wei(魏昌进)
*/
@SuppressWarnings("deprecation")
class FastJsonCodecTest {

private String zonesJson = ""//
+ "[" + System.lineSeparator() //
+ " {" + System.lineSeparator() //
+ " \"name\": \"denominator.io.\"" + System.lineSeparator()//
+ " }," + System.lineSeparator()//
+ " {" + System.lineSeparator()//
+ " \"name\": \"denominator.io.\"," + System.lineSeparator()//
+ " \"id\": \"ABCD\"" + System.lineSeparator()//
+ " }" + System.lineSeparator()//
+ "]" + System.lineSeparator();

@Test
void encodesMapObjectNumericalValuesAsInteger() {
Map<String, Object> map = new LinkedHashMap<>();
map.put("foo", 1);

RequestTemplate template = new RequestTemplate();
new Fastjson2Encoder().encode(map, map.getClass(), template);

assertThat(template).hasBody(""//
+ "{" //
+ "\"foo\":1" //
+ "}");
}

@Test
void encodesFormParams() {
Map<String, Object> form = new LinkedHashMap<>();
form.put("foo", 1);
form.put("bar", Arrays.asList(2, 3));

RequestTemplate template = new RequestTemplate();
new Fastjson2Encoder().encode(form, new TypeReference<Map<String, ?>>() {}.getType(), template);

assertThat(template).hasBody(""//
+ "{" //
+ "\"foo\":1,"//
+ "\"bar\":[2,3]"//
+ "}");
}

@Test
void decodes() throws Exception {
List<Zone> zones = new LinkedList<>();
zones.add(new Zone("denominator.io."));
zones.add(new Zone("denominator.io.", "ABCD"));

Response response = Response.builder()
.status(200)
.reason("OK")
.request(Request.create(Request.HttpMethod.GET, "/api", Collections.emptyMap(), null,
Util.UTF_8))
.headers(Collections.emptyMap())
.body(zonesJson, UTF_8)
.build();
assertThat(
new Fastjson2Decoder().decode(response, new TypeReference<List<Zone>>() {}.getType()))
.isEqualTo(zones);
}

@Test
void nullBodyDecodesToNull() throws Exception {
Response response = Response.builder()
.status(204)
.reason("OK")
.request(Request.create(Request.HttpMethod.GET, "/api", Collections.emptyMap(), null,
Util.UTF_8))
.headers(Collections.emptyMap())
.build();
assertThat(new Fastjson2Decoder().decode(response, String.class)).isNull();
}

@Test
void emptyBodyDecodesToNull() throws Exception {
Response response = Response.builder()
.status(204)
.reason("OK")
.request(Request.create(Request.HttpMethod.GET, "/api", Collections.emptyMap(), null,
Util.UTF_8))
.headers(Collections.emptyMap())
.body(new byte[0])
.build();
assertThat(new Fastjson2Decoder().decode(response, String.class)).isNull();
}


@Test
void decoderCharset() throws IOException {
Zone zone = new Zone("denominator.io.", "ÁÉÍÓÚÀÈÌÒÙÄËÏÖÜÑ");

Map<String, Collection<String>> headers = new HashMap<>();
headers.put("Content-Type", Arrays.asList("application/json;charset=ISO-8859-1"));

Response response = Response.builder()
.status(200)
.reason("OK")
.request(Request.create(Request.HttpMethod.GET, "/api", Collections.emptyMap(), null,
Util.UTF_8))
.headers(headers)
.body(new String("" //
+ "{"
+ " \"name\" : \"DENOMINATOR.IO.\","
+ " \"id\" : \"ÁÉÍÓÚÀÈÌÒÙÄËÏÖÜÑ\""
+ "}").getBytes(StandardCharsets.ISO_8859_1))
.build();
assertThat(
((Zone) new Fastjson2Decoder().decode(response, new TypeReference<Zone>() {}.getType())))
.containsEntry("id", zone.get("id"));
}

static class Zone extends LinkedHashMap<String, Object> {

private static final long serialVersionUID = 1L;

Zone() {
// for reflective instantiation.
}

Zone(String name) {
this(name, null);
}

Zone(String name, String id) {
put("name", name);
if (id != null) {
put("id", id);
}
}
}



/** Enabled via {@link feign.Feign.Builder#dismiss404()} */
@Test
void notFoundDecodesToEmpty() throws Exception {
Response response = Response.builder()
.status(404)
.reason("NOT FOUND")
.request(Request.create(Request.HttpMethod.GET, "/api", Collections.emptyMap(), null,
Util.UTF_8))
.headers(Collections.emptyMap())
.build();
assertThat((byte[]) new Fastjson2Decoder().decode(response, byte[].class)).isEmpty();
}


}
Loading