Java调用第三方http接口的常用方式

时间：2025-05-11 07:40:41

1.概述

在实际开发过程中，我们经常需要调用对方提供的接口或测试自己写的接口是否合适。很多项目都会封装规定好本身项目的接口规范，所以大多数需要去调用对方提供的接口或第三方接口（短信、天气等）。

在Java项目中调用第三方接口的常用方式有：

①通过JDK网络类；

②通过Apache common封装好的HttpClient；

③通过Apache封装好的CloseableHttpClient；

④通过OkHttp；

⑤通过Spring的RestTemplate；

⑥通过hutool的HttpUtil。

调用第三方http接口的方式

2.1 通过JDK网络类

简介：包下的原生java api提供的http请求。 

使用步骤：

1、通过统一资源定位器（）获取连接器（）。

2、设置请求的参数。

3、发送请求。

4、以输入流的形式获取返回内容。

5、关闭输入流。

比较原始的一种调用做法，这里把get请求和post请求都统一放在一个方法里面，直接上代码：

import ;
import .*;
import ;
import ;

/**
 * @ClassName : HttpUrlConnectionToInterface
 * @Description : jdk类HttpURLConnection调用第三方http接口
 * @Author : THQ
 * @Date: 2021-09-02 14:09
 * @Version V1.0
 */
public class HttpUrlConnectionToInterface {

    /**
     * 以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) ();

            //设定请求的方法为"POST"，默认是GET
            //post与get的不同之处在于post的参数不是放在URL字串里面，而是放在http请求的正文内。
            ("POST");

            //设置30秒连接超时
            (30000);
            //设置30秒读取超时
            (30000);

            // 设置是否向httpUrlConnection输出，因为这个是post请求，参数要放在http正文内，因此需要设为true, 默认情况下是false;
            (true);
            // 设置是否从httpUrlConnection读入，默认情况下是true;
            (true);

            // Post请求不能使用缓存
            (false);

            //设置通用的请求属性
            ("accept", "*/*");
            ("connection", "Keep-Alive");  //维持长链接
            ("Content-Type", "application/json;charset=utf-8");

            //连接，从上述()至此的配置必须要在connect之前完成，
            ();

            /**
             * 下面的三句代码，就是调用第三方http接口
             */
            //获取URLConnection对象对应的输出流
            //此处getOutputStream会隐含的进行connect(即：如同调用上面的connect()方法，所以在开发中不调用上述的connect()也可以)。
            out = new OutputStreamWriter((), "UTF-8");
            //发送请求参数即数据
            (data);
            //flush输出流的缓冲
            ();

            /**
             * 下面的代码相当于，获取调用第三方http接口后返回的结果
             */
            //获取URLConnection对象对应的输入流
            InputStream is = ();
            //构造一个字符流缓存
            br = new BufferedReader(new InputStreamReader(is));
            String str = "";
            while ((str = ()) != null){
                result += str;
            }
            (result);
            //关闭流
            ();
            //断开连接，disconnect是在底层tcp socket链接空闲时才切断，如果正在被其他线程使用就不切断。
            ();

        } catch (Exception e) {
            ();
        }finally {
            try {
                if (out != null){
                    ();
                }
                if (br != null){
                    ();
                }
            } catch (IOException e) {
                ();
            }
        }
    }

    /**
     * 以get方式调用对方接口方法
     * @param pathUrl
     */
    public static void doGet(String pathUrl){
        BufferedReader br = null;
        String result = "";
        try {
            URL url = new URL(pathUrl);

            //打开和url之间的连接
            HttpURLConnection conn = (HttpURLConnection) ();

            //设定请求的方法为"GET"，默认是GET
            //post与get的不同之处在于post的参数不是放在URL字串里面，而是放在http请求的正文内。
            ("GET");

            //设置30秒连接超时
            (30000);
            //设置30秒读取超时
            (30000);

            // 设置是否向httpUrlConnection输出，因为这个是post请求，参数要放在http正文内，因此需要设为true, 默认情况下是false;
            (true);
            // 设置是否从httpUrlConnection读入，默认情况下是true;
            (true);

            // Post请求不能使用缓存(get可以不使用)
            (false);

            //设置通用的请求属性
            ("accept", "*/*");
            ("connection", "Keep-Alive");  //维持长链接
            ("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");

            //连接，从上述()至此的配置必须要在connect之前完成，
            ();

            /**
             * 下面的代码相当于，获取调用第三方http接口后返回的结果
             */
            //获取URLConnection对象对应的输入流
            InputStream is = ();
            //构造一个字符流缓存
            br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
            String str = "";
            while ((str = ()) != null){
                result += str;
            }
            (result);
            //关闭流
            ();
            //断开连接，disconnect是在底层tcp socket链接空闲时才切断，如果正在被其他线程使用就不切断。
            ();
        } catch (Exception e) {
            ();
        }finally {
            try {
                if (br != null){
                    ();
                }
            } catch (IOException e) {
                ();
            }
        }
    }

    public static void main(String[] args) {
        //post请求一般都是把实体对象转为Json字符串
        LocationPrintDTO locationPrintDTO = new LocationPrintDTO();
        String s = (locationPrintDTO);
        doPost("http://127.0.0.1:9090/ZebraPrinter/locationPrint", s);
        doGet("/api/climate?stationid=57516");
    }
}

