Skip to content

Improved efficincy of Jakarta REST Response implementation #835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ok2c wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improved efficincy of Jakarta REST Response implementation #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
189 changes: 70 additions & 119 deletions ...jakarta-rest-client/src/main/java/org/apache/hc/client5/http/rest/RestClientResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
import java.time.Instant;
import java.util.Collections;
import java.util.Date;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
Expand All @@ -54,13 +54,16 @@
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.core.NewCookie;
import jakarta.ws.rs.core.Response;

import org.apache.hc.client5.http.utils.DateUtils;
import org.apache.hc.client5.http.validator.ETag;
import org.apache.hc.client5.http.validator.ValidatorType;
import org.apache.hc.core5.http.ContentType;
import org.apache.hc.core5.http.Header;
import org.apache.hc.core5.http.HttpHeaders;
import org.apache.hc.core5.http.HttpResponse;
import org.apache.hc.core5.http.message.MessageSupport;
import org.apache.hc.core5.util.Args;
import org.apache.hc.core5.util.CharArrayBuffer;

/**
* Minimal {@link Response} implementation backed by a consumed {@link JsonNode}
Expand All @@ -83,30 +86,26 @@ final class RestClientResponse extends Response {

private static final byte[] EMPTY = new byte[0];

private final int status;
private final String reasonPhrase;
private final JsonNode body;
private final MediaType mediaType;
private final MultivaluedMap<String, Object> metadata;
private final MultivaluedMap<String, String> stringHeaders;
private final ObjectMapper objectMapper;
private final HttpResponse response;
private final JsonNode body;
private final ContentType contentType;
private final long len;

private boolean closed;
private Object cachedEntity;

RestClientResponse(final HttpResponse response, final JsonNode body, final ObjectMapper objectMapper) {
this.status = response.getCode();
this.reasonPhrase = response.getReasonPhrase();
this.body = body;
RestClientResponse(
final ObjectMapper objectMapper,
final HttpResponse response,
final JsonNode jsonNode,
final ContentType contentType,
final long len) {
this.objectMapper = Args.notNull(objectMapper, "Object mapper");
this.metadata = new MultivaluedHashMap<>();
this.stringHeaders = new MultivaluedHashMap<>();
for (final Header h : response.getHeaders()) {
this.metadata.add(h.getName(), h.getValue());
this.stringHeaders.add(h.getName(), h.getValue());
}
final Header ct = response.getFirstHeader(HttpHeaders.CONTENT_TYPE);
this.mediaType = ct != null ? toMediaType(ContentType.parse(ct.getValue())) : null;
this.response = Args.notNull(response, "Response");
this.contentType = contentType;
this.body = jsonNode;
this.len = len;
}

private static MediaType toMediaType(final ContentType ct) {
Expand All @@ -125,20 +124,21 @@ private static MediaType toMediaType(final ContentType ct) {

@Override
public int getStatus() {
return status;
return response.getCode();
}

@Override
public StatusType getStatusInfo() {
final Status standard = Status.fromStatusCode(status);
final String reason = reasonPhrase != null ? reasonPhrase
final int statusCode = response.getCode();
final Status standard = Status.fromStatusCode(statusCode);
final String reason = response.getReasonPhrase() != null ? response.getReasonPhrase()
: standard != null ? standard.getReasonPhrase() : "";
final Status.Family family = Status.Family.familyOf(status);
final Status.Family family = Status.Family.familyOf(statusCode);
return new StatusType() {

@Override
public int getStatusCode() {
return status;
return statusCode;
}

@Override
Expand All @@ -162,7 +162,7 @@ public Object getEntity() {

@Override
public <T> T readEntity(final Class<T> entityType) {
return readEntity(entityType, (Annotation[]) null);
return readEntity(entityType, null);
}

@Override
Expand Down Expand Up @@ -245,13 +245,7 @@ private byte[] bodyAsBytes() {
}

private Charset charset() {
if (mediaType != null) {
final String cs = mediaType.getParameters().get(MediaType.CHARSET_PARAMETER);
if (cs != null) {
return Charset.forName(cs);
}
}
return StandardCharsets.UTF_8;
return ContentType.getCharset(contentType, StandardCharsets.UTF_8);
}

@Override
Expand All @@ -278,43 +272,25 @@ private void ensureOpen() {

@Override
public MediaType getMediaType() {
return mediaType;
return toMediaType(contentType);
}

@Override
public Locale getLanguage() {
final String lang = getHeaderString(HttpHeaders.CONTENT_LANGUAGE);
return lang != null ? Locale.forLanguageTag(lang) : null;
final Header h = response.getFirstHeader(HttpHeaders.CONTENT_LANGUAGE);
return h != null ? Locale.forLanguageTag(h.getValue()) : null;
}

@Override
public int getLength() {
final String len = getHeaderString(HttpHeaders.CONTENT_LENGTH);
if (len != null) {
try {
return Integer.parseInt(len);
} catch (final NumberFormatException ignore) {
}
}
return hasEntity() ? bodyAsBytes().length : -1;
return (int) len;
}

@Override
public Set<String> getAllowedMethods() {
final List<String> values = headerValues(HttpHeaders.ALLOW);
if (values == null || values.isEmpty()) {
return Collections.emptySet();
}
final Set<String> result = new LinkedHashSet<>();
for (final String v : values) {
for (final String m : v.split(",")) {
final String trimmed = m.trim();
if (!trimmed.isEmpty()) {
result.add(trimmed.toUpperCase(Locale.ROOT));
}
}
}
return result;
final LinkedHashSet<String> allowedMethods = new LinkedHashSet<>();
MessageSupport.parseTokens(response, HttpHeaders.ALLOW, allowedMethods::add);
return allowedMethods;
}

@Override
Expand All @@ -324,51 +300,32 @@ public Map<String, NewCookie> getCookies() {

@Override
public EntityTag getEntityTag() {
final String etag = getHeaderString(HttpHeaders.ETAG);
if (etag == null) {
return null;
}
String raw = etag.trim();
boolean weak = false;
if (raw.startsWith("W/")) {
weak = true;
raw = raw.substring(2).trim();
}
if (raw.length() >= 2 && raw.charAt(0) == '"' && raw.charAt(raw.length() - 1) == '"') {
raw = raw.substring(1, raw.length() - 1);
}
return new EntityTag(raw, weak);
final ETag eTag = ETag.get(response);
return eTag != null ? new EntityTag(eTag.getValue(), eTag.getType() == ValidatorType.WEAK) : null;
}

@Override
public Date getDate() {
return parseHttpDate(getHeaderString(HttpHeaders.DATE));
final Instant instant = DateUtils.parseStandardDate(response, HttpHeaders.DATE);
return instant != null ? Date.from(instant) : null;
}

@Override
public Date getLastModified() {
return parseHttpDate(getHeaderString(HttpHeaders.LAST_MODIFIED));
}

private static Date parseHttpDate(final String value) {
if (value == null) {
return null;
}
final Instant instant = DateUtils.parseDate(value, DateUtils.STANDARD_PATTERNS);
final Instant instant = DateUtils.parseStandardDate(response, HttpHeaders.LAST_MODIFIED);
return instant != null ? Date.from(instant) : null;
}

@Override
public URI getLocation() {
final String loc = getHeaderString(HttpHeaders.LOCATION);
if (loc == null) {
return null;
}
try {
return new URI(loc);
} catch (final URISyntaxException ex) {
return null;
final Header h = response.getFirstHeader(HttpHeaders.LOCATION);
if (h != null) {
try {
return new URI(h.getValue());
} catch (final URISyntaxException ignore) {
}
}
return null;
}

@Override
Expand All @@ -394,52 +351,46 @@ public Link.Builder getLinkBuilder(final String relation) {

@Override
public MultivaluedMap<String, Object> getMetadata() {
return metadata;
final MultivaluedMap<String, Object> multimap = new MultivaluedHashMap<>();
for (final Iterator<Header> it = response.headerIterator(); it.hasNext(); ) {
final Header h = it.next();
multimap.add(h.getName(), h.getValue());
}
return multimap;
}

@Override
public MultivaluedMap<String, String> getStringHeaders() {
return stringHeaders;
final MultivaluedMap<String, String> multimap = new MultivaluedHashMap<>();
for (final Iterator<Header> it = response.headerIterator(); it.hasNext(); ) {
final Header h = it.next();
multimap.add(h.getName(), h.getValue());
}
return multimap;
}

@Override
public String getHeaderString(final String name) {
final List<String> values = headerValues(name);
if (values == null || values.isEmpty()) {
final Header[] headers = response.getHeaders(name);
if (headers.length == 0) {
return null;
}
if (values.size() == 1) {
return values.get(0);
}
final StringBuilder sb = new StringBuilder();
for (final String v : values) {
if (sb.length() > 0) {
sb.append(',');
} else if (headers.length == 1) {
return headers[0].getValue();
} else {
final CharArrayBuffer buf = new CharArrayBuffer(128);
buf.append(headers[0].getValue());
for (int i = 1; i < headers.length; i++) {
buf.append(", ");
buf.append(headers[i].getValue());
}
sb.append(v);
}
return sb.toString();
}

private List<String> headerValues(final String name) {
for (final Map.Entry<String, List<String>> entry : stringHeaders.entrySet()) {
if (entry.getKey().equalsIgnoreCase(name)) {
return entry.getValue();
}
return buf.toString();
}
return null;
}

@Override
public String toString() {
final StringBuilder sb = new StringBuilder("RestClientResponse[status=");
sb.append(status);
if (mediaType != null) {
sb.append(", mediaType=").append(mediaType);
}
sb.append(", length=").append(getLength());
sb.append(']');
return sb.toString();
return response.toString();
}

}
30 changes: 24 additions & 6 deletions ...arta-rest-client/src/main/java/org/apache/hc/client5/http/rest/RestInvocationHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
import java.util.concurrent.CompletionException;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.stream.Collectors;

import com.fasterxml.jackson.databind.ObjectMapper;
Expand All @@ -68,7 +69,6 @@
import org.apache.hc.core5.http.nio.entity.StringAsyncEntityProducer;
import org.apache.hc.core5.http.nio.support.BasicRequestProducer;
import org.apache.hc.core5.http.nio.support.BasicResponseConsumer;
import org.apache.hc.core5.jackson2.http.JsonNodeEntityFallbackConsumer;
import org.apache.hc.core5.jackson2.http.JsonObjectEntityProducer;
import org.apache.hc.core5.jackson2.http.JsonResponseConsumers;
import org.apache.hc.core5.net.URIBuilder;
Expand Down Expand Up @@ -183,7 +183,7 @@ private Object executeRequest(final ResourceMethod rm,

final boolean isAsync = isAsync(rm.getMethod());
final Class<?> rawType = resolveResponseType(rm.getMethod(), isAsync);
final CompletableFuture<Object> future = dispatchAsync(rawType, requestProducer);
final Future<?> future = dispatchAsync(rawType, requestProducer);
if (isAsync) {
return future;
}
Expand Down Expand Up @@ -215,7 +215,7 @@ private static Class<?> resolveResponseType(final Method method, final boolean a
return Object.class;
}

private CompletableFuture<Object> dispatchAsync(final Class<?> rawType,
private CompletableFuture<?> dispatchAsync(final Class<?> rawType,
final BasicRequestProducer requestProducer) {
if (rawType == void.class || rawType == Void.class) {
return submit(requestProducer, new BasicResponseConsumer<>(new DiscardingEntityConsumer<>()))
Expand All @@ -225,8 +225,26 @@ private CompletableFuture<Object> dispatchAsync(final Class<?> rawType,
});
}
if (rawType == Response.class) {
return submit(requestProducer, new BasicResponseConsumer<>(new JsonNodeEntityFallbackConsumer(objectMapper)))
.thenApply(result -> new RestClientResponse(result.getHead(), result.getBody(), objectMapper));
final CompletableFuture<Object> cf = new CompletableFuture<>();
httpClient.execute(requestProducer, new RestResponseConsumer(objectMapper), null,
new FutureCallback<>() {

@Override
public void completed(final Response result) {
cf.complete(result);
}

@Override
public void failed(final Exception ex) {
cf.completeExceptionally(ex);
}

@Override
public void cancelled() {
cf.cancel(false);
}
});
return cf;
}
if (rawType == byte[].class) {
return submit(requestProducer, new BasicResponseConsumer<>(new BasicAsyncEntityConsumer()))
Expand Down Expand Up @@ -277,7 +295,7 @@ public void cancelled() {
return cf;
}

private static Object awaitSync(final CompletableFuture<Object> future) {
private static Object awaitSync(final Future<?> future) {
try {
return future.get();
} catch (final ExecutionException ex) {
Expand Down
Loading
Loading