关于java:Java-调用第三方接口实战来了

9次阅读

共计 9007 个字符，预计需要花费 23 分钟才能阅读完成。

在我的项目开发中常常会遇到调用第三方接口的状况，比如说调用第三方的天气预报接口。

1、筹备工作：

在我的项目的工具包下导入 HttpClientUtil 这个工具类，或者也能够应用 Spring 框架的 restTemplate 来调用，下面有调用接口的办法【分为 Get 和 Post 形式的有参和无参调用】：

package com.njsc.credit.util;
 
import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
 
import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
 
public class HttpClientUtil {
 
 /**
  * 带参数的 get 申请
  * @param url
  * @param param
  * @return String
  */
 public static String doGet(String url, Map<String, String> param) {
  // 创立 Httpclient 对象
  CloseableHttpClient httpclient = HttpClients.createDefault();
 
  String resultString = "";
  CloseableHttpResponse response = null;
  try {
   // 创立 uri
   URIBuilder builder = new URIBuilder(url);
   if (param != null) {for (String key : param.keySet()) {builder.addParameter(key, param.get(key));
    }
   }
   URI uri = builder.build();
   // 创立 http GET 申请
   HttpGet httpGet = new HttpGet(uri);
   // 执行申请
   response = httpclient.execute(httpGet);
   // 判断返回状态是否为 200
   if (response.getStatusLine().getStatusCode() == 200) {resultString = EntityUtils.toString(response.getEntity(), "UTF-8");
   }
  } catch (Exception e) {e.printStackTrace();
  } finally {
   try {if (response != null) {response.close();
    }
    httpclient.close();} catch (IOException e) {e.printStackTrace();
   }
  }
  return resultString;
 }
 
 /**
  * 不带参数的 get 申请
  * @param url
  * @return String
  */
 public static String doGet(String url) {return doGet(url, null);
 }
 
 /**
  * 带参数的 post 申请
  * @param url
  * @param param
  * @return String
  */
 public static String doPost(String url, Map<String, String> param) {
  // 创立 Httpclient 对象
  CloseableHttpClient httpClient = HttpClients.createDefault();
  CloseableHttpResponse response = null;
  String resultString = "";
  try {
   // 创立 Http Post 申请
   HttpPost httpPost = new HttpPost(url);
   // 创立参数列表
   if (param != null) {List<NameValuePair> paramList = new ArrayList<>();
    for (String key : param.keySet()) {paramList.add(new BasicNameValuePair(key, param.get(key)));
    }
    // 模仿表单
    UrlEncodedFormEntity entity = new UrlEncodedFormEntity(paramList);
    httpPost.setEntity(entity);
   }
   // 执行 http 申请
   response = httpClient.execute(httpPost);
   resultString = EntityUtils.toString(response.getEntity(), "utf-8");
  } catch (Exception e) {e.printStackTrace();
  } finally {
   try {response.close();
   } catch (IOException e) {e.printStackTrace();
   }
  }
  return resultString;
 }
 
 /**
  * 不带参数的 post 申请
  * @param url
  * @return String
  */
 public static String doPost(String url) {return doPost(url, null);
 }
 
 /**
  * 传送 json 类型的 post 申请
  * @param url
  * @param json
  * @return String
  */
 public static String doPostJson(String url, String json) {
  // 创立 Httpclient 对象
  CloseableHttpClient httpClient = HttpClients.createDefault();
  CloseableHttpResponse response = null;
  String resultString = "";
  try {
   // 创立 Http Post 申请
   HttpPost httpPost = new HttpPost(url);
   // 创立申请内容
   StringEntity entity = new StringEntity(json, ContentType.APPLICATION_JSON);
   httpPost.setEntity(entity);
   // 执行 http 申请
   response = httpClient.execute(httpPost);
   resultString = EntityUtils.toString(response.getEntity(), "utf-8");
  } catch (Exception e) {e.printStackTrace();
  } finally {
   try {response.close();
   } catch (IOException e) {e.printStackTrace();
   }
  }
  return resultString;
 }
}

2、创立 url 和拜访 key 以及参数等：

代码如下：

/**
 * 聚合接口校验身份证
 * @param idCard
 * @param realName
 * @return boolean
 */
