SpringBoot呼叫第三方IP查詢介面(Https)
阿新 • • 發佈：2019-01-06
一：需求簡介.
1.1專案中天新增IP歸屬地查詢功能,前後端分離.後端返回給前端json字串.
1.2使用阿里雲免費的IP歸屬地查詢介面.官網一下不太好找.下面圖解演示一下,儘量節省時間吧.
免費購買的.不限流免費還好用.
以上我們知道了這個介面的主要資訊如下：上面那個API測試工具多試試看.
① 不限流免費的.②基於Https+GET的方式呼叫.③返回的是JSON資料.
二：實戰演練呼叫.
2.1 環境準備.
SpringBoot 1.5.10.RELEASE.Maven依賴如下.阿里雲提供的Demo呼叫中的Maven依賴比較舊了,SpringBoot框架使用出來點問題,我這些版本測試是可行的.HttpClient的版本差異有點大,注意下面的版本資訊.
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.10.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <!-- 開發熱部署--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <version>1.5.10.RELEASE</version> <optional>true</optional> </dependency> <!-- fastJson--> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.47</version> </dependency> <!-- HttpClient--> <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <version>4.5.3</version> </dependency> <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpcore</artifactId> <version>4.4.6</version> </dependency> <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> <version>2.6</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.18</version> </dependency>
2.2 SpringBoot呼叫網路資源服務可選HttpClient，以及框架自帶的RestTemplate呼叫Http非常方便，但是要呼叫遠端的Https介面就要封裝一下SSL了.
根據這個介面的返回Json值,我們先建立JavaBean來接收一下吧.AIP介面呼叫成功與否都返回的是統一格式的JSON資訊.
使用這個線上的JSON資料轉換為JavaBean，快捷方便.連結
例如將下面這段JSON資料轉換為JavaBean實體類.
IpMessage
import com.fasterxml.jackson.annotation.JsonProperty; import lombok.Getter; import lombok.NoArgsConstructor; import lombok.Setter; /** * author: * date: * time: 13:32 * description:第三方介面返回的IP地址資訊 */ @Setter @Getter @NoArgsConstructor public class IpMessage { /** * 響應狀態碼 */ private int ret; /** * 返回資訊 */ private String msg; /** * 趕回實體資訊 */ private DataMessage data; /** * 注意命名規範 */ @JsonProperty("log_id") /** 返回請求ID編號*/ private String logId; }
DataMessage
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
/**
* author:
* date:
* time:
* description:第三方ip的返回實體資訊
*/
@Setter
@Getter
@NoArgsConstructor
public class DataMessage {
/** 地區*/
private String area;
/** 國家*/
private String country;
/** 國家編號*/
@JsonProperty("country_id")
private String countryId;
/** 省份編號*/
@JsonProperty("region_id")
private String regionId;
/** 省份*/
private String region;
/** 城市*/
private String city;
/** 城市編號*/
@JsonProperty("city_id")
private String cityId;
/** Long型別的IP*/
@JsonProperty("long_ip")
private String longIp;
/** IP地址*/
private String ip;
/** 運營商*/
private String isp;
}2.3 配置介面呼叫資訊.
將介面呼叫資訊編寫為一個自定義的配置檔案.提高擴充套件性和解決硬編碼問題.
thirdip.properties
#用來配置呼叫第三方ip介面的呼叫資訊
#配置Host
dockerboot.ip.host=https://api01.aliyun.venuscn.com
#配置ip路徑
dockerboot.ip.path=/ip
#配置AppCode
dockerboot.ip.appcode=你的appCode
#配置請求方法
dockerboot.ip.method=get屬性注入Spring容器.
ThirdProperties
import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
/**
* author:
* date:
* time: 13:52
* description: 配置第三方ip介面資訊
*/
@Component
@ConfigurationProperties(prefix = "dockerboot.ip")
@PropertySource(value = "classpath:thirdip.properties")
@Setter
@Getter
public class ThirdIpPrpperties {
private String host;
private String path;
private String appcode;
private String method;
}2.4 封裝HttpClient呼叫Https介面.
HttpClientUtils.
import org.springframework.stereotype.Component;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.security.KeyManagementException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.X509Certificate;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.net.ssl.SSLContext;
import javax.net.ssl.TrustManager;
import javax.net.ssl.X509TrustManager;
import org.apache.commons.lang.StringUtils;
import org.apache.http.HttpResponse;
import org.apache.http.NameValuePair;
import org.apache.http.client.HttpClient;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.conn.ClientConnectionManager;
import org.apache.http.conn.scheme.Scheme;
import org.apache.http.conn.scheme.SchemeRegistry;
import org.apache.http.conn.ssl.SSLSocketFactory;
import org.apache.http.entity.ByteArrayEntity;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.message.BasicNameValuePair;
/**
* author:
* date:
* time:
* description: HttpClient呼叫Https介面封裝.
*/
@Component
public class HttpClientUtils {
public static HttpResponse doGet(String host, String path, String method,
Map<String, String> headers,
Map<String, String> querys)
throws Exception {
HttpClient httpClient = wrapClient(host);
HttpGet request = new HttpGet(buildUrl(host, path, querys));
for (Map.Entry<String, String> e : headers.entrySet()) {
request.addHeader(e.getKey(), e.getValue());
}
return httpClient.execute(request);
}
/**
* post form
*
* @param host
* @param path
* @param method
* @param headers
* @param querys
* @param bodys
* @return
* @throws Exception
*/
public static HttpResponse doPost(String host, String path, String method,
Map<String, String> headers,
Map<String, String> querys,
Map<String, String> bodys)
throws Exception {
HttpClient httpClient = wrapClient(host);
HttpPost request = new HttpPost(buildUrl(host, path, querys));
for (Map.Entry<String, String> e : headers.entrySet()) {
request.addHeader(e.getKey(), e.getValue());
}
if (bodys != null) {
List<NameValuePair> nameValuePairList = new ArrayList<NameValuePair>();
for (String key : bodys.keySet()) {
nameValuePairList.add(new BasicNameValuePair(key, bodys.get(key)));
}
UrlEncodedFormEntity formEntity = new UrlEncodedFormEntity(nameValuePairList, "utf-8");
formEntity.setContentType("application/x-www-form-urlencoded; charset=UTF-8");
request.setEntity(formEntity);
}
return httpClient.execute(request);
}
/**
* Post String
*
* @param host
* @param path
* @param method
* @param headers
* @param querys
* @param body
* @return
* @throws Exception
*/
public static HttpResponse doPost(String host, String path, String method,
Map<String, String> headers,
Map<String, String> querys,
String body)
throws Exception {
HttpClient httpClient = wrapClient(host);
HttpPost request = new HttpPost(buildUrl(host, path, querys));
for (Map.Entry<String, String> e : headers.entrySet()) {
request.addHeader(e.getKey(), e.getValue());
}
if (StringUtils.isNotBlank(body)) {
request.setEntity(new StringEntity(body, "utf-8"));
}
return httpClient.execute(request);
}
/**
* Post stream
*
* @param host
* @param path
* @param method
* @param headers
* @param querys
* @param body
* @return
* @throws Exception
*/
public static HttpResponse doPost(String host, String path, String method,
Map<String, String> headers,
Map<String, String> querys,
byte[] body)
throws Exception {
HttpClient httpClient = wrapClient(host);
HttpPost request = new HttpPost(buildUrl(host, path, querys));
for (Map.Entry<String, String> e : headers.entrySet()) {
request.addHeader(e.getKey(), e.getValue());
}
if (body != null) {
request.setEntity(new ByteArrayEntity(body));
}
return httpClient.execute(request);
}
/**
* Put String
*
* @param host
* @param path
* @param method
* @param headers
* @param querys
* @param body
* @return
* @throws Exception
*/
public static HttpResponse doPut(String host, String path, String method,
Map<String, String> headers,
Map<String, String> querys,
String body)
throws Exception {
HttpClient httpClient = wrapClient(host);
HttpPut request = new HttpPut(buildUrl(host, path, querys));
for (Map.Entry<String, String> e : headers.entrySet()) {
request.addHeader(e.getKey(), e.getValue());
}
if (StringUtils.isNotBlank(body)) {
request.setEntity(new StringEntity(body, "utf-8"));
}
return httpClient.execute(request);
}
/**
* Put stream
*
* @param host
* @param path
* @param method
* @param headers
* @param querys
* @param body
* @return
* @throws Exception
*/
public static HttpResponse doPut(String host, String path, String method,
Map<String, String> headers,
Map<String, String> querys,
byte[] body)
throws Exception {
HttpClient httpClient = wrapClient(host);
HttpPut request = new HttpPut(buildUrl(host, path, querys));
for (Map.Entry<String, String> e : headers.entrySet()) {
request.addHeader(e.getKey(), e.getValue());
}
if (body != null) {
request.setEntity(new ByteArrayEntity(body));
}
return httpClient.execute(request);
}
/**
* Delete
*
* @param host
* @param path
* @param method
* @param headers
* @param querys
* @return
* @throws Exception
*/
public static HttpResponse doDelete(String host, String path, String method,
Map<String, String> headers,
Map<String, String> querys)
throws Exception {
HttpClient httpClient = wrapClient(host);
HttpDelete request = new HttpDelete(buildUrl(host, path, querys));
for (Map.Entry<String, String> e : headers.entrySet()) {
request.addHeader(e.getKey(), e.getValue());
}
return httpClient.execute(request);
}
private static String buildUrl(String host, String path, Map<String, String> querys) throws UnsupportedEncodingException {
StringBuilder sbUrl = new StringBuilder();
sbUrl.append(host);
if (!StringUtils.isBlank(path)) {
sbUrl.append(path);
}
if (null != querys) {
StringBuilder sbQuery = new StringBuilder();
for (Map.Entry<String, String> query : querys.entrySet()) {
if (0 < sbQuery.length()) {
sbQuery.append("&");
}
if (StringUtils.isBlank(query.getKey()) && !StringUtils.isBlank(query.getValue())) {
sbQuery.append(query.getValue());
}
if (!StringUtils.isBlank(query.getKey())) {
sbQuery.append(query.getKey());
if (!StringUtils.isBlank(query.getValue())) {
sbQuery.append("=");
sbQuery.append(URLEncoder.encode(query.getValue(), "utf-8"));
}
}
}
if (0 < sbQuery.length()) {
sbUrl.append("?").append(sbQuery);
}
}
return sbUrl.toString();
}
private static HttpClient wrapClient(String host) {
HttpClient httpClient = new DefaultHttpClient();
if (host.startsWith("https://")) {
sslClient(httpClient);
}
return httpClient;
}
private static void sslClient(HttpClient httpClient) {
try {
SSLContext ctx = SSLContext.getInstance("TLS");
X509TrustManager tm = new X509TrustManager() {
public X509Certificate[] getAcceptedIssuers() {
return null;
}
public void checkClientTrusted(X509Certificate[] xcs, String str) {
}
public void checkServerTrusted(X509Certificate[] xcs, String str) {
}
};
ctx.init(null, new TrustManager[]{tm}, null);
SSLSocketFactory ssf = new SSLSocketFactory(ctx);
ssf.setHostnameVerifier(SSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);
ClientConnectionManager ccm = httpClient.getConnectionManager();
SchemeRegistry registry = ccm.getSchemeRegistry();
registry.register(new Scheme("https", 443, ssf));
} catch (KeyManagementException ex) {
throw new RuntimeException(ex);
} catch (NoSuchAlgorithmException ex) {
throw new RuntimeException(ex);
}
}
}IpServiceImpl封裝
import com.lixing.docker.dockerboot.util.HttpClientUtils;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.util.EntityUtils;
import org.springframework.stereotype.Service;
import java.util.Map;
/**
* author:
* date:
* time:
* description:Service封裝處理IP歸屬地查詢
*/
@Service
public class IpServiceImpl {
public String doGet(String host, String path, String method,
Map<String, String> headers,
Map<String, String> querys) throws Exception {
HttpResponse response=null;
HttpEntity entity=null;
String respContent=null;
response = HttpClientUtils.doGet(host, path, method, headers, querys);
entity=response.getEntity();
respContent= EntityUtils.toString(entity, "UTF-8");
return respContent;
}
}IpSearchController
import com.alibaba.fastjson.JSON;
import com.lixing.docker.dockerboot.config.ThirdIpPrpperties;
import com.lixing.docker.dockerboot.entity.IpMessage;
import com.lixing.docker.dockerboot.service.impl.IpServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.HashMap;
import java.util.Map;
/**
* author:
* date:
* time:
* description:IP歸屬地查詢控制器
*/
@RestController
@RequestMapping("/ip")
public class IPSearchController {
@Autowired
private ThirdIpPrpperties thirdIpPrpperties;
@Autowired
private IpServiceImpl ipServiceImpl;
@RequestMapping(value = "/search")
@ExceptionHandler(value = Exception.class)
public IpMessage search(@RequestParam("ip") String ip) throws Exception {
String host = thirdIpPrpperties.getHost();
String path = thirdIpPrpperties.getPath();
String appCode = thirdIpPrpperties.getAppcode();
String method = thirdIpPrpperties.getMethod();
Map<String, String> headers = new HashMap();
headers.put("Authorization", "APPCODE " + appCode);
Map<String, String> querys = new HashMap();
querys.put("ip", ip);
IpMessage message=new IpMessage();
// 返回字串
String respContent = ipServiceImpl.doGet(host, path, method, headers, querys);
// JSON串解析為JavaBean
IpMessage ipMessage=JSON.parseObject(respContent, IpMessage.class);
message.setMsg(ipMessage.getMsg());
message.setData(ipMessage.getData());
message.setLogId(ipMessage.getLogId());
message.setRet(ipMessage.getRet());
System.out.println("返回的資訊:"+ipMessage.getMsg());
System.out.println("返回的LogId:"+ipMessage.getLogId());
System.out.println("獲取IP城市:"+(ipMessage.getData()==null?null:ipMessage.getData().getCity()));
return message;
}
}做了全域性異常處理器,在Controller層只是丟擲異常即可.這個開發的介面返回的結果根據查詢的ip返回內容即可.不要在Controller層try catch了,太多重複程式碼了,不利於統一管理了維護,加入全域性異常處理,可返回人性化的頁面以及描述具體的json資料.
成功了返回成功的資訊,失敗了也是返回統一格式的失敗資訊.
下面來測試一下吧:
測試一：空的IP地址.
測試二：內網IP地址.
測試三：錯誤格式的IP地址.
測試四：正確的IP地址.
JSON解析的結果列印如下.
至此完成了SpringBoot呼叫遠端Https介面的過程.
簡單總結：第三方API介面的呼叫方式,返回資料,呼叫方式授權(新增請求頭授權資訊),JavaBean接收資料,統一格式的json資料返回,異常的處理,傳遞引數的方式,HttpClient的版本注意問題.SpringBoot的常用註解熟練使用.