Spring Boot 调用外部接口的常用方式!

news/2024/12/22 19:53:14/

使用Feign进行服务消费是一种简化HTTP调用的方式,可以通过声明式的接口定义来实现。下面是一个使用Feign的示例,包括设置Feign客户端和调用服务的方法。

添加依赖
首先,请确保你的项目中已经添加了Feign的依赖。如果你使用的是Maven,可以在pom.xml中添加以下依赖(如果使用Spring Boot,通常已经包含了这些依赖):

<dependency>  <groupId>org.springframework.cloud</groupId>  <artifactId>spring-cloud-starter-openfeign</artifactId>  
</dependency>  

以下是完整示例的结构:

主应用类(YourApplication.java):

import org.springframework.boot.SpringApplication;  
import org.springframework.boot.autoconfigure.SpringBootApplication;  
import org.springframework.cloud.openfeign.EnableFeignClients;  @SpringBootApplication  
@EnableFeignClients  
public class YourApplication {  public static void main(String[] args) {  SpringApplication.run(YourApplication.class, args);  }  
}  

Feign客户端接口(UserServiceClient.java):

import org.springframework.cloud.openfeign.FeignClient;  
import org.springframework.web.bind.annotation.GetMapping;  
import org.springframework.web.bind.annotation.RequestParam;  @FeignClient(name = "user-service", url = "http://USER-SERVICE")  
public interface UserServiceClient {  @GetMapping("/user")  String getUserByName(@RequestParam("name") String name);  
}  

服务类(UserService.java):

import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.stereotype.Service;  @Service  
public class UserService {  private final UserServiceClient userServiceClient;  @Autowired  public UserService(UserServiceClient userServiceClient) {  this.userServiceClient = userServiceClient;  }  public String fetchUserByName(String name) {  return userServiceClient.getUserByName(name);  }  
}  

注意事项
Feign的配置:可以通过application.yml或application.properties配置Feign的超时、编码等。
服务发现:如果使用服务发现工具(如Eureka),可以将url参数省略,程序会自动根据服务名称进行调用。
错误处理:请考虑使用Feign提供的错误解码器或自定义的异常处理机制。

WebClient
WebClient是Spring WebFlux提供的非阻塞式HTTP客户端,适用于异步调用。

示例代码:

import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.stereotype.Service;  
import org.springframework.web.reactive.function.client.WebClient;  
import reactor.core.publisher.Mono;  @Service  
public class WebClientService {  private final WebClient webClient;  @Autowired  public WebClientService(WebClient.Builder webClientBuilder) {  this.webClient = webClientBuilder.baseUrl("http://USER-SERVICE").build();  }  public Mono<String> getUser(String username) {  return webClient.get()  .uri("/user?name={username}", username)  .retrieve()  .bodyToMono(String.class);  }  
}  

配置:
在@Configuration类中配置WebClient bean:

import org.springframework.context.annotation.Bean;  
import org.springframework.context.annotation.Configuration;  
import org.springframework.web.reactive.function.client.WebClient;  @Configuration  
public class AppConfig {  @Bean  public WebClient.Builder webClientBuilder() {  return WebClient.builder();  }  
}  

使用hutool

import cn.hutool.http.HttpUtil;
import cn.hutool.json.JSONObject;
import cn.hutool.json.JSONUtil;
import java.net.URLEncoder;  
import java.nio.charset.StandardCharsets;  
import java.util.Map;  public class ApiClient {  public String sendPostRequest(String code, String appAccessToken, SocialDetails socialDetails) {  String url = formatUrl(socialDetails.getUrl(), appAccessToken);  String jsonBody = createRequestBody(code);  return executePost(url, jsonBody);  }  private String formatUrl(String baseUrl, String token) {  try {  return String.format(baseUrl, URLEncoder.encode(token, StandardCharsets.UTF_8.toString()));  } catch (Exception e) {  throw new RuntimeException("Error encoding URL", e);  }  }  private String createRequestBody(String code) {  Map<String, String> requestBody = Map.of("code", code);  return JSONUtil.toJsonStr(requestBody);  }  private String executePost(String url, String jsonBody) {  try {  return HttpUtil.post(url, jsonBody);  } catch (Exception e) {  throw new RuntimeException("Failed to execute POST request", e);  }  }  
}
  1. 创建一个 RestTemplate Bean
    在你的 Spring Boot 应用中创建一个 RestTemplate 的 Bean,通常在主类或配置类中:
import org.springframework.context.annotation.Bean;  
import org.springframework.context.annotation.Configuration;  
import org.springframework.web.client.RestTemplate;  @Configuration  
public class AppConfig {  @Bean  public RestTemplate restTemplate() {  return new RestTemplate();  }  
}  

