afinal框架網絡

請求網絡的方式感受平時漏掉了不少:java

/**
 * Copyright (c) 2012-2013, Michael Yang 楊福海 (www.yangfuhai.com).
 *
 * 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 net.tsz.afinal;node

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.Executor;
import java.util.concurrent.Executors;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.zip.GZIPInputStream;ajax

import net.tsz.afinal.http.AjaxCallBack;
import net.tsz.afinal.http.AjaxParams;
import net.tsz.afinal.http.HttpHandler;
import net.tsz.afinal.http.RetryHandler;
import net.tsz.afinal.http.SyncRequestHandler;算法

import org.apache.http.Header;
import org.apache.http.HeaderElement;
import org.apache.http.HttpEntity;
import org.apache.http.HttpRequest;
import org.apache.http.HttpRequestInterceptor;
import org.apache.http.HttpResponse;
import org.apache.http.HttpResponseInterceptor;
import org.apache.http.HttpVersion;
import org.apache.http.client.CookieStore;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.protocol.ClientContext;
import org.apache.http.conn.params.ConnManagerParams;
import org.apache.http.conn.params.ConnPerRouteBean;
import org.apache.http.conn.scheme.PlainSocketFactory;
import org.apache.http.conn.scheme.Scheme;
import org.apache.http.conn.scheme.SchemeRegistry;
import org.apache.http.conn.ssl.SSLSocketFactory;
import org.apache.http.entity.HttpEntityWrapper;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager;
import org.apache.http.params.BasicHttpParams;
import org.apache.http.params.HttpParams;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpProtocolParams;
import org.apache.http.protocol.BasicHttpContext;
import org.apache.http.protocol.HttpContext;
import org.apache.http.protocol.SyncBasicHttpContext;express

public class FinalHttp {apache

 private static final int DEFAULT_SOCKET_BUFFER_SIZE = 8 * 1024; //8KB
 private static final String HEADER_ACCEPT_ENCODING = "Accept-Encoding";
 private static final String ENCODING_GZIP = "gzip";安全

 private static int maxConnections = 10; //http請求最大併發鏈接數
 private static int socketTimeout = 10 * 1000; //超時時間,默認10秒
 private static int maxRetries = 5;//錯誤嘗試次數,錯誤異常表請在RetryHandler添加
 private static int httpThreadCount = 3;//http線程池數量服務器

 private final DefaultHttpClient httpClient;
 private final HttpContext httpContext;
 private String charset = "utf-8";cookie

 private final Map<String, String> clientHeaderMap;
 //工廠模式
 private static final ThreadFactory  sThreadFactory = new ThreadFactory() {
  //保證現場安全,至關實用synchronized在++中保證線程安全 mCount=1
  private final AtomicInteger mCount = new AtomicInteger(1);
  public Thread newThread(Runnable r) {
   //getAndIncrement()以原子方式將當前值加 1。
   Thread tread = new Thread(r, "FinalHttp #" + mCount.getAndIncrement());
   //設置線程優先級比普通線程優先級低,目的還不瞭解
   tread.setPriority(Thread.NORM_PRIORITY - 1);
   return tread;
  }
 };
 //線程池放三條線程
 private static final Executor executor =Executors.newFixedThreadPool(httpThreadCount, sThreadFactory);網絡

 public FinalHttp() {
  //這個類表明HTTP協議參數的集合。協議參數可能鏈接在一塊兒造成一個層次結構。若是一個特定的參數值沒有明肯定義在集合自己,它的價值未來自父母的參數集合。
  BasicHttpParams httpParams = new BasicHttpParams();


  // ConnManagerParams這個類表明HTTP協議的集合參數適用於客戶端鏈接管理器。
  //•'http.socket.timeout':定義了套接字的毫秒級超時時間(SO_TIMEOUT),這就是等待數據,換句話說,在兩個連續的數據包之間最大的閒置時間。若是超時時間是0就解釋爲是一個無限大的超時時間。這個參數指望獲得一個java.lang.Integer類型的值。若是這個參數沒有被設置,那麼讀取操做就不會超時(無限大的超時時間)。
  //       這定義了從ConnectionManager管理的鏈接池中取出鏈接的超時時間
  ConnManagerParams.setTimeout(httpParams, socketTimeout);
  //每一個路由接口容許最大鏈接數。
  ConnManagerParams.setMaxConnectionsPerRoute(httpParams, new ConnPerRouteBean(maxConnections));
  // 設置容許的最大鏈接數。
  ConnManagerParams.setMaxTotalConnections(httpParams, 10);


  // 這定義了Socket讀數據的超時時間,即從服務器獲取響應數據須要等待的時間
  HttpConnectionParams.setSoTimeout(httpParams, socketTimeout);
  // 這定義了經過網絡與服務器創建鏈接的超時時間。Httpclient包中經過一個異步線程去建立與服務器的socket鏈接,這就是該socket鏈接的超時時間
  HttpConnectionParams.setConnectionTimeout(httpParams, socketTimeout);
  // •'http.tcp.nodelay':決定了是否使用Nagle算法。Nagle算法視圖經過最小化發送的分組數量來節省帶寬。當應用程序但願下降網絡延遲並提升性能時,它們能夠關閉Nagle算法(也就是開啓TCP_NODELAY)。數據將會更早發送,增長了帶寬消耗的成文。這個參數指望獲得一個java.lang.Boolean類型的值。若是這個參數沒有被設置,那麼TCP_NODELAY就會開啓(無延遲)。
  HttpConnectionParams.setTcpNoDelay(httpParams, true);
  HttpConnectionParams.setSocketBufferSize(httpParams, DEFAULT_SOCKET_BUFFER_SIZE);
  HttpProtocolParams.setVersion(httpParams, HttpVersion.HTTP_1_1);

  /* 設置咱們的HttpClient支持HTTP和HTTPS兩種模式 */
  //Scheme類表明了一個協議模式,好比「http」或「https」同時包含一些協議屬性,好比默認端口,用來爲給定協議建立java.net.Socket實例的套接字工廠。SchemeRegistry類用來維持一組Scheme,當去經過請求URI創建鏈接時,HttpClient能夠從中選擇:
  SchemeRegistry schemeRegistry = new SchemeRegistry();
  // PlainSocketFactory是建立和初始化普通的(不加密的)套接字的默認工廠。
  schemeRegistry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), 80));
  //HttpClient使用SSLSocketFactory來建立SSL鏈接。SSLSocketFactory容許高度定製
  schemeRegistry.register(new Scheme("https", SSLSocketFactory.getSocketFactory(), 443));
  //implements ClientConnectionManager 建立一個新的線程安全的鏈接管理器。
  ThreadSafeClientConnManager cm = new ThreadSafeClientConnManager(httpParams, schemeRegistry);

  httpContext = new SyncBasicHttpContext(new BasicHttpContext());
  httpClient = new DefaultHttpClient(cm, httpParams);
  httpClient.addRequestInterceptor(new HttpRequestInterceptor() {
   public void process(HttpRequest request, HttpContext context) {
    if (!request.containsHeader(HEADER_ACCEPT_ENCODING)) {
     request.addHeader(HEADER_ACCEPT_ENCODING, ENCODING_GZIP);
    }
    for (String header : clientHeaderMap.keySet()) {
     request.addHeader(header, clientHeaderMap.get(header));
    }
   }
  });

  httpClient.addResponseInterceptor(new HttpResponseInterceptor() {
   public void process(HttpResponse response, HttpContext context) {
    final HttpEntity entity = response.getEntity();
    if (entity == null) {
     return;
    }
    final Header encoding = entity.getContentEncoding();
    if (encoding != null) {
     for (HeaderElement element : encoding.getElements()) {
      if (element.getName().equalsIgnoreCase(ENCODING_GZIP)) {
       response.setEntity(new InflatingEntity(response.getEntity()));
       break;
      }
     }
    }
   }
  });
