1、簡介
在Spring-Boot項目開發中，當本模塊的代碼需要訪問外面模塊接口，或外部url鏈接的需求的時候, 需要使用網絡連接調用，下面提供了四種方式（排除dubbo的方式）供大家選擇。
方式一：使用OKHttp
網上對于 OkHttp 相關的介紹如下！
OkHttp 是 Square 公司基于 JAVA 和 Android 程序，封裝的一個高性能 http 網絡請求客戶端，并且對外開源，它的設計初衷是為了更快地加載資源并節省帶寬。
使用 OkHttp 的主要優勢：
- 支持HTTP/2（有效使用套接字）
- 連接池（在沒有HTTP/2的情況下減少請求延遲）
- GZIP壓縮（縮小下載大小）
- 響應緩存（避免了重新獲取相同的數據）
- 從常見的連接問題中無聲恢復
- 替代 IP 地址檢測（在 IPv4 和 IPv6 環境下）
- 支持現代TLS功能（TLS 1.3，ALPN，證書釘子）
- 支持同步和異步調用
目前 OkHttp 在開源項目中被廣泛使用，同時也是 Retrofit、Picasso 等庫的核心庫。springboot已經很好地支持okhttp庫。
2.1、添加依賴包
在使用之前，我們需要先導入okhttp依賴包，不同的版本號，相關 api 稍有區別，本次介紹的 api 操作基于3.14.9版本號。
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
<version>3.14.9</version>
</dependency>
2.2、get 同步請求
okhttp發起get同步請求非常的簡單，只需要幾行代碼就可以搞定。
案例如下！
String url = "https://www.bAIdu.com/";
OkHttpClient client = new OkHttpClient();
// 配置GET請求
Request request = new Request.Builder()
.url(url)
.get()
.build();
// 發起同步請求
try (Response response = client.newCall(request).execute()){
// 打印返回結果
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
2.3、post 表單同步請求
okhttp發起post表單格式的數據提交，同步請求編程也非常的簡單，只需要幾行代碼就可以搞定。
案例如下！
String url = "https://www.baidu.com/";
OkHttpClient client = new OkHttpClient();
// 配置 POST + FORM 格式數據請求
RequestBody body = new FormBody.Builder()
.add("userName", "zhangsan")
.add("userPwd", "123456")
.build();
Request request = new Request.Builder()
.url(url)
.post(body)
.build();
// 發起同步請求
try (Response response = client.newCall(request).execute()){
// 打印返回結果
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
2.4、post 表單 + 文件上傳，同步請求
如果在發起表單請求的時候，還需要上傳文件，該如何實現呢？
案例如下！
String url = "https://www.baidu.com/";
OkHttpClient client = new OkHttpClient();
// 要上傳的文件
File file = new File("/doc/Downloads/429545913565844e9b26f97dbb57a1c3.jpeg");
RequestBody fileBody = RequestBody.create(MediaType.parse("image/jpg"), file);
// 表單 + 文件數據提交
RequestBody multipartBody = new MultipartBody.Builder()
.setType(MultipartBody.FORM)
.addFormDataPart("userName", "zhangsan")
.addFormDataPart("userPwd", "123456")
.addFormDataPart("userFile", "00.png", fileBody)
.build();
Request request = new Request.Builder()
.url(url)
.post(multipartBody)
.build();
// 發起同步請求
try (Response response = client.newCall(request).execute()){
// 打印返回結果
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
2.5、post + json 數據，同步請求
okhttp發起post + json格式的數據提交，同步請求編程也很簡單。
案例如下！
MediaType contentType = MediaType.get("Application/json; charset=utf-8");
String url = "https://www.baidu.com/";
String json = "{}";
OkHttpClient client = new OkHttpClient();
// 配置 POST + JSON 請求
RequestBody body = RequestBody.create(contentType, json);
Request request = new Request.Builder()
.url(url)
.post(body)
.build();
// 發起同步請求
try (Response response = client.newCall(request).execute()){
// 打印返回結果
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
2.5、文件下載，同步請求
文件下載，通常是get方式請求，只需要在響應端使用字節流接受數據即可！
案例如下
public static void main(String[] args) {
//目標存儲文件
String targetFile = "/doc/Downloads/1.png";
//需要下載的原始文件
String url = "https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png";
OkHttpClient client = new OkHttpClient();
// 配置GET請求
Request request = new Request.Builder()
.url(url)
.build();
// 發起同步請求
try (Response response = client.newCall(request).execute()){
// 獲取文件字節流
byte[] stream = response.body().bytes();
// 寫入目標文件
writeFile(targetFile, stream);
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 寫入目標文件
* @param targetFile
* @param stream
* @throws IOException
*/
private static void writeFile(String targetFile, byte[] stream) throws IOException {
String filePath = StringUtils.substringBeforeLast(targetFile, "/");
Path folderPath = Paths.get(filePath);
if(!Files.exists(folderPath)){
Files.createDirectories(folderPath);
}
Path targetFilePath = Paths.get(targetFile);
if(!Files.exists(targetFilePath)){
Files.write(targetFilePath, stream, StandardOpenOption.CREATE);
}
}
2.6、其他方式的同步請求
在實際的項目開發中，有的接口需要使用put或者delete方式請求，應該如何處理呢？
put方式請求，案例如下！
// 只需要在 Request 配置類中，換成 put 方式即可
Request request = new Request.Builder()
.url(url)
.put(body)
.build();
同樣的，delete方式請求也類似，案例如下！
// 只需要在 Request 配置中，換成 delete 方式即可
Request request = new Request.Builder()
.url(url)
.delete(body)
.build();
2.7、自定義添加請求頭部
大部分的時候，基于安全的考慮，很多時候我們需要把相關的鑒權參數放在請求頭部，應該如何處理呢？
以post + json格式請求為例，添加頭部請求參數，案例如下！
MediaType contentType = MediaType.get("application/json; charset=utf-8");
String url = "https://www.baidu.com/";
String json = "{}";
OkHttpClient client = new OkHttpClient();
// 配置 header 頭部請求參數
Headers headers = new Headers.Builder()
.add("token", "11111-22222-333")
.build();
// 配置 POST + JSON 請求
RequestBody body = RequestBody.create(contentType, json);
Request request = new Request.Builder()
.url(url)
.headers(headers)
.post(body)
.build();
// 發起同步請求
try (Response response = client.newCall(request).execute()){
// 打印返回結果
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}
2.8、發起異步請求
在上文中我們介紹的都是同步請求，在最開始我們也說到 OkHttp 不僅支持同步調用，也異步調用，那么如何進行異步請求編程呢？
其實操作很簡單，案例如下！
String url = "https://www.baidu.com/";
OkHttpClient client = new OkHttpClient().newBuilder().build();
Request request = new Request.Builder()
.url(url)
.get()
.build();
// 發起異步請求
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
System.out.println("請求異常 + " + e.getMessage());
}
@Override
public void onResponse(Call call, Response response) throws IOException {
System.out.println("請求完成，返回結果：" + response.body().string());
}
});
方式二：使用原始httpClient請求
使用Apache httpclient庫。
/* * @description get方式獲取入參，插入數據并發起流程
* @author ly
* @params documentId
* @return String
*/
//
@RequestMapping("/submit/{documentId}")
public String submit1(@PathVariable String documentId) throws ParseException {
//此處將要發送的數據轉換為json格式字符串
Map<String,Object> map =task2Service.getMap(documentId);
String jsonStr = JSON.toJSONString(map, SerializerFeature.WRITE_MAP_NULL_FEATURES,SerializerFeature.QuoteFieldNames);
JSONObject jsonObject = JSON.parseobject(jsonStr);
JSONObject sr = task2Service.doPost(jsonObject);
return sr.toString();
}
/*
* @description 使用原生httpClient調用外部接口
* @author ly
* @params date
* @return JSONObject
*/
public static JSONObject doPost(JSONObject date) {
String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ";
CloseableHttpClient client = HttpClients.createDefault();
// 要調用的接口url
String url = "http://39.103.201.110:30661 /xdap-open/open/process/v1/submit";
HttpPost post = new HttpPost(url);
JSONObject jsonObject = null;
try {
//創建請求體并添加數據
StringEntity s = new StringEntity(date.toString());
//此處相當于在header里頭添加content-type等參數
s.setContentType("application/json");
s.setContentEncoding("UTF-8");
post.setEntity(s);
//此處相當于在Authorization里頭添加Bear token參數信息
post.addHeader("Authorization", "Bearer " +assessToken);
HttpResponse res = client.execute(post);
String response1 = EntityUtils.toString(res.getEntity());
if (res.getStatusLine()
.getStatusCode() == HttpStatus.SC_OK) {
// 返回json格式：
String result = EntityUtils.toString(res.getEntity());
jsonObject = JSONObject.parseObject(result);
}
} catch (Exception e) {
throw new RuntimeException(e);
}
return jsonObject;
}
、方式三：使用RestTemplate方法
Spring-Boot開發中，RestTemplate同樣提供了對外訪問的接口API，這里主要介紹Get和Post方法的使用。
Get請求
提供了getForObject 、getForEntity兩種方式，其中getForEntity如下三種方法的實現：
Get--getForEntity，存在以下兩種方式重載
1.getForEntity(Stringurl,Class responseType,Object…urlVariables)
2.getForEntity(URI url,Class responseType)
Get--getForEntity(URI url,Class responseType)
//該方法使用URI對象來替代之前的url和urlVariables參數來指定訪問地址和參數綁定。URI是JDK java.NET包下的一個類，表示一個統一資源標識符(Uniform Resource Identifier)引用。參考如下：
RestTemplate restTemplate=new RestTemplate();
UriComponents
uriComponents=UriComponentsBuilder.fromUriString("http://USER-SERVICE/user?name={name}")
.build()
.expand("dodo")
.encode();
URI uri=uriComponents.toUri();
ResponseEntityresponseEntity=restTemplate.getForEntity(uri,String.class).getBody();
Get--getForObject，存在以下三種方式重載
1.getForObject(String url,Class responseType,Object...urlVariables)
2.getForObject(String url,Class responseType,Map urlVariables)
3.getForObject(URI url,Class responseType)
getForObject方法可以理解為對getForEntity的進一步封裝，它通過HttpMessageConverterExtractor對HTTP的請求響應體body內容進行對象轉換，實現請求直接返回包裝好的對象內容。
Post 請求
Post請求提供有postForEntity、postForObject和postForLocation三種方式，其中每種方式都有三種方法，下面介紹postForEntity的使用方法。
Post--postForEntity，存在以下三種方式重載
1.postForEntity(String url,Object request,Class responseType,Object... uriVariables)
2.postForEntity(String url,Object request,Class responseType,Map uriVariables)
3.postForEntity(URI url,Object request，Class responseType)
如下僅演示第二種重載方式
/*
* @description post方式獲取入參，插入數據并發起流程
* @author ly
* @params
* @return
*/
@PostMapping("/submit2")
public Object insertFinanceCompensation(@RequestBody JSONObject jsonObject) {
String documentId=jsonObject.get("documentId").toString();
return task2Service.submit(documentId);
}
/*
* @description 使用restTimeplate調外部接口
* @author ly
* @params documentId
* @return String
*/
public String submit(String documentId){
String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ";
RestTemplate restTemplate = new RestTemplate();
//創建請求頭
HttpHeaders httpHeaders = new HttpHeaders();
//此處相當于在Authorization里頭添加Bear token參數信息
httpHeaders.add(HttpHeaders.AUTHORIZATION, "Bearer " + assessToken);
//此處相當于在header里頭添加content-type等參數
httpHeaders.add(HttpHeaders.CONTENT_TYPE,"application/json");
Map<String, Object> map = getMap(documentId);
String jsonStr = JSON.toJSONString(map);
//創建請求體并添加數據
HttpEntity<Map> httpEntity = new HttpEntity<Map>(map, httpHeaders);
String url = "http://39.103.201.110:30661/xdap-open/open/process/v1/submit";
ResponseEntity<String> forEntity = restTemplate.postForEntity(url,httpEntity,String.class);//此處三個參數分別是請求地址、請求體以及返回參數類型
return forEntity.toString();
}
、方式四：使用Feign進行消費
在maven項目中添加依賴
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-feign</artifactId>
<version>1.2.2.RELEASE</version>
</dependency>
啟動類上加上@EnableFeignClients
@SpringBootApplication
@EnableFeignClients
@ComponentScan(basePackages = {"com.definesys.mpaas", "com.xdap.*" ,"com.xdap.*"})
public class MobilecardApplication {
public static void main(String[] args) {
SpringApplication.run(MobilecardApplication.class, args);
}
}
此處編寫接口模擬外部接口供feign調用外部接口方式使用
定義controller
@Autowired
PrintService printService;
@PostMapping("/outSide")
public String test(@RequestBody TestDto testDto) {
return printService.print(testDto);
}
定義service
@Service
public interface PrintService {
public String print(TestDto testDto);
}
定義serviceImpl
public class PrintServiceImpl implements PrintService {
@Override
public String print(TestDto testDto) {
return "模擬外部系統的接口功能"+testDto.getId();
}
}
構建Feigin的Service
定義service
//此處name需要設置不為空，url需要在.properties中設置
@Service
@FeignClient(url = "${outSide.url}", name = "service2")
public interface FeignService2 {
@RequestMapping(value = "/custom/outSide", method = RequestMethod.POST)
@ResponseBody
public String getMessage(@Valid @RequestBody TestDto testDto);
}
定義controller
@Autowired
FeignService2 feignService2;
//測試feign調用外部接口入口
@PostMapping("/test2")
public String test2(@RequestBody TestDto testDto) {
return feignService2.getMessage(testDto);
}
postman測試
此處因為我使用了所在項目，所以需要添加一定的請求頭等信息，關于Feign的請求頭添加也會在后續補充
補充如下：
添加Header解決方法
將token等信息放入Feign請求頭中，主要通過重寫RequestInterceptor的apply方法實現
定義config
@Configuration
public class FeignConfig implements RequestInterceptor {
@Override
public void apply(RequestTemplate requestTemplate) {
//添加token
requestTemplate.header("token", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ");
}
}
定義service
@Service
@FeignClient(url = "${outSide.url}",name = "feignServer", configuration = FeignDemoConfig.class)
public interface TokenDemoClient {
@RequestMapping(value = "/custom/outSideAddToken", method = RequestMethod.POST)
@ResponseBody
public String getMessage(@Valid @RequestBody TestDto testDto);
}
定義controller
//測試feign調用外部接口入口，加上token
@PostMapping("/testToken")
public String test4(@RequestBody TestDto testDto) {
return tokenDemoClient.getMessage(testDto);
}