2.2 通过apache common封装好的HttpClient

简介：http client到目前为止最新是5.1版，官网地址：/ 。Http client专为推展而设计，同时为基本http协议提供强大支持，尽管包提供了通过http访问的基本功能，但是未提供许多应用程序所需要功能。

使用步骤：

  1. 生成一个HttpClient对象并设置相应的参数；
  2. 生成一个GetMethod对象或PostMethod并设置响应的参数；
  3. 用HttpClient生成的对象来执行GetMethod生成的Get方法；
  4. 处理响应状态码；
  5. 若响应正常，处理HTTP响应内容；
  6. 释放连接。无论执行方法是否成功，都必须释放连接。

导入如下jar包：

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

代码如下：

import ;
import ;
import ;
import ;
import ;
import ;
import ;
import ;

import ;

/**
 * @ClassName : HttpClientToInterface
 * @Description : HttpClient模拟get、post请求并发送请求参数（json等）
 * @Author : THQ
 * @Date: 2021-09-02 16:50
 * @Version V1.0
 */
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秒
        ().getParams().setConnectionTimeout(5000);

        /**
         * 2.生成GetMethod对象并设置参数
         */
        GetMethod getMethod = new GetMethod(url);
        //设置get请求超时为5秒
        ().setParameter(HttpMethodParams.SO_TIMEOUT, 5000);
        //设置请求重试处理，用的是默认的重试处理：请求三次
        ().setParameter(HttpMethodParams.RETRY_HANDLER, new DefaultHttpMethodRetryHandler());

        String response = "";

        /**
         * 3.执行HTTP GET 请求
         */
        try {
            int statusCode = (getMethod);

            /**
             * 4.判断访问的状态码
             */
            if (statusCode != HttpStatus.SC_OK){
                ("请求出错：" + ());
            }

            /**
             * 5.处理HTTP响应内容
             */
            //HTTP响应头部信息，这里简单打印
            Header[] headers = ();
            for (Header h: headers){
                (() + "---------------" + ());
            }
            //读取HTTP响应内容，这里简单打印网页内容
            //读取为字节数组
            byte[] responseBody = ();
            response = new String(responseBody, charset);
            ("-----------response:" + response);
            //读取为InputStream，在网页内容数据量大时候推荐使用
            //InputStream response = ();

        } catch (HttpException e) {
            //发生致命的异常，可能是协议不对或者返回的内容有问题
            ("请检查输入的URL!");
            ();
        } catch (IOException e){
            //发生网络异常
            ("发生网络异常!");
        }finally {
            /**
             * 6.释放连接
             */
            ();
        }
        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);

        ("accept", "*/*");
        ("connection", "Keep-Alive");
        //设置json格式传送
        ("Content-Type", "application/json;charset=utf-8");
        //必须设置下面这个Header
        ("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");
        //添加请求参数
        ("commentId", ("commentId"));

        String res = "";
        try {
            int code = (postMethod);
            if (code == 200){
                res = ();
                (res);
            }
        } catch (IOException e) {
            ();
        }
        return res;
    }

    public static void main(String[] args) {
        doGet("/cc/json/mobile_tel_segment.htm?tel=13026194071", "UTF-8");
        ("-----------分割线------------");
        ("-----------分割线------------");
        ("-----------分割线------------");

        JSONObject jsonObject = new JSONObject();
        ("commentId", "13026194071");
        doPost("/cc/json/mobile_tel_segment.htm", jsonObject);
    }
}

2.3 通过Apache封装好的CloseableHttpClient

 CloseableHttpClient是在HttpClient的基础上修改更新而来的，这里还涉及到请求头token的设置（请求验证），利用fastjson转换请求或返回结果字符串为json格式，当然上面两种方式也是可以设置请求头token、json的，这里只在下面说明。

