微服务学习之OpenFeign【Hoxton.SR1版】

目录

 

1 Feign（OpenFeign）是什么

2 Feign能干什么

3 Feign与OpenFeign的区别

4 使用

4.1 pom.xml

4.2 application.yml

4.3 启动类

4.4 业务类

5 关于日志

6 Feign超时控制

---

1 Feign（OpenFeign）是什么

官网介绍：https://cloud.spring.io/spring-cloud-openfeign/reference/html/。

Feign是一个声明式WebService客户端，使用Feign能让编写WebService客户端更加简单。

Feign的使用方法是：定义一个服务接口，并在上面添加注解。Feign可以与Eureka、Ribbon组合使用从而支持负载均衡。

两个注解：1)@EnableFeignClients 启动Feign客户端 2）@FeignClient 定义Feign客户端。

2 Feign能干什么

Feign致力于让编写Http客户端更加简单。

之前博客中使用Ribbon+RestTemplate组合，利用RestTemplate对http请求的封装处理，形成一套模板化的封装方法。

但是实际开发中，大多数时候对服务依赖的调用并不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。Feign就是在这个基础上做了进一步的封装，由它来定义并实现依赖服务接口的定义。

在Feign的实现下，开发者只需要创建一个接口并使用注解的方式进行配置，即可完成对服务提供方接口的绑定，简化了使用SpringCloud Ribbon时，自动封装服务调用调用客户端的开发量。（此前dao接口上标注Mapper注解，现在是在一个微服务接口上面标注一个Feign注解即可）

Feign集成了Ribbon。

3 Feign与OpenFeign的区别

4 使用

4.1 pom.xml

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

    <artifactId>cloud-consumer-feign-order80</artifactId>

    <dependencies>
        <!--openfeign-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

        <!-- Eureka client-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!--引入自定义的api通用包，可以使用Payment支付Entity-->
        <dependency>
            <groupId>com.bighuan.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </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-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <mainClass>com.bighuan.springcloud.OrderFeignMain80</mainClass>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

4.2 application.yml

server:
  port: 80
spring:
  application:
    name: cloud-order-service
eureka:
  instance:
    instance-id: order${server.port}   #例如：order80
    prefer-ip-address: true  # 访问路径可以显示ip地址
  client:
    # 表示是否将自己注册进Eureka Server，默认为true
    register-with-eureka: true
     # 是否从Eureka Server获取已有的注册信息，默认为true，单节点无所谓，集群必须设置为true，才能配合ribbon使用负载均衡
    fetch-registry: true
    service-url:
      # defaultZone: http://localhost:7001/eureka
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka # 集群版
ribbon:
  # 处理请求的超时时间，默认为1秒
  ReadTimeout: 5000
  # 连接建立的超时时间，默认1秒
  ConnectTimeout: 5000
logging:
  level:
    # feign日志以什么级别监控哪个接口
    #com.bighuan.springcloud.service.PaymentFeignService: debug
    com.bighuan.springcloud.service: debug

4.3 启动类

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients // 激活Feign
public class OrderFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class, args);
    }
}

4.4 业务类

接口类：

@Component
// // 设置远程服务，将一个远程服务映射为一个本地方法调用
@FeignClient(name = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {

    /**
     * 查询
     *
     * @param id
     * @return
     */
    @GetMapping(value = "/payment/get/{id}")
    CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);

    @GetMapping(value = "/payment/feign/timeout")
     String paymentFeignTimeOut();
}

控制类：

@RestController
@Slf4j
public class OrderFeignController {

    @Resource
    private PaymentFeignService paymentFeignService;


    @GetMapping(value = "/consumer/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id) {
        log.info("id:" + id);
        return paymentFeignService.getPaymentById(id);
    }

    @GetMapping(value = "/consumer/payment/feign/timeout")
    public String paymentFeignTimeOut() {
        return paymentFeignService.paymentFeignTimeOut();
    }
}

5 关于日志

Feign提供了日志打印功能，可通过配置调整日志打印级别，从而了解Feign中Http请求的细节。

配置示例：

@Configuration
public class FeignConfig {
    @Bean
    public Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

yml文件中需要进行相应的配置，已在前面的文件中贴出。

6 Feign超时控制

查看这篇文章：https://www.cnblogs.com/WaterGe/p/11687118.html