3-SpringCloudAlibaba整合OpenFeign

OpenFeign是一个用于简化HTTP客户端的开源框架，它是Spring Cloud生态系统的一部分。它的主要作用是简化在使用HTTP请求时编写客户端代码的过程，特别是在构建微服务架构中的服务之间进行通信时。
OpenFeign提供了一种声明式的方式来定义和使用HTTP客户端接口。通过使用注解来描述HTTP请求的细节，开发人员可以将HTTP请求方法映射到Java接口的方法上。这样一来，在进行服务调用时，开发人员不再需要手动编写HTTP请求代码，而是通过接口方法的调用来发起请求。这大大简化了HTTP客户端的使用和管理。
主要功能和作用包括：
声明式的HTTP客户端：使用注解方式定义接口的方法，将HTTP请求细节和业务逻辑解耦，提高了代码的可读性和维护性。
内置负载均衡：OpenFeign集成了Ribbon，可以通过服务名自动进行负载均衡，从而实现对服务实例的自动选择和请求分发。
支持多种HTTP请求方式：可以通过注解定义接口方法的请求方式（GET、POST、PUT等），以及请求参数、请求头等信息。
支持动态URL：可以在接口方法中使用占位符来动态构建URL，便于在不同环境下进行配置和部署。
整合Hystrix：OpenFeign可以与Hystrix进行集成，实现服务调用的容错和熔断机制。
整合Spring Cloud：作为Spring Cloud生态系统的一部分，OpenFeign与其他Spring Cloud组件（如Eureka、Zuul等）无缝集成，可以更方便地构建微服务架构。
综上所述，OpenFeign的作用是简化HTTP客户端的使用，使开发人员能够通过声明式的方式来定义和调用HTTP请求接口，同时提供了负载均衡、动态URL、熔断机制等功能，适用于构建基于微服务架构的分布式系统。

本来中间还有一章应该是要讲下怎么集成ribbon的，但是发现新版本得openfeign已经废弃了ribbon，改为了自带的LoadBalancer，这个东西使用起来也很简单，默认就是轮询的，如果需要用权重模式的话直接在nacos上改下权重就可以了
比如stock现在有两个服务

我们只需要点击详情然后进去编辑下这个权重值就可以了，值越大被请求的概率就越大
当然LoadBalancer还有很多其它负载均衡策略，但是配置起来都不难，大家有兴趣自己了解下就可以了

好了我们开始在项目中集成openfeign
首先我们还是覆盖order的pom文件

<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>com.sakura.springcloud</groupId>
        <artifactId>springcloudalibaba</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <artifactId>order</artifactId>
    <packaging>jar</packaging>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- nacos服务注册发现 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <!-- loadbalancer启动器 新版本的springcloud去掉了ribbon自带的负载均衡器 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>

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

    </dependencies>
</project>

然后我们在order的application.yml文件中加入相关配置

server:
  port: 8010

spring:
  application:
    name: order-service
  cloud:
    # loadbalancer只是为了后面的测试，没有啥用可以不要
    loadbalancer:
      nacos:
        enabled: true
    nacos:
      server-addr: 192.168.43.128:8848
      discovery:
        username: nacos
        password: nacos
        namespace: public

logging:
  level:
    com.sakura.order.feign: debug # 这里我们可以单独配置feign的日志级别

feign:
  client:
    config:
      product-service:
        logger-level: basic
        connect-timeout: 5000 # 连接超时时间，默认2s
        read-timeout: 6000 #请求处理超时时间，默认5s
        request-interceptors:
          - com.sakura.order.interceptor.feign.CustomFeignInterceptor # 开启自定义拦截器

可以看到里面开启了日志，还可以设置一些超时时间之类的，然后还可以定义拦截器
所以我们把这些代码加上
现在这个order服务结构是下面这样的

我们一个个文件来
FeignConfig 这个没啥说的，配置全局feign日志等级

package com.sakura.order.config;

import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author Sakura
 * @date 2023/7/20 15:30
 */
@Configuration
public class FeignConfig {

    // 配置feign的日志等级，默认是不打印日志的，这里我们设置成最高级别full
    @Bean
    public Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

然后OrderController里面调用了两个feign服务，RestTemplate已经可以不要了

package com.sakura.order.controller;

import com.sakura.order.feign.ProductFeignService;
import com.sakura.order.feign.StockFeignService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Sakura
 * @date 2023/7/19 11:25
 */
@RestController
@RequestMapping("/order")
public class OrderController {

