原创

Spring Cloud OpenFeign快速入门demo

一、应用场景

Spring Cloud OpenFeign 是一个声明式的 HTTP 客户端,旨在简化微服务之间的通信。它使得开发者能够通过简单的接口定义和注解来调用 RESTful API,极大地减少了样板代码。以下是一些典型的应用场景:

  1. 微服务间调用:在微服务架构中,服务之间需要频繁地进行 HTTP 调用,OpenFeign 提供了一种简洁的方式来实现这些调用。
  2. RESTful API 客户端:当需要与外部 RESTful API 进行交互时,OpenFeign 可以帮助快速构建客户端。
  3. 服务发现:与 Eureka 等服务发现组件结合使用时,OpenFeign 可以自动处理服务的负载均衡和故障转移。
  4. 动态配置:在需要根据不同环境或条件动态配置请求时,OpenFeign 提供了灵活的解决方案。

二、原理

Spring Cloud OpenFeign 的核心原理是利用 Java 的动态代理和注解来简化 HTTP 请求的构建。开发者只需定义接口,并使用注解描述请求的细节(如 HTTP 方法、路径、参数等),在运行时,OpenFeign 会生成实现类并处理请求。

主要组件

  1. Feign Client:定义服务接口,使用注解描述请求。
  2. Request Interceptor:用于在请求发送之前对请求进行修改(如添加 header)。
  3. Encoder/Decoder:用于请求和响应的编码和解码,支持 JSON、XML 等格式。
  4. 错误处理:提供自定义的错误处理机制,以便在请求失败时进行处理。

三、代码示例

1. 添加依赖

在 Maven 项目的 pom.xml 中添加 OpenFeign 依赖:

<?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">
    <parent>
        <artifactId>springcloud-demo</artifactId>
        <groupId>com.et</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>spring-cloud-openfeign</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
</project>

2. 启用 OpenFeign

在 Spring Boot 应用的主类上添加 @EnableFeignClients 注解:

package com.et;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableFeignClients
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

3. 定义 Feign Client

创建一个 Feign Client 接口,使用注解定义请求:

package com.et.service;

import com.et.model.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient(name = "user-service", url = "http://localhost:8088")
public interface UserServiceClient {

    @GetMapping("/user/{id}")
    User getUserById(@PathVariable("id") Long id);
}

4. 使用 Feign Client

在服务中使用 Feign Client:

package com.et.controller;

import com.et.model.User;
import com.et.service.UserService;
import jakarta.servlet.http.HttpServletRequest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/users/{id}")
    public User getUser(@PathVariable Long id) {
        return userService.getUser(id);
    }
    @GetMapping("/user/{id}")
    public User user(@PathVariable Long id, HttpServletRequest request) {
        // get username and password from header
        String userHeader = request.getHeader("user");
        String passwordHeader = request.getHeader("password");

        // print params
        System.out.println("User Header: " + userHeader);
        System.out.println("Password Header: " + passwordHeader);
        User  user =   new User();
        user.setId(id);
        user.setEmail("xxx@xx.com");
        user.setName("test");
        return user;
    }
}

四、拦截器

OpenFeign 允许你使用请求拦截器来修改请求,例如添加 header、日志记录等。以下是如何实现一个简单的请求拦截器:

1. 创建拦截器

package com.et.interceptor;

import feign.RequestInterceptor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author liuhaihua
 * @version 1.0
 * @ClassName JSONPlaceHolderInterceptor
 * @Description todo
 * @date 2024/12/23/ 14:18
 */
@Configuration
public class JSONPlaceHolderInterceptor  {
    @Value("${feign.client.config.default.username}")
    private String username;

    @Value("${feign.client.config.default.password}")
    private String password;
    @Bean
    public RequestInterceptor requestInterceptor() {
        return requestTemplate -> {
            requestTemplate.header("user", username);
            requestTemplate.header("password", password);
            requestTemplate.header("Accept", "application/json");
        };
    }
}

2. 在 Feign Client 中使用拦截器

server:
  port: 8088
feign:
  client:
    config:
      default:
        username: xxxx
        password: password
        requestInterceptors:
          com.et.interceptor.JSONPlaceHolderInterceptor

五、测试

启动Spring CLoud应用,访问http://127.0.0.1:8088/users/1,返回结果如下
{"id":1,"name":"test","email":"xxx@xx.com"}
查看控制台,发现获得拦截器设置的值
User Header: xxxx
Password Header: password

l六、总结

Spring Cloud OpenFeign 是一个强大的工具,能够简化微服务之间的 HTTP 调用。通过声明式的方式,开发者可以快速构建 RESTful 客户端,减少样板代码,提高开发效率。结合请求拦截器,OpenFeign 还可以灵活地处理请求的各种需求,如身份验证和日志记录。

在微服务架构中,使用 OpenFeign 可以有效地提高服务间的通信效率和可维护性,是构建现代分布式系统的重要组成部分。通过简单的配置和注解,开发者能够专注于业务逻辑,而不必过多关注底层的 HTTP 请求细节。

正文到此结束
Loading...