SpringCloud 中feign在服务间传递header

本文介绍: 在上述示例中，通过自定义的He a de rIn t e rce p t or拦截器类，在请求发出之前添加了名为“headerNa m e“，值为“headerValue“的header。最后，在MyServ ic e中调用MyFe i g nClie n t的getSomeData 方法，Fei g n会自动将指定的header 传递到服务端。总结起来，使用Fei g n 传递 header的方法有两种：通过自定义拦截器来添加 header，或者通过@Reque stHeader注解来手动指定需要传递的header。根据具体需求和场景选择适合的方式。

在Spr in g Cloud中，Fei g n是一个声明式的HTTP客户端工具，用于简化服务之间的通信。在使用Fei g n时，可以通过配置来传递 header。要在服务间传递header，可以使用Feign的拦截器机制。拦截器可以在请求发出之前或者响应返回之后对请求和响应进行处理。通过自定义一个拦截器，我们可以在请求中添加header。首先，创建一个实现Feign的Reque stInterce p t or接口的拦截器类，例如：

javaCopy codeimport feign.RequestInterceptor;
import feign.RequestTemplate;
public class HeaderInterceptor implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate template) {
        // 在这里添加header
        template.header("headerName", "headerValue");
    }
}

然后，在使用Feign的接口上加上@FeignClient注解，并通过configuration 属性来指定使用的拦截器类，例如：

javaCopy code@FeignClient(name = "service", configuration = HeaderInterceptor.class)
public interface MyFeignClient {
    // 定义接口方法
}

这样，通过配置HeaderInterc eptor拦截器，Feign在向服务发起请求时会自动将指定的header传递到服务端。注意：以上代码仅为示例，实际使用中需要根据具体需求进行调整。另外，还可以通过使用Feign的注解@Reque stHeader来手动指定需要传递的header。例如：

javaCopy code@FeignClient(name = "service")
public interface MyFeignClient {
    @GetMapping("/api/someEndpoint")
    String getSomeData(@RequestHeader("headerName") String headerValue);
}

在使用Feign调用getSomeData 方法时，会自动将headerName和对应的headerValue传递给服务端。总结起来，使用Feign传递header的方法有两种：通过自定义拦截器来添加header，或者通过@RequestHeader注解来手动指定需要传递的header。根据具体需求和场景选择适合的方式。

以下是一个完整的示例代码，展示了如何在Spr ing Cloud中使用Feign传递header：

javaCopy codeimport feign.RequestInterceptor;
import feign.RequestTemplate;
public class HeaderInterceptor implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate template) {
        // 在这里添加header
        template.header("headerName", "headerValue");
    }
}

javaCopy codeimport org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestHeader;
@FeignClient(name = "service", configuration = HeaderInterceptor.class)
public interface MyFeignClient {
    @GetMapping("/api/someEndpoint")
    String getSomeData(@RequestHeader("headerName") String headerValue);
}

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

javaCopy codeimport org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class MyService {
    private final MyFeignClient myFeignClient;
    @Autowired
    public MyService(MyFeignClient myFeignClient) {
        this.myFeignClient = myFeignClient;
    }
    public String callSomeEndpoint() {
        String headerValue = "headerValue";
        return myFeignClient.getSomeData(headerValue);
    }
}

在上述示例中，通过自定义的HeaderInterceptor拦截器类，在请求发出之前添加了名为“headerName”，值为“headerValue”的header。然后在MyFeignClient接口的getSomeData方法上使用@RequestHeader注解来指定需要传递的header。最后，在MyService中调用MyFeignClient的getSomeData方法，Feign会自动将指定的header传递到服务端。注意：上述代码仅为示例，实际使用中需要根据具体需求进行调整。

javaCopy code@FeignClient(name = "example-service")
public interface ExampleFeignClient {
    
    @GetMapping("/example")
    String getExample(@RequestHeader("Authorization") String token);
}

javaCopy codepublic class CustomRequestInterceptor implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate template) {
        String token = // 获取token的逻辑
        template.header("Authorization", token);
    }
}

yamlCopy codefeign:
  client:
    config:
      default:
        requestInterceptors:
          - com.example.CustomRequestInterceptor

上述配置将自定义的RequestInterceptor添加到了所有的Feign客户端中。其次，我们需要启用Feign的Header传递功能。在启动类上添加@EnableFeignClients注解，并设置defaultConfiguration属性为我们自定义的配置类，例如：

javaCopy code@SpringBootApplication
@EnableFeignClients(defaultConfiguration = CustomFeignConfiguration.class)
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}