    @Autowired
    StockFeignService stockFeignService;
    @Autowired
    ProductFeignService productFeignService;

    @RequestMapping("/add")
    public String add(){
        System.out.println("下单成功");
        String msg = stockFeignService.reduct();
        String productMsg = productFeignService.get(1);
        return "下单成功" + msg + "-" + productMsg;
    }

}

要主要的就是feign接口的参数要和对应controller接口一致，最好就是直接复制过来
对应的ProductFeignService

package com.sakura.order.feign;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @description: stock服务接口
 * @author: Sakura
 * @date: 2023/7/20 14:38
 */
@FeignClient(name = "product-service", path = "/product")
public interface ProductFeignService {

    @RequestMapping("/get/{id}")
    public String get(@PathVariable("id") Integer id);
}

然后StockFeignService

package com.sakura.order.feign;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @description: stock服务接口
 * @author: Sakura
 * @date: 2023/7/20 14:38
 */
@FeignClient(name = "stock-service", path = "/stock")
public interface StockFeignService {

    @RequestMapping("/reduct")
    public String reduct();
}

feign的自定义拦截器，在这里我把浏览器输入id从1改成了5

package com.sakura.order.interceptor.feign;

import feign.RequestInterceptor;
import feign.RequestTemplate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @author Sakura
 * @date 2023/7/20 17:24
 */
public class CustomFeignInterceptor implements RequestInterceptor {
    Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public void apply(RequestTemplate requestTemplate) {
        logger.info("进入feign自定义拦截器");
        // 我们可以在这里记录日志或者添加参数以及修改参数等
        requestTemplate.header("123", "123");
        requestTemplate.query("456", "456");
        // 我们把参数从1改成5
        requestTemplate.uri("/get/5");
    }
}

OrderApplication里面加了个@EnableFeignClients

package com.sakura.order;

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

/**
 * @author Sakura
 * @date 2023/7/19 11:43
 */
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {

    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }

}

这里我加入了一个新的product服务，创建方式和之前一样

ProductController里面就一个测试接口，这里加了个Thread.sleep(4000)是为了测试超时连接

package com.sakura.stock.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Sakura
 * @date 2023/7/19 11:35
 */
@RestController
@RequestMapping("/product")
public class ProductController {

    @Value("${server.port}")
    String port;

    @RequestMapping("/get/{id}")
    public String get(@PathVariable("id") Integer id) throws Exception {
        System.out.println("查询商品信息" + id);
        Thread.sleep(4000);
        return "查询商品信息" + id + "-" + port;
    }

}

然后对应的ProductApplication

package com.sakura.stock;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author Sakura
 * @date 2023/7/19 11:43
 */
@SpringBootApplication
public class ProductApplication {

    public static void main(String[] args) {
        SpringApplication.run(ProductApplication.class, args);
    }

}

再就是配置文件application.yml，注意application.name，一般新模块复制粘贴这些容易忘记改

server:
  port: 8030

spring:
  application:
    name: product-service
  cloud:
    nacos:
      server-addr: 192.168.43.128:8848
      discovery:
        username: nacos
        password: nacos
        namespace: public

最后就是pom

<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>com.sakura.springcloud</groupId>
        <artifactId>springcloudalibaba</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <artifactId>product</artifactId>
    <packaging>jar</packaging>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- nacos服务注册发现 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
    </dependencies>
</project>

最后stock这边我就改了一下端口，方便后面开多个服务好区分，不至于混乱，也是前期没注意的地方
order服务8010开始
stock服务8020开始
product服务8030开始

然后启动这几个服务
我们还是在浏览器输入：http://localhost:8010/order/add

然后我们可以看一下order的日志

想测试超时的话把这里改成3000，因为我在product那个接口睡了4秒，所以会报错

因为openfeign已经集成了LoadBalancer，所以这里的请求是已经带有负载均衡效果了，你可以多开些服务多点几次
到这里微服务之间的调用就完成了，我们可以直接通过服务名称来调用，其它的都交给nacos根据服务名称区分就可以了

有需要代码的自取（https://github.com/PX1206/SpringCloudAlibaba）

移步到下一章 4-SpringCloudAlibaba整合Nacos配置中心