SpringCloud-OpenFeign基础

2024-06-22 19:36
文章标签 java 基础 spring springcloud openfeign

本文主要是介绍SpringCloud-OpenFeign基础，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

OpenFeign

OpenFeign简介

  1. OpenFeign是一个基于HTTP协议的RPC（远程过程调用）组件，用于简化HTTP请求和响应的处理。
  2. 它通过声明式的方式定义REST API接口，并自动生成实现该接口的客户端代码，从而简化了RESTful服务的调用过程。
  3. 它和其它框架，比如Dubbo、Mybatis等发送请求的框架相同，底层是动态代理
  4. 它是Feign的增强版，同时整合了Ribbon和Eureka，使Feign更加灵活

Feign.client

OpenFeign默认使用jdk的HttpUrlConnection，没有链接池，也没有资源管理，性能不是很好

Feign的日志

  1. Feign的日志级别
  2. NONE:默认的，不打印任何日志
  3. BASIC:仅记录请求方法，URL、响应状态码以及执行时间
  4. HEADERS：在BASIC基础上，记录请求和响应的header信息
  5. FULL:记录响应和请求的header、body和元数据
  6. 开发环境一般使用FULL，生产环境一般使用BASIC

配置Feign日志可以通过两种方式配置

Feign的日志打印是基于springboot日志的所以要配置springboot日志

  • 引入springboot日志依赖
        <!--日志--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></dependency>
  • 配置springboot日志输出级别
logging:level:com.shaoby: debug
  1. 配置类，需要注意的是如果使用配置类的方式，配置类加了@Configuration注解，全局使用；如果不加可以通过@FeignClient注解的configuration属性指定配置类；
public class FeignLogConfig {@Beanpublic Logger.Level logger(){return Logger.Level.FULL;}
}
@FeignClient(value = "SMS-cache",configuration = FeignLogConfig.class)
public interface SmsCacheClient {@GetMapping(value = "/cache/hGetAll/{key}")Map hGetAll(@PathVariable("key") String key);
}
  1. 配置文件，或直接使用配置文件配置feign日志
logging:level:com.shaoby: debug
feign:client:config:
#      feignClient的value,可以配置多个SMS-cache:loggerLevel: full

Feign支持的配置项

Feign契约

  1. Feign默认使用springMVC的契约，即springMVC中的注解如@RequestMapping、@PostMapper、@PathVariable等。
  2. 如果使用Feign的默认契约，就必须使用Feign中的注解调用远程接口，可通过配置文件或者配置类修改契约，默认值feign.Contract.Default
  3. 不建议修改

编解码

  1. 编解码是指的：指将请求数据编码成HTTP请求体并将HTTP响应体解码成Java对象的过程。
  2. Feign中提供了自定义编解码配置，同时也提供了多项编解码的实现，比如Gson、Jaxb、Jackson.默认使用SpringEncoder&&SpringDecoder
  3. 可通过实现Encoder&&Decoder自定义编解码
  4. 可通过配置文件指定编解码方式，一般不建议修改
feign:client:config:#调用的服务名称，可配置多个SMS-cache:encoder: com.xxx.xxxEncoderdecoder: com.xxx.xxxDecoder

拦截器

  1. 实现RequestInterceptor接口，自定义拦截器
public class FeignAuthRequestInterceptor implements RequestInterceptor {private String tookenId;public FeignAuthRequestInterceptor(String tookenId) {this.tookenId = tookenId;}@Overridepublic void apply(RequestTemplate requestTemplate) {requestTemplate.header("Authorization",tookenId);}
}
  1. 通过配置类将拦截器配置到Feign中
  2. 服务提供端加入拦截器

Client设置

Feign中默认使用JDK原生的URLConnection发送HTTP请求，可以自定义实现替换，一般使用feign自带的,比如OkHTTPClient,apche httpclient等，配置方式相同。只要引入依赖，springboot自动装配。

比如使用apche httpclient

  • 引入依赖
<dependency><groupId>io.github.openfeign</groupId><atrifactId>feign-httpclient</atrifactId>
</dependency>
  • 配置类
feign:
#  使用apche httpclienthttpclient: true
#  最大连接数max-connections: 200
#  单路径最大链接数max-connections-pre-rote: 50

超时时间配置

  • 注入配置：
@Configuration
public class FeignConfig {@Beanpublic Request.Options options(){return new Request.Options(200,400);}
}

