SpringBoot 第三方接口调用

调用第三方的接口的方式有很多，推荐使用Hutool的HttpUtil方式、RestTemplate方式、Feign消费方式。

案例项目地址 (opens new window)

1、Hutool的HttpUtil方式

1.1、引入依赖

<!--  hutool工具包  -->
<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.16</version>
</dependency>

1.2、GET请求

@Test
public void testHutoolHttpGet(){
    // 最简单的HTTP请求，可以自动通过header等信息判断编码，不区分HTTP和HTTPS
    String result1= HttpUtil.get("https://www.baidu.com");
    log.info("result1===>"+result1);

    // 当无法识别页面编码的时候，可以自定义请求页面的编码
    String result2= HttpUtil.get("https://www.baidu.com", CharsetUtil.CHARSET_UTF_8);
    log.info("result2===>"+ JSON.parse(result2));

    //可以单独传入http参数，这样参数会自动做URL编码，拼接在URL中
    HashMap<String, Object> paramMap = new HashMap<>();
    paramMap.put("city", "北京");
    String result3= HttpUtil.get("https://www.baidu.com", paramMap);
    log.info("result3===>"+result3);
}

1.3、POST请求

@Test
public void testHutoolHttpPost(){
    HashMap<String, Object> paramMap = new HashMap<>();
    paramMap.put("city", "北京");
    String result= HttpUtil.post("https://www.baidu.com", paramMap);
    log.info("result===>"+result);
}

1.4、文件上传

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

String result= HttpUtil.post("https://www.baidu.com", paramMap);

1.5、下载文件

支持大文件下载

详情查看：Hutool-Http客户端工具类-HttpUtil (opens new window)

2、RestTemplate方式

RestTemplate是SpringBoot提供的访问外部接口API。

2.1、GET请求

• getForEntity(String url,Class responseType,Object…urlVariables)

@Test
public void testRestTemplateHttpGet(){
    String url = "https://www.xygalaxy.com/api/link/ranking/list?sorted={sorted}&type={type}";

    Map<String,String> params=new HashMap<>();
    params.put("sorted","最高人气");
    params.put("type","点赞榜");

    RestTemplate restTemplate=new RestTemplate();
    ResponseEntity<String> responseEntity=restTemplate.getForEntity(url,String.class,params);
    log.info("responseEntity====>"+responseEntity);
}

• getForEntity(URI url,Class responseType)

@Test
public void testRestTemplateHttpGet2(){
    String url = "https://www.xygalaxy.com/api/link/ranking/list?sorted={sorted}&type={type}";

    RestTemplate restTemplate=new RestTemplate();
    UriComponents uriComponents= UriComponentsBuilder.fromUriString(url)
            .queryParam("sorted","最高人气")
            .queryParam("type","点赞榜")
            .build()
            .encode();
    URI uri = uriComponents.toUri();
    String responseEntity = restTemplate.getForEntity(uri,String.class).getBody();
    log.info("responseEntity====>"+responseEntity);
}

• getForObject

getForObject方法可以理解为对getForEntity的进一步封装，它通过HttpMessageConverterExtractor对HTTP的请求响应体body内容进行对象转换，实现请求直接返回包装好的对象内容。

getForObject(String url,Class responseType,Object...urlVariables)
getForObject(String url,Class responseType,Map urlVariables)
getForObject(URI url,Class responseType)

@Test
public void testRestTemplateHttpGet3(){
    String url = "https://www.xygalaxy.com/api/link/ranking/list?sorted={sorted}&type={type}";

    Map<String,String> params=new HashMap<>();
    params.put("sorted","最高人气");
    params.put("type","点赞榜");

    RestTemplate restTemplate=new RestTemplate();
    String responseEntity = restTemplate.getForObject(url,String.class,params);
    log.info("responseEntity====>"+responseEntity);
}

2.2、POST请求

Post请求提供有三种方法，postForEntity、postForObject和postForLocation。其中每种方法都存在三种方法，postForEntity方法如下:

postForEntity(String url,Object request,Class responseType,Object... uriVariables)
postForEntity(String url,Object request,Class responseType,Map uriVariables)
postForEntity(URI url,Object request，Class responseType)

使用上跟GET方式差不多，这里不再赘述。

3、Feign消费方式

微服务中调用别的服务，通过Feign或者OpenFeign方式进行调用

