首页 > 其他分享 >SpringBoot调用外部接口的几种方式

SpringBoot调用外部接口的几种方式

时间：2024-10-31 15:02:45浏览次数：1  
标签：map 调用 SpringBoot url userId 接口 new public String

使用FeignClient调用

FeignClient调用大多用于微服务开发中，各服务之间的接口调用。它以Java接口注解的方式调用HTTP请求，使服务间的调用变得简单

1、在使用方引入依赖

<!-- Feign注解 这里openFeign的版本要和自己使用的SpringBoot匹配-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
    <!-- <version>4.0.1</version> -->
</dependency>

　　

2、服务接口调用方

2.1、在启动类上加上@EnableFeigncliens注解

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableFeignClients
public class StudyfeignApplication {

    public static void main(String[] args) {
        SpringApplication.run(StudyfeignApplication.class, args);
        System.out.println("项目启动成功");
    }

}

　　

2.2、编写Feign接口调用服务controller层

import com.hysoft.studyfeign.service.SysUserClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("feign")
public class SysUserController {

    @Autowired
    private SysUserClient sysUserClient;

    @PostMapping("getUserId")
    public void getUserId(String userId){
        this.sysUserClient.getUserById(userId);
    }

}

　　

2.3、服务接口调用service层

feign的客户端需要使用@FeignClient注解进行表示，这样扫描时才知道这是一个feign客户端。@FeignClient最常用的就两个属性，一个name，用于给客户端定义一个唯一的名称，另一个就是url，用于定义该客户端调用的远程地址。url中的内容，可以写在配置文件application.yml中，便于管理

@Service
@FeignClient(name = "feign-service",url = "${master-getuserbyId}")
public interface SysUserClient {

    @PostMapping("/master/test")
    String getUserById(String id);

}

　　application.yml中的配置如下

server:
  port: 8081
master-getuserbyId: http://localhost:8080

　　

3、服务接口提供者

对于接口提供者来说没有特别要求，和正常的接口开发一样
  • 1

4、说明

需要说明的是，在接口调用方，可以继续拓展service层，书写service实现层，进一步进行拓展	

import org.springframework.stereotype.Service;

@Service
public class SysUserClientImpl implements SysUserClient{
    @Override
    public String getUserById(String id) {
        return "";
    }
}

　　

使用RestTemplate调用

RestTemplate中几个常用的方法：getForObject()、getForEntity()、postForObject()、postForEntity()。其中，getForObject() 和 getForEntity() 方法可以用来发送 GET 请求

1、引入依赖

  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
  </dependency>

　　

2、RestTemplateConfig配置类

SimpleClientHttpRequestFactory类对应的HTTP库是JDK自带的HttpUrlConnection，当然我们可以根据自身的需求使用其他的HTTP库，例如HttpComponentsAsyncClientHttpRequestFactory

@Configuration
public class RestTemplateConfig {

    @Bean
    public RestTemplate restTemplate(ClientHttpRequestFactory factory){
        return new RestTemplate(factory);
    }

    @Bean
    public ClientHttpRequestFactory simpleClientHttpRequestFactory(){
        SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
        factory.setReadTimeout(5000);//单位为ms
        factory.setConnectTimeout(5000);//单位为ms
        return factory;
    }
}

　　

3、接口调用

@RestController
public class TestRestTemplate {
    @Resource
    private RestTemplate restTemplate;

    @GetMapping(value = "/saveUser")
    public void saveUser(String userId) {
        String url = "http://127.0.0.1:8080/master/test";
        Map map = new HashMap<>();
        map.put("userId", "hy001");
        String results = restTemplate.postForObject(url, map, String.class);
    }
  }

　　

使用WebClient调用

Spring3.0引入了RestTemplate，但是在后来的官方源码中介绍，RestTemplate有可能在未来的版本中被弃用，所谓替代RestTemplate，在Spring5中引入了WebClient作为异步的非阻塞、响应式的HTTP客户端。

1、引入依赖

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

　　

2、接口调用示例

