脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → OpenFeign指定url调用

OpenFeign指定url方式调用的方式详解

 更新时间：2024年11月08日 10:38:37   作者：morris131  
OpenFeign一般是结合注册中心一起使用的,也就是可以通过提供服务的名称而不是url来完成对目标服务的访问,本篇我们就讲解一下OpenFeign直接通过目标服务的url进行调用的方式,需要的朋友可以参考下

引言

OpenFeign一般是结合注册中心一起使用的，也就是可以通过提供服务的名称而不是url来完成对目标服务的访问。但是出于本地调试的需要，或者考虑到一些简单的服务可能并不需要依赖注册中心，所以本篇我们就讲解一下OpenFeign直接通过目标服务的url进行调用的方式。

FeignClient注解配置URL

在@FeignClient注解的url属性中写一个固定的调用地址：

package com.morris.user.client;

import com.morris.user.entity.Order;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.List;

/**
 * 指定url属性
 */
@FeignClient(value = "order-service", url = "http://localhost:8020", path = "/order", contextId = "orderUrl")
public interface OrderUrlClient {

    @GetMapping("findOrderByUserId")
    List<Order> findOrderByUserId(@RequestParam("userId") Long userId);

}

或者写一个可配置的地址，这样可以在配置文件里指定，可以根据不同的环境配置不同的URL，这种方式在创建feign客户端的时候就需要规划好：

@FeignClient(value = "order-service", url = "${customer.url}", path = "/order", contextId = "orderUrl")
public interface OrderUrlClient {

    @GetMapping("findOrderByUserId")
    List<Order> findOrderByUserId(@RequestParam("userId") Long userId);

}

实现RequestInterceptor接口？

实现RequestInterceptor接口在发起HTTP请求之前将注册中心调用方式修改为url方式调用。

在@FeignClient注解中指定configuration属性，这里并没有指定url属性：

package com.morris.user.client;

import com.morris.user.config.FeignUrlConfig;
import com.morris.user.entity.Order;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.List;

@FeignClient(value = "order-service", path = "/order", contextId = "orderUrl2", configuration = FeignUrlConfig.class)
public interface OrderUrlClient2 {

    @GetMapping("findOrderByUserId")
    List<Order> findOrderByUserId(@RequestParam("userId") Long userId);

}

FeignUrlConfig类中注入了一个RequestInterceptor类来拦截OrderUrlClient2中的请求，这里只会拦截OrderUrlClient2类中的请求：

package com.morris.user.config;

import feign.Logger;
import feign.Request;
import org.springframework.context.annotation.Bean;

public class FeignUrlConfig {

    @Bean
    public Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }

    @Bean
    public FeignUrlRequestInterceptor feignTraceRequestInterceptor() {
        return new FeignUrlRequestInterceptor();
    }
}

FeignUrlRequestInterceptor类中将请求的地址修改为具体的url，而不是之前的serviceId。

package com.morris.user.config;

import feign.RequestInterceptor;
import feign.RequestTemplate;

public class FeignUrlRequestInterceptor implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate template) {
        System.out.println("old: " + template.url()); // /findOrderByUserId?userId=1
        template.target("http://localhost:8020/order");
        System.out.println("new: " + template.url()); // http://localhost:8020/order/findOrderByUserId?userId=1
    }
}

发起请求后抛出如下异常：

java.lang.RuntimeException: Load balancer does not contain an instance for the service localhost
	at com.morris.user.config.FeignErrorDecoder.decode(FeignErrorDecoder.java:24) ~[classes/:na]

可以发现Feign还是会去注册中心寻找服务，这是为什么呢？

通过阅读FeignClientFactoryBean源码发现：