public boolean identityCheck(String idCard, String realName){logger.info("----------------- 调用聚合数据 身份证验证 API BEGIN--------------->");
 String key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
 String url = "http://op.juhe.cn/idcard/query" + "?key=" + key + "&idcard=" + idCard + "&realname=" + realName;
 logger.info("申请 url:" + url);
 boolean match = false; // 是否匹配
 try {String result = HttpClientUtil.doGet(url);
  System.out.println("申请后果：" + result);
  IdentityCheckResult identityCheckResult = JsonUtils.parse(result, IdentityCheckResult.class);
  IdentityCheck identityCheck = JsonUtils.parse(result, "result", IdentityCheck.class);
  logger.info(identityCheckResult);
  logger.info(identityCheck.toString());
  if(identityCheckResult.correct() && identityCheck.getRes() == 1){match = true;}
 } catch (Exception e) {e.printStackTrace();
 }
 logger.info("<----------------- 调用聚合数据 身份证验证 API END---------------");
 return match;
}

3、申请这个第三方接口：

应用 HttpClientUtil 工具类中的 doGet 办法来申请 URL，失去后果，当初大多数是一个 json 字符串，类型为 String

4、依据接口返回数据格式来解析数据：

能够看到，返回参数有六个，所以在我的项目中新建一个 bean，蕴含以上六个字段，用来接住返回数据，如下：

因为接口返回的数据是一个 json 的字符串，类型实际上是一个 String 字符串，要解析数据，用工具类 JsonUtils 的 parse 办法将字符串转换为 Java 对象，JsonUtils 的代码如下：

package com.eqianxian.commons.utils.json;
 
import java.util.List;
import java.util.Map;
 
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.serializer.PropertyFilter;
import com.alibaba.fastjson.serializer.SerializerFeature;
 
/**
 * 在零碎中对立应用这个，以不便未来切换不同的 JSON 生成工具
 * 
 * @author KelvinZ
 * 
 */
public class JsonUtils {
 public static final int TYPE_FASTJSON = 0;
 public static final int TYPE_GSON = 1;
 
 /**
  * <pre>
  * 对象转化为 json 字符串
  * 
  * @param obj 待转化对象
  * @return 代表该对象的 Json 字符串
  */
 public static final String toJson(final Object obj) {return JSON.toJSONString(obj);
  // return gson.toJson(obj);
 }
 
 /**
  * <pre>
  * 对象转化为 json 字符串
  * 
  * @param obj 待转化对象
  * @return 代表该对象的 Json 字符串
  */
 public static final String toJson(final Object obj, SerializerFeature... features) {return JSON.toJSONString(obj, features);
  // return gson.toJson(obj);
 }
 
 /**
  * 对象转化为 json 字符串并格式化
  * 
  * @param obj
  * @param format 是否要格式化
  * @return
  */
 public static final String toJson(final Object obj, final boolean format) {return JSON.toJSONString(obj, format);
 }
 
 /**
  * 对象对指定字段进行过滤解决，生成 json 字符串
  * 
  * @param obj
  * @param fields 过滤解决字段
  * @param ignore true 做疏忽解决，false 做蕴含解决
  * @param features json 特色，为 null 疏忽
  * @return
  */
 public static final String toJson(final Object obj, final String[] fields, final boolean ignore,
   SerializerFeature... features) {if (fields == null || fields.length < 1) {return toJson(obj);
  }
  if (features == null)
   features = new SerializerFeature[] { SerializerFeature.QuoteFieldNames};
  return JSON.toJSONString(obj, new PropertyFilter() {
   @Override
   public boolean apply(Object object, String name, Object value) {for (int i = 0; i < fields.length; i++) {if (name.equals(fields[i])) {return !ignore;}
    }
    return ignore;
   }
  }, features);
 }
 
 /**
  * <pre>
  * 解析 json 字符串中某门路的值
  * 
  * @param json
  * @param path
  * @return
  */
 @SuppressWarnings("unchecked")
 public static final <E> E parse(final String json, final String path) {String[] keys = path.split(",");
  JSONObject obj = JSON.parseObject(json);
  for (int i = 0; i < keys.length - 1; i++) {obj = obj.getJSONObject(keys[i]);
  }
  return (E) obj.get(keys[keys.length - 1]);
 }
 
 /**
  * <pre>
  * json 字符串解析为对象
  * 
  * @param json 代表一个对象的 Json 字符串
  * @param clazz 指定指标对象的类型，即返回对象的类型
  * @return 从 json 字符串解析进去的对象
  */
 public static final <T> T parse(final String json, final Class<T> clazz) {return JSON.parseObject(json, clazz);
 }
 
