1. 概述

在實際開發過程中，我們經常需要調用對方提供的接口或測試自己寫的接口是否合適。很多項目都會封裝規定好本身項目的接口規范，所以大多數需要去調用對方提供的接口或第三方接口（短信、天氣等）。

在Java項目中調用第三方接口的方式有：

①通過JDK網絡類Java.net.HttpURLConnection；

②通過common封裝好的HttpClient；

③通過Apache封裝好的CloseableHttpClient；

④通過SpringBoot-RestTemplate；

2. Java調用第三方http接口的方式

2.1 通過JDK網絡類Java.net.HttpURLConnection

比較原始的一種調用做法，這里把get請求和post請求都統一放在一個方法里面，直接上代碼：

按 Ctrl+C 復制代碼

2.2 通過apache common封裝好的HttpClient

httpClient的get或post請求方式步驟：

生成一個HttpClient對象並設置相應的參數；
生成一個GetMethod對象或PostMethod並設置響應的參數；
用HttpClient生成的對象來執行GetMethod生成的Get方法；
處理響應狀態碼；
若響應正常，處理HTTP響應內容；
釋放連接。

導入如下jar包：

        <!--HttpClient-->
        <dependency>
            <groupId>commons-httpclient</groupId>
            <artifactId>commons-httpclient</artifactId>
            <version>3.1</version>
        </dependency>

代碼如下：

import com.alibaba.fastjson.JSONObject;
import org.apache.commons.httpclient.*;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.params.HttpMethodParams;

import java.io.IOException;
import java.io.InputStream;

/**
 * @Author: Yang JianQiu
 * @Date: 2019/4/28 11:07
 *
 * HttpClient模擬get、post請求並發送請求參數（json等）
 * 【參考資料】
 * https://javasam.iteye.com/blog/2117845
 * https://blog.csdn.net/qq_28379809/article/details/82898792
 */
public class HttpClientToInterface {

    /**
     * httpClient的get請求方式
     * 使用GetMethod來訪問一個URL對應的網頁實現步驟：
     * 1.生成一個HttpClient對象並設置相應的參數；
     * 2.生成一個GetMethod對象並設置響應的參數；
     * 3.用HttpClient生成的對象來執行GetMethod生成的Get方法；
     * 4.處理響應狀態碼；
     * 5.若響應正常，處理HTTP響應內容；
     * 6.釋放連接。
     * @param url
     * @param charset
     * @return
     */
    public static String doGet(String url, String charset){
        /**
         * 1.生成HttpClient對象並設置參數
         */
        HttpClient httpClient = new HttpClient();
        //設置Http連接超時為5秒
        httpClient.getHttpConnectionManager().getParams().setConnectionTimeout(5000);

        /**
         * 2.生成GetMethod對象並設置參數
         */
        GetMethod getMethod = new GetMethod(url);
        //設置get請求超時為5秒
        getMethod.getParams().setParameter(HttpMethodParams.SO_TIMEOUT, 5000);
        //設置請求重試處理，用的是默認的重試處理：請求三次
        getMethod.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, new DefaultHttpMethodRetryHandler());

        String response = "";

