网络请求框架——OkGo解读（三）——request

所有请求的基类，其中泛型R主要用于属性设置方法后，返回对应的子类型，以便于实现链式调用

public abstract class BaseRequest<R extends BaseRequest> {

protected String url;
protected String baseUrl;
protected Object tag;
protected long readTimeOut;
protected long writeTimeOut;
protected long connectTimeout;
protected int retryCount;
protected CacheMode cacheMode;
protected String cacheKey;
protected long cacheTime = CacheEntity.CACHE_NEVER_EXPIRE;      //默认缓存的超时时间
private HttpsUtils.SSLParams sslParams;
protected HostnameVerifier hostnameVerifier;
protected HttpParams params = new HttpParams();                 //添加的param
protected HttpHeaders headers = new HttpHeaders();              //添加的header
protected List<Interceptor> interceptors = new ArrayList<>();   //额外的拦截器
protected List<Cookie> userCookies = new ArrayList<>();         //用户手动添加的Cookie

private AbsCallback mCallback;
private Converter mConverter;
private HttpUrl httpUrl;
private Request mRequest;

public BaseRequest(String url) {
this.url = url;
baseUrl = url;
httpUrl = HttpUrl.parse(url);
OkGo go = OkGo.getInstance();
//默认添加 Accept-Language
String acceptLanguage = HttpHeaders.getAcceptLanguage();
if (!TextUtils.isEmpty(acceptLanguage)) headers(HttpHeaders.HEAD_KEY_ACCEPT_LANGUAGE, acceptLanguage);
//默认添加 User-Agent
String userAgent = HttpHeaders.getUserAgent();
if (!TextUtils.isEmpty(userAgent)) headers(HttpHeaders.HEAD_KEY_USER_AGENT, userAgent);
//添加公共请求参数
if (go.getCommonParams() != null) params.put(go.getCommonParams());
if (go.getCommonHeaders() != null) headers.put(go.getCommonHeaders());
//添加缓存模式
if (go.getCacheMode() != null) cacheMode = go.getCacheMode();
cacheTime = go.getCacheTime();
//超时重试次数
retryCount = go.getRetryCount();
}

@SuppressWarnings("unchecked")
public R url(String url) {
this.url = url;
return (R) this;
}

@SuppressWarnings("unchecked")
public R tag(Object tag) {
this.tag = tag;
return (R) this;
}

@SuppressWarnings("unchecked")
public R readTimeOut(long readTimeOut) {
this.readTimeOut = readTimeOut;
return (R) this;
}

@SuppressWarnings("unchecked")
public R writeTimeOut(long writeTimeOut) {
this.writeTimeOut = writeTimeOut;
return (R) this;
}

@SuppressWarnings("unchecked")
public R connTimeOut(long connTimeOut) {
this.connectTimeout = connTimeOut;
return (R) this;
}

@SuppressWarnings("unchecked")
public R cacheMode(CacheMode cacheMode) {
this.cacheMode = cacheMode;
return (R) this;
}

@SuppressWarnings("unchecked")
public R cacheKey(String cacheKey) {
this.cacheKey = cacheKey;
return (R) this;
}

/** 传入 -1 表示永久有效,默认值即为 -1 */
@SuppressWarnings("unchecked")
public R cacheTime(long cacheTime) {
if (cacheTime <= -1) cacheTime = CacheEntity.CACHE_NEVER_EXPIRE;
this.cacheTime = cacheTime;
return (R) this;
}

@SuppressWarnings("unchecked")
public R setCertificates(InputStream... certificates) {
sslParams = HttpsUtils.getSslSocketFactory(null, null, certificates);
return (R) this;
}

@SuppressWarnings("unchecked")
public R setCertificates(InputStream bksFile, String password, InputStream... certificates) {
sslParams = HttpsUtils.getSslSocketFactory(bksFile, password, certificates);
return (R) this;
}

@SuppressWarnings("unchecked")
public R setHostnameVerifier(HostnameVerifier hostnameVerifier) {
this.hostnameVerifier = hostnameVerifier;
return (R) this;
}

@SuppressWarnings("unchecked")
public R headers(HttpHeaders headers) {
this.headers.put(headers);
return (R) this;
}

@SuppressWarnings("unchecked")
public R headers(String key, String value) {
headers.put(key, value);
return (R) this;
}

@SuppressWarnings("unchecked")
public R removeHeader(String key) {
headers.remove(key);
return (R) this;
}

@SuppressWarnings("unchecked")
public R removeAllHeaders() {
headers.clear();
return (R) this;
}

@SuppressWarnings("unchecked")
public R params(HttpParams params) {
this.params.put(params);
return (R) this;
}

@SuppressWarnings("unchecked")
public R params(Map<String, String> params, boolean... isReplace) {
this.params.put(params, isReplace);
return (R) this;
}

@SuppressWarnings("unchecked")
public R params(String key, String value, boolean... isReplace) {
params.put(key, value, isReplace);
return (R) this;
}

@SuppressWarnings("unchecked")
public R params(String key, int value, boolean... isReplace) {
params.put(key, value, isReplace);
return (R) this;
}

@SuppressWarnings("unchecked")
public R params(String key, float value, boolean... isReplace) {
params.put(key, value, isReplace);
return (R) this;
}

@SuppressWarnings("unchecked")
public R params(String key, double value, boolean... isReplace) {
params.put(key, value, isReplace);
return (R) this;
}

@SuppressWarnings("unchecked")
public R params(String key, long value, boolean... isReplace) {
params.put(key, value, isReplace);
return (R) this;
}

@SuppressWarnings("unchecked")
public R params(String key, char value, boolean... isReplace) {
params.put(key, value, isReplace);
return (R) this;
}

@SuppressWarnings("unchecked")
public R params(String key, boolean value, boolean... isReplace) {
params.put(key, value, isReplace);
return (R) this;
}

@SuppressWarnings("unchecked")
public R addUrlParams(String key, List<String> values) {
params.putUrlParams(key, values);
return (R) this;
}

@SuppressWarnings("unchecked")
public R removeParam(String key) {
params.remove(key);
return (R) this;
}

@SuppressWarnings("unchecked")
public R removeAllParams() {
params.clear();
return (R) this;
}

@SuppressWarnings("unchecked")
public R addCookie(String name, String value) {
Cookie.Builder builder = new Cookie.Builder();
Cookie cookie = builder.name(name).value(value).domain(httpUrl.host()).build();
userCookies.add(cookie);
return (R) this;
}

@SuppressWarnings("unchecked")
public R addCookie(Cookie cookie) {
userCookies.add(cookie);
return (R) this;
}

@SuppressWarnings("unchecked")
public R addCookies(List<Cookie> cookies) {
userCookies.addAll(cookies);
return (R) this;
}

@SuppressWarnings("unchecked")
public R setCallback(AbsCallback callback) {
this.mCallback = callback;
return (R) this;
}

@SuppressWarnings("unchecked")
public R addInterceptor(Interceptor interceptor) {
interceptors.add(interceptor);
return (R) this;
}

/** 默认返回第一个参数 */
public String getUrlParam(String key) {
List<String> values = params.urlParamsMap.get(key);
if (values != null && values.size() > 0) return values.get(0);
return null;
}

/** 默认返回第一个参数 */
public HttpParams.FileWrapper getFileParam(String key) {
List<HttpParams.FileWrapper> values = params.fileParamsMap.get(key);
if (values != null && values.size() > 0) return values.get(0);
return null;
}

public HttpParams getParams() {
return params;
}

public HttpHeaders getHeaders() {
return headers;
}

public String getUrl() {
return url;
}

public String getBaseUrl() {
return baseUrl;
}

public Object getTag() {
return tag;
}

public CacheMode getCacheMode() {
return cacheMode;
}

public void setCacheMode(CacheMode cacheMode) {
this.cacheMode = cacheMode;
}

public String getCacheKey() {
return cacheKey;
}

public void setCacheKey(String cacheKey) {
this.cacheKey = cacheKey;
}

public long getCacheTime() {
return cacheTime;
}

public int getRetryCount() {
return retryCount;
}

public Request getRequest() {
return mRequest;
}

public AbsCallback getCallback() {
return mCallback;
}

public Converter getConverter() {
return mConverter;
}

/**
* 返回当前的请求方法
* GET,POST,HEAD,PUT,DELETE,OPTIONS
*/
public String getMethod() {
return mRequest.method();
}

/** 根据不同的请求方式和参数，生成不同的RequestBody */
public abstract RequestBody generateRequestBody();

/** 对请求body进行包装，用于回调上传进度 */
public RequestBody wrapRequestBody(RequestBody requestBody) {
ProgressRequestBody progressRequestBody = new ProgressRequestBody(requestBody);
progressRequestBody.setListener(new ProgressRequestBody.Listener() {
@Override
public void onRequestProgress(final long bytesWritten, final long contentLength, final long networkSpeed) {
OkGo.getInstance().getDelivery().post(new Runnable() {
@Override
public void run() {
if (mCallback != null) mCallback.upProgress(bytesWritten, contentLength, bytesWritten * 1.0f / contentLength, networkSpeed);
}
});
}
});
return progressRequestBody;
}

/** 根据不同的请求方式，将RequestBody转换成Request对象 */
public abstract Request generateRequest(RequestBody requestBody);

/** 根据当前的请求参数，生成对应的 Call 任务 */
public okhttp3.Call generateCall(Request request) {
mRequest = request;
if (readTimeOut <= 0 && writeTimeOut <= 0 && connectTimeout <= 0 && sslParams == null && userCookies.size() == 0) {
return OkGo.getInstance().getOkHttpClient().newCall(request);
} else {
OkHttpClient.Builder newClientBuilder = OkGo.getInstance().getOkHttpClient().newBuilder();
if (readTimeOut > 0) newClientBuilder.readTimeout(readTimeOut, TimeUnit.MILLISECONDS);
if (writeTimeOut > 0) newClientBuilder.writeTimeout(writeTimeOut, TimeUnit.MILLISECONDS);
if (connectTimeout > 0) newClientBuilder.connectTimeout(connectTimeout, TimeUnit.MILLISECONDS);
if (hostnameVerifier != null) newClientBuilder.hostnameVerifier(hostnameVerifier);
if (sslParams != null) newClientBuilder.sslSocketFactory(sslParams.sSLSocketFactory, sslParams.trustManager);
if (userCookies.size() > 0) OkGo.getInstance().getCookieJar().addCookies(userCookies);
if (interceptors.size() > 0) {
for (Interceptor interceptor : interceptors) {
newClientBuilder.addInterceptor(interceptor);
}
}
return newClientBuilder.build().newCall(request);
}
}

/** 获取同步call对象 */
public okhttp3.Call getCall() {
//构建请求体，返回call对象
RequestBody requestBody = generateRequestBody();
mRequest = generateRequest(wrapRequestBody(requestBody));
return generateCall(mRequest);
}

/** Rx支持,获取同步call对象 */
public <T> Call<T> getCall(Converter<T> converter) {
mConverter = converter;
return DefaultCallAdapter.<T>create().adapt(new CacheCall<T>(this));
}

/** Rx支持,获取同步call对象 */
public <T, E> E getCall(Converter<T> converter, CallAdapter<E> adapter) {
mConverter = converter;
return adapter.adapt(getCall(converter));
}

/** 普通调用，阻塞方法，同步请求执行 */
public Response execute() throws IOException {
return getCall().execute();
}

/** 非阻塞方法，异步请求，但是回调在子线程中执行 */
@SuppressWarnings("unchecked")
public <T> void execute(AbsCallback<T> callback) {
mCallback = callback;
mConverter = callback;
new CacheCall<T>(this).execute(callback);
}
}