public class TestWebClient {
    @Test
    public void doGet() {
        String userId = "郭郭";
        String url = "http://127.0.0.1:8080/master/test/getSysUserById?userId={userId}";
        Mono<String> mono = WebClient
                //创建WebClient实例
                .create()
                //方法调用，WebClient中提供了多种方法
                .get()
                //请求url
                .uri(url, userId)
                //获取响应结果
                .retrieve()
                //将结果转换为指定类型
                .bodyToMono(String.class);
        //返回最终结果：block是阻塞的/subscribe()非阻塞式获取响应结果
        System.out.println("响应结果：" + mono.block());
    }
    @Test
    public void doPost() {
        Map map = new HashMap<>();
        map.put("name", "郭郭");
        String requestBody = JSON.toJSONString(map);
        String url = "http://127.0.0.1:8080/master/test/saveUser";
        Mono<String> mono = WebClient
                //创建WebClient实例
                .create()
                //方法调用，WebClient中提供了多种方法
                .post()
                //请求url
                .uri(url)
                //指定请求的Content-Type为JSON
                .contentType(MediaType.APPLICATION_JSON)
                //使用bodyValue方法传递请求体
                .bodyValue(requestBody)
                //获取响应结果
                .retrieve()
                //将结果转换为指定类型
                .bodyToMono(String.class);
        //返回最终结果：block是阻塞的/subscribe()非阻塞式获取响应结果
        System.out.println("响应结果：" + mono.block());
    }
}

　　

在上述doPost请求中，我们的请求接口入参是一个Map，但是需要转换为JSON格式传递，这是因为WebClient默认是使用JSON序列化的。

使用Apache HttpClient调用

public class TestHttpClient {
    @Test
    public void doGet() throws IOException {
        //步骤一：创建httpClient实例
        CloseableHttpClient httpClient = HttpClients.createDefault();
        //步骤二：创建HTTP请求
        HttpGet httpGet = new HttpGet("http://127.0.0.1:8094/masterdata/sysUser/getSysUserById?userId=郭郭");
        //步骤三：发送请求并获取响应数据
        CloseableHttpResponse response = httpClient.execute(httpGet);
        //步骤四：处理响应数据
        HttpEntity entity = response.getEntity();
        String result = EntityUtils.toString(entity);
        //步骤五：关闭httpClient和response
        response.close();
        httpClient.close();
    }
    @Test
    public void doPost() throws IOException {
        //步骤一：创建httpClient实例
        CloseableHttpClient httpClient = HttpClients.createDefault();
        //步骤二：创建HTTP请求
        HttpPost httpPost = new HttpPost("http://127.0.0.1:8094/masterdata/sysUser/saveUser");
        //步骤三：设置请求体数据，使用JSON格式
        Map map = new HashMap<>();
        map.put("name", "郭郭");
        String requestBody = JSON.toJSONString(map);
        StringEntity stringEntity = new StringEntity(requestBody, "UTF-8");
        stringEntity.setContentType("application/json");
        httpPost.setEntity(stringEntity);
        
        //步骤四：发送请求并获取响应数据
        CloseableHttpResponse response = httpClient.execute(httpPost);
        //步骤五：处理响应数据
        HttpEntity entity = response.getEntity();
        String result = EntityUtils.toString(entity);
        //步骤五：关闭httpClient和response
        response.close();
        httpClient.close();
    }
}

　　

使用HttpURLConnection调用

public class TestHttpURLConnection {