//重試
  httpClient.setHttpRequestRetryHandler(new RetryHandler(maxRetries));

  clientHeaderMap = new HashMap<String, String>();

 }

 public HttpClient getHttpClient() {
  return this.httpClient;
 }

 public HttpContext getHttpContext() {
  return this.httpContext;
 }

 public void configCharset(String charSet){
  if(charSet!=null && charSet.trim().length()!=0)
   this.charset = charSet;
 }

 public void configCookieStore(CookieStore cookieStore) {
  httpContext.setAttribute(ClientContext.COOKIE_STORE, cookieStore);
 }


 public void configUserAgent(String userAgent) {
  HttpProtocolParams.setUserAgent(this.httpClient.getParams(), userAgent);
 }


 /**
  * 設置網絡鏈接超時時間,默認爲10秒鐘
  * @param timeout
  */
 public void configTimeout(int timeout){
  final HttpParams httpParams = this.httpClient.getParams();
  ConnManagerParams.setTimeout(httpParams, timeout);
  HttpConnectionParams.setSoTimeout(httpParams, timeout);
  HttpConnectionParams.setConnectionTimeout(httpParams, timeout);
 }

 /**
  * 設置https請求時  的 SSLSocketFactory
  * @param sslSocketFactory
  */
 public void configSSLSocketFactory(SSLSocketFactory sslSocketFactory) {
  Scheme scheme = new Scheme("https", sslSocketFactory, 443);
  this.httpClient.getConnectionManager().getSchemeRegistry().register(scheme);
 }

 /**
  * 配置錯誤重試次數
  * @param retry
  */
 public void configRequestExecutionRetryCount(int count){
  this.httpClient.setHttpRequestRetryHandler(new RetryHandler(count));
 }

 /**
  * 添加http請求頭
  * @param header
  * @param value
  */
 public void addHeader(String header, String value) {
  clientHeaderMap.put(header, value);
 }



 //------------------get 請求-----------------------
 public void get( String url, AjaxCallBack<? extends Object> callBack) {
  get( url, null, callBack);
 }

 public void get( String url, AjaxParams params, AjaxCallBack<? extends Object> callBack) {
  sendRequest(httpClient, httpContext, new HttpGet(getUrlWithQueryString(url, params)), null, callBack);
 }

 public void get( String url, Header[] headers, AjaxParams params, AjaxCallBack<? extends Object> callBack) {
  HttpUriRequest request = new HttpGet(getUrlWithQueryString(url, params));
  if(headers != null) request.setHeaders(headers);
  sendRequest(httpClient, httpContext, request, null, callBack);
 }

 public Object getSync( String url) {
  return getSync( url, null);
 }

 public Object getSync( String url, AjaxParams params) {
  HttpUriRequest request = new HttpGet(getUrlWithQueryString(url, params));
  return sendSyncRequest(httpClient, httpContext, request, null);
 }


 public Object getSync( String url, Header[] headers, AjaxParams params) {
  HttpUriRequest request = new HttpGet(getUrlWithQueryString(url, params));
  if(headers != null) request.setHeaders(headers);
  return sendSyncRequest(httpClient, httpContext, request, null);
 }


 //------------------post 請求-----------------------
 public void post(String url, AjaxCallBack<? extends Object> callBack) {
  post(url, null, callBack);
 }

 public void post(String url, AjaxParams params, AjaxCallBack<? extends Object> callBack) {
  post(url, paramsToEntity(params), null, callBack);
 }

 public void post( String url, HttpEntity entity, String contentType, AjaxCallBack<? extends Object> callBack) {
  sendRequest(httpClient, httpContext, addEntityToRequestBase(new HttpPost(url), entity), contentType, callBack);
 }

 public <T> void post( String url, Header[] headers, AjaxParams params, String contentType,AjaxCallBack<T> callBack) {
  HttpEntityEnclosingRequestBase request = new HttpPost(url);
  if(params != null) request.setEntity(paramsToEntity(params));
  if(headers != null) request.setHeaders(headers);
  sendRequest(httpClient, httpContext, request, contentType, callBack);
 }

 public void post( String url, Header[] headers, HttpEntity entity, String contentType,AjaxCallBack<? extends Object> callBack) {
  HttpEntityEnclosingRequestBase request = addEntityToRequestBase(new HttpPost(url), entity);
  if(headers != null) request.setHeaders(headers);
  sendRequest(httpClient, httpContext, request, contentType, callBack);
 }


 public Object postSync(String url) {
  return postSync(url, null);
 }

 public Object postSync(String url, AjaxParams params) {
  return postSync(url, paramsToEntity(params), null);
 }

 public Object postSync( String url, HttpEntity entity, String contentType) {
  return sendSyncRequest(httpClient, httpContext, addEntityToRequestBase(new HttpPost(url), entity), contentType);
 }


 public Object postSync( String url, Header[] headers, AjaxParams params, String contentType) {
  HttpEntityEnclosingRequestBase request = new HttpPost(url);
  if(params != null) request.setEntity(paramsToEntity(params));
  if(headers != null) request.setHeaders(headers);
  return sendSyncRequest(httpClient, httpContext, request, contentType);
 }

 public Object postSync( String url, Header[] headers, HttpEntity entity, String contentType) {
  HttpEntityEnclosingRequestBase request = addEntityToRequestBase(new HttpPost(url), entity);
  if(headers != null) request.setHeaders(headers);
  return sendSyncRequest(httpClient, httpContext, request, contentType);
 }


 //------------------put 請求-----------------------

 public void put(String url, AjaxCallBack<? extends Object> callBack) {
  put(url, null, callBack);
 }


 public void put( String url, AjaxParams params, AjaxCallBack<? extends Object> callBack) {
  put(url, paramsToEntity(params), null, callBack);
 }

 public void put( String url, HttpEntity entity, String contentType, AjaxCallBack<? extends Object> callBack) {
  sendRequest(httpClient, httpContext, addEntityToRequestBase(new HttpPut(url), entity), contentType, callBack);
 }

 public void put(String url,Header[] headers, HttpEntity entity, String contentType, AjaxCallBack<? extends Object> callBack) {
  HttpEntityEnclosingRequestBase request = addEntityToRequestBase(new HttpPut(url), entity);
  if(headers != null) request.setHeaders(headers);
  sendRequest(httpClient, httpContext, request, contentType, callBack);
 }

 public Object putSync(String url) {
  return putSync(url, null);
 }

 public Object putSync( String url, AjaxParams params) {
  return putSync(url, paramsToEntity(params),null);
 }

 public Object putSync(String url, HttpEntity entity, String contentType) {
  return putSync(url,null, entity, contentType);
 }


 public Object putSync(String url,Header[] headers, HttpEntity entity, String contentType) {
  HttpEntityEnclosingRequestBase request = addEntityToRequestBase(new HttpPut(url), entity);
  if(headers != null) request.setHeaders(headers);
  return sendSyncRequest(httpClient, httpContext, request, contentType);
 }

 //------------------delete 請求-----------------------
 public void delete( String url, AjaxCallBack<? extends Object> callBack) {
  final HttpDelete delete = new HttpDelete(url);
  sendRequest(httpClient, httpContext, delete, null, callBack);
 }

 public void delete( String url, Header[] headers, AjaxCallBack<? extends Object> callBack) {
  final HttpDelete delete = new HttpDelete(url);
  if(headers != null) delete.setHeaders(headers);
  sendRequest(httpClient, httpContext, delete, null, callBack);
 }

 public Object deleteSync(String url) {
  return deleteSync(url,null);
 }

 public Object deleteSync( String url, Header[] headers) {
  final HttpDelete delete = new HttpDelete(url);
  if(headers != null) delete.setHeaders(headers);
  return sendSyncRequest(httpClient, httpContext, delete, null);
 }

 //---------------------下載---------------------------------------
 public HttpHandler<File> download(String url,String target,AjaxCallBack<File> callback){
  return download(url, null, target, false, callback);
 }


 public HttpHandler<File> download(String url,String target,boolean isResume,AjaxCallBack<File> callback){
  return download(url, null, target, isResume, callback);
 }

 public HttpHandler<File> download( String url,AjaxParams params, String target, AjaxCallBack<File> callback) {
  return download(url, params, target, false, callback);
 }

 public HttpHandler<File> download( String url,AjaxParams params, String target,boolean isResume, AjaxCallBack<File> callback) {
  final HttpGet get =  new HttpGet(getUrlWithQueryString(url, params));
  HttpHandler<File> handler = new HttpHandler<File>(httpClient, httpContext, callback,charset);
  handler.executeOnExecutor(executor,get,target,isResume);
  return handler;
 }


 protected <T> void sendRequest(DefaultHttpClient client, HttpContext httpContext, HttpUriRequest uriRequest, String contentType, AjaxCallBack<T> ajaxCallBack) {
  if(contentType != null) {
   uriRequest.addHeader("Content-Type", contentType);
  }

  new HttpHandler<T>(client, httpContext, ajaxCallBack,charset)
  .executeOnExecutor(executor, uriRequest);

 }

 protected Object sendSyncRequest(DefaultHttpClient client, HttpContext httpContext, HttpUriRequest uriRequest, String contentType) {
  if(contentType != null) {
   uriRequest.addHeader("Content-Type", contentType);
  }
  return new SyncRequestHandler(client, httpContext,charset).sendRequest(uriRequest);
 }

 public static String getUrlWithQueryString(String url, AjaxParams params) {
  if(params != null) {
   String paramString = params.getParamString();
   url += "?" + paramString;
  }
  return url;
 }

 private HttpEntity paramsToEntity(AjaxParams params) {
  HttpEntity entity = null;

  if(params != null) {
   entity = params.getEntity();
  }

  return entity;
 }

 private HttpEntityEnclosingRequestBase addEntityToRequestBase(HttpEntityEnclosingRequestBase requestBase, HttpEntity entity) {
  if(entity != null){
   requestBase.setEntity(entity);
  }

  return requestBase;
 }

 private static class InflatingEntity extends HttpEntityWrapper {
  public InflatingEntity(HttpEntity wrapped) {
   super(wrapped);
  }

  @Override
  public InputStream getContent() throws IOException {
   return new GZIPInputStream(wrappedEntity.getContent());
  }

  @Override
  public long getContentLength() {
   return -1;
  }
 }
}