<T> T getTarget() {
  FeignContext context = applicationContext.getBean(FeignContext.class);
  Feign.Builder builder = feign(context);

  if (!StringUtils.hasText(url)) {
    if (!name.startsWith("http")) {
      url = "http://" + name;
    }
    else {
      url = name;
    }
    url += cleanPath();
    // url不存在
    return (T) loadBalance(builder, context,
        new HardCodedTarget<>(type, name, url));
  }
  if (StringUtils.hasText(url) && !url.startsWith("http")) {
    url = "http://" + url;
  }
  String url = this.url + cleanPath();
  Client client = getOptional(context, Client.class);
  if (client != null) {
    if (client instanceof LoadBalancerFeignClient) {
      // not load balancing because we have a url,
      // but ribbon is on the classpath, so unwrap
      client = ((LoadBalancerFeignClient) client).getDelegate();
    }
    if (client instanceof FeignBlockingLoadBalancerClient) {
      // not load balancing because we have a url,
      // but Spring Cloud LoadBalancer is on the classpath, so unwrap
      // url不存在
      client = ((FeignBlockingLoadBalancerClient) client).getDelegate();
    }
    builder.client(client);
  }
  Targeter targeter = get(context, Targeter.class);
  return (T) targeter.target(this, builder, context,
      new HardCodedTarget<>(type, name, url));
}

当@FeignClient中的url属性不存在时，底层的Client使用的是FeignBlockingLoadBalancerClient，这个Client会根据serviceId去注册中心查询服务，并进行负载均衡，虽然FeignUrlRequestInterceptor修改了url地址，但是Client会根据修改后的serviceId，也就是FeignUrlRequestInterceptor只能修改serviceId，不能改变调用方式。

当@FeignClient中的url属性存在时，底层的Client使用的是FeignBlockingLoadBalancerClient.getDelegate()，也就是ApacheHttpClient，这个client就不会去注册中心查询服务了，直接发起接口的调用。

自定义FeignBlockingLoadBalancerClient

自定义一个FeignBlockingLoadBalancerClient来改写url：

@FeignClient注解中指定configuration属性：

package com.morris.user.client;

import com.morris.user.config.OrderUrlClient3Config;
import com.morris.user.entity.Order;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.List;

@FeignClient(value = "order-service", path = "/order", contextId = "orderUrl3", configuration = OrderUrlClient3Config.class)
public interface OrderUrlClient3 {

    @GetMapping("findOrderByUserId")
    List<Order> findOrderByUserId(@RequestParam("userId") Long userId);

}

OrderUrlClient3Config类中注入了一个OrderUrlClient3Client类来拦截OrderUrlClient3中的请求，这里只会拦截OrderUrlClient3类中的请求，如果要实现全局的拦截，可以在OrderUrlClient3Config类上加@Configuration注解：

package com.morris.user.config;

import feign.Client;
import feign.Logger;
import org.springframework.context.annotation.Bean;

public class OrderUrlClient3Config {

    @Bean
    public Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }

    @Bean
    public OrderUrlClient3Client orderUrlClient3Client() {
        return new OrderUrlClient3Client(new Client.Default(null, null), null);
    }
}

OrderUrlClient3Client类继承了FeignBlockingLoadBalancerClient，重写了execute()方法：

package com.morris.user.config;

import feign.Client;
import feign.Request;
import feign.Response;
import org.springframework.cloud.loadbalancer.blocking.client.BlockingLoadBalancerClient;
import org.springframework.cloud.openfeign.loadbalancer.FeignBlockingLoadBalancerClient;
import org.springframework.web.util.UriComponentsBuilder;

import java.io.IOException;
import java.net.URI;

public class OrderUrlClient3Client extends FeignBlockingLoadBalancerClient {

    private final Client delegate;

    public OrderUrlClient3Client(Client delegate, BlockingLoadBalancerClient loadBalancerClient) {
        super(delegate, loadBalancerClient);
        this.delegate = delegate;
    }

    @Override
    public Response execute(Request request, Request.Options options) throws IOException {
        final URI originalUri = URI.create(request.url());
        // 修改url
        URI newUri = UriComponentsBuilder.fromUri(originalUri).host("localhost").port(8020)
                .build().toUri();
        Request newRequest = Request.create(request.httpMethod(), newUri.toString(),
                request.headers(), request.body(), request.charset(),
                request.requestTemplate());
        return delegate.execute(newRequest, options);
    }
}

BeanFactoryPostProcessor修改bean的url属性

这里可以使用Spring的扩展，给@FeignClient对应的Bean对象FeignClientFactoryBean加上url属性，这样在容器启动过程中就加上了url属性，feign创建的client为ApacheHttpClient，而不是FeignBlockingLoadBalancerClient

package com.morris.user.config;

