HttpURLConnection学习

浏览数：43 / 时间：2015年06月09日

最常用的Http请求无非是get和post，get请求可以获取静态页面，也可以把参数放在URL字串后面，传递给servlet，post与get的不同之处在于post的参数不是放在URL字串里面，而是放在http请求的正文内。
在Java中可以使用HttpURLConnection发起这两种请求，了解此类，对于了解soap，和编写servlet的自动测试代码都有很大的帮助。
下面的代码简单描述了如何使用HttpURLConnection发起这两种请求，以及传递参数的方法：

  1 public class HttpInvoker {
  2 
  3     public static final String GET_URL = "http://localhost:8080/welcome1";
  4 
  5     public static final String POST_URL = "http://localhost:8080/welcome1";
  6 
  7     public static void readContentFromGet() throws IOException {
  8         // 拼凑get请求的URL字串，使用URLEncoder.encode对特殊和不可见字符进行编码
  9         String getURL = GET_URL + "?username="
 10                 + URLEncoder.encode("fat man", "utf-8");
 11         URL getUrl = new URL(getURL);
 12         // 根据拼凑的URL，打开连接，URL.openConnection函数会根据URL的类型，
 13         // 返回不同的URLConnection子类的对象，这里URL是一个http，因此实际返回的是HttpURLConnection
 14         HttpURLConnection connection = (HttpURLConnection) getUrl
 15                 .openConnection();
 16         // 进行连接，但是实际上get request要在下一句的connection.getInputStream()函数中才会真正发到
 17         // 服务器
 18         connection.connect();
 19         // 取得输入流，并使用Reader读取
 20         BufferedReader reader = new BufferedReader(new InputStreamReader(
 21                 connection.getInputStream()));
 22         System.out.println("=============================");
 23         System.out.println("Contents of get request");
 24         System.out.println("=============================");
 25         String lines;
 26         while ((lines = reader.readLine()) != null) {
 27             System.out.println(lines);
 28         }
 29         reader.close();
 30         // 断开连接
 31         connection.disconnect();
 32         System.out.println("=============================");
 33         System.out.println("Contents of get request ends");
 34         System.out.println("=============================");
 35     }
 36 
 37     public static void readContentFromPost() throws IOException {
 38         // Post请求的url，与get不同的是不需要带参数
 39         URL postUrl = new URL(POST_URL);
 40         // 打开连接
 41         HttpURLConnection connection = (HttpURLConnection) postUrl
 42                 .openConnection();
 43         // Output to the connection. Default is
 44         // false, set to true because post
 45         // method must write something to the
 46         // connection
 47         // 设置是否向connection输出，因为这个是post请求，参数要放在
 48         // http正文内，因此需要设为true
 49         connection.setDoOutput(true);
 50         // Read from the connection. Default is true.
 51         connection.setDoInput(true);
 52         // Set the post method. Default is GET
 53         connection.setRequestMethod("POST");
 54         // Post cannot use caches
 55         // Post 请求不能使用缓存
 56         connection.setUseCaches(false);
 57         // This method takes effects to
 58         // every instances of this class.
 59         // URLConnection.setFollowRedirects是static函数，作用于所有的URLConnection对象。
 60         // connection.setFollowRedirects(true);
 61 
 62         // This methods only
 63         // takes effacts to this
 64         // instance.
 65         // URLConnection.setInstanceFollowRedirects是成员函数，仅作用于当前函数
 66         connection.setInstanceFollowRedirects(true);
 67         // Set the content type to urlencoded,
 68         // because we will write
 69         // some URL-encoded content to the
 70         // connection. Settings above must be set before connect!
 71         // 配置本次连接的Content-type，配置为application/x-www-form-urlencoded的
 72         // 意思是正文是urlencoded编码过的form参数，下面我们可以看到我们对正文内容使用URLEncoder.encode
 73         // 进行编码
 74         connection.setRequestProperty("Content-Type",
 75                 "application/x-www-form-urlencoded");
 76         // 连接，从postUrl.openConnection()至此的配置必须要在connect之前完成，
 77         // 要注意的是connection.getOutputStream会隐含的进行connect。
 78         connection.connect();
 79         DataOutputStream out = new DataOutputStream(connection
 80                 .getOutputStream());
 81         // The URL-encoded contend
 82         // 正文，正文内容其实跟get的URL中‘?‘后的参数字符串一致
 83         String content = "firstname=" + URLEncoder.encode("一个大肥人", "utf-8");
 84         // DataOutputStream.writeBytes将字符串中的16位的unicode字符以8位的字符形式写道流里面
 85         out.writeBytes(content); 
 86 
 87         out.flush();
 88         out.close(); // flush and close
 89         BufferedReader reader = new BufferedReader(new InputStreamReader(
 90                 connection.getInputStream()));
 91         String line;
 92         System.out.println("=============================");
 93         System.out.println("Contents of post request");
 94         System.out.println("=============================");
 95         while ((line = reader.readLine()) != null) {
 96             System.out.println(line);
 97         }
 98         System.out.println("=============================");
 99         System.out.println("Contents of post request ends");
100         System.out.println("=============================");
101         reader.close();
102         connection.disconnect();
103     }
104 
105     /** *//**
106      * @param args
107      */
108     public static void main(String[] args) {
109         // TODO Auto-generated method stub
110         try {
111             readContentFromGet();
112             readContentFromPost();
113         } catch (IOException e) {
114             // TODO Auto-generated catch block
115             e.printStackTrace();
116         }
117     }
118 
119 }

