強力な提携: OpenFeign が Sentinel を統合

一緒に創造し、成長するために一緒に働きましょう！「Nuggets Daily New Plan・August Update Challenge」に参加して22日目、イベント詳細はこちら

序文

この本は次のように続きます。

マイクロサービス間のリモート インターフェイス呼び出し: OpenFeign の使用

プロジェクトで使用したOpenFeign後、リモート サービスを呼び出すのは非常に便利ですが、問題が発生しました.リモート サービスが失敗した場合、リモート インターフェイスを調整できず、返される結果を心配しています.どうすればよいですか?

もちろん、サービスの. この記事では、リモート呼び出しOpenFeignを行うために使用し、 と組み合わせてSentinel、例外や障害などの問題に対してサービスのダウングレードを実行します.

準備

以前のopen-feign-serviceサービス、nacos-providerサービスをプロバイダーとして使用してドリルを実行します。

Jar パッケージの依存関係

open-feign-serviceの導入に加えてspring-cloud-starter-openfeign、spring-cloud-starter-alibaba-sentinelコンポーネントの導入、およびここで使用nacosするSentinel現在の制限ルールを永続化するために使用されるため、 および も導入する必要がspring-cloud-alibaba-sentinel-datasourceありsentinel-datasource-nacosます。

<!-- 引入二方库 -->
<dependency>
    <groupId>cn.chendapeng.springcloud</groupId>
    <artifactId>internal-common</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

<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>

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-sentinel-datasource</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-datasource-nacos</artifactId>
</dependency>
复制代码

構成ファイル

構成ファイルapplication.yml:

spring:
  application:
    name: open-feign-service

  cloud:
    nacos:
      discovery:
        server-addr: 192.168.242.112:81
    sentinel:
      transport:
        dashboard: localhost:8080
        port: 8719
      # https://github.com/alibaba/Sentinel/issues/1213
      web-context-unify: false
      # Sentinel 规则持久化到 Nacos
      datasource:
        rule1:
          nacos:
            serverAddr: 192.168.242.112:81
            groupId: DEFAULT_GROUP
            dataId: sentinelFlowRule.json
            ruleType: flow
            
feign:
  client:
    config:
      # 默认的超时时间设置
      default:
        connectTimeout: 5000
        readTimeout: 5000
      # 在指定的 FeignClient 设置超时时间，覆盖默认的设置
      nacos-provider:
        connectTimeout: 1000
        readTimeout: 1000
        loggerLevel: full
  # 激活 Sentinel
  sentinel:
    enabled: true
复制代码

Sentinelここに のデータ永続化内容、アクティベーションOpenFeignとSentinel併用の設定を追加しますfeign.sentinel.enabled=true。

グローバルに統一された例外処理

Sentinel電流制限後の復帰もOpenFeignのfallback復帰も本質的に異常なので、ここでグローバル統一例外処理を設定します。

まず、ビジネス例外クラスを追加します。

public class BusinessException extends RuntimeException {

    private String code;

    private String message;

    public BusinessException(String code, String message) {
        this.code = code;
        this.message = message;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    @Override
    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}
复制代码

然后使用 Spring 的 @RestControllerAdvice 注解进行全局的异常进行处理：

@RestControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 业务异常，统一处理
     * @param e 异常对象
     * @return ResponseResult 全局异常响应
     */
    @ExceptionHandler(BusinessException.class)
    public ResponseResult<String> businessException(BusinessException e) {
        LOGGER.info("code={}, message={}", e.getCode(), e.getMessage());
        return ResponseResult.fail(e.getCode(), e.getMessage());
    }

    // 其他异常...
}
复制代码

这样，只要指定了抛出的异常类型，就会返回统一的响应格式。

操练

@FeignClient 的 fallback

在上一篇文章中，我们通过 FeignClient 接口调用远程的服务：

@Service
@FeignClient("nacos-provider")
public interface ProductService {

