Springboot中调用外部接口的三种方式
Posted Chelsea__
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Springboot中调用外部接口的三种方式相关的知识，希望对你有一定的参考价值。
目录
1、简介
SpringBoot不仅继承了Spring框架原有的优秀特性，而且还通过简化配置来进一步简化了Spring应用的整个搭建和开发过程。在Spring-Boot项目开发中，存在着本模块的代码需要访问外面模块接口，或外部url链接的需求, 比如在apaas开发过程中需要封装接口在接口中调用apaas提供的接口（像发起流程接口submit等等）下面也是提供了三种方式（不使用dubbo的方式）供我们选择
2、方式一：使用原始httpClient请求
/*
* @description get方式获取入参，插入数据并发起流程
* @author lyx
* @date 2022/8/24 16:05
* @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 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();
// 要调用的接口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;
3、方式二：使用RestTemplate方法
Spring-Boot开发中，RestTemplate同样提供了对外访问的接口API，这里主要介绍Get和Post方法的使用。
-
Get请求
提供了getForObject 、getForEntity两种方式，其中getForEntity如下三种方法的实现：
Get--getForEntity，存在以下两种方式重载
getForEntity(Stringurl,Class responseType,Object…urlVariables)
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--getForEntity(Stringurl,Class responseType,Object…urlVariables)
//该方法提供了三个参数，其中url为请求的地址，responseType为请求响应body的包装类型，urlVariables为url中的参数绑定，该方法的参考调用如下：
// 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，存在以下三种方式重载
getForObject(String url,Class responseType,Object...urlVariables)
getForObject(String url,Class responseType,Map urlVariables)
getForObject(URI url,Class responseType)
getForObject方法可以理解为对getForEntity的进一步封装，它通过HttpMessageConverterExtractor对HTTP的请求响应体body内容进行对象转换，实现请求直接返回包装好的对象内容。
-
Post 请求
Post请求提供有postForEntity、postForObject和postForLocation三种方式，其中每种方式都有三种方法，下面介绍postForEntity的使用方法。
Post--postForEntity，存在以下三种方式重载
postForEntity(String url,Object request,Class responseType,Object... uriVariables) postForEntity(String url,Object request,Class responseType,Map uriVariables) postForEntity(URI url,Object request，Class responseType)
如下仅演示第二种重载方式
/*
* @description post方式获取入参，插入数据并发起流程
* @author lyx
* @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调外部接口
* @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();
//创建请求头
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();
4、方式三：使用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);
异步回调函数-创建进程的三种方式
回调函数
有两个类，A,B,在类A中调用B，在B中调用A的方法完成A的工作，那么这个在B类中调用的A的函数就称为回调函数。
异步回掉函数：类A将自己的工作交给类B后，继续执行剩下的程序，而B继续完成A交给的工作。
使用方法：
1、定义一个接口
2、A可以直接继承此接口，也可以定义一个内部类继承此接口；
定义一个方法，调用B中的方法
3、B中的方法调用A中的方法。
//定义接口 public interface doJob public void fillBlank(int a,int b,int result) throws InterruptedException; //定义A类 public class Student private String name = null; public Student(String name) this.name = name; public void setName(String name) this.name = name; public String getName() return name; @SuppressWarnings("unused") private int calcAdd(int a,int b) return a+b; private int useCalculator(int a,int b) return new Calculator().add(a,b); public void fillBlank(int a,int b) int result = useCalculator(a,b); System.out.println(name + "使用计算器：" + a + " + " + b + " = " + result); public void fillBlank(int result) System.out.println(name + "使用计算器： a + b = " + result); public class doHomeWork implements doJob public void fillBlank(int a, int b, int result) throws InterruptedException System.out.println(name + "求助小红计算：" +a+" + "+b+" = "+result); public void callHelp(final int a,final int b) throws InterruptedException new Thread(new Runnable() public void run() try Thread.sleep(5000); new SuperCalculator().add(a,b,new doHomeWork()); catch (InterruptedException e) e.printStackTrace(); ).start(); //定义B类 public class SuperCalculator public void add(int a,int b,doJob s) throws InterruptedException int result = a +b; s.fillBlank(a,b,result); //主函数，测试 public class Test public static void main(String[] args) throws InterruptedException int a =1; int b = 2; Student s = new Student("小明"); s.callHelp(a,b); System.out.println("结束");
输出结果：
结束
小明求助小红计算：1 + 2 = 3
线程的三种方式
Runnable
实现Runnable接口，需要实现run方法，run方法中可以调用其他方法，使用其他类，并声明变量，就像主线程一样，代码如下：
public class RunableProcessor implements Runnable
private Thread t;
private String threadName;
public RunableProcessor(String threadName)
this.threadName = threadName;
public void run()
System.out.println("ssss");
public void start()
t = new Thread(this,threadName);
t.start();
//调用
public class TestThread
public static void main(String args[])
RunnableProcessor R1 = new RunnableProcessor( "Thread-1");
R1.start();
Thread
继承Thread类，run方法中可以调用其他方法，使用其他类，并声明变量，就像主线程一样，代码如下：
public class ThreadProcessor extends Thread
private String name = "sss";
private Thread t;
@Override
public synchronized void start()
t = new Thread(this,name);
t.start();
@Override
public void run()
System.out.println(name);
//调用
public class TestThread
public static void main(String args[])
ThreadProcessorR1 = new ThreadProcessor( "Thread-1");
R1.start();
Thread类本身有一些函数，比如修改进程名字，修改优先级。
Callable方式
此方式有返回值，需要继承Callable接口实现call方法。to那个锅FutureTask来完成调用。
//实现Callable接口
public class CallableProcessor implements Callable<String>
private String str = "s";
public String call() throws Exception
String result = "";
for(int i =0;i<20;i++)
result.concat(str);
result += str;
return result;
//调用，并获取返回值
public class Test
public static void main(String[] args)
CallableProcessor callableProcessor = new CallableProcessor();
FutureTask<String> ft = new FutureTask<String>(callableProcessor);
Thread t = new Thread(ft);
t.start();
try
System.out.println(ft.get());
catch (InterruptedException e)
e.printStackTrace();
catch (ExecutionException e)
e.printStackTrace();
System.exit(0);
以上是关于Springboot中调用外部接口的三种方式的主要内容，如果未能解决你的问题，请参考以下文章
SpringBoot2.0.2 Application调用的三种方式