Android 学习笔记之Volley开源框架解析（五）

package com.android.volley.toolbox;

import java.io.ByteArrayOutputStream;
import java.io.IOException;

public class PoolingByteArrayOutputStream extends ByteArrayOutputStream {
  
    private static final int DEFAULT_SIZE = 256; //定义缓冲池的默认字节大小..

    private final ByteArrayPool mPool;  //定义比特回收池对象...

    //按照默认的方式去构造一个缓冲池对象...
    public PoolingByteArrayOutputStream(ByteArrayPool pool) {
        this(pool, DEFAULT_SIZE);
    }

    //按照人为指定的大小去构造一个缓冲池对象...
    public PoolingByteArrayOutputStream(ByteArrayPool pool, int size) {
        mPool = pool;
        buf = mPool.getBuf(Math.max(size, DEFAULT_SIZE));
    }
    //释放内存...关闭流的操作...
    @Override
    public void close() throws IOException {
        mPool.returnBuf(buf);
        buf = null;
        super.close();
    }
    //返回一个缓冲池...
    @Override
    public void finalize() {
        mPool.returnBuf(buf);
    }

    //写入数据前需要调用的函数，确保在缓存有足够大的空间来满足给定的字节大小...
    private void expand(int i) {
        /* Can the buffer handle @i more bytes, if not expand it */
        if (count + i <= buf.length) {
            return;
        }
        byte[] newbuf = mPool.getBuf((count + i) * 2);
        System.arraycopy(buf, 0, newbuf, 0, count);
        mPool.returnBuf(buf);
        buf = newbuf;
    }
    //写入数据函数...
    @Override
    public synchronized void write(byte[] buffer, int offset, int len) {
        expand(len);
        super.write(buffer, offset, len);
    }

    @Override
    public synchronized void write(int oneByte) {
        expand(1);
        super.write(oneByte);
    }
}

package com.android.volley.toolbox;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedList;
import java.util.List;

public class ByteArrayPool {
   
    private List<byte[]> mBuffersByLastUse = new LinkedList<byte[]>();//以时间的先后顺序保存Byte[]
    private List<byte[]> mBuffersBySize = new ArrayList<byte[]>(64);//以字节大小的顺序保存Byte[]

    /** The total size of the buffers in the pool */
    private int mCurrentSize = 0; //记录Bytep[]的数量...

    private final int mSizeLimit; //大小限制..

    /** Compares buffers by size */
    //对所有的Byte[]进行大小比较...
    protected static final Comparator<byte[]> BUF_COMPARATOR = new Comparator<byte[]>() {
        @Override
        public int compare(byte[] lhs, byte[] rhs) {
            return lhs.length - rhs.length;
        }
    };

    /**
     * @param sizeLimit the maximum size of the pool, in bytes
     */
    //设置允许的最大Byte[]...
    public ByteArrayPool(int sizeLimit) {
        mSizeLimit = sizeLimit;
    }

   //获取缓冲的过程，如果缓冲池当中存在一个合适的缓冲区，那么就return这个缓冲区，如果没有合适的，那么就需要新建立一个缓冲区...  
    public synchronized byte[] getBuf(int len) {
        for (int i = 0; i < mBuffersBySize.size(); i++) { //遍历过程...
            byte[] buf = mBuffersBySize.get(i); //获取每一个缓冲..
            if (buf.length >= len) {   //如果满足规格...
                mCurrentSize -= buf.length;
               //表示缓冲被占用，那么ArrayList就将其移除并返回...  
                mBuffersBySize.remove(i); 
                mBuffersByLastUse.remove(buf);
                return buf;  //返回合适的buf...
            }
        }
        return new byte[len];   //如果没有，新建立一个缓冲...
    }
    //对使用过的Byte[]进行保存...根据大小插入到合适的ArrayList中...
    public synchronized void returnBuf(byte[] buf) {
        if (buf == null || buf.length > mSizeLimit) {
            return;
        }
        mBuffersByLastUse.add(buf); //加入这次使用过的缓冲...
        //比较完大小进行插入..
        int pos = Collections.binarySearch(mBuffersBySize, buf, BUF_COMPARATOR);
        if (pos < 0) {
            pos = -pos - 1;
        }
        mBuffersBySize.add(pos, buf);//插入过程...
        mCurrentSize += buf.length; //记录当前大小...
        trim();  //trim()函数调用...
    }