4、Java原生Http方式

作为了解即可，能使用封装的就使用封装的，这里网上找了个案例。

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) url.openConnection();
 
            //设定请求的方法为"POST"，默认是GET
            //post与get的不同之处在于post的参数不是放在URL字串里面，而是放在http请求的正文内。
            conn.setRequestMethod("POST");
 
            //设置30秒连接超时
            conn.setConnectTimeout(30000);
            //设置30秒读取超时
            conn.setReadTimeout(30000);
 
            // 设置是否向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");
 
            //连接，从上述url.openConnection()至此的配置必须要在connect之前完成，
            conn.connect();
 
            /**
             * 下面的三句代码，就是调用第三方http接口
             */
            //获取URLConnection对象对应的输出流
            //此处getOutputStream会隐含的进行connect(即：如同调用上面的connect()方法，所以在开发中不调用上述的connect()也可以)。
            out = new OutputStreamWriter(conn.getOutputStream(), "UTF-8");
            //发送请求参数即数据
            out.write(data);
            //flush输出流的缓冲
            out.flush();
 
            /**
             * 下面的代码相当于，获取调用第三方http接口后返回的结果
             */
            //获取URLConnection对象对应的输入流
            InputStream is = conn.getInputStream();
            //构造一个字符流缓存
            br = new BufferedReader(new InputStreamReader(is));
            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();
            }
        }
    }
 
    /**
     * 以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");
 
            //设置30秒连接超时
            conn.setConnectTimeout(30000);
            //设置30秒读取超时
            conn.setReadTimeout(30000);
 
            // 设置是否向httpUrlConnection输出，因为这个是post请求，参数要放在http正文内，因此需要设为true, 默认情况下是false;
            conn.setDoOutput(true);
            // 设置是否从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");
 
            //连接，从上述url.openConnection()至此的配置必须要在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();
            }
        }
    }
 
    public static void main(String[] args) {
        //post请求一般都是把实体对象转为Json字符串
        LocationPrintDTO locationPrintDTO = new LocationPrintDTO();
        String s = JSON.toJSONString(locationPrintDTO);
        doPost("http://127.0.0.1:9090/ZebraPrinter/locationPrint", s);
        doGet("https://weather.cma.cn/api/climate?stationid=57516");
    }
}

5、Common的HttpClient方式

5.1、引入依赖

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

5.2、代码案例

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", jsonObject);
    }
}

6、OkHttp方式

6.1、引入依赖

<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.10.0</version>
</dependency>

6.2、代码案例

public class OkHttpToInterface {
 
    public static final MediaType JSON = MediaType.get("application/json; charset=utf-8");
 
    /**
     * 以get方式调用第三方接口
     * @param url
     */
    public static void doGet(String url) {
        OkHttpClient okHttpClient = new OkHttpClient();
        final Request request = new Request.Builder()
                .url(url)
                .get()//默认就是GET请求，可以不写
                .build();
        Call call = okHttpClient.newCall(request);
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                System.out.println( "onFailure: ");
            }
 
            @Override
            public void onResponse(Call call, Response response) throws IOException {
                System.out.println("onResponse: " + response.body().string());
            }
        });
    }
 
    /**
     * post请求
     * @param url
     * @param json
     */
    public static void doPost(String url, String json){
        MediaType mediaType = MediaType.parse("text/x-markdown; charset=utf-8");
        String requestBody = json;
        Request request = new Request.Builder()
                .url(url)
                .post(RequestBody.create(mediaType, requestBody))
                .build();
        OkHttpClient okHttpClient = new OkHttpClient();
        okHttpClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                System.out.println("onFailure: " + e.getMessage());
            }
 
            @Override
            public void onResponse(Call call, Response response) throws IOException {
                System.out.println(response.protocol() + " " +response.code() + " " + response.message());
                Headers headers = response.headers();
                for (int i = 0; i < headers.size(); i++) {
                    System.out.println(headers.name(i) + ":" + headers.value(i));
                }
                System.out.println("onResponse: " + response.body().string());
            }
        });
    }
 
    public static void main(String[] args) {
        doGet("http://tcc.taobao.com/cc/json/mobile_tel_segment.htm?tel=13026194071");
        doPost("https://api.github.com/markdown/raw","I am Jdqm.");
    }
}