服务调用 – OpenFeign

生命不息，写作不止

继续踏上学习之路，学之同享笔记

总有一天我也能像各位大佬相同

一个有梦有戏的人 @怒放吧德德

同享学习心得，欢迎纠正，我们一同学习生长！

介绍

OpenFeign 全称 Spring Cloud OpenFeign，它是 Spring 官方推出的一种声明式服务调用与负载均衡组件，它的呈现就是为了替代进入停更维护情况的 Feign。 Spring Cloud openfeign对Feign进行了增强，使其支撑Spring MVC注解，另外还整合了Ribbon和Nacos，然后使得Feign的运用更加便利。 Feign运用http远程调用方法就好像调用本地的方法，感觉不到是远程方法。他的运用就和直接写控制类那样，暴露接口供应调用，我们只需求编写调用接口+@FeignClient注解，在运用这个api的时分，只需求定义好方法，到时分调用这个方法就可以了。这种服务之间的调用运用起来是非常的便利，体会也比较好。

怎么完成接口调用？

在平常开发的springboot项目中，像这种rest服务是怎么被调用的呢？一般下是运用Httpclient、Okhttp、HttpURLConnection、RestTemplate，其间RestTemplate是最常见的。之前在 nacos配备中心运用的是RestTemplate。

SpringCloud整合OpenFeign

就用一个例子来简略运用OpenFeign进行服务间的调用，通过实例来学习关于Feign组件的功用。

引进依托

运用OpenFeign组件需求引进客户端依托

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

编写调用接口

通过OpenFeign远程调用服务的时分，比RestTemplate更加便利，就跟编写controller接口是差不多的。需求写上@FeignClient注解，里面配备微服务姓名和rest的@RequestMapping(“/api/store”)，或许可以在声明调用pai的时分写上完整的途径。简略的对应如下图所示

代码如下：

package com.lyd.demo.feign;
import com.lyd.demo.feign.config.FeignOkhttpConfig;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import java.util.Map;
/**
 * @author: lyd
 * @description: 远程调用 service-store 服务
 * @Date: 2022/9/24
 * 介绍:
 *      name / value : 要调用的微服务名
 *      path：控制类上面的途径 --- @RequestMapping("/api/store")
 */
@FeignClient(name = "service-store", path = "/api/store")
public interface StoreFeignService {
    // 声明要调用的rest
    @GetMapping("/{id}")
    Map<String, Object> getStoreNum(@PathVariable String id);
}
/**
 * @RestController
 * @RequestMapping("/api/store")
 * public class StoreController {
 *     @Value("${server.port}")
 *     private String currentPort;
 *     @GetMapping("/{id}")
 *     public Map<String, Object> getStoreNum(@PathVariable String id) throws InterruptedException {
 *         Map<String, Object> map = new HashMap<>();
 *         map.put("port", currentPort);
 *         map.put("num", 10);
 *         return map;
 *     }
 * }
 */

需求在建议类中写上注解 @EnableFeignClients

@Autowired
private StoreFeignService storeFeignService;
// 在事务中直接调用
storeFeignService.getStoreNum(uid);

OpenFeign自定义配备

Feign 供应了许多的扩展机制，让用户可以更加灵敏的运用。 feign.Logger.Level：修正日志等级，包含四种不同的等级：NONE、BASIC、HEADERS、FULL feign.codec.Decoder：照应效果的解析器，http远程调用的效果做解析，例如解析json字符串为java目标 feign.codec.Encoder：央求参数编码，将央求参数编码，便于通过http央求发送 feign. Contract：支撑的注解格局，默许是SpringMVC的注解 feign. Retryer：失利重试机制，央求失利的重试机制，默许是没有，不过会运用Ribbon的重试

日志配备

可以通过配备Feign的日志等级来闪现需求的日志。

1)、定义配备类

定义一个feign的配备文件，并交给spring办理。 feign的日志等级一开始默许是NONE，不闪现任何的日志，可以通过定义一个bean，回来日志的等级

package com.lyd.demo.feign.config;
import feign.Logger;
import feign.Retryer;
import org.springframework.context.annotation.Bean;
import java.util.concurrent.TimeUnit;
/**
 * @author: lyd
 * @description: feign配备文件 - 日志
 * @Date: 2022/9/24
 */
@Configuration
public class FeignConfig {
    @Bean
    public Logger.Level feignLoggerLevel() {
        return Logger.Level.BASIC;
    }
}

日志等级有四种：

NONE【功用最佳，适用于出产】：不记载任何日志（默许值）。
BASIC【适用于出产环境追踪问题】：仅记载央求方法、URL、照应情况代码以及执行时间。
HEADERS：记载BASIC等级的基础上，记载央求和照应的header。
FULL【比较适用于开发及测验环境定位问题】：记载央求和照应的header、body和元数据。

2)、配备文件设置等级

springboot默许的等级是info，等级比较高，需求在配备文件中配备，如果只在loggin.level下配备等级，就是大局配备，所以我们可以指定包，指定哪个包下面的日志等级。

logging:
  level:
    com.lyd.demo.feign: debug

3)、配备域

大局配备：在feign配备类加上@Configuration注解，直接丢给spring来办理，达成大局配备。部分配备： ①、部分配备可以通过在feign客户端中指定配备文件，只需求在注解后边加上指定配备类

@FeignClient(name = "service-store", path = "/api/store", configuration = FeignConfig.class)

②、部分配备还可以直接通过yml配备文件来指定。

feign:
  client:
    config:
      service-goods: FULL # 指定哪个服务，并且赋上类型。

配备超时时间

通过yml直接配备超时时间

