如何使用 Micronaut 客户端注解映射 errorType
How to map errorType using Micronaut client annotation
如何使用 Micronaut 客户端注释映射 errorType,在编程的情况下,我们可以在成功和失败的情况下提供主体类型和 errorType 对象。
以编程方式调用客户端:
import io.micronaut.core.type.Argument;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpResponse;
import io.micronaut.http.MediaType;
import io.micronaut.http.client.DefaultHttpClient;
import io.micronaut.http.client.exceptions.HttpClientResponseException;
import io.micronaut.http.uri.UriBuilder;
import io.reactivex.Single;
import java.net.URL;
@Singleton
public class Test{
public User getUser(String id) {
try {
String uriPath = UriBuilder.of("url")
.queryParam("id", id)
.toString();
DefaultHttpClient httpClient = new DefaultHttpClient(new URL(""),httpClientConfiguration);
Single<HttpResponse<User>> single = Single.fromPublisher(httpClient.exchange(
HttpRequest.GET(uriPath).header(X_REQUEST_ID, REQUEST_ID).accept(MediaType.APPLICATION_JSON_TYPE),
Argument.of(User.class), //bodyType
Argument.of(Object.class) //errorType
));
HttpResponse<User> response = single.blockingGet();
User user = response.body();
return user;
} catch (HttpClientResponseException | Exception e ) {
}
}
}
使用注释调用客户端
import io.micronaut.http.HttpResponse;
import io.micronaut.http.MediaType;
import io.micronaut.http.annotation.Consumes;
import io.micronaut.http.annotation.Get;
import io.micronaut.http.annotation.Header;
import io.micronaut.http.client.annotation.Client;
import io.reactivex.Single;
@Client(value = "url",
path = "/user")
public interface TestClient {
@Get("?id=123")
@Consumes(MediaType.APPLICATION_JSON)
Single<HttpResponse<User>> getUser();
}
根据 Micronaut API 文档,@Client 注释提供了 errorType,它对我处理 errorType 响应很有帮助。
https://docs.micronaut.io/latest/api/index.html
https://docs.micronaut.io/latest/guide/index.html#clientAnnotation
@Client(id="",//The ID of the client
value = "url", //The URL or service ID of the remote service
path = "/user",//The base URI for the client. Only to be used in conjunction with id().
errorType=Object.class,//The type used to decode errors
configuration=<? extends HttpClientConfiguration>//The http client configuration bean to use
)
@Header(name="", value="")
public interface TestClient {
@Get("?id=123")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
Single<HttpResponse<User>> getUser();
}
如果想定义自己的自定义对象为errorType,可以在micronaut中使用声明式客户端时声明如下:
@Client(id="",//The ID of the client
value = "url", //The URL or service ID of the remote service
path = "/user",//The base URI for the client. Only to be used in conjunction with id().
errorType=YourCustomObject.class,//The type used to decode errors
configuration=<? extends HttpClientConfiguration>//The http client configuration bean to use
)
public interface ExternalCallClient{
//some API method
}
然后在您的连接器客户端 class:
class Connect{
@Inject
private ExternalCallClient externalCallClient;
call(){
try{
//call to external API method using externalCallClient
}catch(HttpClientResponseException e){
Optional<YourCustomObject> error = e.getResponse()
.getBody(YourCustomObject.class)
}
}
}
如果底层客户端发生异常,Micronaut 客户端会针对 HTTP 代码(400 和 400 以上(404 除外))抛出 HttpClientResponseException。
因此,如果底层客户端在异常情况下提供自定义错误对象作为响应主体,则此自定义错误类型可用于优雅的错误处理和日志记录。
DefaultHttpClient 也可以使用类似的方法。
如何使用 Micronaut 客户端注释映射 errorType,在编程的情况下,我们可以在成功和失败的情况下提供主体类型和 errorType 对象。
以编程方式调用客户端:
import io.micronaut.core.type.Argument;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpResponse;
import io.micronaut.http.MediaType;
import io.micronaut.http.client.DefaultHttpClient;
import io.micronaut.http.client.exceptions.HttpClientResponseException;
import io.micronaut.http.uri.UriBuilder;
import io.reactivex.Single;
import java.net.URL;
@Singleton
public class Test{
public User getUser(String id) {
try {
String uriPath = UriBuilder.of("url")
.queryParam("id", id)
.toString();
DefaultHttpClient httpClient = new DefaultHttpClient(new URL(""),httpClientConfiguration);
Single<HttpResponse<User>> single = Single.fromPublisher(httpClient.exchange(
HttpRequest.GET(uriPath).header(X_REQUEST_ID, REQUEST_ID).accept(MediaType.APPLICATION_JSON_TYPE),
Argument.of(User.class), //bodyType
Argument.of(Object.class) //errorType
));
HttpResponse<User> response = single.blockingGet();
User user = response.body();
return user;
} catch (HttpClientResponseException | Exception e ) {
}
}
}
使用注释调用客户端
import io.micronaut.http.HttpResponse;
import io.micronaut.http.MediaType;
import io.micronaut.http.annotation.Consumes;
import io.micronaut.http.annotation.Get;
import io.micronaut.http.annotation.Header;
import io.micronaut.http.client.annotation.Client;
import io.reactivex.Single;
@Client(value = "url",
path = "/user")
public interface TestClient {
@Get("?id=123")
@Consumes(MediaType.APPLICATION_JSON)
Single<HttpResponse<User>> getUser();
}
根据 Micronaut API 文档,@Client 注释提供了 errorType,它对我处理 errorType 响应很有帮助。
https://docs.micronaut.io/latest/api/index.html https://docs.micronaut.io/latest/guide/index.html#clientAnnotation
@Client(id="",//The ID of the client
value = "url", //The URL or service ID of the remote service
path = "/user",//The base URI for the client. Only to be used in conjunction with id().
errorType=Object.class,//The type used to decode errors
configuration=<? extends HttpClientConfiguration>//The http client configuration bean to use
)
@Header(name="", value="")
public interface TestClient {
@Get("?id=123")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
Single<HttpResponse<User>> getUser();
}
如果想定义自己的自定义对象为errorType,可以在micronaut中使用声明式客户端时声明如下:
@Client(id="",//The ID of the client
value = "url", //The URL or service ID of the remote service
path = "/user",//The base URI for the client. Only to be used in conjunction with id().
errorType=YourCustomObject.class,//The type used to decode errors
configuration=<? extends HttpClientConfiguration>//The http client configuration bean to use
)
public interface ExternalCallClient{
//some API method
}
然后在您的连接器客户端 class:
class Connect{
@Inject
private ExternalCallClient externalCallClient;
call(){
try{
//call to external API method using externalCallClient
}catch(HttpClientResponseException e){
Optional<YourCustomObject> error = e.getResponse()
.getBody(YourCustomObject.class)
}
}
}
如果底层客户端发生异常,Micronaut 客户端会针对 HTTP 代码(400 和 400 以上(404 除外))抛出 HttpClientResponseException。 因此,如果底层客户端在异常情况下提供自定义错误对象作为响应主体,则此自定义错误类型可用于优雅的错误处理和日志记录。
DefaultHttpClient 也可以使用类似的方法。