    //函数的目的是判断，如果使用过的缓冲大小超出了预先设定的大小，那么按照先进先出的原则，缓冲会移除每次都移除第一个Byte,当Byte[]满足了指定大小，就不用再删除字节了...
    private synchronized void trim() {
        while (mCurrentSize > mSizeLimit) {
            byte[] buf = mBuffersByLastUse.remove(0);
            mBuffersBySize.remove(buf);
            mCurrentSize -= buf.length;
        }
    }

}

package com.android.volley.toolbox;

import com.android.volley.AuthFailureError;
import com.android.volley.Request;

import org.apache.http.HttpResponse;

import java.io.IOException;
import java.util.Map;
public interface HttpStack {
  
    public HttpResponse performRequest(Request<?> request, Map<String, String> additionalHeaders)
        throws IOException, AuthFailureError;

}

package com.android.volley.toolbox;

import com.android.volley.AuthFailureError;
import com.android.volley.Request;
import com.android.volley.Request.Method;

import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.ProtocolVersion;
import org.apache.http.StatusLine;
import org.apache.http.entity.BasicHttpEntity;
import org.apache.http.message.BasicHeader;
import org.apache.http.message.BasicHttpResponse;
import org.apache.http.message.BasicStatusLine;

import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import javax.net.ssl.HttpsURLConnection;
import javax.net.ssl.SSLSocketFactory;


public class HurlStack implements HttpStack {

    private static final String HEADER_CONTENT_TYPE = "Content-Type"; //Header内容的类型...

    public interface UrlRewriter {
        public String rewriteUrl(String originalUrl); //重写一个url...
    }

    private final UrlRewriter mUrlRewriter;  //url重写对象...
    private final SSLSocketFactory mSslSocketFactory;  //用于Https请求...

    public HurlStack() {
        this(null);
    }

    public HurlStack(UrlRewriter urlRewriter) {
        this(urlRewriter, null);
    }

    //创建一个栈区，保存url连接...
    public HurlStack(UrlRewriter urlRewriter, SSLSocketFactory sslSocketFactory) {
        mUrlRewriter = urlRewriter;
        mSslSocketFactory = sslSocketFactory;
    }

    @Override
    public HttpResponse performRequest(Request<?> request, Map<String, String> additionalHeaders)  //执行请求的过程...
            throws IOException, AuthFailureError {
        //获取url...
        String url = request.getUrl();
        HashMap<String, String> map = new HashMap<String, String>();
        //为请求加上头部，以及我们传递的额外参数..
        map.putAll(request.getHeaders());
        map.putAll(additionalHeaders);
        //对url进行重写，重写的好处使url更加的保密，安全...
        if (mUrlRewriter != null) {
            String rewritten = mUrlRewriter.rewriteUrl(url);
            if (rewritten == null) {
                throw new IOException("URL blocked by rewriter: " + url);
            }
            url = rewritten;
        }
        //创建url对象...
        URL parsedUrl = new URL(url);
        HttpURLConnection connection = openConnection(parsedUrl, request); //建立连接...
        for (String headerName : map.keySet()) {
            connection.addRequestProperty(headerName, map.get(headerName)); //设置请求的相关属性...
        }
        setConnectionParametersForRequest(connection, request);//根据请求的方式去执行相关的方法...
        // Initialize HttpResponse with data from the HttpURLConnection.
        ProtocolVersion protocolVersion = new ProtocolVersion("HTTP", 1, 1); //获取协议版本...
        int responseCode = connection.getResponseCode(); //响应码获取...
        if (responseCode == -1) { //如果为-1，抛出异常...
            throw new IOException("Could not retrieve response code from HttpUrlConnection.");
        }
        StatusLine responseStatus = new BasicStatusLine(protocolVersion,
                connection.getResponseCode(), connection.getResponseMessage()); //获取响应信息...
        BasicHttpResponse response = new BasicHttpResponse(responseStatus);  //封装响应状态...
        response.setEntity(entityFromConnection(connection)); //获取响应中的实体...
        //对Header进行遍历...为响应添加相关的Header...
        for (Entry<String, List<String>> header : connection.getHeaderFields().entrySet()) {
            if (header.getKey() != null) {
                Header h = new BasicHeader(header.getKey(), header.getValue().get(0));
                response.addHeader(h);
            }
        }
        return response;//返回响应...
    }