上面的readContentFromGet()函数产生了一个get请求，传给servlet一个username参数，值为"fat man"。
readContentFromPost()函数产生了一个post请求，传给servlet一个firstname参数，值为"一个大肥人"。
HttpURLConnection.connect函数，实际上只是建立了一个与服务器的tcp连接，并没有实际发送http请求。无论是post还是get，http请求实际上直到HttpURLConnection.getInputStream()这个函数里面才正式发送出去。

在readContentFromPost() 中，顺序是重中之重，对connection对象的一切配置（那一堆set函数）都必须要在connect()函数执行之前完成。而对 outputStream的写操作，又必须要在inputStream的读操作之前。这些顺序实际上是由http请求的格式决定的。

http 请求实际上由两部分组成，一个是http头，所有关于此次http请求的配置都在http头里面定义，一个是正文content，在connect()函数里面，会根据HttpURLConnection对象的配置值生成http头，因此在调用connect函数之前，就必须把所有的配置准备好。

紧接着http头的是http请求的正文，正文的内容通过outputStream写入，实际上outputStream不是一个网络流，充其量是个字符串流，往里面写入的东西不会立即发送到网络，而是在流关闭后，根据输入的内容生成http正文。

至此，http请求的东西已经准备就绪。在getInputStream()函数调用的时候，就会把准备好的http请求正式发送到服务器了，然后返回一个输入流，用于读取服务器对于此次http请求的返回信息。由于http请求在getInputStream的时候已经发送出去了（包括http头和正文），因此在getInputStream()函数之后对connection对象进行设置（对http头的信息进行修改）或者写入 outputStream（对正文进行修改）都是没有意义的了，执行这些操作会导致异常的发生
上节说道，post请求的OutputStream实际上不是网络流，而是写入内存，在getInputStream中才真正把写道流里面的内容作为正文与根据之前的配置生成的http request头合并成真正的http request，并在此时才真正向服务器发送。

HttpURLConnection.setChunkedStreamingMode 函数可以改变这个模式，设置了ChunkedStreamingMode后，不再等待OutputStream关闭后生成完整的http request一次过发送，而是先发送http request头，正文内容则是网路流的方式实时传送到服务器。实际上是不告诉服务器http正文的长度，这种模式适用于向服务器传送较大的或者是不容易获取长度的数据，如文件。

 1 public static void readContentFromChunkedPost() throws IOException {
 2         URL postUrl = new URL(POST_URL);
 3         HttpURLConnection connection = (HttpURLConnection) postUrl
 4                 .openConnection();
 5         connection.setDoOutput(true);
 6         connection.setDoInput(true);
 7         connection.setRequestMethod("POST");
 8         connection.setUseCaches(false);
 9         connection.setInstanceFollowRedirects(true);
10         connection.setRequestProperty("Content-Type",
11                 "application/x-www-form-urlencoded");
12         /**//*
13          * 与readContentFromPost()最大的不同，设置了块大小为5字节
14          */
15         connection.setChunkedStreamingMode(5);
16         connection.connect();
17         /**//*
18          * 注意，下面的getOutputStream函数工作方式于在readContentFromPost()里面的不同
19          * 在readContentFromPost()里面该函数仍在准备http request，没有向服务器发送任何数据
20          * 而在这里由于设置了ChunkedStreamingMode，getOutputStream函数会根据connect之前的配置
21          * 生成http request头，先发送到服务器。
22          */
23         DataOutputStream out = new DataOutputStream(connection
24                 .getOutputStream());
25         String content = "firstname=" + URLEncoder.encode("一个大肥人                                                                               " +
26                 "                                          " +
27                 "asdfasfdasfasdfaasdfasdfasdfdasfs", "utf-8");
28         out.writeBytes(content); 
29 
30         out.flush();
31         out.close(); // 到此时服务器已经收到了完整的http request了，而在readContentFromPost()函数里，要等到下一句服务器才能收到http请求。
32         BufferedReader reader = new BufferedReader(new InputStreamReader(
33                 connection.getInputStream()));
34         
35         out.flush();
36         out.close(); // flush and close
37         String line;
38         System.out.println("=============================");
39         System.out.println("Contents of post request");
40         System.out.println("=============================");
41         while ((line = reader.readLine()) != null) {
42             System.out.println(line);
43         }
44         System.out.println("=============================");
45         System.out.println("Contents of post request ends");
46         System.out.println("=============================");
47         reader.close();
48         connection.disconnect();
49     }