基本使用案例

本案例基于nacos作为注册中心和配置中心，用OpenFeign实现远程过程调用。

服务提供端

  1. 引入nacos相关依赖，用于将服务注册到nacos中
<!--注册到nacos-->
<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!--nacos拉取配置-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
  1. 配置nacos,配置注册中心地址
spring:application:name: SMS-cacheprofiles:active: devcloud:nacos:discovery:server-addr: 47.92.xxx.xxx:8848config:server-addr: 47.92.xxx.xxx:8848file-extension: ymlredis:host: 47.92.xxx.xxxport: 6379
  1. 开启nacos配置，启动类标记注解@EnableDiscoveryClient
@SpringBootApplication
@EnableDiscoveryClient
public class CacheStarterApp {public static void main(String[] args) {SpringApplication.run(CacheStarterApp.class,args);}
}
  1. 提供restful接口
/*** @Author Cookie* @Date 2024/6/22 0:42*/
@RestController
@Slf4j
public class CacheController {@Autowiredprivate RedisClient redisClient;@PostMapping(value = "/cache/hset/{key}")void hSet(@PathVariable("key") String key, @RequestBody Map map){log.info("【缓存模块】hSet方法存储数据成功key={},value{}",key,map);redisClient.putMap(key,map);}@GetMapping(value = "/cache/set/{key}/{value}")void set(@PathVariable("key") String key, @PathVariable("value") String value){log.info("【缓存模块】set方法存储数据成功key={},value{}",key,value);}
}

消费者

  1. 引入相关依赖，nacos、OpenFeign等
<!--注册到nacos--><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency><!--nacos拉取配置--><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId></dependency><!--openfeign--><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId></dependency>
  1. 配置nacos

同被调用端，将服务注册到nacos中

  1. 标记启动类，使用@EnableFeignClients自动装配OpenFeign
@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class TestAppStarter {public static void main(String[] args) {SpringApplication.run(TestAppStarter.class,args);}
}
  1. 消费者调用提供者接口,通过@FeignClient注解实现。
@FeignClient("SMS-cache")
public interface CacheClient {@PostMapping(value = "/cache/hset/{key}")void hSet(@PathVariable("key") String key, @RequestBody Map map);@GetMapping(value = "/cache/set/{key}/{value}")void set(@PathVariable("key") String key, @PathVariable("value") String value);
}

@FeignClient中有以下属性：

  1. value:指定服务的名称，要和注册中心中服务提供者名称一致
  2. name：指定该类的容器名称，即ioc中的类ID
  3. url: url一般用于调试，可以手动指定@FeignClient调用的地址
  4. decode404:当发生http 404错误时，如果该字段位true，会调用decoder进行解码，否则抛出FeignException
  5. configuration: Feign配置类，可以自定义Feign的Encoder、Decoder、LogLevel、Contract
  6. fallback: 服务容错处理类
  7. fallbackFactory: 工厂类，用于生成fallback类示例，通过这个属性我们可以实现每个接口通用的容错逻辑
  8. path: 定义当前FeignClient的统一前缀，项目中配置了server.context-path,server.servlet-path时使用
  1. 测试,注入消费者调用提供者接口的接口，由组件自动生产动态代理类
@SpringBootTest
@RunWith(SpringRunner.class)
public class ClientBusinessMapperTest {@Autowiredprivate ClientBusinessMapper mapper;@Autowiredprivate CacheClient cacheClient;@Testpublic void findById() throws JsonProcessingException {ClientBusiness clientBusiness = mapper.findById(1L);ObjectMapper objectMapper = new ObjectMapper();Map map = objectMapper.readValue(objectMapper.writeValueAsString(clientBusiness), Map.class);cacheClient.hSet("test"+clientBusiness.getApikey(),map);System.out.println("success...");}
}

这篇关于SpringCloud-OpenFeign基础的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1085215。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...
零基础学习Redis(10) -- zset类型命令使用

零基础学习Redis(10) -- zset类型命令使用

zset是有序集合，内部除了存储元素外，还会存储一个score，存储在zset中的元素会按照score的大小升序排列，不同元素的score可以重复，score相同的元素会按照元素的字典序排列。 1. zset常用命令 1.1 zadd  zadd key [NX | XX] [GT | LT]   [CH] [INCR] score member [score member ...]
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2