OpenFeign指定url方式調(diào)用的方式詳解

更新時(shí)間：2024年11月08日 10:38:37 作者：morris131

OpenFeign一般是結(jié)合注冊(cè)中心一起使用的,也就是可以通過(guò)提供服務(wù)的名稱而不是url來(lái)完成對(duì)目標(biāo)服務(wù)的訪問(wèn),本篇我們就講解一下OpenFeign直接通過(guò)目標(biāo)服務(wù)的url進(jìn)行調(diào)用的方式,需要的朋友可以參考下

引言

OpenFeign一般是結(jié)合注冊(cè)中心一起使用的，也就是可以通過(guò)提供服務(wù)的名稱而不是url來(lái)完成對(duì)目標(biāo)服務(wù)的訪問(wèn)。但是出于本地調(diào)試的需要，或者考慮到一些簡(jiǎn)單的服務(wù)可能并不需要依賴注冊(cè)中心，所以本篇我們就講解一下OpenFeign直接通過(guò)目標(biāo)服務(wù)的url進(jìn)行調(diào)用的方式。

FeignClient注解配置URL

在@FeignClient注解的url屬性中寫一個(gè)固定的調(diào)用地址：

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);

}

或者寫一個(gè)可配置的地址，這樣可以在配置文件里指定，可以根據(jù)不同的環(huán)境配置不同的URL，這種方式在創(chuàng)建feign客戶端的時(shí)候就需要規(guī)劃好：

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

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

}

實(shí)現(xiàn)RequestInterceptor接口？

實(shí)現(xiàn)RequestInterceptor接口在發(fā)起HTTP請(qǐng)求之前將注冊(cè)中心調(diào)用方式修改為url方式調(diào)用。

在@FeignClient注解中指定configuration屬性，這里并沒(méi)有指定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類中注入了一個(gè)RequestInterceptor類來(lái)攔截OrderUrlClient2中的請(qǐng)求，這里只會(huì)攔截OrderUrlClient2類中的請(qǐng)求：

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類中將請(qǐng)求的地址修改為具體的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
    }
}

發(fā)起請(qǐng)求后拋出如下異常：

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]

可以發(fā)現(xiàn)Feign還是會(huì)去注冊(cè)中心尋找服務(wù)，這是為什么呢？

通過(guò)閱讀FeignClientFactoryBean源碼發(fā)現(xiàn)：

<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));
}

當(dāng)@FeignClient中的url屬性不存在時(shí)，底層的Client使用的是FeignBlockingLoadBalancerClient，這個(gè)Client會(huì)根據(jù)serviceId去注冊(cè)中心查詢服務(wù)，并進(jìn)行負(fù)載均衡，雖然FeignUrlRequestInterceptor修改了url地址，但是Client會(huì)根據(jù)修改后的serviceId，也就是FeignUrlRequestInterceptor只能修改serviceId，不能改變調(diào)用方式。

當(dāng)@FeignClient中的url屬性存在時(shí)，底層的Client使用的是FeignBlockingLoadBalancerClient.getDelegate()，也就是ApacheHttpClient，這個(gè)client就不會(huì)去注冊(cè)中心查詢服務(wù)了，直接發(fā)起接口的調(diào)用。

自定義FeignBlockingLoadBalancerClient

自定義一個(gè)FeignBlockingLoadBalancerClient來(lái)改寫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類中注入了一個(gè)OrderUrlClient3Client類來(lái)攔截OrderUrlClient3中的請(qǐng)求，這里只會(huì)攔截OrderUrlClient3類中的請(qǐng)求，如果要實(shí)現(xiàn)全局的攔截，可以在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的擴(kuò)展，給@FeignClient對(duì)應(yīng)的Bean對(duì)象FeignClientFactoryBean加上url屬性，這樣在容器啟動(dòng)過(guò)程中就加上了url屬性，feign創(chuàng)建的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，放開(kāi)就是全局
                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跳過(guò)
                        continue;
                    }
                }
            }

            // 相當(dāng)于給@FeignClinet注解加上url屬性
            beanDefinition.getPropertyValues().addPropertyValue("url", "http://localhost:8020");
        }
    }
}

到此這篇關(guān)于OpenFeign指定url方式調(diào)用的方式詳解的文章就介紹到這了,更多相關(guān)OpenFeign指定url調(diào)用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: