FeignClient header

在使用FeignClient进行远程调用时，可以通过添加@RequestHeader注解来设置请求头的参数。@RequestHeader注解有两个参数，分别是name和value，name表示请求头的名称，value表示请求头的值。下面是一个示例：

@FeignClient(name = "exampleClient", url = "http://example.com")
public interface ExampleClient {
    
    @GetMapping("/api/example")
    String getExample(@RequestHeader("Authorization") String token);
}

在上面的示例中，使用@RequestHeader注解设置了Authorization请求头的值为token。当调用getExample方法时，FeignClient会自动将该请求头添加到远程调用的请求中。

相关问题

test FeignClient

### 测试 FeignClient 示例代码

为了有效地测试 `@FeignClient` 定义的服务客户端，可以采用多种策略来确保其功能正常。以下是几种常见的测试方法：

#### 单元测试

单元测试通常通过模拟（mocking）依赖项来进行。对于 Feign Client 的单元测试，主要关注点在于验证请求构建是否正确以及响应处理逻辑。

@RunWith(MockitoJUnitRunner.class)
public class MyFeignClientTest {

    @Mock
    private MyFeignClient myFeignClient;

    @Test
    public void testMyMethod() {
        String expectedResponse = "Expected Response";
        
        when(myFeignClient.myMethod()).thenReturn(expectedResponse);

        assertEquals(expectedResponse, myFeignClient.myMethod());
    }
}

这种方法允许开发者专注于业务逻辑而无需实际调用外部服务[^1]。

#### 集成测试

集成测试则更进一步，在真实的网络环境中运行，但为了避免对外部系统的依赖，常使用 WireMock 或类似的工具来伪造 HTTP 响应。

##### 使用 WireMock 进行集成测试

WireMock 是一种流行的库，可用于创建独立于任何应用程序服务器的虚拟服务端口。这使得能够轻松设置预期的行为并捕获传入请求以供断言。

import com.github.tomakehurst.wiremock.WireMockServer;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.springframework.cloud.contract.wiremock.AutoConfigureWireMock;

@AutoConfigureWireMock(port = 0)
public class MyFeignClientIntegrationTests {

    private static final int WIREMOCK_PORT = 8089; // 可选配置
    private static WireMockServer wireMockServer;

    @BeforeClass
    public static void setup() {
        wireMockServer = new WireMockServer(WIREMOCK_PORT);
        wireMockServer.start();
        configureFor("localhost", WIREMOCK_PORT);
        stubFor(get(urlEqualTo("/my/endpoint"))
                .willReturn(aResponse()
                        .withStatus(200)
                        .withHeader("Content-Type", "application/json")
                        .withBody("{\"key\":\"value\"}")));
    }

    @AfterClass
    public static void teardown() {
        if (wireMockServer != null) {
            wireMockServer.stop();
        }
    }

    @Autowired
    private MyFeignClient client;

    @Test
    public void shouldReturnDefaultMessage() throws Exception {
        ResponseEntity<String> responseEntity = this.client.someApiCall();

        assertThat(responseEntity.getStatusCode(), is(HttpStatus.OK));
        assertThat(responseEntity.getBody(), containsString("\"key\":\"value\""));
    }
}

此方式不仅检验了 Feign Client 构建 URL 和解析 JSON 能力，还提供了对整个通信链路的有效覆盖[^2]。

#### Mock Server 方式

另一种替代方案是利用 Spring Cloud 提供的 `@EnableFeignClients` 注解配合自定义实现类的方式，即所谓的 mock server 方法。这种方式可以在不改变原有代码结构的前提下完成较为复杂的场景重现。

@TestPropertySource(properties = {"feign.hystrix.enabled=false"})
@EnableFeignClients(clients = MyFeignClient.class,
                   defaultConfiguration = CustomFeignConfig.class)
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyFeignClientApplicationTests {

    @LocalServerPort
    private int port;

    @BeforeEach
    void setUp() {
        RestAssured.port = port;
    }

    @Test
    void contextLoads() {}

    @RestController
    static class StubController {

        @GetMapping("/api/data")
        public Map<String,Object> getData(){
            HashMap<String,Object> map=new HashMap<>();
            map.put("name","test");
            return map;
        }
    }
}

上述例子展示了如何在一个完整的应用上下文中启动一个简单的 REST 控制器作为目标服务，并让 Feign Client 对它发起请求[^3]。

FeignClient调用如何同时在header和body传参

引用\[1\]中描述了使用FeignClient进行远程调用时，如果POST请求中有查询参数并且没有请求实体（body为空），那么查询参数会被丢失，服务提供者获取不到查询参数的值。在代码描述中，可以看到在FeignClient接口的方法中使用了@RequestParam注解来传递查询参数。然而，由于FeignClient默认使用的是POST请求，而POST请求的查询参数是通过请求体（body）传递的，所以查询参数会被丢失。

要同时在header和body传递参数，可以使用@RequestHeader注解来传递header参数，使用@RequestBody注解来传递body参数。例如，可以将B作为请求体的一部分，同时将其他参数作为请求头的一部分进行传递。

下面是一个示例代码：

@FeignClient(name = "a-service", configuration = FeignConfiguration.class)
public interface ACall {
    @RequestMapping(method = RequestMethod.POST, value = "/api/xxx/{A}", headers = {"Content-Type=application/json"})
    void updateAToB(@PathVariable("A") final String A, @RequestHeader("B") final String B, @RequestBody final Object body) throws Exception;
}

在这个示例中，使用@RequestHeader注解将B作为请求头的一部分传递，使用@RequestBody注解将其他参数作为请求体的一部分传递。

这样，就可以同时在header和body传递参数了。
#### 引用[.reference_title]
- *1* [FeignClient调用POST请求时查询参数被丢失的情况分析与处理](https://blog.csdn.net/hui008/article/details/82842720)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insertT0,239^v3^insert_chatgpt"}} ] [.reference_item]
- *2* [Java——使用@FeignClient调用远程服务](https://blog.csdn.net/wang__sepcial/article/details/122171795)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insertT0,239^v3^insert_chatgpt"}} ] [.reference_item]
- *3* [@FeignClient 调用远程服务](https://blog.csdn.net/m0_38017766/article/details/94481713)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insertT0,239^v3^insert_chatgpt"}} ] [.reference_item]
[ .reference_list ]