声明式服务调用组件OpenFeign

Feign是一个声明式的模板化的Http客户端，其作用与RestTemplate类似，能够使用HTTP请求访问远程服务。可以理解为RestTemplate的一种简化方案。Open Feign是Spring Cloud 基于Netflix Feign的基础上开发的声明式服务调用组件，支持Spring MVC注解，可以像Spring Web一样使用HttpMessageConverters等。

简单使用

在项目中添加新模块openfeign，选择以下依赖

项目创建

修改配置文件application.properties，将服务注册到Eureka

spring.application.name=openfeign
server.port=4000
eureka.client.service-url.defaultZone=http://localhost:1111/eureka

在启动类添加@EnableFeignClients注解，开启Feign的支持

定义HelloService接口，使用OpenFeign：

@FeignClient("provider")
public interface HelloService {
    @GetMapping("/hello")
    String hello();
}

最后在HelloController中调用HelloService进行测试，provider和OpenFeign都注册到Eureka上之后就可以通过OpenFeign调用provider中的方法了。

参数传递

OpenFeign参数传递特点：

1.参数一定要绑定参数名。

2.如果通过header传参数，一定要中文转码。

在provider中提供服务接口，在OpenFeign中添加调用

在HelloService中添加调用接口，凡是KeyValue类型的参数一定要记得绑定参数名称

@FeignClient("provider")
public interface HelloService {
    @GetMapping("/hello")
    String hello();

    @GetMapping("/hello2")
    String hello2(@RequestParam("name") String name);

    @PostMapping("/user2")
    User addUser(@RequestBody User user);

    @DeleteMapping("/user2/{id}")
    void deleteUserById(@PathVariable("id") Integer id);

    @GetMapping("/user3")
    void getUserByName(@RequestHeader("name") String name);
}

在controller中添加测试接口，放在header中的参数一定要编码之后再传递

 @GetMapping("/hello")
    public String hello() throws UnsupportedEncodingException {
        String s = helloService.hello2("openfeign");
        System.out.println(s);
        User user = new User();
        user.setId(1);
        user.setUsername("zby");
        user.setPassword("123");
        User u  = helloService.addUser(user);
        System.out.println(u);
        helloService.deleteUserById(1);
        helloService.getUserByName(URLEncoder.encode("莱昂纳多","UTF-8"));
        return helloService.hello();
    }

继承特性

在使用声明式feign客户端工具的时候，因为书写的方式代码可能会产生重复。可以将provider和OpenFeign中的公共部分提取出来，一起使用减少代码。

新建一个Model，hello-api，由于这个模块需要被其他模块所依赖，所以新建一个Maven项目(Spring Boot项目依赖比较麻烦)，这个模块也需要使用Spring MVC中的内容，因此创建成功后在项目中添加web依赖。


    org.springframework.boot
    spring-boot-starter-web
    2.2.5.RELEASE


    com.example
    commons
    1.0-SNAPSHOT

然后定义公共接口，也就是provider和OpenFeign中的公共模块

public interface IUserService {
    @GetMapping("/hello")
    String hello();

    @GetMapping("/hello2")
    String hello2(@RequestParam("name") String name);

    @PostMapping("/user2")
    User addUser(@RequestBody User user);

    @DeleteMapping("/user2/{id}")
    void deleteUserById(@PathVariable("id") Integer id);

    @GetMapping("/user3")
    void getUserByName(@RequestHeader("name") String name);
}

定义完成后在provider和OpenFeign中添加该模块的依赖


    com.example
    hello-api
    1.0-SNAPSHOT

添加成功后在provider中实现这些接口，由于公共模块中已经定义了接口地址，所以实现接口方法时可以不用再添加请求注释直接重写接口中的方法即可。

    @Override
    public String hello(){
        return "hello cloud"+port;
    }

    @Override
    public String hello2(String name){
        System.out.println(new Date()+">>>"+name);
        return "hello "+name;
    }
    
      @Override
    public User addUser2(@RequestBody User user){
        return user;
    }
    
      @Override
    public void deleteUser2(@PathVariable Integer id){
        System.out.println(id);
    }

    @Override
    public void getUserByName(@RequestHeader String name) throws UnsupportedEncodingException {
        System.out.println(URLDecoder.decode(name,"UTF-8"));
    }

在OpenFeign中定义接口，继承自公共接口

@FeignClient("provider")
public interface HelloService extends IUserService {
}

这样就可以更方便的调用接口和更改接口名称，使服务端和客户端代码统一，避免因为接口名称不对造成的错误，缺点则是提高了代码耦合度
参数传递方式在使用继承特性之后依然不变

日志

OpenFeign中可以通过配置日志查看整个请求调用的过程。日志级别分四种：

NONE：不开启日志(默认方案)
BASIC：记录请求方法、URL、响应状态码、执行时间
HEADER：在BASIC的基础上加载请求、响应头
FULL：在HEADER基础上增加body及请求元素

可以在启动类中，通过Bean来配置

    @Bean
    Logger.Level loggerLevel(){
        return Logger.Level.FULL;
    }

在配置文件中将日志级别调整至debug

logging.level.com.example.openfeign.service.HelloService=debug

之后重启OpenFeign发送请求即可看到日志。

数据压缩相关配置

#开启请求的数据压缩
feign.compression.request.enabled=true
#开启请求的响应压缩
feign.compression.response.enabled=true
#压缩的数据类型
feign.compression.request.mime-types=text/html,application/json
#压缩的数据下限(当要传输数据大于2048时进行数据压缩)
feign.compression.request.min-request-size=2048

服务降级

首先定义服务降级的方法，这个方法同样实现hello-api中的IUserService接口。使用@Component将该方法注册为一个组件，为防止请求地址重复还要再添加一个@RequestMapping注解

@Component
@RequestMapping("/fallback")//防止请求接口重复
public class HelloServiceFallback implements HelloService {
    @Override
    public String hello() {
        return "error";
    }

    @Override
    public String hello2(String name) {
        return "error2";
    }

    @Override
    public User addUser2(User user) {
        return null;
    }

    @Override
    public void deleteUser2(Integer id) {

    }

    @Override
    public void getUserByName(String name) throws UnsupportedEncodingException {

    }
}

在HelloService的@FeignClient注解中配置服务降级类

@FeignClient(value = "provider",fallback = HelloServiceFallback.class)

最后在配置文件中开启hystrix
feign.hystrix.enabled=true

这样在请求失败时会自动调用HelloServiceFallback中的方法

声明式服务调用组件OpenFeign

简单使用

参数传递

继承特性

日志

服务降级

你可能感兴趣的:(声明式服务调用组件OpenFeign)