创建 RestTemplate 示例
以下是一个简单的服务类,展示如何使用 RestTemplate 发送 GET 和 POST 请求:

import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.stereotype.Service;  
import org.springframework.web.client.RestTemplate;  @Service  
public class ApiService {  @Autowired  private RestTemplate restTemplate;  // 发送 GET 请求  public String getExample() {  String url = "https://baidu.com/posts/1";  return restTemplate.getForObject(url, String.class);  }  // 发送 POST 请求  public String postExample() {  String url = "https://baidu.com/posts";  Post post = new Post("foo", "bar");  return restTemplate.postForObject(url, post, String.class);  }  static class Post {  private String title;  private String body;  public Post(String title, String body) {  this.title = title;  this.body = body;  }  // Getters and Setters (如果需要)  }  
}  

调用示例
通常在一个控制器中调用这个服务:

import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.web.bind.annotation.GetMapping;  
import org.springframework.web.bind.annotation.PostMapping;  
import org.springframework.web.bind.annotation.RestController;  @RestController  
public class ApiController {  @Autowired  private ApiService apiService;  @GetMapping("/get")  public String get() {  return apiService.getExample();  }  @PostMapping("/post")  public String post() {  return apiService.postExample();  }  
}  

http://www.ppmy.cn/news/1533327.html

相关文章

【QT】QWidget 重要属性

文章目录 enabledgeometrywindowTitlewindowIconqrc 机制windowOpacitycursorfontQFont toolTip 和 toolTipDurationfocusPolicyQt::FocusPolicy styleSheet enabled 作用&#xff1a;设置控件是否可使用. true 表⽰可用, false 表⽰禁用. 对应的API bool isEnabled(); // 获…

探索Python新境界:funboost库揭秘

文章目录 探索Python新境界&#xff1a;funboost库揭秘背景&#xff1a;为什么选择funboost&#xff1f;funboost是什么&#xff1f;如何安装funboost&#xff1f;简单的库函数使用方法场景应用常见Bug及解决方案总结 探索Python新境界&#xff1a;funboost库揭秘 背景&#x…

实时Python解释器介绍和使用

Realtime Python &#xff08;实时Python解释器&#xff09; 使用 概述 项目地址&#xff1a;https://github.com/nitsc/Real-time-Python/tree/main Realtime Python&#xff08;rtpy.py&#xff09; 是一个 Python 脚本&#xff0c;旨在根据配置文件的设定频率&#xff0c;自…

C++:STL(四)之vector的基本介绍与使用方式|容器接口

✨ Blog’s 主页: 白乐天_ξ( ✿&#xff1e;◡❛) &#x1f308; 个人Motto&#xff1a;他强任他强&#xff0c;清风拂山冈&#xff01; &#x1f525; 所属专栏&#xff1a;C深入学习笔记 &#x1f4ab; 欢迎来到我的学习笔记&#xff01; 一、C/C中的字符串 1.1. C语言中的…

云计算Openstack Nova

OpenStack Nova是OpenStack云计算平台中的一个核心组件&#xff0c;主要负责管理和部署虚拟机实例。以下是对OpenStack Nova的详细解析&#xff1a; 一、定义与功能 定义&#xff1a;OpenStack Nova是一个计算服务组件&#xff0c;它提供了虚拟机实例的创建、启动、暂停、恢复…

虚幻引擎-设置UI自适应屏幕大小

在游戏中&#xff0c;如果想实现不同分辨率下&#xff0c;都可以支持当前的UI界面布局&#xff0c;都需要用到锚点功能。 ‌虚幻引擎中的UI锚点&#xff08;Anchor&#xff09;是指控件在屏幕或父物体上的固定点&#xff0c;用于确定控件的位置和布局。‌ 锚点的作用是确保UI元…

用示波器测动态滞回线

大学物理&#xff08;下&#xff09;实验-中南民族大学通信工程2022级 手动逐个处理数据较为麻烦且还要绘图&#xff0c;故想到用pythonmatplotlib来计算结果并数据可视化。 代码实现 import matplotlib.pyplot as plt# 样品一磁化曲线 X [0, 0.2, 0.4, 0.6, 0.8, 1, 1.5, 2.…

LeetCode 面试经典150题 50.Pow(x,n)

题目&#xff1a;实现 pow(x, n) &#xff0c;即计算 x 的整数 n 次幂函数&#xff08;即&#xff0c; &#xff09;。 思路&#xff1a; 代码&#xff1a; class Solution {public double myPow(double x, int n) {double ans 1;long N n;if (N < 0) {N -N;x 1 / x;}…