    @Test
    public void doGet() throws IOException {
        String userId = "郭郭";  // 参数值
        userId = URLEncoder.encode(userId, "UTF-8"); // 对参数值进行URL编码
        //步骤一：创建URL对象
        URL url = new URL("http://127.0.0.1:8094/masterdata/sysUser/getSysUserById?userId=" + userId);
        //步骤二：打开连接
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();
        //步骤三：设置请求方式
        conn.setRequestMethod("GET");
        //步骤四：读取响应内容
        BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
        StringBuilder sb = new StringBuilder();
        String line;
        while ((line = reader.readLine()) != null) {
            sb.append(line);
        }
        reader.close();
        System.out.println(sb.toString());
    } 
    @Test
    public void doPost() throws IOException {
        //创建URL对象
        URL url = new URL("http://127.0.0.1:8094/masterdata/sysUser/saveUser");
        //打开连接
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();
        //设置请求方式
        conn.setRequestMethod("POST");
        // 设置请求头
        conn.setRequestProperty("Content-Type", "application/json");
        //启用输出流
        conn.setDoOutput(true);
        //设置请求体数据
        Map map = new HashMap<>();
        map.put("name", "郭郭");
        String requestBody = JSON.toJSONString(map);
        //发送请求体数据
        try (DataOutputStream outputStream = new DataOutputStream(conn.getOutputStream())) {
            outputStream.write(requestBody.getBytes(StandardCharsets.UTF_8));
        }

        //读取响应内容
        BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
        StringBuilder sb = new StringBuilder();
        String line;
        while ((line = reader.readLine()) != null) {
            sb.append(line);
        }
        reader.close();
        System.out.println(sb.toString());
    } 
  }

　　

使用OkHttp调用

1、引入依赖

<!--okhttp依赖-->
  <dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.0.0</version>
  </dependency>

　　

2、示例代码

public class TestOkHttp {

    @Test
    public void doGet() throws IOException {
        OkHttpClient client = new OkHttpClient();
        String url = "http://127.0.0.1:8080/master/test/getSysUserById?userId=郭郭";
        Request request = new Request.Builder().url(url).build();
        try (Response response = client.newCall(request).execute()) {
            ResponseBody body = response.body();
            System.out.println(body.string());
        }
    }

    @Test
    public void doPost() throws IOException{
        OkHttpClient client = new OkHttpClient();
        String url = "http://127.0.0.1:8080/master/test/saveUser";
        MediaType mediaType = MediaType.get("application/json; charset=utf-8");
        //requestBody请求入参
        Map map = new HashMap<>();
        map.put("name", "admin");
        RequestBody requestBody = RequestBody.create(mediaType, JSON.toJSONString(map));
        Request request = new Request.Builder()
                .url(url)
                .post(requestBody)
                .build();
        try (Response response = client.newCall(request).execute()) {
            ResponseBody body = response.body();
            System.out.println(body.string());
        }
    }
}

　　

使用AsyncHttpClient调用

1、引入依赖

<dependency>
      <groupId>org.asynchttpclient</groupId>
      <artifactId>async-http-client</artifactId>
      <version>2.12.3</version>
</dependency>

　　

2、示例代码

public class TestAsyncHttpClient {
    @Test
    public void doGet() throws IOException {
        try (AsyncHttpClient client = new DefaultAsyncHttpClient();) {
            BoundRequestBuilder requestBuilder = client.prepareGet("http://127.0.0.1:8080/master/test/getSysUserById?userId=hy001");
            CompletableFuture<String> future = requestBuilder.execute()
                    .toCompletableFuture()
                    .thenApply(Response::getResponseBody);
            //使用join等待响应完成
            String responseBody = future.join();
            System.out.println(responseBody);
        }
    }
    @Test
    public void doPost() throws IOException {
        try (AsyncHttpClient client = new DefaultAsyncHttpClient();) {
            BoundRequestBuilder requestBuilder = client.preparePost("http://127.0.0.1:8094/8080/master/test/saveUser");
            //requestBody请求入参
            Map map = new HashMap<>();
            map.put("name", "admin");
            String requestBody = JSON.toJSONString(map);
            requestBuilder.addHeader("Content-Type", "application/json");
            requestBuilder.setBody(requestBody);
            CompletableFuture<String> future = requestBuilder.execute()
                    .toCompletableFuture()
                    .thenApply(Response::getResponseBody);
            //使用join等待响应完成
            String responseBody = future.join();
            System.out.println(responseBody);
        }
    }
  }

　　

原文地址  https://blog.csdn.net/qq_40386113/article/details/141223841

 

标签：map,调用,SpringBoot,url,userId,接口,new,public,String
From： https://www.cnblogs.com/xianz666/p/18517822