导入如下jar包：

        <!--CloseableHttpClient-->
        <dependency>
            <groupId></groupId>
            <artifactId>httpclient</artifactId>
            <version>4.5.2</version>
        </dependency>
        <dependency>
            <groupId></groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.28</version>
        </dependency>

代码如下：

import ;
import ;
import ;
import ;
import ;
import ;
import ;
import ;
import ;

import ;

/**
 * @ClassName : CloseableHttpClientToInterface
 * @Description : Apache封装好的CloseableHttpClient
 * @Author : THQ
 * @Date: 2021-09-02 17:16
 * @Version V1.0
 */
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 = ().build();
        HttpGet get = new HttpGet(url);

        try {
            if (tokenString != null && !("")){
                tokenString = getToken();
            }
            //api_gateway_auth_token自定义header头，用于token验证使用
            ("api_gateway_auth_token", tokenString);
            ("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 = (get);
            if (().getStatusCode() == HttpStatus.SC_OK){
                //返回json格式
                String res = (());
                return res;
            }
        } catch (IOException e) {
            ();
        }
        return null;
    }

    /**
     * 以post方式调用第三方接口
     * @param url
     * @param json
     * @return
     */
    public static String doPost(String url, JSONObject json){

        try {
            if (httpClient == null){
                httpClient = ().build();
            }

            HttpPost post = new HttpPost(url);

            if (tokenString != null && !("")){
                tokenString = getToken();
            }

            //api_gateway_auth_token自定义header头，用于token验证使用
            ("api_gateway_auth_token", tokenString);
            ("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(());
            ("UTF-8");
            //发送json数据需要设置contentType
            ("application/x-www-form-urlencoded");
            //设置请求参数
            (s);
            HttpResponse response = (post);

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

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

        String token = "";

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

        try {
            if (httpClient == null){
                httpClient = ().build();
            }
            HttpPost post = new HttpPost("http://localhost/login");

            ("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(());
            ("UTF-8");
            //发送json数据需要设置contentType
            ("application/x-www-form-urlencoded");
            //设置请求参数
            (s);
            HttpResponse response = (post);

            //这里可以把返回的结果按照自定义的返回数据结果，把string转换成自定义类
            //ResultTokenBO result = (response, );

            //把response转为jsonObject
            JSONObject result = ((response));
            if (("token")){
                token = ("token");
            }
        } catch (Exception e) {
            ();
        }
        return token;
    }

    /**
     * 测试
     */
    public static void test(String telephone){

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

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

            //如果返回的结果是list形式的，需要使用转换
            //List<Result> list = (response, );

            (response);

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

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

2.4 通过OkHttp

简介：OkHttp是一个默认有效的HTTP客户端，有效地执行HTTP可以加快您的负载并节省带宽，如果您的服务有多个IP地址，如果第一次连接失败，OkHttp将尝试备用地址。这对于IPv4 + IPv6和冗余数据中心中托管的服务是必需的。OkHttp启动具有现代TLS功能（SNI，ALPN）的新连接，并在握手失败时回退到TLS 1.0，OkHttp支持Android 2.3及更高版本。对于Java，最低要求是1.7。

操作步骤：

1、创建OkhttpClient。

2、mClient执行newCall将Request转化成一个Call。

3、最后call执行excute同步执行，enqueue异步执行。

4、Request主要通过来构建。

5、缓存。

6、取消请求。

导入如下jar包：

        <!--okhttp3-->
        <dependency>
            <groupId>.okhttp3</groupId>
            <artifactId>okhttp</artifactId>
            <version>4.9.1</version>
        </dependency>

代码如下：

import okhttp3.*;

import ;

/**
 * @ClassName : OkHttpToInterface
 * @Description :
 * @Author : THQ
 * @Date: 2021-09-02 17:36
 * @Version V1.0
 */
public class OkHttpToInterface {

    public static final MediaType JSON = ("application/json; charset=utf-8");

    /**
     * 以get方式调用第三方接口
     * @param url
     */
    public static void doGet(String url) {
        OkHttpClient okHttpClient = new OkHttpClient();
        final Request request = new ()
                .url(url)
                .get()//默认就是GET请求，可以不写
                .build();
        Call call = (request);
        (new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                ( "onFailure: ");
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                ("onResponse: " + ().string());
            }
        });
    }

    /**
     * post请求
     * @param url
     * @param json
     */
    public static void doPost(String url, String json){
        MediaType mediaType = ("text/x-markdown; charset=utf-8");
        String requestBody = json;
        Request request = new ()
                .url(url)
                .post((mediaType, requestBody))
                .build();
        OkHttpClient okHttpClient = new OkHttpClient();
        (request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                ("onFailure: " + ());
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                (() + " " +() + " " + ());
                Headers headers = ();
                for (int i = 0; i < (); i++) {
                    ((i) + ":" + (i));
                }
                ("onResponse: " + ().string());
            }
        });
    }

    public static void main(String[] args) {
        doGet("/cc/json/mobile_tel_segment.htm?tel=13026194071");
        doPost("/markdown/raw","I am Jdqm.");
    }
}

