Retrofit2调用远程接口

Retrofit2调用远程接口

前言

调用远程接口其中一种实现便是以retrofit2的方式实现，以下笔记备注一下实现步骤。

准备工作

pom文件引入

使用retrofit2需要在pom.xml引入相关依赖

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

<dependency> <groupId>com.google.code.gsongroupId> <artifactId>gsonartifactId> dependency> <dependency> <groupId>com.squareup.okhttp3groupId> <artifactId>okhttpartifactId> <version>3.8.1version> dependency> <dependency> <groupId>com.squareup.okhttp3groupId> <artifactId>logging-interceptorartifactId> <version>3.8.1version> dependency> <dependency> <groupId>com.squareup.retrofit2groupId> <artifactId>retrofitartifactId> <version>2.3.0version> dependency> <dependency> <groupId>com.squareup.retrofit2groupId> <artifactId>converter-gsonartifactId> <version>2.3.0version> dependency> <dependency> <groupId>org.apache.httpcomponentsgroupId> <artifactId>httpclientartifactId> <version>4.5.2version> dependency>

工具类编写

这里我们需要一个HttpProxy工具类

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

package com.viroyal.common.http; import okhttp3.OkHttpClient; import okhttp3.ResponseBody; import okhttp3.internal.platform.Platform; import okhttp3.logging.HttpLoggingInterceptor; import org.slf4j.LoggerFactory; import retrofit2.Converter; import retrofit2.Retrofit; import retrofit2.converter.gson.GsonConverterFactory; import javax.net.ssl.SSLSocketFactory; import java.lang.annotation.Annotation; import java.lang.reflect.Type; import java.util.HashMap; import java.util.Map; public class HttpProxy { private static org.slf4j.Logger logger = LoggerFactory.getLogger(HttpProxy.class); public static final HttpProxy INSTANCE = new HttpProxy(); private static Map, Object> HTTP_PROXIES_MAP = new HashMap<>(); private static Map, Object> HTTPS_PROXIES_MAP = new HashMap<>(); /** * @param clazz * @param host * @param * @return */ public synchronized Object getApiProxy(Class clazz, String host) { if (HTTP_PROXIES_MAP.containsKey(clazz)) { return HTTP_PROXIES_MAP.get(clazz); } HttpLoggingInterceptor logInterceptor = new HttpLoggingInterceptor((String s) -> { }); logInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY); OkHttpClient okHttpClient = new OkHttpClient.Builder().addInterceptor(logInterceptor).build(); Retrofit retrofitUser = new Retrofit.Builder() .baseUrl(host) .client(okHttpClient) .addConverterFactory(new EmptyBodyConverterFactory()) .addConverterFactory(GsonConverterFactory.create()) .build(); Object apiProxy = retrofitUser.create(clazz); HTTP_PROXIES_MAP.put(clazz, apiProxy); return apiProxy; } /** * @param clazz * @param host * @param sslSocketFactory * @param * @return */ public synchronized Object getApiProxy( Class clazz, String host, SSLSocketFactory sslSocketFactory) { if (HTTPS_PROXIES_MAP.containsKey(clazz)) { return HTTPS_PROXIES_MAP.get(clazz); } HttpLoggingInterceptor logInterceptor = new HttpLoggingInterceptor((String s) -> { }); logInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY); OkHttpClient okHttpClient = new OkHttpClient.Builder() .addInterceptor(logInterceptor) .sslSocketFactory(sslSocketFactory, Platform.get().trustManager(sslSocketFactory)) .hostnameVerifier((String, SSLSession) -> { logger.debug("ssl hostname verifier with host: {}", host); return true; }).build(); Retrofit retrofitUser = new Retrofit.Builder() .baseUrl(host) .client(okHttpClient) .addConverterFactory(new EmptyBodyConverterFactory()) .addConverterFactory(GsonConverterFactory.create()) .build(); Object apiProxy = retrofitUser.create(clazz); HTTPS_PROXIES_MAP.put(clazz, apiProxy); return apiProxy; } class EmptyBodyConverterFactory extends Converter.Factory { @Override public Converter responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) { return (ResponseBody body) -> { if (body.contentLength() == 0) return null; return retrofit.nextResponseBodyConverter(this, type, annotations).convert(body); }; } } }

接口声明

把需要引用的接口api完成，其中除了@POST还包括@GET等注解。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

package com.viroyal.user.command; import retrofit2.Call; import retrofit2.http.Body; import retrofit2.http.Header; import retrofit2.http.POST; public interface ApiCommand { @POST("/unified/message/v1/msg/deliver") Call

http实现

此处，由于host为http请求，所以不需要SSLSocketFactory(https跳过安全验证的工厂)

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

package com.viroyal.user.command; import com.google.gson.Gson; import com.viroyal.common.http.HttpProxy; import com.viroyal.common.pojo.ExtraResponse; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Component; import retrofit2.Response; import java.io.IOException; import java.util.HashMap; import java.util.Map; /** * Created by toughChow * 2019-03-08 14:36 */ @Component public class MessageDeliverCommand { Logger logger = LoggerFactory.getLogger(this.getClass()); @Value("${msg_host}") protected String msgHost; @Value("${auth_key}") protected String authKey; @Value("${auth_secret}") protected String authSecret; @Value("${app_id}") protected String appId; @Value("${mdc_value}") protected String mdcValue; public Object smokeSensorNotification(String phone, String position, String imei) throws IOException { Map map = new HashMap(); map.put("type", 0); map.put("action", "smoker_sensor"); map.put("mobile", phone); map.put("param", position + "," + imei); logger.info("Smoke sensor: post cmd with body : {}", new Gson().toJson(map)); ApiCommand apiCommand = (ApiCommand) HttpProxy.INSTANCE.getApiProxy(ApiCommand.class, msgHost); Response

https实现

若host为https则需要注入javax.net.ssl.SSLSocketFactory

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

package com.viroyal.user.command; import com.google.gson.Gson; import com.viroyal.common.http.HttpProxy; import com.viroyal.common.pojo.ExtraResponse; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Component; import retrofit2.Response; import javax.net.ssl.SSLSocketFactory import java.io.IOException; import java.util.HashMap; import java.util.Map; /** * Created by toughChow * 2019-03-08 14:36 */ @Component public class MessageDeliverCommand { Logger logger = LoggerFactory.getLogger(this.getClass()); @Value("${msg_host}") protected String msgHost; @Value("${auth_key}") protected String authKey; @Value("${auth_secret}") protected String authSecret; @Value("${app_id}") protected String appId; @Value("${mdc_value}") protected String mdcValue; @Autowired private SSLSocketFactory sslSocketFactory; public Object smokeSensorNotification(String phone, String position, String imei) throws IOException { Map map = new HashMap(); map.put("type", 0); map.put("action", "smoker_sensor"); map.put("mobile", phone); map.put("param", position + "," + imei); logger.info("Smoke sensor: post cmd with body : {}", new Gson().toJson(map)); ApiCommand apiCommand = (ApiCommand) HttpProxy.INSTANCE.getApiProxy(ApiCommand.class, msgHost, sslSocketFactory); Response