相关文章

  • C++——将一个5x5的矩阵中最大的元素放在中心,4个角分别放4个最小的元素(按从左到右、
    没注释的源代码#include<iostream>#include<stdio.h>#include<string.h>usingnamespacestd;voidtransform(int*arry,intcol_row);intmain(){   intarry[5][5];   cout<<"Pleaseentera5x5matrix:"<<endl;   for(......
  • 基于SpringBoot+MySQL+SSM+Vue.js的交友系统(附论文)
    获取见最下方名片信息获取见最下方名片信息获取见最下方名片信息演示视频基于SpringBoot+MySQL+SSM+Vue.js的交友系统(附论文)技术描述开发工具：Idea/Eclipse数据库：MySQLJar包仓库：Maven前端框架：Vue/ElementUI后端框架：Spring+SpringMVC+Mybatis+SpringBoo......
  • excel表格文字识别-ocr表格文字提取api接口集成
    表格文字识别接口的集成示例通常包含几个关键步骤，从接入API接口到最终数据处理和展示。以下是翔云表格文字识别接口的一个基本集成流程示例：1.获取接口信息在开始集成前，请确保已经获取了表格文字识别API的接口文档，并了解该接口的参数需求、返回结果格式、以及鉴权方......
  • 基于SpringBoot+MySQL+SSM+Vue.js的宠物猫售卖管理
    获取见最下方名片获取见最下方名片获取见最下方名片演示视频基于SpringBoot+MySQL+SSM+Vue.js的宠物猫售卖管理技术描述开发工具：Idea/Eclipse数据库：MySQLJar包仓库：Maven前端框架：Vue/ElementUI后端框架：Spring+SpringMVC+Mybatis+SpringBoot文字描述基......
  • 品类超全的免费API接口整理分享
    免费API接口AI绘画-StableDiffusion：通过AI生成图片，包括图生文、文生图等。全国招投标查询：查询招标保标信息，涵盖招标信息查询、历史招标库、政府采集信息、招标定制等数十个招投标领域。全国快递物流查询：目前已支持600+快递公司的快递信息查询。自动识别快递公司及单号，服......
  • 基于SpringBoot的旅游网站系统
    引言  在当今旅游业的数字化发展背景下，设计一个高效的旅游网站系统显得尤为重要。传统旅游网站往往存在页面加载缓慢、信息更新不及时、交互性差等问题，无法满足现代用户的需求。而基于SpringBoot+Vue+MySQL+MyBatis实现的旅游网站系统，通过前后端分离的架构设计，提升......
  • 音乐网站新篇章：SpringBoot Web实现
    2相关技术2.1MYSQL数据库MySQL是一个真正的多用户、多线程SQL数据库服务器。是基于SQL的客户/服务器模式的关系数据库管理系统，它的有点有有功能强大、使用简单、管理方便、安全可靠性高、运行速度快、多线程、跨平台性、完全网络化、稳定性等，非常适用于Web站点或者其他......
  • SpringBoot节奏：Web音乐网站构建手册
    2相关技术2.1MYSQL数据库MySQL是一个真正的多用户、多线程SQL数据库服务器。是基于SQL的客户/服务器模式的关系数据库管理系统，它的有点有有功能强大、使用简单、管理方便、安全可靠性高、运行速度快、多线程、跨平台性、完全网络化、稳定性等，非常适用于Web站点或者其他......
  • 基于SpringBoot的校园失物招领系统
    引言  在信息化快速发展的当下，校园内的失物招领管理是一个常见问题。传统的失物招领方式主要依靠公告栏或线下查询，存在信息滞后、查询不便等缺点，难以满足师生的实际需求。基于此，设计一款基于SpringBoot+Vue+MySQL+MyBatis的校园失物招领系统，采用前后端分离的架构，通......
  • 基于SpringBoot的智能餐厅点餐管理系统
    引言  随着数字化技术的发展，智慧餐厅逐渐成为餐饮行业提升服务质量和运营效率的重要方向。传统的点餐方式在高峰期经常导致顾客等待时间过长，影响用餐体验。智慧餐厅通过技术手段，实现了无纸化、自助式点餐，并有效减少人工操作，提高了点餐效率。本文介绍的基于SpringBoot+V......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99