    private static HttpEntity entityFromConnection(HttpURLConnection connection) { //获取实体的方法..
        BasicHttpEntity entity = new BasicHttpEntity(); //实体封装对象的创建...
        InputStream inputStream;
        try {
            inputStream = connection.getInputStream(); //获取连接的I/O流..
        } catch (IOException ioe) {
            inputStream = connection.getErrorStream();
        }
        entity.setContent(inputStream); //实体的内容..
        entity.setContentLength(connection.getContentLength());//实体的长度..
        entity.setContentEncoding(connection.getContentEncoding()); //实体的编码...
        entity.setContentType(connection.getContentType());//实体内容的类型...
        return entity;
    }
    //创建连接...
    protected HttpURLConnection createConnection(URL url) throws IOException {
        return (HttpURLConnection) url.openConnection();
    }
    //打开连接方法,,,
    private HttpURLConnection openConnection(URL url, Request<?> request) throws IOException {
        HttpURLConnection connection = createConnection(url); 

        int timeoutMs = request.getTimeoutMs(); //设置请求的超时时间..
        connection.setConnectTimeout(timeoutMs); //连接超时时间的设置..
        connection.setReadTimeout(timeoutMs); //读取时间超时...
        connection.setUseCaches(false); //是否设置缓存..
        connection.setDoInput(true); //是否有相关的输入..

        // use caller-provided custom SslSocketFactory, if any, for HTTPS
        if ("https".equals(url.getProtocol()) && mSslSocketFactory != null) {
            ((HttpsURLConnection)connection).setSSLSocketFactory(mSslSocketFactory);  //创建一个Https连接...
        }

        return connection;
    }
    //为请求设置连接方式...
    @SuppressWarnings("deprecation")
    /* package */ static void setConnectionParametersForRequest(HttpURLConnection connection,
            Request<?> request) throws IOException, AuthFailureError {
        switch (request.getMethod()) {
            case Method.DEPRECATED_GET_OR_POST:
                byte[] postBody = request.getPostBody();
                if (postBody != null) {
                    // Prepare output. There is no need to set Content-Length explicitly,
                    // since this is handled by HttpURLConnection using the size of the prepared
                    // output stream.
                    connection.setDoOutput(true);
                    connection.setRequestMethod("POST");
                    connection.addRequestProperty(HEADER_CONTENT_TYPE,
                            request.getPostBodyContentType());
                    DataOutputStream out = new DataOutputStream(connection.getOutputStream());
                    out.write(postBody);
                    out.close();
                }
                break;
            case Method.GET:
                // Not necessary to set the request method because connection defaults to GET but
                // being explicit here.
                connection.setRequestMethod("GET");
                break;
            case Method.DELETE:
                connection.setRequestMethod("DELETE");
                break;
            case Method.POST:
                connection.setRequestMethod("POST");
                addBodyIfExists(connection, request); //调用最后一个函数...
                break;
            case Method.PUT:
                connection.setRequestMethod("PUT");
                addBodyIfExists(connection, request);
                break;
            default:
                throw new IllegalStateException("Unknown method type.");
        }
    }
    //如果一个请求存在实体数据，那么需要为其加上请求数据...
    private static void addBodyIfExists(HttpURLConnection connection, Request<?> request)
            throws IOException, AuthFailureError {
        byte[] body = request.getBody();
        if (body != null) {
            connection.setDoOutput(true);
            connection.addRequestProperty(HEADER_CONTENT_TYPE, request.getBodyContentType());
            DataOutputStream out = new DataOutputStream(connection.getOutputStream());
            out.write(body);
            out.close();
        }
    }
}

