guava-retrying 使用手册

guava-retrying 使用手册

guava-retryingThis is a small extension to Google's Guava library to allow for the creation of configurable retrying strategies for an arbitrary function call, such as something that talks to a remote service with flaky uptime.项目地址:https://gitcode.com/gh_mirrors/gu/guava-retrying

一、项目目录结构及介绍

guava-retrying 是一个轻量级的Java库，它扩展了Google的Guava库，提供了灵活的重试策略实现。以下是典型的项目结构概述：

guava-retrying
├── src
│   ├── main
│   │   └── java
│   │       └── com.github.rholder.retry # 主要源码所在，包含了RetryerBuilder和其他核心类
│   └── test
│       └── java
│           └── com.github.rholder.retry # 测试代码
├── pom.xml # Maven构建文件，定义了项目依赖和构建指令
├── README.md # 项目说明文件，包含基本的使用指南和贡献指南
├── LICENSE # 许可证文件，本项目遵循Apache License 2.0
└── ...

• src/main/java: 存放项目的主要Java源代码。
• src/test/java: 包含单元测试和集成测试的代码。
• pom.xml: Maven项目的配置文件，用于管理依赖、编译设置、插件等。
• README.md: 快速了解项目、安装和使用方法的关键文档。

二、项目启动文件介绍

guava-retrying作为一个库，并没有传统的“启动文件”。它的应用是通过将其添加到你的项目依赖中，然后在你的应用程序中创建并使用Retryer实例来实现的。因此，“启动”涉及到的主要是你的应用程序如何初始化这个库，比如在Spring Boot应用中，可能是在特定的配置类中或应用初始化阶段通过DI(Dependency Injection)注入Retryer对象。

// 示例：通过RetryerBuilder构建Retryer实例
import com.github.rholder.retry.Retryer;
import com.github.rholder.retry.RetryerBuilder;

public class YourApplication {
    private static final Retryer<Boolean> retryer = RetryerBuilder.<Boolean>newBuilder()
            .retryIfResult(Predicates.isNull())
            .retryIfException()
            .withWaitStrategy(WaitStrategies.fixedWait(1, TimeUnit.SECONDS))
            .withStopStrategy(StopStrategies.stopAfterAttempt(3))
            .build();
    
    public static void main(String[] args) {
        // 应用逻辑...
    }
}

三、项目的配置文件介绍

guava-retrying本身并不直接使用外部配置文件（如application.properties或.yml文件）来设置其行为。它的配置是通过代码层面的API完成的，如上述例子所示，在创建RetryerBuilder实例时进行配置。如果你的应用环境需要通过外部配置来决定重试策略，这通常是通过应用框架（如Spring Boot的@ConfigurationProperties或手动读取配置文件）来间接实现的。

例如，在Spring Boot应用中，你可以这样做：

# application.yaml
retry:
  attemptLimit: 3
  waitDuration: 1000 #毫秒
  
// Java配置类
@Configuration
@ConfigurationProperties(prefix = "retry")
public class RetryConfig {
    private int attemptLimit;
    private long waitDuration;

    // Getter and Setter略...

    @Bean
    public Retryer<Void> retryer() {
        return RetryerBuilder.<Void>newBuilder()
                .retryIfException()
                .withWaitStrategy(WaitStrategies.fixedWait(waitDuration, TimeUnit.MILLISECONDS))
                .withStopStrategy(StopStrategies.stopAfterAttempt(attemptLimit))
                .build();
    }
}

如此一来，guava-retrying的配置就融入到了你的应用配置体系中，可以通过应用的配置文件进行调整，实现了灵活性与统一管理。

guava-retryingThis is a small extension to Google's Guava library to allow for the creation of configurable retrying strategies for an arbitrary function call, such as something that talks to a remote service with flaky uptime.项目地址:https://gitcode.com/gh_mirrors/gu/guava-retrying