 /**
  * <pre>
  * json 字符串解析为对象
  * 
  * @param json json 字符串
  * @param path 逗号分隔的 json 层次结构
  * @param clazz 指标类
  */
 public static final <T> T parse(final String json, final String path, final Class<T> clazz) {String[] keys = path.split(",");
  JSONObject obj = JSON.parseObject(json);
  for (int i = 0; i < keys.length - 1; i++) {obj = obj.getJSONObject(keys[i]);
  }
  String inner = obj.getString(keys[keys.length - 1]);
  return parse(inner, clazz);
 }
 
 /**
  * 将制订的对象通过字段过滤解决后，解析成为 json 汇合
  * 
  * @param obj
  * @param fields
  * @param ignore
  * @param clazz
  * @param features
  * @return
  */
 public static final <T> List<T> parseArray(final Object obj, final String[] fields, boolean ignore,
   final Class<T> clazz, final SerializerFeature... features) {String json = toJson(obj, fields, ignore, features);
  return parseArray(json, clazz);
 }
 
 /**
  * <pre>
  * 从 json 字符串中解析出一个对象的汇合，被解析字符串要求是非法的汇合类型
  *（形如:["k1":"v1","k2":"v2",..."kn":"vn"]）* 
  * @param json - [key-value-pair...]
  * @param clazz
  * @return
  */
 public static final <T> List<T> parseArray(final String json, final Class<T> clazz) {return JSON.parseArray(json, clazz);
 }
 
 /**
  * <pre>
  * 从 json 字符串中依照门路寻找，并解析出一个对象的汇合，例如：* 类 Person 有一个属性 name，要从以下 json 中解析出其汇合：* {
  *  "page_info":{
  *   "items":{*    "item":[{"name":"KelvinZ"},{"name":"Jobs"},...{"name":"Gates"}]
  *  }
  * }
  * 应用办法：parseArray(json, "page_info,items,item", Person.class)，* 将依据指定门路，正确的解析出所需汇合，排除外层烦扰
  * 
  * @param json json 字符串
  * @param path 逗号分隔的 json 层次结构
  * @param clazz 指标类
  * @return
  */
 public static final <T> List<T> parseArray(final String json, final String path, final Class<T> clazz) {String[] keys = path.split(",");
  JSONObject obj = JSON.parseObject(json);
  for (int i = 0; i < keys.length - 1; i++) {obj = obj.getJSONObject(keys[i]);
  }
  String inner = obj.getString(keys[keys.length - 1]);
  List<T> ret = parseArray(inner, clazz);
  return ret;
 }
 
 /**
  * <pre>
  * 有些 json 的常见格局谬误这里能够解决，以便给后续的办法解决
  * 常见谬误：应用了 \"或者"{或者}"，腾讯的页面中常见这种格局
  * 
  * @param invalidJson 蕴含非法格局的 json 字符串
  * @return
  */
 public static final String correctJson(final String invalidJson) {String content = invalidJson.replace("\\\"", "\"").replace("\"{","{").replace("}\"","}");
  return content;
 }
 
 /**
  * 格式化 Json
  * 
  * @param json
  * @return
  */
 public static final String formatJson(String json) {Map<?, ?> map = (Map<?, ?>) JSON.parse(json);
  return JSON.toJSONString(map, true);
 }
 
 /**
  * 获取 json 串中的子 json
  * 
  * @param json
  * @param path
  * @return
  */
 public static final String getSubJson(String json, String path) {String[] keys = path.split(",");
  JSONObject obj = JSON.parseObject(json);
  for (int i = 0; i < keys.length - 1; i++) {obj = obj.getJSONObject(keys[i]);
   System.out.println(obj.toJSONString());
  }
  return obj != null ? obj.getString(keys[keys.length - 1]) : null;
 }
 
}

起源：https://blog.csdn.net/qq_3586…

近期热文举荐：

1.1,000+ 道 Java 面试题及答案整顿 (2021 最新版)

2. 别在再满屏的 if/ else 了，试试策略模式，真香！！

3. 卧槽！Java 中的 xx ≠ null 是什么新语法？

4.Spring Boot 2.5 重磅公布，光明模式太炸了！

5.《Java 开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞 + 转发哦！

正文完
java
发表至： java
2021-09-14
 0
关于java:JavaSE第18篇多线程上篇
关于java:Java-的流程控制是什么样子的
Java中的栈
关于java:线程池ForkJoinPool简介