SpringBoot3.4.3基于Openfeign实现声明式http接口调用

itbeien2025年3月3日大约 7 分钟

SpringBoot3.4.3基于Openfeign实现声明式http接口调用

本专栏前一篇文章SpringBoot3.4.3基于SpringDoc2和Swagger3实现项目接口文档管理。今天分享SpringBoot3.4.3基于openfeign实现http声明式接口调用功能，通过声明简单的注解即可完成跨服务http接口调用。

完整代码在文章最后，如果觉得本篇文章对你有用，记得点赞、关注、收藏哦。你的支持是我持续更新的动力!

文章最后可以加入免费的Java&AI技术和支付系统沟通社群，一起探讨Java/你的产品如何与AI结合，请按照要求加入。在群中可以聊开发、系统设计、架构、行业趋势、AI等等话题

SpringBoot3专栏软件环境

JDK17.0.12
SpringBoot3.4.3
IDEA2024.3.3
Openfeign13.5

我们先看本篇文章对应的项目结构，请看下图

1 什么是OpenFeign

OpenFeign 是一个声明式的 Web 服务客户端，它使得编写 HTTP 客户端变得更加简单。
声明式服务调用：通过注解定义接口，简化了HTTP客户端的开发。
集成Spring Cloud：与Spring Cloud生态中的其他组件（如Eureka、Ribbon、Hystrix等）无缝集成，提供负载均衡和服务熔断等功能。
自动序列化和反序列化：支持请求参数和响应结果的自动转换，通常使用Jackson或Gson进行JSON处理。
可插拔的日志级别配置：可以根据需要配置不同级别的日志输出。

2 项目搭建

今天的代码分为两部分第一部分为OpenFeign客户端项目，用于发起http调用。另外一个服务为服务提供方，用于接收客户端的http请求并响应数据给客户端。项目都是基于SpringBoot3

2.1 pom依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>cn.itbeien</groupId>
        <artifactId>springboot3-labs-master</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>springboot-openfeign</artifactId>
    <packaging>pom</packaging>
    <modules>
        <module>springboot-openfeign-client</module>
        <module>springboot-openfeign-service</module>
    </modules>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <openfeign-version>13.5</openfeign-version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-core</artifactId>
            <version>${openfeign-version}</version>
        </dependency>
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-gson</artifactId>
            <version>${openfeign-version}</version>
        </dependency>
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-spring4</artifactId>
            <version>${openfeign-version}</version>
        </dependency>
    </dependencies>

</project>

2.2 Openfeign配置

package cn.itbeien.openfeign.config;

import cn.itbeien.openfeign.feign.ServiceFeignClient;
import feign.Feign;
import feign.gson.GsonDecoder;
import feign.gson.GsonEncoder;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author itbeien
 * 项目网站：https://www.itbeien.cn
 * 公众号：贝恩聊架构
 * 全网同名，欢迎小伙伴们关注
 * Java/AI学习社群
 * Copyright© 2025 itbeien
 */
@Configuration
public class FeignConfig {

    @Value("${api.serviceUrl}")
    private String serviceUrl;

    @Bean
    public ServiceFeignClient serviceFeignClient() {
        return Feign.builder()
                .encoder(new GsonEncoder())
                .decoder(new GsonDecoder())
                .target(ServiceFeignClient.class, serviceUrl); // 服务提供者地址
    }

}

2.3 声明式http接口

package cn.itbeien.openfeign.feign;

import cn.itbeien.openfeign.feign.vo.UserRequest;
import cn.itbeien.openfeign.feign.vo.UserResponse;
import feign.Headers;
import feign.Param;
import feign.QueryMap;
import feign.RequestLine;

import java.util.List;
import java.util.Map;

/**
 * @author itbeien
 * 项目网站：https://www.itbeien.cn
 * 公众号：贝恩聊架构
 * 全网同名，欢迎小伙伴们关注
 * Java/AI学习社群
 * Copyright© 2025 itbeien
 */
public interface ServiceFeignClient {
    // 获得用户详情
    @RequestLine("GET /api/get?id={id}")
    UserResponse get(@Param("id") Integer id);

    @RequestLine("GET /api/list?name={name}&gender={gender}")
    List<UserResponse> list(@Param("name") String name,
                            @Param("gender") Integer gender);

    @RequestLine("GET /api/list")
    List<UserResponse> list(@QueryMap Map<String, Object> queryMap);

    @RequestLine("POST /api/add")
    @Headers("Content-Type: application/json")
    Integer add(UserRequest request);
}

3 单元测试

使用Openfeign声明式接口调用该服务端接口

package cn.itbeien.openfeign.test;

import cn.itbeien.openfeign.feign.ServiceFeignClient;
import cn.itbeien.openfeign.feign.vo.UserResponse;
import cn.itbeien.openfeign.feign.vo.UserRequest;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author itbeien
 * 项目网站：https://www.itbeien.cn
 * 公众号：贝恩聊架构
 * 全网同名，欢迎小伙伴们关注
 * Java/AI学习社群
 * Copyright© 2025 itbeien
 */
@SpringBootTest
@Slf4j
public class ServiceApiTest {
    @Autowired
    private ServiceFeignClient serviceFeignClient;

    @Test
    public void  get() {
        UserResponse response = serviceFeignClient.get(3);
        log.info("response: {}", response);
    }

    @Test
    public void list() {
        List<UserResponse> responseList =  serviceFeignClient.list("itbeien", 1);
        log.info("responseList: {}", responseList);
    }

    @Test
    public void  test() {
        Map<String, Object> queryMap = new HashMap<>();
        queryMap.put("name", "itbeien");
        List<UserResponse> responspList =  serviceFeignClient.list(queryMap);
        log.info("responspList: {}", responspList);
    }

    @Test
    public void add() {
        UserRequest request =new UserRequest();
        request.setName("itbeien");
        request.setGender(2);
        Integer id = serviceFeignClient.add(request);
        log.info("id: {}", id);
    }
}