ExpiringMap 技术文档

1. 安装指南

ExpiringMap 是一个高性能、低开销、无依赖、线程安全的 ConcurrentMap 实现，支持 Java 6 及以上版本。您可以通过以下方式引入到您的项目中：

Maven 引入

<dependency>
    <groupId>net.jodah</groupId>
    <artifactId>expiringmap</artifactId>
    <version>版本号</version>
</dependency>

请将 版本号 替换为最新或适合您项目的版本。

Gradle 引入

dependencies {
    implementation 'net.jodah:expiringmap:版本号'
}

同样，将 版本号 替换为最新或适合您项目的版本。

2. 项目的使用说明

ExpiringMap 允许您创建一个在特定时间周期后过期或当达到最大映射大小后过期的映射。以下是一些基本用法示例：

创建过期映射

Map<String, Connection> map = ExpiringMap.builder()
    .maxSize(123)
    .expiration(30, TimeUnit.SECONDS)
    .build();

添加元素

map.put("connection", connection);

该元素将在30秒后过期，或者在添加第124个元素时过期（如果它是下一个根据过期策略要过期的元素）。

过期策略

Map<String, Connection> map = ExpiringMap.builder()
    .expirationPolicy(ExpirationPolicy.ACCESSED)
    .build();

您可以为单个条目指定过期策略：

map.put("connection", connection, ExpirationPolicy.CREATED);

并且可以在运行时更改策略：

map.setExpirationPolicy("connection", ExpirationPolicy.ACCESSED);

可变过期时间

ExpiringMap<String, Connection> map = ExpiringMap.builder()
    .variableExpiration()
    .build();

map.put("connection", connection, ExpirationPolicy.ACCESSED, 5, TimeUnit.MINUTES);

过期时间和策略也可以随时更改：

map.setExpiration(connection, 5, TimeUnit.MINUTES);
map.setExpirationPolicy(connection, ExpirationPolicy.ACCESSED);

最大大小

Map<String, Connection> map = ExpiringMap.builder()
    .maxSize(123)
    .build();

过期监听器

Map<String, Connection> map = ExpiringMap.builder()
    .expirationListener((key, connection) -> connection.close())
    .build();

异步过期监听器也可以配置：

Map<String, Connection> map = ExpiringMap.builder()
    .asyncExpirationListener((key, connection) -> connection.close())
    .build();

懒加载条目

Map<String, Connection> connections = ExpiringMap.builder()
    .expiration(10, TimeUnit.MINUTES)
    .entryLoader(address -> new Connection(address))
    .build();

connections.get("jodah.net");

过期内省

long expiration = map.getExpectedExpiration("jodah.net");
map.resetExpiration("jodah.net");

3. 项目API使用文档

具体的项目API文档可以在项目的 Javadoc 中找到。以下是一些主要的API入口点：

• ExpiringMap.builder(): 用于创建 ExpiringMap 实例的构建器。
• map.put(key, value): 添加一个元素到映射中。
• map.put(key, value, policy): 添加一个元素并指定过期策略。
• map.put(key, value, policy, duration, timeUnit): 添加一个元素，指定过期策略和过期时间。
• map.get(key): 从映射中获取一个元素。
• map.getExpectedExpiration(key): 获取一个元素的预期过期时间。
• map.setExpirationPolicy(key, policy): 设置一个元素的过期策略。
• map.setExpiration(key, duration, timeUnit): 设置一个元素的过期时间。

更多详细的API使用和说明，请参考项目提供的 Javadoc。

4. 项目安装方式

项目的安装方式已在“安装指南”中提供。您可以通过 Maven 或 Gradle 方式将项目依赖添加到您的项目中。请确保替换依赖中的版本号为适合您项目的版本。