HttpsUtils：   

public abstract class SSLSocketFactory extends SocketFactory {
public SSLSocketFactory() {
throw new RuntimeException("Stub!");
}
// 第一次调用此方法时，将检查安全属性 "ssl.SocketFactory.provider"。

// 如果它不为 null，则加载并实例化使用该名称的类。

// 如果成功并且该对象是 SSLSocketFactory 的实例，则它成为默认的 SSL 套接字工厂。
public static synchronized SocketFactory getDefault() {
throw new RuntimeException("Stub!");
}

// 返回默认情况下启用的密码套件的列表。

// 除非启用了不同的列表，否则 SSL 连接上的联络将使用这些密码套件中的一个。

// 这些默认值的最低服务质量是要求保护机密性和服务器验证（也就是说没有匿名的密码套件）。

public abstract String[] getDefaultCipherSuites();

// 返回可以在 SSL 连接上启用的密码套件的名称。

// 通常，因为此列表可能包含不能满足这些默认值的服务质量要求的密码套件，所以默认情况下只能实际启用它们的子集。

//这种密码套件在专门的应用程序中才能有用。

public abstract String[] getSupportedCipherSuites();

// 返回在连接到指定主机的给定端口的现有套接字上分层的套接字。

// 通过代理使用 SSL 或者协商在已有的套接字上使用 SSL 时可以使用此构造方法。

// 主机和端口号指的是逻辑同位体目标。使用为此工厂建立的套接字选项来配置此套接字。
public abstract Socket createSocket(Socket var1, String var2, int var3, boolean var4) throws IOException;
}

 此接口的实例管理使用哪一个 X509 证书来验证远端的安全套接字。决定是根据信任的证书授权、证书撤消列表、在线状态检查或其他方式做出的。

