Java调用第三方接口示范的实现

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

使用流程

【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;
	}
 
}

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。