Http Trunked协议使用

1.  为什么要使用Http Trunked协议？

      一般http通信时会使用content_length头信息来表示服务器发送的文档内容长度，这是因为我们已经提前知道了文档内容的长度，但

有时候我们无法提前知道我们需要传输的文档的长度，这时我们就要采用分块传输的方式来发送内容，也就是通过我们的http trunked协议。

Http1.1x协议的chunked编码方式，可以确保接收端能够准确的判断不定长内容收取是否完整。

2.  http RFC文档中的chunked编码格式

chunked编码一般使用若干个chunk串联而成，最后一个chunk的长度为0，表示chunk数据结束。每个chunked分为头部和正文，头部指

定下一段正文的长度，正文只的是实际内容。通过/r/n分隔符来分隔各个部分。

Chunked编码格式：

      Chunked-Body   = *chunk

                        last-chunk

                        trailer

                        CRLF

 

       chunk          = chunk-size [ chunk-extension ] CRLF

                        chunk-data CRLF

       chunk-size     = 1*HEX

       last-chunk     = 1*("0") [ chunk-extension ] CRLF

 

       chunk-extension= *( ";" chunk-ext-name [ "=" chunk-ext-val ] )

       chunk-ext-name = token

       chunk-ext-val  = token | quoted-string

       chunk-data     = chunk-size(OCTET)

       trailer        = *(entity-header CRLF)

Chunked-Body表示经过chunked编码后的报文体。报文体可以分为chunk, last-chunk，trailer和结束符四部分。chunk的数量在报文

体中最少可以为0，无上限；每个chunk的长度是自指定的，即，起始的数据必然是16进制数字的字符串，代表后面chunk-data的长度

（字节数）。这个16进制的字符串第一个字符如果是“0”，则表示chunk-size为0，该chunk为last-chunk,无chunk-data部分。可选的

chunk-extension由通信双方自行确定，如果接收者不理解它的意义，可以忽略。
    trailer是附加的在尾部的额外头域，通常包含一些元数据，后文中会给出具体的例子。

3.   Http RFC文档中chunked协议解码

    length := 0         //长度计数器置0
    read chunk-size, chunk-extension (if any) and CRLF    

 //读取chunk-size, chunk-extension和CRLF
    while(chunk-size > 0 )   {            //表明不是last-chunk
          read chunk-data and CRLF            //读chunk-size大小的chunk-data,skip CRLF
          append chunk-data to entity-body     //将此块chunk-data追加到entity-body后
          read chunk-size and CRLF          //读取新chunk的chunk-size 和 CRLF
    }
    read entity-header      //entity-header的格式为name:valueCRLF,如果为空即只有CRLF
    while （entity-header not empty)   //即，不是只有CRLF的空行
    {
       append entity-header to existing header fields
       read entity-header
    }
    Content-Length:=length      //将整个解码流程结束后计算得到的新报文体length
                                 //作为Content-Length域的值写入报文中
    Remove "chunked" from Transfer-Encoding  //同时从Transfer-Encoding中域值去除   chunked这个标记

从这段伪代码中，我们可以看出chunked协议还是比较简单的，用任何一门语言实现起来都很方便。下面我们给出Java版实现的例子。