    /**
     * 调用远程服务 nacos-provider 的 product/{id} 接口
     * @param id 参数 id
     * @return 返回
     */
    @GetMapping("/product/{id}")
    String getProductById(@PathVariable("id") Long id);
}
复制代码

如果远程接口不通，这里可以在 @FeignClient 注解上增加一个属性 fallback ，该属性定义一个容错的处理类，当调用远程接口失败或超时时，会调用对应接口的容错逻辑，fallback 指定的类必须实现 @FeignClient 标记的接口。

先来定义一个实现 ProductService 的类：

@Component
@Slf4j
public class ProductServiceImpl implements ProductService {

    /**
     * 调用远程服务 nacos-provider 的 product/{id} 接口失败后的处理方法
     *
     * @param id 参数 id
     * @return 返回
     */
    @Override
    public String getProductById(Long id) {
        log.error("调用接口 getProduct 失败，id={}", id);
        //return "OpenFeign 降级";
        throw new BusinessException(ResponseCode.RPC_ERROR.getCode(), ResponseCode.RPC_ERROR.getMessage());
    }
}
复制代码

该类需要被 Spring 识别，所以加个 @Component 。该类的实现方法可以添加实际业务的处理逻辑，本案例只是打印一些信息后直接抛出自定义的异常。

Tips ：ResponseCode.RPC_ERROR 在二方库中有定义。

给 FeignClient 接口增加 fallback 属性：

@FeignClient(name = "nacos-provider", fallback = ProductServiceImpl.class)
复制代码

OK，不启动服务提供方 nacos-provider，直接调用接口测试。

接口返回：

控制台打印信息：

これにより、フォールバックのフォールトトレラントな処理が実現され、リモートサービスが利用できなくなった場合でも、ダウングレードすることができます。

@SentinelResource の現在の制限

コントローラー レイヤーが FeignClient によって定義されたインターフェイスを使用してサービスをリモートで呼び出す場合、Sentinel リソースを定義し、リソースの現在の流れを制限するルールを設定することもできます。

@SentinelResourceを使用するいくつかの方法は、以前の記事で言及されており、ここでは組み合わせてOpenFeign使用​​さ. この例では、次の定義が提供されています。

@GetMapping("/product/{id}")
@SentinelResource(value = "getProduct",
                  blockHandler = "getProductBlock",
                  fallback = "getProductFallback")
public String getProduct(@PathVariable("id") Long id) {
    return productService.getProductById(id);
}

public String getProductBlock(Long id, BlockException e) {
    log.error("访问资源 getProduct 被限流，id={}", id);
    throw new BusinessException("C0002", "访问资源 getProduct 被限流");
}

public String getProductFallback(Long id) {
    log.error("访问资源 getProduct fallback");
    return "请稍后重试";
}
复制代码

前の準備で、Sentinel リソースの現在の制限ルールを Nacos に永続化するように構成しました. Nacos でリソースgetProductの現在の:

[
  {
    "resource": "getProduct",
    "limitApp": "default",
    "grade": 1,
    "count": 1,
    "strategy": 0,
    "controlBehavior": 0,
    "clusterMode": false
  }
]
复制代码

現在のスロットリング ルールは、QPS しきい値が 1 であり、1 秒あたり 1 つ以上のリクエストがある限り、スロットリングされます。

リモート サービスnacos-providerを開始し、以下で確認します。

1 秒間に 1 つのリクエストのみを送信した結果:

1 秒以内に数回すばやく更新すると、QPS が 1 を超え、電流が制限されます。

まとめ

• OpenFeign統合Sentinelには、Sentinel関連する依存パッケージの導入が必要です。
• 構成ファイルfeign.sentinel.enabled=trueで、Feign と Sentinel を組み合わせて使用​​できるようにします。
• この属性を@FeignClientfallbackアノテーションに追加します。これは、リモート インターフェイス アクセスに問題がある場合のフォールト トレラントな処理ロジックのクラスを定義します。
• fallback定義されたクラスは、 @FeignClientによって定義されたインターフェースを実装する必要があります。

親指を立てて行きましょう〜