feign:
  client:
    config:
      default: # 这儿用default就是大局配备，如果是写服务名称，则是针对某个微服务的配备
        connectTimeout: 2000
        readTimeout: 2000

在store服务中加个Thread.sleep(5000)，就能看到报超时反常SocketTimeoutException。

重试机制配备

通过参加bean来完成创建重试器（重试周期（50毫秒），最大重试周期（2000毫秒），最多测验次数 3次），feign没有选用线性的重试机制而是选用的是一种指数级（乘法）的重试机制每次重试时间当前重试时间*= 1.5

@Bean
public Retryer retryer() {
    return new Retryer.Default(50, TimeUnit.SECONDS.toMillis(2), 3);
}

在来看看default的结构器，就能更清楚参数含义。

public Default(long period, long maxPeriod, int maxAttempts) {
    this.period = period;
    this.maxPeriod = maxPeriod;
    this.maxAttempts = maxAttempts;
    this.attempt = 1;
}

如图，会进行重试，直到最终报出反常。不仅如此，还可以配备契约设置，增加拦截器等等。。。

Feign运用优化

Feign底层建议http央求，依托于其它的结构。其底层客户端完成包含：

URLConnection：默许完成，不支撑衔接池
Apache HttpClient ：支撑衔接池
OKHttp：支撑衔接池

这次就选用OkHttp

导入依托

<!--okHttp-->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-okhttp</artifactId>
</dependency>

设置配备类

package com.lyd.demo.feign.config;
import okhttp3.ConnectionPool;
import okhttp3.OkHttpClient;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.concurrent.TimeUnit;
/**
 * @author: lyd
 * @description: OkHttpFeign 的配备
 * @Date: 2022/9/24
 */
@Configuration
@ConditionalOnClass({OkHttpClient.class})
@ConditionalOnProperty({"feign.okhttp.enabled"})
public class FeignOkhttpConfig {
    @Bean
    public okhttp3.OkHttpClient okHttpClient(OkhttpProperties okhttpProperties) {
        return new okhttp3.OkHttpClient.Builder()
                //设置衔接超时
                .connectTimeout(okhttpProperties.getConnectTimeout(), TimeUnit.MILLISECONDS)
                //设置读超时
                .readTimeout(okhttpProperties.getReadTimeout(), TimeUnit.MILLISECONDS)
                //是否主动重连
                .retryOnConnectionFailure(true)
                .connectionPool(new ConnectionPool())
                .addInterceptor(new OkHttpLogInterceptor())
                //构建OkHttpClient目标
                .build();
    }
}

yml配备

feign:
  client:
    config:
      default:
        connectTimeout: 2000
        readTimeout: 2000
  httpclient:
    enabled: false
  okhttp:
    enabled: true
    connectTimeout: 4000
    readTimeout: 3000

通过类获取超时时间

package com.lyd.demo.feign.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
 * @author: lyd
 * @description: 配备参数
 * @Date: 2022/9/24
 */
@Data
@Component
@ConfigurationProperties(prefix = "feign.okhttp")
public class OkhttpProperties {
    private Long connectTimeout;
    private Long readTimeout;
}

拦截器

可以在拦截器中配备事务需求的代码。

package com.lyd.demo.feign.config;
import lombok.extern.slf4j.Slf4j;
import okhttp3.Interceptor;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.ResponseBody;
import java.io.IOException;
/**
 * @author: lyd
 * @description: 拦截器
 * @Date: 2022/9/24
 */
@Slf4j
public class OkHttpLogInterceptor implements Interceptor {
    @Override
    public Response intercept(Interceptor.Chain chain) throws IOException {
        //这个chain里面包含了request和response，所以你要什么都可以从这儿拿
        Request request = chain.request();
        long t1 = System.nanoTime();//央求建议的时间
        log.info(String.format("发送央求 %s on %s%n%s",
                request.url(), chain.connection(), request.headers()));
        Response response = chain.proceed(request);
        long t2 = System.nanoTime();//收到照应的时间
        //注意这儿不能直接运用response.body().string()的方法输出日志
        //由于response.body().string()之后，response中的流会被封闭，程序会报错，我们需求创建出一个新的response给应用层处理
        ResponseBody responseBody = response.peekBody(1024 * 1024);
        log.info(String.format("接收照应: [%s] %n回来json:【%s】 %.1fms%n%s",
                response.request().url(),
                responseBody.string(),
                (t2 - t1) / 1e6d,
                response.headers()));
        return response;
    }
}

引进配备

@FeignClient(name = "service-store", path = "/api/store", configuration = FeignOkhttpConfig.class)

工作效果：

创作不易，或许有些言语不是很晓畅，如有过错请纠正，感谢观看！记得点赞哦！

【微服务】- 服务调用 – OpenFeign

服务调用 – OpenFeign

介绍

怎么完成接口调用？

SpringCloud整合OpenFeign

引进依托

编写调用接口

OpenFeign自定义配备

日志配备

1)、定义配备类

2)、配备文件设置等级

3)、配备域

配备超时时间

重试机制配备

Feign运用优化

导入依托

设置配备类

yml配备

拦截器

引进配备

作者信息

【微服务】- 服务调用 – OpenFeign

服务调用 – OpenFeign

介绍

怎么完成接口调用？

SpringCloud整合OpenFeign

引进依托

编写调用接口

OpenFeign自定义配备

日志配备

1)、定义配备类

2)、配备文件设置等级

3)、配备域

配备超时时间

重试机制配备

Feign运用优化

导入依托

设置配备类

yml配备

拦截器

引进配备

相关文章

整合银行APP的几点想法

教你用Python快速替换iOS项目应用图标

昨晚 Chrome 浏览器停用了 The Great Suspender 插件

使用chatGPT自动回复抖音评论

作者信息