2.5 通过Spring的RestTemplate

 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

注意：目前标红的为常用的

操作步骤：

1、使用默认构造方法new一个实例new RestTemplate()。

2、RestTemplate 内部通过调用 doExecute 方法，首先就是获取 ClientHttpRequest。

3、RestTemplate 实现了抽象类 HttpAccessor ，所以可以调用父类的 createRequest。

4、SimpleClientHttpRequestFactory 实现了 ClientHttpRequest，同时实现方法。

5、执行 (request)。

6、执行 response = ()。

7、最后解析response。

首先导入springboot的web包

    <parent>
        <groupId></groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId></groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId></groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

在启动类同包下创建类

import ;
import ;
import ;
import ;
import ;

/**
 * @ClassName : RestTemplateConfig 
 * @Description :
 * @Author : THQ
 * @Date: 2021-09-02 20:00
 * @Version V1.0
 */
@Configuration
public class RestTemplateConfig {

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

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

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

具体代码如下：

import ;
import ;
import .*;
import ;

/**
 * @ClassName : RestTemplateToInterface
 * @Description :
 * @Author : THQ
 * @Date: 2021-09-02 20:03
 * @Version V1.0
 */
public class RestTemplateToInterface {

    @Autowired
    private RestTemplate restTemplate;

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

    /**
     * 以get方式请求第三方http接口 getForObject
     * 返回值返回的是响应体，省去了我们再去getBody()
     * @param url
     * @return
     */
    public User doGetWith2(String url){
        User user  = (url, );
        return user;
    }

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

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

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

        //放入body中的json参数
        JSONObject obj = new JSONObject();
        ("age", age);
        ("name", name);

        //组装
        HttpEntity<JSONObject> request = new HttpEntity<>(obj, headers);
        ResponseEntity<String> responseEntity = (url, , request, );
        String body = ();
        return body;
    }

}

2.6通过hutool的HttpUtil

 简介：关于Hutool工具类之HttpUtil如何使用可以参考官方文档Hutool之HttpUtil。

导入如下jar包：

        <dependency>
            <groupId></groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.7.1</version>
        </dependency>

代码如下：

import ;
import ;
import ;

import ;

/**
 * @ClassName : HttpUtilToInterface
 * @Description :
 * @Author : THQ
 * @Date: 2021-09-02 20:15
 * @Version V1.0
 */
public class HttpUtilToInterface {

    /**
     * get请求示例
     */
    public static void doGet() {
        // 最简单的HTTP请求，可以自动通过header等信息判断编码，不区分HTTP和HTTPS
        String result1 = ("");

        // 当无法识别页面编码的时候，可以自定义请求页面的编码
        String result2 = ("", CharsetUtil.CHARSET_UTF_8);

        //可以单独传入http参数，这样参数会自动做URL编码，拼接在URL中
        HashMap<String, Object> paramMap = new HashMap<>();
        ("city", "北京");
        String result3 = ("", paramMap);
    }

    /**
     * post请求示例
     */
    public static void doPost() {
        //post普通请求示例
        HashMap<String, Object> paramMap = new HashMap<>();
        ("city", "北京");
        String result= ("", paramMap);

        //文件上传示例
        HashMap<String, Object> paramMap1 = new HashMap<>();
        //文件上传只需将参数中的键指定（默认file），值设为文件对象即可，对于使用者来说，文件上传与普通表单提交并无区别
        ("file", ("D:\\"));
        String result1= ("", paramMap1);

        //下载文件（很少用）
        String fileUrl = "/centos/8.4.2105/isos/x86_64/CentOS-8.4.2105-x86_64";
        //将文件下载后保存在E盘，返回结果为下载文件大小
        long size = (fileUrl, ("e:/"));
        ("Download size: " + size);
    }
}

3.总结

日常开发中，我们一般使用spring的resttemplate和hutool的HttpUtil偏多，特别是hutool，非常推荐，里面有很多省心的工具类。

整理花了大半天时间，求收藏点赞。

相关文章