public interface X509TrustManager extends TrustManager {

 //  给出同位体提供的部分或完整的证书链，构建到可信任的根的证书路径，并且返回是否可以确认和信任将其用于基于验证类型的客户端 SSL 验证。
void checkClientTrusted(X509Certificate[] var1, String var2) throws CertificateException;
//  给出同位体提供的部分或完整的证书链，构建到可信任的根的证书路径，并且返回是否可以确认和信任将其用于基于验证类型的服务器 SSL 验证。
void checkServerTrusted(X509Certificate[] var1, String var2) throws CertificateException;
//  返回受验证同位体信任的认证中心的数组。
X509Certificate[] getAcceptedIssuers();
}

/** Https相关的工具类 */
public class HttpsUtils {

public static class SSLParams {
public SSLSocketFactory sSLSocketFactory;
public X509TrustManager trustManager;
}

public static SSLParams getSslSocketFactory(InputStream bksFile, String password, InputStream[] certificates) {
SSLParams sslParams = new SSLParams();
try {
KeyManager[] keyManagers = prepareKeyManager(bksFile, password);
TrustManager[] trustManagers = prepareTrustManager(certificates);
SSLContext sslContext = SSLContext.getInstance("TLS");
X509TrustManager trustManager;
if (trustManagers != null) {
trustManager = new MyTrustManager(chooseTrustManager(trustManagers));
} else {
trustManager = new UnSafeTrustManager();
}
sslContext.init(keyManagers, new TrustManager[]{trustManager}, null);
sslParams.sSLSocketFactory = sslContext.getSocketFactory();
sslParams.trustManager = trustManager;
return sslParams;
} catch (NoSuchAlgorithmException e) {
throw new AssertionError(e);
} catch (KeyManagementException e) {
throw new AssertionError(e);
} catch (KeyStoreException e) {
throw new AssertionError(e);
}
}

private static TrustManager[] prepareTrustManager(InputStream... certificates) {
if (certificates == null || certificates.length <= 0) return null;
try {
CertificateFactory certificateFactory = CertificateFactory.getInstance("X.509");
KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
keyStore.load(null);
int index = 0;
for (InputStream certificate : certificates) {
String certificateAlias = Integer.toString(index++);
keyStore.setCertificateEntry(certificateAlias, certificateFactory.generateCertificate(certificate));
try {
if (certificate != null) certificate.close();
} catch (IOException e) {
OkLogger.e(e);
}
}
TrustManagerFactory trustManagerFactory;
trustManagerFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
trustManagerFactory.init(keyStore);
return trustManagerFactory.getTrustManagers();
} catch (NoSuchAlgorithmException e) {
OkLogger.e(e);
} catch (CertificateException e) {
OkLogger.e(e);
} catch (KeyStoreException e) {
OkLogger.e(e);
} catch (Exception e) {
OkLogger.e(e);
}
return null;
}

private static KeyManager[] prepareKeyManager(InputStream bksFile, String password) {
try {
if (bksFile == null || password == null) return null;
KeyStore clientKeyStore = KeyStore.getInstance("BKS");
clientKeyStore.load(bksFile, password.toCharArray());
KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm());
keyManagerFactory.init(clientKeyStore, password.toCharArray());
return keyManagerFactory.getKeyManagers();
} catch (KeyStoreException e) {
OkLogger.e(e);
} catch (NoSuchAlgorithmException e) {
OkLogger.e(e);
} catch (UnrecoverableKeyException e) {
OkLogger.e(e);
} catch (CertificateException e) {
OkLogger.e(e);
} catch (IOException e) {
OkLogger.e(e);
} catch (Exception e) {
OkLogger.e(e);
}
return null;
}

