feignclient,参数传body,应该怎么写

在Feign Client中传递请求体(body)参数,主要有以下几种方式:

1. 基本使用方式

1.1 使用 @RequestBody注解

复制代码
@FeignClient(name = "service-name", url = "${service.url}")
public interface MyFeignClient {
    
    @PostMapping("/api/user")
    UserDTO createUser(@RequestBody UserRequest request);
}

1.2 完整示例

复制代码
// 请求体对象
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserRequest {
    private String username;
    private String email;
    private Integer age;
    private List<String> roles;
}

// 响应体对象
@Data
public class UserDTO {
    private Long id;
    private String username;
    private String email;
}

// Feign Client
@FeignClient(name = "user-service", url = "http://localhost:8080")
public interface UserFeignClient {
    
    @PostMapping("/users")
    UserDTO createUser(@RequestBody UserRequest request);
    
    @PutMapping("/users/{id}")
    UserDTO updateUser(@PathVariable("id") Long id, @RequestBody UserRequest request);
    
    @PatchMapping("/users/{id}")
    UserDTO partialUpdateUser(@PathVariable("id") Long id, @RequestBody Map<String, Object> updates);
}

2. 多种参数类型传递

2.1 Map类型参数

复制代码
@FeignClient(name = "dynamic-service")
public interface DynamicFeignClient {
    
    @PostMapping("/api/data")
    String postData(@RequestBody Map<String, Object> data);
    
    @PostMapping("/api/search")
    SearchResult search(@RequestBody SearchCriteria criteria, 
                       @RequestParam("page") int page,
                       @RequestParam("size") int size);
}

2.2 List类型参数

复制代码
@FeignClient(name = "batch-service")
public interface BatchFeignClient {
    
    @PostMapping("/api/batch")
    BatchResult processBatch(@RequestBody List<BatchItem> items);
}

3. 复杂请求示例

3.1 包含请求头的复杂请求

复制代码
@FeignClient(name = "auth-service")
public interface AuthFeignClient {
    
    @PostMapping(value = "/oauth/token", 
                 consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE)
    TokenResponse getToken(@RequestBody MultiValueMap<String, String> formData,
                          @RequestHeader("Authorization") String authorization);
}

3.2 文件上传

复制代码
@FeignClient(name = "file-service")
public interface FileFeignClient {
    
    @PostMapping(value = "/upload", 
                 consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
    UploadResult uploadFile(@RequestPart("file") MultipartFile file,
                           @RequestPart("metadata") @RequestBody FileMetadata metadata);
}

4. 配置类配置

4.1 自定义配置

复制代码
@Configuration
public class FeignConfig {
    
    @Bean
    public Encoder feignEncoder() {
        ObjectFactory<HttpMessageConverters> messageConverters = () -> 
            new HttpMessageConverters(new MappingJackson2HttpMessageConverter());
        return new SpringEncoder(messageConverters);
    }
    
    @Bean
    public Decoder feignDecoder() {
        return new ResponseEntityDecoder(new SpringDecoder(messageConverters()));
    }
    
    @Bean
    public Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

5. 使用示例

复制代码
@Service
public class UserService {
    
    @Autowired
    private UserFeignClient userFeignClient;
    
    public UserDTO createNewUser(String username, String email) {
        UserRequest request = new UserRequest();
        request.setUsername(username);
        request.setEmail(email);
        request.setAge(25);
        request.setRoles(Arrays.asList("USER", "MEMBER"));
        
        return userFeignClient.createUser(request);
    }
    
    public String postDynamicData() {
        Map<String, Object> data = new HashMap<>();
        data.put("name", "test");
        data.put("value", 123);
        data.put("items", Arrays.asList("item1", "item2"));
        
        return userFeignClient.postData(data);
    }
}

6. 注意事项

  1. JSON序列化:默认使用Jackson,确保对象有正确的getter/setter

  2. Content-Type :默认是application/json,可通过consumes属性修改

  3. 空值处理:默认不序列化null值,可通过配置修改

  4. 编码器/解码器:可自定义处理特定类型

  5. 异常处理:建议使用ErrorDecoder处理异常

7. 常见问题解决

7.1 日期格式处理

复制代码
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date createTime;

7.2 自定义序列化

复制代码
@FeignClient(name = "service", configuration = CustomFeignConfig.class)
public interface CustomClient {
    // ...
}

7.3 启用GZIP压缩

复制代码
feign:
  compression:
    request:
      enabled: true
    response:
      enabled: true

以上是在Feign Client中传递body参数的完整写法,根据实际需求选择合适的方式。

相关推荐
小涛不学习1 小时前
手写线程池(从0实现 ThreadPoolExecutor 核心思想)
windows
twc8292 小时前
大模型生成 QA Pairs 提升 RAG 应用测试效率的实践
服务器·数据库·人工智能·windows·rag·大模型测试
wenlonglanying3 小时前
Windows安装Rust环境(详细教程)
开发语言·windows·rust
polaris06304 小时前
Windows操作系统部署Tomcat详细讲解
java·windows·tomcat
mldlds4 小时前
windows手动配置IP地址与DNS服务器以及netsh端口转发
服务器·windows·tcp/ip
取个名字太难了a5 小时前
DebugActiveProcess 调试流程分析(一)
windows
Java.熵减码农5 小时前
火绒安全软件误杀explorer.exe导致黑屏解决方法
windows
love530love5 小时前
不用聊天软件 OpenClaw 手机浏览器远程访问控制:Tailscale 配置、设备配对与常见问题全解
人工智能·windows·python·智能手机·tailscale·openclaw·远程访问控制
夏末蝉未鸣015 小时前
Windows环境下载并安装milvus
windows·milvus
葡萄星球6 小时前
win11右键菜单一步改成win10样式
windows