`
yangguangfu
  • 浏览: 1539689 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

xUtils 中的HttpUtils全面注释

 
阅读更多
/*


/**
 * 网络请求工具类
 * @author 阿福
 *
 */
public class HttpUtils {

    public final static HttpCache sHttpCache = new HttpCache();

    private final DefaultHttpClient httpClient;
    private final HttpContext httpContext = new BasicHttpContext();

    private HttpRedirectHandler httpRedirectHandler;

    /**
     * 构造方法,默认联网15秒超时
     */
    public HttpUtils() {
        this(HttpUtils.DEFAULT_CONN_TIMEOUT, null);
    }

    /**
     * 构造方法设置超时时间
     * @param connTimeout 超时时间毫秒
     */
    public HttpUtils(int connTimeout) {
        this(connTimeout, null);
    }

    /**
     * 构造方法,浏览器的信息包
     * @param userAgent
     */
    public HttpUtils(String userAgent) {
        this(HttpUtils.DEFAULT_CONN_TIMEOUT, userAgent);
    }

    /**
     * 构造方法
     * @param connTimeout 链接超时时间,毫秒单位
     * @param userAgent  浏览器的信息包
     */
    public HttpUtils(int connTimeout, String userAgent) {
        HttpParams params = new BasicHttpParams();

        ConnManagerParams.setTimeout(params, connTimeout);
        HttpConnectionParams.setSoTimeout(params, connTimeout);
        HttpConnectionParams.setConnectionTimeout(params, connTimeout);

        if (TextUtils.isEmpty(userAgent)) {
            userAgent = OtherUtils.getUserAgent(null);
        }
        HttpProtocolParams.setUserAgent(params, userAgent);

        ConnManagerParams.setMaxConnectionsPerRoute(params, new ConnPerRouteBean(10));
        ConnManagerParams.setMaxTotalConnections(params, 10);

        HttpConnectionParams.setTcpNoDelay(params, true);
        HttpConnectionParams.setSocketBufferSize(params, 1024 * 8);
        HttpProtocolParams.setVersion(params, HttpVersion.HTTP_1_1);

        SchemeRegistry schemeRegistry = new SchemeRegistry();
        schemeRegistry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), 80));
        schemeRegistry.register(new Scheme("https", DefaultSSLSocketFactory.getSocketFactory(), 443));

        httpClient = new DefaultHttpClient(new ThreadSafeClientConnManager(params, schemeRegistry), params);

        httpClient.setHttpRequestRetryHandler(new RetryHandler(DEFAULT_RETRY_TIMES));

        httpClient.addRequestInterceptor(new HttpRequestInterceptor() {
            @Override
            public void process(org.apache.http.HttpRequest httpRequest, HttpContext httpContext) throws org.apache.http.HttpException, IOException {
                if (!httpRequest.containsHeader(HEADER_ACCEPT_ENCODING)) {
                    httpRequest.addHeader(HEADER_ACCEPT_ENCODING, ENCODING_GZIP);
                }
            }
        });

        httpClient.addResponseInterceptor(new HttpResponseInterceptor() {
            @Override
            public void process(HttpResponse response, HttpContext httpContext) throws org.apache.http.HttpException, IOException {
                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("gzip")) {
                            response.setEntity(new GZipDecompressingEntity(response.getEntity()));
                            return;
                        }
                    }
                }
            }
        });
    }

    // ************************************    default settings & fields ****************************

    
    private String responseTextCharset = HTTP.UTF_8;

    private long currentRequestExpiry = HttpCache.getDefaultExpiryTime();

    private final static int DEFAULT_CONN_TIMEOUT = 1000 * 15; // 15s

    private final static int DEFAULT_RETRY_TIMES = 3;

    private static final String HEADER_ACCEPT_ENCODING = "Accept-Encoding";
    private static final String ENCODING_GZIP = "gzip";

    private final static int DEFAULT_POOL_SIZE = 3;
    private final static PriorityExecutor EXECUTOR = new PriorityExecutor(DEFAULT_POOL_SIZE);

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

    // ***************************************** config *******************************************

    /**
     * 配置请求文本编码,默认UTF-8
     * @param charSet
     * @return
     */
    public HttpUtils configResponseTextCharset(String charSet) {
        if (!TextUtils.isEmpty(charSet)) {
            this.responseTextCharset = charSet;
        }
        return this;
    }

    /**
     * http重定向处理
     * @param httpRedirectHandler
     * @return
     */
    public HttpUtils configHttpRedirectHandler(HttpRedirectHandler httpRedirectHandler) {
        this.httpRedirectHandler = httpRedirectHandler;
        return this;
    }

    /**
     * 配置http缓存大小
     * @param httpCacheSize
     * @return
     */
    public HttpUtils configHttpCacheSize(int httpCacheSize) {
        sHttpCache.setCacheSize(httpCacheSize);
        return this;
    }

    /**
     * 配置默认http缓存失效 ,默认是60秒
     * @param defaultExpiry 
     * @return
     */
    public HttpUtils configDefaultHttpCacheExpiry(long defaultExpiry) {
        HttpCache.setDefaultExpiryTime(defaultExpiry);
        currentRequestExpiry = HttpCache.getDefaultExpiryTime();
        return this;
    }

    /**
     * 配置当前http缓存失效,时间默认60秒
     * @param currRequestExpiry
     * @return
     */
    public HttpUtils configCurrentHttpCacheExpiry(long currRequestExpiry) {
        this.currentRequestExpiry = currRequestExpiry;
        return this;
    }

    /**
     * cookie存储配置
     * @param cookieStore
     * @return
     */
    public HttpUtils configCookieStore(CookieStore cookieStore) {
        httpContext.setAttribute(ClientContext.COOKIE_STORE, cookieStore);
        return this;
    }

    /**
     * 配置浏览器信息包
     * @param userAgent
     * @return
     */
    public HttpUtils configUserAgent(String userAgent) {
        HttpProtocolParams.setUserAgent(this.httpClient.getParams(), userAgent);
        return this;
    }

    /**
     * 配置时间链接超时
     * @param timeout
     * @return
     */
    public HttpUtils configTimeout(int timeout) {
        final HttpParams httpParams = this.httpClient.getParams();
        ConnManagerParams.setTimeout(httpParams, timeout);
        HttpConnectionParams.setConnectionTimeout(httpParams, timeout);
        return this;
    }

    /**
     * 配置socket时间连接溢出
     * @param timeout
     * @return
     */
    public HttpUtils configSoTimeout(int timeout) {
        final HttpParams httpParams = this.httpClient.getParams();
        HttpConnectionParams.setSoTimeout(httpParams, timeout);
        return this;
    }

    /**
     * 配置注册Scheme
     * @param scheme
     * @return
     */
    public HttpUtils configRegisterScheme(Scheme scheme) {
        this.httpClient.getConnectionManager().getSchemeRegistry().register(scheme);
        return this;
    }

    /**
     * 配置SSLSocketFactory
     * @param sslSocketFactory
     * @return
     */
    public HttpUtils configSSLSocketFactory(SSLSocketFactory sslSocketFactory) {
        Scheme scheme = new Scheme("https", sslSocketFactory, 443);
        this.httpClient.getConnectionManager().getSchemeRegistry().register(scheme);
        return this;
    }

    /**
     * 配置请求重试次数
     * @param count 重试次数
     * @return
     */
    public HttpUtils configRequestRetryCount(int count) {
        this.httpClient.setHttpRequestRetryHandler(new RetryHandler(count));
        return this;
    }

    /**
     * 配置请求线程池个数
     * @param threadPoolSize 线程池个数
     * @return
     */
    public HttpUtils configRequestThreadPoolSize(int threadPoolSize) {
        HttpUtils.EXECUTOR.setPoolSize(threadPoolSize);
        return this;
    }

    // ***************************************** send request 发送请求*******************************************

    /**
     * 发送异步网络请求 -重要
     * @param method get或者post请求等等
     * @param url 网络请求路径
     * @param callBack 回调
     * @return
     */
    public <T> HttpHandler<T> send(HttpRequest.HttpMethod method, String url,
                                   RequestCallBack<T> callBack) {
        return send(method, url, null, callBack);
    }

    /**
     * 发送异步网络请求 -重要
     * @param method get或者post请求等等
     * @param url 网络请求路径
     * @param params 请求参数
     * @param callBack 回调
     * @return
     */
    public <T> HttpHandler<T> send(HttpRequest.HttpMethod method, String url, RequestParams params,
                                   RequestCallBack<T> callBack) {
        if (url == null) throw new IllegalArgumentException("url may not be null");

        HttpRequest request = new HttpRequest(method, url);
        return sendRequest(request, params, callBack);
    }

    /**
     * 发送同步网络请求 -用得不多
     * @param method get或者post等方法
     * @param url 联网网络url
     * @return
     * @throws HttpException
     */
    public ResponseStream sendSync(HttpRequest.HttpMethod method, String url) throws HttpException {
        return sendSync(method, url, null);
    }

    /**
     * 发送同步网络请求 -用得不多
     * @param method get或者post等方法
     * @param url 联网网络url 
     * @param params 请求参数
     * @return
     * @throws HttpException
     */
    public ResponseStream sendSync(HttpRequest.HttpMethod method, String url, RequestParams params) throws HttpException {
        if (url == null) throw new IllegalArgumentException("url may not be null");

        HttpRequest request = new HttpRequest(method, url);
        return sendSyncRequest(request, params);
    }

    // ***************************************** download  下载*******************************************

    /**
     * 下载文件方法
     * @param url 下载文件的url
     * @param target 下载保存的目录
     * @param callback 回调
     * @return
     */
    public HttpHandler<File> download(String url, String target,
                                      RequestCallBack<File> callback) {
        return download(HttpRequest.HttpMethod.GET, url, target, null, false, false, callback);
    }

    /**
     * 下载文件方法
     * @param url 下载文件的url
     * @param target 下载保存的目录
     * @param autoResume 是否自动恢复下载
     * @param callback 回调
     * @return
     */
    public HttpHandler<File> download(String url, String target,
                                      boolean autoResume, RequestCallBack<File> callback) {
        return download(HttpRequest.HttpMethod.GET, url, target, null, autoResume, false, callback);
    }

    /**
     * 下载文件方法
     * @param url 下载文件的url
     * @param target 下载保存的目录
     * @param autoResume  是否自动恢复下载
     * @param autoRename 是否自动重命名
     * @param callback 回调
     * @return
     */
    public HttpHandler<File> download(String url, String target,
                                      boolean autoResume, boolean autoRename, RequestCallBack<File> callback) {
        return download(HttpRequest.HttpMethod.GET, url, target, null, autoResume, autoRename, callback);
    }

    /**
     * 下载文件方法
     * @param url 下载文件的url
     * @param target 下载保存的目录
     * @param params 参数类
     * @param callback 回调
     * @return
     */
    public HttpHandler<File> download(String url, String target,
                                      RequestParams params, RequestCallBack<File> callback) {
        return download(HttpRequest.HttpMethod.GET, url, target, params, false, false, callback);
    }

    /**
     * 下载文件方法
     * @param url  下载文件的url
     * @param target 下载保存的目录
     * @param params 参数类
     * @param autoResume 是否自动恢复下载
     * @param callback 回调
     * @return
     */
    public HttpHandler<File> download(String url, String target,
                                      RequestParams params, boolean autoResume, RequestCallBack<File> callback) {
        return download(HttpRequest.HttpMethod.GET, url, target, params, autoResume, false, callback);
    }

    /**
     * 下载文件方法
     * @param url 下载文件的url
     * @param target 下载保存的目录
     * @param params 参数
     * @param autoResume 是否自动恢复
     * @param autoRename 是否自动命名
     * @param callback 回调
     * @return
     */
    public HttpHandler<File> download(String url, String target,
                                      RequestParams params, boolean autoResume, boolean autoRename, RequestCallBack<File> callback) {
        return download(HttpRequest.HttpMethod.GET, url, target, params, autoResume, autoRename, callback);
    }

    /**
     * 下载文件方法
     * @param method 请求用get还是post等
     * @param url 下载文件的url
     * @param target 下载保存的目录
     * @param params 参数
     * @param callback 回调
     * @return
     */
    public HttpHandler<File> download(HttpRequest.HttpMethod method, String url, String target,
                                      RequestParams params, RequestCallBack<File> callback) {
        return download(method, url, target, params, false, false, callback);
    }

    /**
     * 下载文件方法
     * @param method 请求用get还是post等
     * @param url 下载文件的url
     * @param target 下载保存的目录
     * @param params 参数
     * @param autoResume 是否自动恢复下载
     * @param callback 回调
     * @return
     */
    public HttpHandler<File> download(HttpRequest.HttpMethod method, String url, String target,
                                      RequestParams params, boolean autoResume, RequestCallBack<File> callback) {
        return download(method, url, target, params, autoResume, false, callback);
    }

    /**
     * 下载文件方法
     * @param method 请求用get还是post等
     * @param url 下载文件的url
     * @param target 下载保存的目录
     * @param params 参数
     * @param autoResume 是否自动恢复下载
     * @param autoRename 是否自动重命名
     * @param callback 回调
     * @return
     */
    public HttpHandler<File> download(HttpRequest.HttpMethod method, String url, String target,
                                      RequestParams params, boolean autoResume, boolean autoRename, RequestCallBack<File> callback) {

        if (url == null) throw new IllegalArgumentException("url may not be null");
        if (target == null) throw new IllegalArgumentException("target may not be null");

        HttpRequest request = new HttpRequest(method, url);

        HttpHandler<File> handler = new HttpHandler<File>(httpClient, httpContext, responseTextCharset, callback);

        handler.setExpiry(currentRequestExpiry);
        handler.setHttpRedirectHandler(httpRedirectHandler);

        if (params != null) {
            request.setRequestParams(params, handler);
            handler.setPriority(params.getPriority());
        }
        handler.executeOnExecutor(EXECUTOR, request, target, autoResume, autoRename);
        return handler;
    }

    ////////////////////////////////////////////////////////////////////////////////////////////////
    private <T> HttpHandler<T> sendRequest(HttpRequest request, RequestParams params, RequestCallBack<T> callBack) {

        HttpHandler<T> handler = new HttpHandler<T>(httpClient, httpContext, responseTextCharset, callBack);

        handler.setExpiry(currentRequestExpiry);
        handler.setHttpRedirectHandler(httpRedirectHandler);
        request.setRequestParams(params, handler);

        if (params != null) {
            handler.setPriority(params.getPriority());
        }
        handler.executeOnExecutor(EXECUTOR, request);
        return handler;
    }

    private ResponseStream sendSyncRequest(HttpRequest request, RequestParams params) throws HttpException {

        SyncHttpHandler handler = new SyncHttpHandler(httpClient, httpContext, responseTextCharset);

        handler.setExpiry(currentRequestExpiry);
        handler.setHttpRedirectHandler(httpRedirectHandler);
        request.setRequestParams(params);

        return handler.sendRequest(request);
    }
}

 

分享到:
评论
1 楼 Letitbeee 2016-05-19  
解释不错

相关推荐

    commons.lang3.ClassUtils 源码中文注释

    org.apache.commons.lang3.ClassUtils 源码中文注释,之后会加上其他的工具类注释,方便以后复习阅读

    HttpUtils Java get post 工具类

    在HttpUtils工具类中,GET请求可能通过以下方式实现: ```java public static String sendGet(String url, Map, String&gt; params) { // 参数处理 // ... // 构建完整URL // ... // 使用HttpURLConnection发送...

    mtd-utils安装包

    **mtd-utils** 是一组用于管理Memory Technology Device (MTD)的工具,主要用于操作和维护嵌入式系统中的闪存设备。MTD是Linux内核中处理非易失性存储器(如EEPROM、EPROM、NOR和NAND闪存)的子系统。mtd-utils提供...

    alsa-utils alsa-utils alsa-utils

    alsa-utils

    exfat-utils-1.0.1.tar.gz_exfat_exfat utils_exfat-utils_exfat-uti

    Linux中的exfat-utils是一个用于在Linux系统上读取、写入和管理ExFAT文件系统的工具集。 "exfat-utils-1.0.1.tar.gz" 是一个包含ExFAT实用程序的源码包,版本号为1.0.1。这个压缩包提供了在Linux环境下操作ExFAT...

    source insight 添加块注释,全选等的脚本文件 utils.rar,

    "utils.em"中可能包含了一个名为`block-comment`的函数,它允许用户选择一段代码后,通过快捷键或菜单命令一次性为这段代码添加或移除注释。这在编写文档或者调试代码时非常有用,可以大大节省时间。 2. **全选功能...

    qrcode-utils-1.1-API文档-中文版.zip

    赠送jar包:qrcode-utils-1.1.jar; 赠送原API文档:qrcode-utils-1.1-javadoc.jar; 赠送源代码:qrcode-utils-1.1-sources.jar;...人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    redis utils 工具类

    Redis Utils工具类是Java开发中常见的一种封装,用于简化与Redis数据库的交互操作。Redis是一种高性能的键值存储系统,广泛应用于缓存、消息队列、数据持久化等多个场景。在Java开发中,为了提高代码的可读性和复用...

    sg3-utils 静态编译包

    注意:在unbuntu上按照压缩文档中的《sg3_utils测试工具交叉编译,静态编译.pdf》进行操作,可自行编译sg3_utils arm64 静态包 sg3_utils ARM64 静态编译链接程序,可直接在arm64平台上运行,用于对scsi 设备进行...

    sourceinsight 代码行注释,去注释代码插件

    其次,"去注释代码"是指移除代码中的注释部分,这在某些情况下非常有用,比如测试未注释的代码或清理代码库。对于`#if 0`和`#endif`包裹的代码块,这是一种条件编译注释,它们可以被整个地启用或禁用,这在调试或...

    vue-cli脚手架build目录下utils.js工具配置文件详解

    此文章用来解释vue-cli脚手架build目录中的utils.js配置文件 1.此配置文件是vue开发环境的wepack相关配置文件,主要用来处理css-loader和vue-style-loader 2.关于注释 •当涉及到较复杂的解释我将通过标识的方式...

    ext4_utils

    本文将详细探讨ext4_utils的原理、功能及在三星线刷ROM制作过程中的应用。 一、ext4文件系统概述 ext4是Linux系统的第四代扩展文件系统,是对ext3的改进版本,旨在提高性能和可靠性。它引入了多项新特性,如更大的...

    plexus-utils-.jar.rar

    在本篇文章中,我们将深入探讨Plexus Utils库的两个主要版本——2.0.4和3.2.0——以及它们包含的关键特性。 首先,我们来看Plexus Utils 2.0.4。这个版本发布于2011年,主要服务于早期的Maven和Plexus项目。2.0.4版...

    bluez-utils-3.36

    《Linux系统中的BlueZ-utils-3.36:蓝牙功能移植与应用详解》 在Linux操作系统的世界里,蓝牙技术的运用日益广泛,特别是在设备间的数据传输、无线音频播放以及物联网(IoT)设备的交互中扮演着关键角色。BlueZ是...

    base64utils jar 包下载

    Base64Utils是一个Java库,通常用于在编程中进行Base64编码和解码。Base64是一种将二进制数据转换为可打印字符的方法,以便在不支持二进制数据的环境中(如电子邮件系统)传输。这个jar包是专门为Java开发者设计的,...

    个人总结常用经典Utils工具类

    1、Utils工具类有String工具类、XmlNode节点工具类、BeanFactory相关、Common工具类、Cookie工具类、Date工具类、Http工具类、JDBC工具类、日志Log工具类、Servlet相关等。2、工具类省了重复造轮子的工作,可以直接...

    canutils-4.0.6及其使用说明

    `can-socket`是CANutils中的一个关键工具,它允许用户通过Linux的socketCAN接口与CAN总线进行交互。socketCAN是Linux内核提供的一个框架,使得应用程序可以通过标准的套接字API来访问CAN接口。 **can-socket基本...

    Android常用工具类Utils

    在Android应用开发中,工具类(Utils)是程序员经常使用的辅助类库,它们包含了各种实用方法,可以帮助开发者高效地处理日常编程任务。本篇将详细阐述`Android常用工具类Utils`的相关知识点,涵盖系统操作、图像处理...

    yum-utils.zip

    [root@localhost yum-utils]# rpm -qa |grep yum-utils 卸载 [root@localhost yum-utils]# rpm -e --nodeps yum-utils-1.1.31-40.el7.noarch 上传离线版本包并解压 安装 [root@localhost yum-utils]# rpm -ivh...

    nfs-utils.tar.gz

    1. **下载离线包**:如描述中提到的,可以使用`yum`命令的`--downloadonly`选项将`nfs-utils`包下载到指定目录,例如 `/root/nfs`。命令如下: ``` yum -y install --downloadonly --downloaddir /root/nfs nfs-...

Global site tag (gtag.js) - Google Analytics