使用OpenFeign实现服务调用

OpenFeign

OpenFeign是运行在客户端的声明式服务调用的框架，通过声明接口的方式来达到对服务的调用，表面上看起来就好像在调用本地方法一样。

OpenFeign使用方法

创建一个Springboot的Web工程，命名为feign-consumer并引入相关依赖如下

xml复制代码<!-- eureka客户端依赖 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    <version>3.1.6</version>
</dependency>

<!-- springcloud-openfeign依赖 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
    <version>3.1.7</version>
</dependency>
           

在项目中创建一个业务接口HelloService，这个步骤即是对相关的调用进行声明，为接口指定一个@FeignClient("myservice")注解开启客户端服务调用，其中myservice表示对应的服务名

java复制代码@FeignClient("myservice")
public interface HelloService {
    @GetMapping({"/hello4"})
    String hello(@RequestParam("name") String var1);

    @GetMapping({"/hello5"})
    String hello(@RequestHeader("name") String var1, @RequestHeader("age") int var2);

    @PostMapping({"/hello6"})
    String hello(@RequestBody User var1);
}
           

需要注意的是，@RequestParam、@RequestHeader注解中的参数名不可以省略

在Controller中添加API方法，依次调用HelloService的三个方法

java复制代码@RequestMapping(value = "/consumer2",method = RequestMethod.GET)
public String helloConsumer2(){
    StringBuilder sb = new StringBuilder();
    sb.append(helloService.hello("张三")).append("\n");
    sb.append(helloService.hello("张三",18)).append("\n");
    sb.append(helloService.hello(new User("张三",18))).append("\n");
    return sb.toString();
}
           

在配置文件中设置注册中心的地址

yml复制代码server.port=9001
spring.application.name=feign-consumer
eureka.client.service-url.defaultZone=http://peer1:1111/eureka/
           

最后在启动类中添加注解开启feign客户端服务调用以及eureka客户端注解

java复制代码@EnableFeignClients
@EnableDiscoveryClient
@SpringBootApplication
public class FeignConsumerApplication {
	public static void main(String[] args) {
		SpringApplication.run(FeignConsumerApplication.class, args);
	}
}
           

启动注册中心、注册服务提供者和消费者，访问/consumer2

抛开编码问题不谈，调用成功哈哈。

完成OpenFeign服务调用的优化

通过对比消费者及服务提供者的相关代码发现，消费者HelloService声明式服务接口的代码与服务提供者Controller层的服务接口代码基本相同。为了实现代码的复用以及降低代码的耦合度，现在将这些代码独立成一个单独的模块。

首先创建一个简单的Maven项目，取名为hello-service-api。因为要使用Spring-MVC相关注解，所以导入相应的依赖

xml复制代码<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.7.0</version>
    </dependency>
</dependencies>
           

紧接着创建HelloService服务调用接口，因为使用到了User对象，所以还要创建一个User类

java复制代码@Component
public interface HelloService {
    @GetMapping("/hello4")
    String hello(@RequestParam("name") String name);

    @GetMapping("/hello5")
    String hello(@RequestHeader("name") String name,@RequestHeader("age") int age);

    @PostMapping("/hello6")
    String hello(@RequestBody User user);
}
           

java复制代码public class User {
    private String name;
    private int age;

    public User(){}
    public User(String name,int age){
        this.name = name;
        this.age = age;
    }

    /** 省略get、set、toString方法 */
}
           

需要注意的是，必须要提供构造函数，因为OpenFeign需要将JSON数据转换为对象，没有会抛异常

使用Maven工具对其进行打包后，分别对消费者及服务提供者的代码进行重构

在服务提供者的Controller中实现HelloService接口，并编写具体的实现

java复制代码@RestController
public class ClientController implements HelloService {
    @Override
    public String hello(String name) {
        return name;
    }

    @Override
    public String hello(String name, int age) {
        return name+"|"+age;
    }

    @Override
    public String hello(User user) {
        return user.getName()+"|"+user.getAge();
    }
}
           

在服务消费者的feign服务调用客户端中继承HelloService接口

java复制代码@FeignClient("myservice")
public interface HelloServiceDidi extends com.didi.service.HelloService {
}
           

最后在Controller中通过helloServiceDidi示例完成服务调用

java复制代码@RequestMapping(value = "/consumer2",method = RequestMethod.GET)
public String helloConsumer2(){
    StringBuilder sb = new StringBuilder();
    sb.append(helloServiceDidi.hello("张三")).append("\n");
    sb.append(helloServiceDidi.hello("张三",18)).append("\n");
    sb.append(helloServiceDidi.hello(new User("张三",18))).append("\n");
    return sb.toString();
}
           

测试结果如下

抛开编码问题不谈，调用成功哈哈。

以上是OpenFeign的简单入门，谢谢大家。