package com.android.volley.toolbox;

import com.android.volley.Cache;
import com.android.volley.NetworkResponse;

import org.apache.http.impl.cookie.DateParseException;
import org.apache.http.impl.cookie.DateUtils;
import org.apache.http.protocol.HTTP;

import java.util.Map;
public class HttpHeaderParser {

    //解析缓存Header...
    public static Cache.Entry parseCacheHeaders(NetworkResponse response) {
        long now = System.currentTimeMillis();

        Map<String, String> headers = response.headers;
        //一些基本数据的定义...
        long serverDate = 0;  
        long serverExpires = 0;
        long softExpire = 0; 
        long maxAge = 0;
        boolean hasCacheControl = false;

        String serverEtag = null;
        String headerValue;
        //获取请求——服务的整个时间,将RFC1123的格式解析成epoch方式...
        headerValue = headers.get("Date");
        if (headerValue != null) {
            serverDate = parseDateAsEpoch(headerValue);
        }
        
        headerValue = headers.get("Cache-Control");
        if (headerValue != null) {
            hasCacheControl = true; 
            String[] tokens = headerValue.split(",");
            for (int i = 0; i < tokens.length; i++) { 
                String token = tokens[i].trim(); //判断是否有缓存...
                if (token.equals("no-cache") || token.equals("no-store")) {
                    return null;
                } else if (token.startsWith("max-age=")) {
                    try {
                        maxAge = Long.parseLong(token.substring(8)); //设置缓存的有效时间...
                    } catch (Exception e) {
                    }
                } else if (token.equals("must-revalidate") || token.equals("proxy-revalidate")) {
                    maxAge = 0; //如果不允许缓存，那么有效期为0...
                }
            }
        }

        headerValue = headers.get("Expires"); 
        if (headerValue != null) {
            serverExpires = parseDateAsEpoch(headerValue); //设置缓存新鲜度时间...
        }

        serverEtag = headers.get("ETag");

       //设置缓存的过期时间...
        if (hasCacheControl) {
            softExpire = now + maxAge * 1000;
        } else if (serverDate > 0 && serverExpires >= serverDate) {
            // Default semantic for Expire header in HTTP specification is softExpire.
            softExpire = now + (serverExpires - serverDate);
        }
        //将Header数据保存在Entry当中..
        Cache.Entry entry = new Cache.Entry();
        entry.data = response.data;
        entry.etag = serverEtag;
        entry.softTtl = softExpire;
        entry.ttl = entry.softTtl;
        entry.serverDate = serverDate;
        entry.responseHeaders = headers;

        return entry;
    }

    //将RFC1123的时间格式转换成epoch格式...
    public static long parseDateAsEpoch(String dateStr) {
        try {
            // Parse date in RFC1123 format if this header contains one
            return DateUtils.parseDate(dateStr).getTime();
        } catch (DateParseException e) {
            // Date in invalid format, fallback to 0
            return 0;
        }
    }

    //解析字符集...
    public static String parseCharset(Map<String, String> headers) {
        String contentType = headers.get(HTTP.CONTENT_TYPE);
        if (contentType != null) {
            String[] params = contentType.split(";");
            for (int i = 1; i < params.length; i++) {
                String[] pair = params[i].trim().split("=");
                if (pair.length == 2) {
                    if (pair[0].equals("charset")) {
                        return pair[1];
                    }
                }
            }
        }

        return HTTP.DEFAULT_CONTENT_CHARSET;
    }
}