import org.apache.commons.lang.StringUtils;
import org.springframework.beans.BeansException;
import org.springframework.beans.PropertyValue;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.stereotype.Component;

import java.util.Objects;

@Component
public class OrderUrl4BeanFactoryPostProcessor implements BeanFactoryPostProcessor {
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        if(!(beanFactory instanceof DefaultListableBeanFactory)) {
            return;
        }

        DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) beanFactory;

        String[] bdNames = defaultListableBeanFactory.getBeanDefinitionNames();
        for (String bdName : bdNames) {
            BeanDefinition beanDefinition = defaultListableBeanFactory.getBeanDefinition(bdName);

            if (!Objects.equals("org.springframework.cloud.openfeign.FeignClientFactoryBean", beanDefinition.getBeanClassName())) {
                continue;
            }

            if(!bdName.equals("com.morris.user.client.OrderUrlClient4")) {
                // 这里只拦截OrderUrlClient4，放开就是全局
                continue;
            }

            PropertyValue urlPv = beanDefinition.getPropertyValues().getPropertyValue("url");
            if (Objects.nonNull(urlPv)) {
                Object value = urlPv.getValue();
                if (value instanceof String) {
                    String url = (String) value;
                    if (StringUtils.isNotBlank(url)) {
                        // 已指定url跳过
                        continue;
                    }
                }
            }

            // 相当于给@FeignClinet注解加上url属性
            beanDefinition.getPropertyValues().addPropertyValue("url", "http://localhost:8020");
        }
    }
}

到此这篇关于OpenFeign指定url方式调用的方式详解的文章就介绍到这了,更多相关OpenFeign指定url调用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • 基于jstree使用JSON数据组装成树

    基于jstree使用JSON数据组装成树

    这篇文章主要为大家详细介绍了基于jstree使用JSON数据组装成树，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-08-08
  • java application maven项目打自定义zip包实例(推荐)

    java application maven项目打自定义zip包实例(推荐)

    下面小编就为大家带来一篇java application maven项目打自定义zip包实例(推荐)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • 详解Java MyBatis 插入数据库返回主键

    详解Java MyBatis 插入数据库返回主键

    这篇文章主要介绍了详解Java MyBatis 插入数据库返回主键，有兴趣的可以了解一下。
    2017-01-01
  • Java面向对象的封装你了解吗

    Java面向对象的封装你了解吗

    这篇文章主要为大家详细介绍了Java面向对象的封装，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助
    2022-03-03
  • Spring Bean如何实现自动配置代码实例

    Spring Bean如何实现自动配置代码实例

    这篇文章主要介绍了Spring Bean如何实现自动配置代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09
  • springboot如何实现自动装配源码解读

    springboot如何实现自动装配源码解读

    这篇文章主要介绍了springboot如何实现自动装配源码赏析,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2020-12-12
  • Java业务中台确保数据一致性的解决方案

    Java业务中台确保数据一致性的解决方案

    数据一致性通常指关联数据之间的逻辑关系是否正确和完整。而数据存储的一致性模型则可以认为是存储系统和数据使用者之间的一种约定。如果使用者遵循这种约定，则可以得到系统所承诺的访问结果
    2021-10-10
  • 解决gateway报netty堆外内存溢出io.netty.util.internal.OutOfDirectMemoryError

    解决gateway报netty堆外内存溢出io.netty.util.internal.OutOfDirectMemor

    这篇文章主要介绍了解决gateway报netty堆外内存溢出io.netty.util.internal.OutOfDirectMemoryError,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • Springboot配置AOP的注解切点失效解决方案

    Springboot配置AOP的注解切点失效解决方案

    本文探讨了在Spring框架中使用AOP拦截静态方法调用的实现细节,重点在于ApplicationContext和ApplicationContextAware接口的使用差异,通过对比两种获取Bean的方式,最终解决了切点无法被拦截的问题
    2026-06-06
  • 在Java中按值调用和按引用调用

    在Java中按值调用和按引用调用

    这篇文章主要介绍了Java中的按值调用和按引用调用，一种是按值调用，另一种是按引用调用，这两种方式通常根据作为输入或参数传递给它们的值的类型来区分，下文相关的更多详细资料感兴趣的小伙伴可以参考一下
    2022-04-04

最新评论