Java 调用第三方接口（get/post）

在项目开发过程中，很多时候会涉及到调用第三方系统的接口的情况，这里使用的是通过JDK网络类Java.net.HttpURLConnection来处理HTTP请求。

使用步骤：

1. 通过统一资源定位器（java.net.URL）获取连接器（java.net.URLConnection)。
2. 设置请求的参数。
3. 发送请求。
4. 以输入流的形式获取返回内容。
5. 关闭输入流。

一、get方式调用

import com.alibaba.fastjson.JSON;
import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
 
public class HttpUrlConnection {
 
    /**
     * 以get方式调用接口
     * @param pathUrl
     */
    public static void doGet(String pathUrl){
        BufferedReader br = null;
        String result = "";
        try {
            URL url = new URL(pathUrl);
 
            //打开和url之间的连接
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
 
            //设定请求的方法为"GET"，默认是GET
            //post与get的不同之处在于post的参数不是放在URL字串里面，而是放在http请求的正文内。
            conn.setRequestMethod("GET");
 
            //设置连接超时（单位：毫秒）
            conn.setConnectTimeout(60000);
            //设置读取超时（单位：毫秒）
            conn.setReadTimeout(60000);
 
            // 设置是否向httpUrlConnection输出(get请求，参数可以直接追加到地址后面，可以不用设置，默认情况下是false)
            conn.setDoOutput(false);
            // 设置是否从httpUrlConnection读入(默认情况下是true)
            conn.setDoInput(true);
 
            // 设置是否使用缓存（Post请求不能使用缓存，get可以不使用)
            conn.setUseCaches(false);
 
            //设置通用的请求属性
            conn.setRequestProperty("accept", "*/*");
            conn.setRequestProperty("connection", "Keep-Alive");  //维持长链接
            conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");
 
            //连接，上述参数的配置必须要在connect之前完成，
            conn.connect();
 
            /**
             * 获取调用第三方http接口后返回的结果
             */
            //获取URLConnection对象对应的输入流
            InputStream is = conn.getInputStream();
            //构造一个字符流缓存
            br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
            String str = "";
            while ((str = br.readLine()) != null){
                result += str;
            }
            System.out.println(result);
            //关闭流
            is.close();
            //断开连接，disconnect是在底层tcp socket链接空闲时才切断，如果正在被其他线程使用就不切断。
            conn.disconnect();
        } catch (Exception e) {
            e.printStackTrace();
        }finally {
            try {
                if (br != null){
                    br.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

}

二、post方式调用

import com.alibaba.fastjson.JSON;
import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
 
public class HttpUrlConnection {
 
    /**
     * 以post方式调用接口
     * @param pathUrl
     */
    public static void doPost(String pathUrl, String data){
        OutputStreamWriter out = null;
        BufferedReader br = null;
        String result = "";
        try {
            URL url = new URL(pathUrl);
 
            //打开和url之间的连接
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
 
            //设定请求的方法为"POST"，默认是GET
            //post与get的不同之处在于post的参数不是放在URL字串里面，而是放在http请求的正文内。
            conn.setRequestMethod("POST");
 
            //设置连接超时（单位：毫秒）
            conn.setConnectTimeout(60000);
            //设置读取数据超时（单位：毫秒）
            conn.setReadTimeout(60000);
 
            // 设置是否向httpUrlConnection输出(对于post请求，参数因为要放在http正文内，因此需要设为true, 默认情况下是false)
            conn.setDoOutput(true);
            // 设置是否从httpUrlConnection读入(默认情况下是true)
            conn.setDoInput(true);
 
            // 设置是否使用缓存（Post请求不能使用缓存）
            conn.setUseCaches(false);
 
            //设置通用的请求属性
            conn.setRequestProperty("accept", "*/*");
            conn.setRequestProperty("connection", "Keep-Alive");  //维持长链接
            conn.setRequestProperty("Content-Type", "application/json;charset=utf-8");
 
            //连接，上述参数配置必须要在connect之前完成，
            conn.connect();
 
            /**
             * 调用第三方http接口
             */
            //获取URLConnection对象对应的输出流
            //此处getOutputStream会隐含的进行connect(即：如同调用上面的connect()方法，所以在开发中不调用上述的connect()也可以)。
            out = new OutputStreamWriter(conn.getOutputStream(), "UTF-8");
            //发送请求参数即数据
            out.write(data);
            //flush输出流的缓冲
            out.flush();
 
            /**
             * 获取调用第三方http接口后返回的结果
             */
            //connection.getResponseCode()可以用来获取状态码
            //int code = connection.getResponseCode();
            
            //获取URLConnection对象对应的输入流
            InputStream is = conn.getInputStream();
            //构造一个字符流缓存
            br = new BufferedReader(new InputStreamReader(is,"UTF-8")));
            String str = "";
            while ((str = br.readLine()) != null){
                result += str;
            }
            System.out.println(result);
            //关闭流
            is.close();
            //断开连接，disconnect是在底层tcp socket链接空闲时才切断，如果正在被其他线程使用就不切断。
            conn.disconnect();
 
        } catch (Exception e) {
            e.printStackTrace();
        }finally {
            try {
                if (out != null){
                    out.close();
                }
                if (br != null){
                    br.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
 
}

---

HttpURLConnection说明

• HttpURLConnection对象不能直接构造，需要通过URL类中的openConnection()方法来获得。
• 对HttpURLConnection对象的配置都需要在connect()方法执行之前完成，因为connect()会根据HttpURLConnection对象的配置值生成HTTP头部信息。
• HttpURLConnection的connect()函数，实际上只是建立了一个与服务器的TCP连接，并没有实际发送HTTP请求。HTTP请求实际上直到我们获取服务器响应数据（如调用getInputStream()、getResponseCode()等方法）时才正式发送出去。
• HttpURLConnection是基于HTTP协议的，其底层通过socket通信实现。如果不设置超时（timeout），在网络异常的情况下，可能会导致程序僵死而不继续往下执行。
• HTTP正文的内容是通过OutputStream流写入的,向流中写入的数据不会立即发送到网络，而是存在于内存缓冲区中，待流关闭时，根据写入的内容生成HTTP正文。
• 调用getInputStream()方法时，返回一个输入流，用于从中读取服务器对于HTTP请求的返回信息。
• 我们可以使用HttpURLConnection.connect()方法手动的发送一个HTTP请求，但是如果要获取HTTP响应的时候，请求就会自动的发起，比如我们使用HttpURLConnection.getInputStream()方法的时候，所以完全没有必要调用connect()方法。

---

HttpURLConnection长连接（Keep-Alive）

JDK8自带的HttpURLConnection，默认启用keepAlive，支持HTTP / 1.1和HTTP / 1.0持久连接，

使用后的HttpURLConnection会放入缓存中供以后的同host:port的请求重用，底层的socket在keepAlive超时之前不会关闭。

HttpURLConnection受以下system properties控制：

1. http.keepAlive=<boolean>（默认值：true），是否启用keepAlive，如果设置为false，则HttpURLConnection不会缓存，使用完后会关闭socket连接。
2. http.maxConnections=<int>（默认值：5），每个目标host缓存socket连接的最大数。

说明：

1. 如果在HttpURLConnection的header中加入Connection: close，则此连接不会启用keepAlive
2. 想要启用keepAlive，程序请求完毕后，必须调用HttpURLConnection.getInputStream().close()（表示归还长连接给缓存，以供下次同host:port的请求重用底层socket连接），而不能调用HttpURLConnection.disconnect()（表示关闭底层socket连接，不会启用keepAlive）
3. keepAliveTimeout首先从http response header中获取，如果没有取到，则默认为5秒，sun.net.www.http.KeepAliveCache.java中有一个线程，每5秒执行一次，检查缓存的连接的空闲时间是否超过keepAliveTimeout，如果超过则关闭连接。从KeepAliveCache中获取缓存的连接时也会检查获取到的连接的空闲时间是否超过keepAliveTimeout，如果超过则关闭连接，并且获取下一个连接，再执行以上检查，直达获取到空闲时间在keepAliveTimeout以内的缓存连接为此。

---

HttpURLConnection关闭

本身要 HttpURLConnection 是很简单的，调用connection.disconnect()就可以了。

这里是想说明一下，是否需要关闭，应该根据实际需要来：
- 当 HttpURLConnection 是 "Connection: close " 模式，那么关闭 inputStream
后就会自动断开连接。
- 当 HttpURLConnection 是 "Connection: Keep-Alive" 模式，那么关闭inputStream后，并不会断开底层的Socket连接。这样的好处，是当需要连接到同一服务器地址时，可以复用该 Socket。这时如果要求断开连接，就可以调用 connection.disconnect() 了。

当然，HttpURLConnection 连接到底是不是Keep-Alive模式，除了 HttpURLConnection 请求设置为 Keep-Alive 外 （http 1.0中默认是关闭的，http 1.1中默认启用Keep-Alive），也需要服务器支持 Keep-Alive，才可以真正建立 Keep-Alive 连接。

---

与HttpClient的区别

在一般情况下，如果只是需要向Web站点的某个简单页面提交请求并获取服务器响应，HttpURLConnection完全可以胜任。但在绝大部分情况下，

Web站点的网页可能没这么简单，这些页面并不是通过一个简单的URL就可访问的，可能需要用户登录而且具有相应的权限才可访问该页面。

在这种情况下，就需要涉及Session、Cookie的处理了，如果打算使用HttpURLConnection来处理这些细节，当然也是可能实现的，只是处理起来难度就大了。

为了更好地处理向Web站点请求，包括处理Session、Cookie等细节问题，Apache开源组织提供了一个HttpClient项目，看它的名称就知道，

它是一个简单的HTTP客户端（并不是浏览器），可以用于发送HTTP请求，接收HTTP响应。但不会缓存服务器的响应，

不能执行HTML页面中嵌入的Javascript代码；也不会对页面内容进行任何解析、处理。

简单来说，HttpClient就是一个增强版的HttpURLConnection，HttpURLConnection可以做的事情HttpClient全部可以做；

HttpURLConnection没有提供的有些功能，HttpClient也提供了，但它只是关注于如何发送请求、接收响应，以及管理HTTP连接。