private static X509TrustManager chooseTrustManager(TrustManager[] trustManagers) {
for (TrustManager trustManager : trustManagers) {
if (trustManager instanceof X509TrustManager) {
return (X509TrustManager) trustManager;
}
}
return null;
}

private static class UnSafeTrustManager implements X509TrustManager {
@Override
public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {
}

@Override
public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {
}

@Override
public X509Certificate[] getAcceptedIssuers() {
return new java.security.cert.X509Certificate[]{};
}
}

private static class MyTrustManager implements X509TrustManager {
private X509TrustManager defaultTrustManager;
private X509TrustManager localTrustManager;

public MyTrustManager(X509TrustManager localTrustManager) throws NoSuchAlgorithmException, KeyStoreException {
TrustManagerFactory var4 = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
var4.init((KeyStore) null);
defaultTrustManager = chooseTrustManager(var4.getTrustManagers());
this.localTrustManager = localTrustManager;
}

@Override
public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {

}

@Override
public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {
try {
defaultTrustManager.checkServerTrusted(chain, authType);
} catch (CertificateException ce) {
localTrustManager.checkServerTrusted(chain, authType);
}
}

@Override
public X509Certificate[] getAcceptedIssuers() {
return new X509Certificate[0];
}
}
}

/**
* ================================================
* 作    者：jeasonlzy（廖子尧）Github地址：https://github.com/jeasonlzy0216
* 版    本：1.0
* 创建日期：16/8/9
* 描    述：表示当前请求是否具有请求体
* 修订历史：
* ================================================
*/
public interface HasBody<R> {
R requestBody(RequestBody requestBody);

R params(String key, File file);

R addFileParams(String key, List<File> files);

R addFileWrapperParams(String key, List<HttpParams.FileWrapper> fileWrappers);

R params(String key, File file, String fileName);

R params(String key, File file, String fileName, MediaType contentType);

R upString(String string);

R upJson(String json);

R upBytes(byte[] bs);
}