private ByteBuffer m_chunkbody = ByteBuffer.allocate(100*1024);
    public byte[] m_buffer;
    protected BufferedInputStream m_bis = getInputStream();
    BisBuffer bb = new BisBuffer(m_bis, 100);//BisBuffer每次读一百个字节
    int contentLength = 0;
    boolean isDataOverLimit = false;
    byte b;
    while (true) {  // 头判断
        b = (byte)bb.read();//每次读取一个字节
        if (b == 'T' || b == 't') {
            byte[] keyBuffer = new byte[50];
            idx = 0;
            while ((keyBuffer[idx++] = (byte)bb.read()) != ' ') // "transfer-Encoding: "
                if (keyBuffer[idx - 1] == '\n')
                    continue;
            String encoding = new String(keyBuffer, 0, idx - 1);
            if (encoding.equalsIgnoreCase("ransfer-Encoding:")) {
                byte[] chuckBuffer = new byte[8];
                idx = 0;
                while ((chuckBuffer[idx++] = (byte)bb.read()) != '\r');
                String chunked = new String(chuckBuffer, 0, idx - 1); // chunked协议标记
                logger.info(chunked);
                if (!chunked.equalsIgnoreCase("chunked"))
                    throw new Exception("not chunked!");
                b = (byte)bb.read(); // \n
            } else if(encoding.equalsIgnoreCase("railer:")){
                byte[] trailerBuffer = new byte[50];
                idx = 0;
                while ((trailerBuffer[idx++] = (byte)bb.read()) != '\r');
                String trailer = new String(trailerBuffer, 0, idx - 1); // trailer
                String[] trailerArr = trailer.split(",");
                if (!(trailerArr[0].trim()).equalsIgnoreCase("data_over_limit"))
                    throw new Exception("trailer doesn't have data_over_limit!");
                b = (byte)bb.read(); // \n
            }else {
                while ((b = (byte)bb.read()) != '\n') ; // \n
            }
        } else if (b == '\r') {
            //到此说明接下来是chunked-body相关内容,。
            b = (byte)bb.read();  // \n
            byte[] lensize = new byte[Integer.SIZE];
            idx = 0;
            while((lensize[idx++] = (byte)bb.read()) != '\r');
            b = (byte)bb.read();  // \n
            int chunksize = Integer.parseInt(new String(lensize,0,idx-1),16);
            //n个chunked包的解析
            while(chunksize > 0){
                contentLength += chunksize;//add len
                if(contentLength < 0 || contentLength > 100*1024)
                    throw new Exception(contentLength+" LENGTH TOO LARGE!");

                byte[] temp = new byte[chunksize];
                idx = 0;
                while(idx != chunksize){
                    temp[idx++] = bb.read();
                }
                m_chunkbody.put(temp);//append chunk-data
                //读取下一个chunk-data
                idx = 0;    
                b = (byte)bb.read();  // \r
                b = (byte)bb.read();  // \n
                while((lensize[idx++] = (byte)bb.read()) != '\r');
                chunksize = Integer.parseInt(new String(lensize,0,idx-1),16);
                b = (byte)bb.read();  // \n
            }
            b = (byte)bb.read();  // \r
            b = (byte)bb.read();  // \n
        } else {
            if(b == 's'){
                //end 读取完chunk-body,最后将trailer数据读取出来
                byte[] trailerBuffer = new byte[50];
                idx = 0;
                while ((trailerBuffer[idx++] = (byte)bb.read()) != '\r');
                String trailer = new String(trailerBuffer, 0, idx - 1); // trailer
                int length = trailer.length();
                trailer = "s" + trailer;
                String tailerKey = "data_over_limit: ";
                if (!trailer.startsWith(tailerKey))
                    throw new Exception("data_over_limit ERROR!");
                String isOverLimit = trailer.substring(tailerKey.length(),length+1);
                if(isOverLimit.equalsIgnoreCase("true")){
                    isDataOverLimit = true;
                }else
                    isDataOverLimit = false;
                b = (byte)bb.read();  // \n
                break;
            }
            while ((b = (byte)bb.read()) != '\n') ; // 其他头字段
        }
    }
    //组装chunk-body的内容，即chunk-size对应的chunk-data的所有块的组合。
    m_chunkbody.flip();//反转
    m_buffer = m_chunkbody.array();
    m_chunkbody.clear();//清空缓冲区

 4 .   Chunked协议发送端数据组装

首先来看一下http普通协议和http trunked协议header头部信息的异同。普通http头部信息如下所示：

     Post  xxx http/1.1

     Accept-Language: en-us

     Accept: */*

     Host: xxx.xxx

     User-Agent: xxx HTTP Client

     Content-Length: 1024

Http Trunked协议头部信息：

   Post  xxx http/1.1

   Accept-Language: en-us

   Accept: */*

   Host: xxx.xxx

   User-Agent: xxx HTTP Client

   Transfer-Encoding: chunked

   Trailer: data_over_limit

      从上面我们可以看到普通http协议header包含了长度信息，chunked协议是没有长度的，需要再客户端全部chunk数据解析后才

能得到传输信息的具体长度。

头部信息的组装通过java代码来实现如下：

public byte[] creatHttpHeader(){
        StringBuilder sb = new StringBuilder(100);
        sb.append("POST xxx http/1.1").append("\r\n");
        sb.append("Accept-Language: en-us").append("\r\n");
        sb.append("Accept: */*").append("\r\n");
        sb.append("Host: xxx.xxx").append("\r\n");
        sb.append("User-Agent: xxx HTTP Client").append("\r\n");
        sb.append("Transfer-Encoding: chunked").append("\r\n");
        sb.append("Trailer: data_over_limit").append("\r\n");
        sb.append("\r\n"); // mark header over
        return sb.toString().getBytes("US-ASCII");
    }

 Trailer信息Java代码实现：

public byte[] createChunkedTrailer(){
        StringBuilder sb = new StringBuilder(100);
        sb.append("data_over_limit: true\r\n");
        return sb.toString().getBytes("US-ASCII");
    }

 传输内容chunked组装java代码实现：

public void send(InputStream fileInputStream) throws IOException {
        OutputStream requestStream = socket.getOutputStream();
        ChunkedOutputStream chunkedBodyStream = new ChunkedOutputStream(requestStream);
        int chunkSize = 2048;
        this.requestStream.write(createHttpHeader());
        
        byte[] buf = new byte[chunkSize];
        int readed = 0;
        int size = 0;
        while ((readed = fileInputStream.read(buf)) != -1) {
            size += readed;
        }
        this.chunkedBodyStream.finish();
        this.requestStream.write(createChunkedTrailer());
    }

     在介绍一下ChunkedOutputStream这个类，这个类是httpclient-3.0.1.jar里面的一个类，源代码我们可以拿到，代码实现的很简

洁，有兴趣的同学可以好好看看，可以去网上获取httpclient的源代码。

      传输内容组装好之后，就可以通过套接字发送到客户端去了，第三节中的代码就可以解析从这里发送过去的数据，怎么样，很简单吧

，看过之后大家都会使用了吧。