        /**
         * 3.執行HTTP GET 請求
         */
        try {
            int statusCode = httpClient.executeMethod(getMethod);

            /**
             * 4.判斷訪問的狀態碼
             */
            if (statusCode != HttpStatus.SC_OK){
                System.err.println("請求出錯：" + getMethod.getStatusLine());
            }

            /**
             * 5.處理HTTP響應內容
             */
            //HTTP響應頭部信息，這里簡單打印
            Header[] headers = getMethod.getResponseHeaders();
            for (Header h: headers){
                System.out.println(h.getName() + "---------------" + h.getValue());
            }
            //讀取HTTP響應內容，這里簡單打印網頁內容
            //讀取為字節數組
            byte[] responseBody = getMethod.getResponseBody();
            response = new String(responseBody, charset);
            System.out.println("-----------response:" + response);
            //讀取為InputStream，在網頁內容數據量大時候推薦使用
            //InputStream response = getMethod.getResponseBodyAsStream();

        } catch (HttpException e) {
            //發生致命的異常，可能是協議不對或者返回的內容有問題
            System.out.println("請檢查輸入的URL!");
            e.printStackTrace();
        } catch (IOException e){
            //發生網絡異常
            System.out.println("發生網絡異常!");
        }finally {
            /**
             * 6.釋放連接
             */
            getMethod.releaseConnection();
        }
        return response;
    }

    /**
     * post請求
     * @param url
     * @param json
     * @return
     */
    public static String doPost(String url, JSONObject json){
        HttpClient httpClient = new HttpClient();
        PostMethod postMethod = new PostMethod(url);

        postMethod.addRequestHeader("accept", "*/*");
        postMethod.addRequestHeader("connection", "Keep-Alive");
        //設置json格式傳送
        postMethod.addRequestHeader("Content-Type", "application/json;charset=utf-8");
        //必須設置下面這個Header
        postMethod.addRequestHeader("User-Agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.81 Safari/537.36");
        //添加請求參數
        postMethod.addParameter("commentId", json.getString("commentId"));

        String res = "";
        try {
            int code = httpClient.executeMethod(postMethod);
            if (code == 200){
                res = postMethod.getResponseBodyAsString();
                System.out.println(res);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return res;
    }

    public static void main(String[] args) {
        doGet("http://tcc.taobao.com/cc/json/mobile_tel_segment.htm?tel=13026194071", "UTF-8");
        System.out.println("-----------分割線------------");
        System.out.println("-----------分割線------------");
        System.out.println("-----------分割線------------");

        JSONObject jsonObject = new JSONObject();
        jsonObject.put("commentId", "13026194071");
        doPost("http://tcc.taobao.com/cc/json/mobile_tel_segment.htm?tel=13026194071", jsonObject);
    }
}

2.3 通過Apache封裝好的CloseableHttpClient

CloseableHttpClient是在HttpClient的基礎上修改更新而來的，這里還涉及到請求頭token的設置（請求驗證），利用fastjson轉換請求或返回結果字符串為json格式，當然上面兩種方式也是可以設置請求頭token、json的，這里只在下面說明。

導入如下jar包：

        <!--CloseableHttpClient-->
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
            <version>4.5.2</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.28</version>
        </dependency>

代碼如下：

import com.alibaba.fastjson.JSONObject;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;

import java.io.IOException;

/**
 * @Author: Yang JianQiu
 * @Date: 2019/4/26 11:41
 * Apache封裝好的CloseableHttpClient
 * 【參考資料】
 *  https://www.cnblogs.com/siv8/p/6222709.html
 *  https://blog.csdn.net/qq_35860138/article/details/82967727
 */
public class CloseableHttpClientToInterface {

    private static String tokenString = "";
    private static String AUTH_TOKEN_EXPIRED = "AUTH_TOKEN_EXPIRED";
    private static CloseableHttpClient httpClient = null;

    /**
     * 以get方式調用第三方接口
     * @param url
     * @return
     */
    public static String doGet(String url, String token){
        //創建HttpClient對象
        CloseableHttpClient httpClient = HttpClientBuilder.create().build();
        HttpGet get = new HttpGet(url);

        try {
            if (tokenString != null && !tokenString.equals("")){
                tokenString = getToken();
            }
            //api_gateway_auth_token自定義header頭，用於token驗證使用
            get.addHeader("api_gateway_auth_token", tokenString);
            get.addHeader("User-Agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.81 Safari/537.36");
            HttpResponse response = httpClient.execute(get);
            if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK){
                //返回json格式
                String res = EntityUtils.toString(response.getEntity());
                return res;
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * 以post方式調用第三方接口
     * @param url
     * @param json
     * @return
     */
    public static String doPost(String url, JSONObject json){
        
        try {
            if (httpClient == null){
                httpClient = HttpClientBuilder.create().build();
            }

            HttpPost post = new HttpPost(url);
            
            if (tokenString != null && !tokenString.equals("")){
                tokenString = getToken();
            }
            
            //api_gateway_auth_token自定義header頭，用於token驗證使用
            post.addHeader("api_gateway_auth_token", tokenString);
            post.addHeader("User-Agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.81 Safari/537.36");

            StringEntity s = new StringEntity(json.toString());
            s.setContentEncoding("UTF-8");
            //發送json數據需要設置contentType
            s.setContentType("application/x-www-form-urlencoded");
            //設置請求參數
            post.setEntity(s);
            HttpResponse response = httpClient.execute(post);

            if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK){
                //返回json格式
                String res = EntityUtils.toString(response.getEntity());
                return res;
            }
        } catch (Exception e) {
            e.printStackTrace();
        }finally {
            if (httpClient != null){
                try {
                    httpClient.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        return null;
    }

    /**
     * 獲取第三方接口的token
     */
    public static String getToken(){

        String token = "";

        JSONObject object = new JSONObject();
        object.put("appid", "appid");
        object.put("secretkey", "secretkey");

        try {
            if (httpClient == null){
                httpClient = HttpClientBuilder.create().build();
            }
            HttpPost post = new HttpPost("http://localhost/login");
            
            post.addHeader("User-Agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.81 Safari/537.36");

            StringEntity s = new StringEntity(object.toString());
            s.setContentEncoding("UTF-8");
            //發送json數據需要設置contentType
            s.setContentType("application/x-www-form-urlencoded");
            //設置請求參數
            post.setEntity(s);
            HttpResponse response = httpClient.execute(post);

            //這里可以把返回的結果按照自定義的返回數據結果，把string轉換成自定義類
            //ResultTokenBO result = JSONObject.parseObject(response, ResultTokenBO.class);

           //把response轉為jsonObject
            JSONObject result = JSONObject.parseObject(response);
            if (result.containsKey("token")){
                token = result.getString("token");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return token;
    }

    /**
     * 測試
     */
    public static void test(String telephone){

        JSONObject object = new JSONObject();
        object.put("telephone", telephone);

        try {
            //首先獲取token
            tokenString = getToken();
            String response = doPost("http://localhost/searchUrl", object);

            //如果返回的結果是list形式的，需要使用JSONObject.parseArray轉換
            //List<Result> list = JSONObject.parseArray(response, Result.class);

            System.out.println(response);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        test("12345678910");
    }

}

2.4 通過SpringBoot-RestTemplate

springBoot-RestTemple是上面三種方式的集大成者，代碼編寫更加簡單，目前可以采用的調用第三方接口有：

delete() 在特定的URL上對資源執行HTTP DELETE操作
exchange() 在URL上執行特定的HTTP方法，返回包含對象的ResponseEntity，這個對象是從響應體中映射得到的
execute() 在URL上執行特定的HTTP方法，返回一個從響應體映射得到的對象
getForEntity() 發送一個HTTP GET請求，返回的ResponseEntity包含了響應體所映射成的對象
getForObject() 發送一個HTTP GET請求，返回的請求體將映射為一個對象
postForEntity() POST 數據到一個URL，返回包含一個對象的ResponseEntity，這個對象是從響應體中映射得到的
postForObject() POST 數據到一個URL，返回根據響應體匹配形成的對象
headForHeaders() 發送HTTP HEAD請求，返回包含特定資源URL的HTTP頭
optionsForAllow() 發送HTTP OPTIONS請求，返回對特定URL的Allow頭信息
postForLocation() POST 數據到一個URL，返回新創建資源的URL
put() PUT 資源到特定的URL

注意：目前標紅的為常用的

首先導入springboot的web包

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.4.RELEASE</version>
    </parent>

    <dependencies>
        <!--CloseableHttpClient-->
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
            <version>4.5.2</version>
        </dependency>

        <!--spring restTemplate-->
        <!-- @ConfigurationProperties annotation processing (metadata for IDEs)
                生成spring-configuration-metadata.json類，需要引入此類-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-tomcat</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jetty</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

在啟動類同包下創建RestTemplateConfig.java類

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.client.SimpleClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;

/**
 * @Author: Yang JianQiu
 * @Date: 2019/4/28 14:01
 */
@Configuration
public class RestTemplateConfig {

    @Bean
    public RestTemplate restTemplate(ClientHttpRequestFactory factory){
        return new RestTemplate(factory);
    }

    @Bean
    public ClientHttpRequestFactory simpleClientHttpRequestFactory(){
        SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
        factory.setConnectTimeout(15000);
        factory.setReadTimeout(5000);
        return factory;
    }
}

然后在Service類（RestTemplateToInterface ）中注入使用

具體代碼如下：

import com.alibaba.fastjson.JSONObject;
import com.swordfall.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.*;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;

/**
 * @Author: Yang JianQiu
 * @Date: 2019/4/28 14:13
 *
 * 【參考資料】
 * https://blog.csdn.net/qq_15452971/article/details/79416469
 * https://blog.csdn.net/weixin_40461281/article/details/83540604
 */
@Service
public class RestTemplateToInterface {

    @Autowired
    private RestTemplate restTemplate;

    /**
     * 以get方式請求第三方http接口 getForEntity
     * @param url
     * @return
     */
    public User doGetWith1(String url){
        ResponseEntity<User> responseEntity = restTemplate.getForEntity(url, User.class);
        User user = responseEntity.getBody();
        return user;
    }

    /**
     * 以get方式請求第三方http接口 getForObject
     * 返回值返回的是響應體，省去了我們再去getBody()
     * @param url
     * @return
     */
    public User doGetWith2(String url){
        User user  = restTemplate.getForObject(url, User.class);
        return user;
    }

    /**
     * 以post方式請求第三方http接口 postForEntity
     * @param url
     * @return
     */
    public String doPostWith1(String url){
        User user = new User("小白", 20);
        ResponseEntity<String> responseEntity = restTemplate.postForEntity(url, user, String.class);
        String body = responseEntity.getBody();
        return body;
    }

    /**
     * 以post方式請求第三方http接口 postForEntity
     * @param url
     * @return
     */
    public String doPostWith2(String url){
        User user = new User("小白", 20);
        String body = restTemplate.postForObject(url, user, String.class);
        return body;
    }

    /**
     * exchange
     * @return
     */
    public String doExchange(String url, Integer age, String name){
        //header參數
        HttpHeaders headers = new HttpHeaders();
        String token = "asdfaf2322";
        headers.add("authorization", token);
        headers.setContentType(MediaType.APPLICATION_JSON);

        //放入body中的json參數
        JSONObject obj = new JSONObject();
        obj.put("age", age);
        obj.put("name", name);

        //組裝
        HttpEntity<JSONObject> request = new HttpEntity<>(obj, headers);
        ResponseEntity<String> responseEntity = restTemplate.exchange(url, HttpMethod.POST, request, String.class);
        String body = responseEntity.getBody();
        return body;
    }
}

總結

【github地址】

https://github.com/SwordfallYeung/JavaInvokingHttpInterface.git

【參考資料】

http://www.cnblogs.com/angusbao/p/7727649.html 純Java api HttpURLConnection

https://blog.csdn.net/chijiandi/article/details/81388240 純Java api HttpURLConnection

https://www.cnblogs.com/xuegu/p/8490815.html 封裝api HttpClient

https://www.cnblogs.com/unknows/p/8534713.html

https://blog.csdn.net/qq_35860138/article/details/82967727 封裝api HttpClient

https://blog.csdn.net/a1032818891/article/details/81172478 SpringBoot-RestTemplate

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 Java調用第三方http接口的方式 java調用第三方http接口的方式【CloseableHttpClient】 Java調用第三方http接口的方式 java調用第三方http接口的方式 java 調用第三方http接口的方式【RestTemplate】 java項目調用第三方接口的三種方式 java中調用第三方接口獲取數據的方式通過HTTP請求調用第三方接口【Java】Java調用第三方接口 JAVA 調用第三方接口