詳解SpringBoot?調(diào)用外部接口的三種方式
更新時(shí)間：2023年04月10日 11:25:40 作者：菜鳥是大神
SpringBoot不僅繼承了Spring框架原有的優(yōu)秀特性，而且還通過簡化配置來進(jìn)一步簡化了Spring應(yīng)用的整個(gè)搭建和開發(fā)過程，這篇文章主要介紹了SpringBoot?調(diào)用外部接口的三種方式,需要的朋友可以參考下
1、簡介
SpringBoot不僅繼承了Spring框架原有的優(yōu)秀特性，而且還通過簡化配置來進(jìn)一步簡化了Spring應(yīng)用的整個(gè)搭建和開發(fā)過程。在Spring-Boot項(xiàng)目開發(fā)中，存在著本模塊的代碼需要訪問外面模塊接口，或外部url鏈接的需求, 比如在apaas開發(fā)過程中需要封裝接口在接口中調(diào)用apaas提供的接口（像發(fā)起流程接口submit等等）下面也是提供了三種方式（不使用dubbo的方式）供我們選擇
2、方式一：使用原始httpClient請求
/*
* @description get方式獲取入?yún)ⅲ迦霐?shù)據(jù)并發(fā)起流程
* @author
* @date 2022/8/24 16:05
* @params documentId
* @return String
*/
//
@RequestMapping("/submit/{documentId}")
public String submit1(@PathVariable String documentId) throws ParseException {
//此處將要發(fā)送的數(shù)據(jù)轉(zhuǎn)換為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調(diào)用外部接口
* @author lyx
* @date 2022/8/24 16:08
* @params date
* @return JSONObject
*/
public static JSONObject doPost(JSONObject date) {
String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ";
CloseableHttpClient client = HttpClients.createDefault();
// 要調(diào)用的接口url
String url = "http://39.103.201.110:30661 /xdap-open/open/process/v1/submit";
HttpPost post = new HttpPost(url);
JSONObject jsonObject = null;
try {
//創(chuàng)建請求體并添加數(shù)據(jù)
StringEntity s = new StringEntity(date.toString());
//此處相當(dāng)于在header里頭添加content-type等參數(shù)
s.setContentType("application/json");
s.setContentEncoding("UTF-8");
post.setEntity(s);
//此處相當(dāng)于在Authorization里頭添加Bear token參數(shù)信息
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;
}
3、方式二：使用RestTemplate方法
Spring-Boot開發(fā)中，RestTemplate同樣提供了對外訪問的接口API，這里主要介紹Get和Post方法的使用。
Get請求
提供了getForObject 、getForEntity兩種方式，其中getForEntity如下三種方法的實(shí)現(xiàn)：
Get--getForEntity，存在以下兩種方式重載
1.getForEntity(Stringurl,Class responseType,Object…urlVariables) 2.getForEntity(URI url,Class responseType)
Get--getForEntity(URI url,Class responseType)
//該方法使用URI對象來替代之前的url和urlVariables參數(shù)來指定訪問地址和參數(shù)綁定。URI是JDK java.net包下的一個(gè)類，表示一個(gè)統(tǒng)一資源標(biāo)識符(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--getForEntity(Stringurl,Class responseType,Object…urlVariables)
//該方法提供了三個(gè)參數(shù)，其中url為請求的地址，responseType為請求響應(yīng)body的包裝類型，urlVariables為url中的參數(shù)綁定，該方法的參考調(diào)用如下：
// http://USER-SERVICE/user?name={name)
RestTemplate restTemplate=new RestTemplate();
Mapparams=new HashMap<>();
params.put("name","dada"); //
ResponseEntityresponseEntity=restTemplate.getForEntity("http://USERSERVICE/user?name={name}",String.class,params);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的進(jìn)一步封裝，它通過HttpMessageConverterExtractor對HTTP的請求響應(yīng)體body內(nèi)容進(jìn)行對象轉(zhuǎn)換，實(shí)現(xiàn)請求直接返回包裝好的對象內(nèi)容。
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方式獲取入?yún)?，插入?shù)據(jù)并發(fā)起流程
* @author
* @date 2022/8/24 16:07
* @params
* @return
*/
@PostMapping("/submit2")
public Object insertFinanceCompensation(@RequestBody JSONObject jsonObject) {
String documentId=jsonObject.get("documentId").toString();
return task2Service.submit(documentId);
}
/*
* @description 使用restTimeplate調(diào)外部接口
* @author lyx
* @date 2022/8/24 16:02
* @params documentId
* @return String
*/
public String submit(String documentId){
String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ";
RestTemplate restTemplate = new RestTemplate();
//創(chuàng)建請求頭
HttpHeaders httpHeaders = new HttpHeaders();
//此處相當(dāng)于在Authorization里頭添加Bear token參數(shù)信息
httpHeaders.add(HttpHeaders.AUTHORIZATION, "Bearer " + assessToken);
//此處相當(dāng)于在header里頭添加content-type等參數(shù)
httpHeaders.add(HttpHeaders.CONTENT_TYPE,"application/json");
Map<String, Object> map = getMap(documentId);
String jsonStr = JSON.toJSONString(map);
//創(chuàng)建請求體并添加數(shù)據(jù)
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);//此處三個(gè)參數(shù)分別是請求地址、請求體以及返回參數(shù)類型
return forEntity.toString();
}
4、方式三：使用Feign進(jìn)行消費(fèi)
在maven項(xiàng)目中添加依賴
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-feign</artifactId>
<version>1.2.2.RELEASE</version>
</dependency>啟動(dòng)類上加上@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調(diào)用外部接口方式使用
定義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 "模擬外部系統(tǒng)的接口功能"+testDto.getId();
}
}
構(gòu)建Feigin的Service
定義service
//此處name需要設(shè)置不為空，url需要在.properties中設(shè)置
@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調(diào)用外部接口入口
@PostMapping("/test2")
public String test2(@RequestBody TestDto testDto) {
return feignService2.getMessage(testDto);
}
postman測試
此處因?yàn)槲沂褂昧怂陧?xiàng)目，所以需要添加一定的請求頭等信息，關(guān)于Feign的請求頭添加也會(huì)在后續(xù)補(bǔ)充
補(bǔ)充如下：
添加Header解決方法
將token等信息放入Feign請求頭中，主要通過重寫RequestInterceptor的apply方法實(shí)現(xiàn)
定義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調(diào)用外部接口入口，加上token
@PostMapping("/testToken")
public String test4(@RequestBody TestDto testDto) {
return tokenDemoClient.getMessage(testDto);
}
到此這篇關(guān)于SpringBoot 調(diào)用外部接口的三種方式的文章就介紹到這了,更多相關(guān)SpringBoot 調(diào)用外部接口內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Mybatis -如何處理clob類型數(shù)據(jù)
這篇文章主要介紹了Mybatis 如何處理clob類型數(shù)據(jù)的操作，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-06-06
myBatis使用@GeneratedValue(generator?=?“...“,?strategy?=?
這篇文章主要介紹了myBatis使用@GeneratedValue(generator?=?“...“,?strategy?=?...)注解問題，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-07-07
這篇文章主要介紹了Spring?boot異步任務(wù)原理，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-11-11
SpringBoot實(shí)現(xiàn)滑塊驗(yàn)證碼驗(yàn)證登陸校驗(yàn)功能詳解
驗(yàn)證碼作為一種自然人的機(jī)器人的判別工具，被廣泛的用于各種防止程序做自動(dòng)化的場景中。傳統(tǒng)的字符型驗(yàn)證安全性已經(jīng)名存實(shí)亡的情況下，各種新型的驗(yàn)證碼如雨后春筍般涌現(xiàn)，今天給大家分享一篇SpringBoot實(shí)現(xiàn)滑塊驗(yàn)證碼2022-09-09
今天小編就為大家分享一篇Java讀取String分行字符串的方法，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-07-07
SpringBoot整合MyBatis-Plus3.1教程詳解
這篇文章主要介紹了SpringBoot整合MyBatis-Plus3.1詳細(xì)教程，非常不錯(cuò)，具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-08-08
本文主要介紹了Java中final的使用方法，final是java的關(guān)鍵字，本文就詳細(xì)說明一下它的使用方法,需要的朋友可以參考下2015-08-08
關(guān)于springboot中nacos動(dòng)態(tài)路由的配置
這篇文章主要介紹了springboot中nacos動(dòng)態(tài)路由的配置方式，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-09-09
Java使用System.currentTimeMillis()方法計(jì)算程序運(yùn)行時(shí)間的示例代碼
System.currentTimeMillis() 方法的返回類型為 long ，表示毫秒為單位的當(dāng)前時(shí)間，文中通過示例代碼介紹了計(jì)算 String 類型與 StringBuilder 類型拼接字符串的耗時(shí)情況，對Java計(jì)算程序運(yùn)行時(shí)間相關(guān)知識感興趣的朋友一起看看吧2022-03-03
這篇文章主要介紹了springcloud使用consul作為配置中心，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-06-06