如何用Spring Boot Couchbase缓存组件为OTP设置TTL过期时间

以下是几个适配你场景的可行方案：

方案一：自定义Couchbase缓存管理器，配置缓存过期时间 #

Spring Cache的Couchbase默认配置可能未正确应用全局过期规则，你可以通过自定义CouchbaseCacheManager，为OTP专属缓存设置过期时间：

1. 在配置类中定义带过期规则的缓存管理器：

@Configuration
@EnableCaching
public class CouchbaseCacheConfig {

    @Autowired
    private CouchbaseTemplate couchbaseTemplate;

    @Bean
    public CacheManager cacheManager() {
        // 配置各缓存的过期规则，key为缓存名称，value为过期时长
        Map<String, CouchbaseCacheConfiguration> cacheConfigs = new HashMap<>();
        // 给OTP缓存设置5分钟过期（可替换为配置文件读取的参数）
        cacheConfigs.put("otpCache", CouchbaseCacheConfiguration.defaultCacheConfig()
                .entryTtl(Duration.ofMinutes(5))
                .serializeKeysWith(CacheKeySerializer.simple())
                .serializeValuesWith(CacheValueSerializer.forSerializer(couchbaseTemplate.getConverter())));

        return CouchbaseCacheManager.builder(couchbaseTemplate.getCouchbaseClientFactory())
                .cacheDefaults(CouchbaseCacheConfiguration.defaultCacheConfig())
                .withCacheConfigurations(cacheConfigs)
                .build();
    }
}

2. 在OTP生成方法上指定该缓存名称：

@Cacheable(value = "otpCache", key = "#phoneNumber")
public String generateOtp(String phoneNumber) {
    // 生成OTP的业务逻辑
    String otp = // 你的OTP生成代码
    return otp;
}

存入otpCache的每个条目都会自动带上5分钟过期时间，到期后Couchbase会自动清理。

方案二：绕过Spring Cache抽象，直接用CouchbaseTemplate操作 #

如果Spring Cache的抽象限制了灵活性，你可以直接通过CouchbaseTemplate手动控制存储和过期时间：

@Service
public class OtpService {

    @Autowired
    private CouchbaseTemplate couchbaseTemplate;

    // 从配置文件读取过期时长，默认5分钟
    @Value("${otp.expiration.minutes:5}")
    private int otpExpirationMinutes;

    public String generateOtp(String phoneNumber) {
        String otp = // OTP生成逻辑
        // 存入Couchbase并设置过期时间
        couchbaseTemplate.upsertById(phoneNumber)
                .withExpiry(Duration.ofMinutes(otpExpirationMinutes))
                .one(otp);
        return otp;
    }

    public String getOtp(String phoneNumber) {
        return couchbaseTemplate.findById(phoneNumber, String.class).one();
    }
}

这种方式完全可控，每个OTP条目独立设置过期时间，不会出现类型转换问题，也无需依赖Spring Cache注解。

方案三：修正@Document+@Expiry的类型转换问题 #

如果你坚持使用Spring Data Couchbase的实体注解方式，需确保包装类是标准可序列化实体，且与缓存返回类型匹配：

1. 创建OTP实体包装类：

@Document
public class OtpEntity {

    @Id
    private String phoneNumber;

    private String otp;

    @Expiry
    private long expiry; // 单位为秒，设置为当前时间+过期时长

    // 构造器、getter、setter
    public OtpEntity(String phoneNumber, String otp, long expirySeconds) {
        this.phoneNumber = phoneNumber;
        this.otp = otp;
        this.expiry = System.currentTimeMillis() / 1000 + expirySeconds;
    }
}

2. 修改服务方法，统一返回该实体类：

@Cacheable(value = "otpCache", key = "#phoneNumber")
public OtpEntity generateOtp(String phoneNumber) {
    String otp = // OTP生成逻辑
    // 设置5分钟过期（300秒）
    return new OtpEntity(phoneNumber, otp, 300);
}

// 获取时提取实体中的OTP值
public String getOtp(String phoneNumber) {
    OtpEntity entity = // 从缓存获取实体的逻辑
    return entity != null ? entity.getOtp() : null;
}

之前的类型转换异常多是因为String类型与带@Document的实体混用，导致序列化/反序列化不匹配，统一使用实体类即可解决。

内容的提问来源于stack exchange，提问作者soumitra goswami