Skip to content

Commit e4009f4

Browse files
mp911dechristophstrobl
mp911de
authored and
christophstrobl
committed
Introduce BoundKeyExpirationOperations.
And rename entry points for Hash Field expiration from expiration to hashFieldExpiration. Original Pull Request: #3115
1 parent b8d2892 commit e4009f4

9 files changed

+301
-2
lines changed

‎src/main/java/org/springframework/data/redis/core/BoundKeyExpirationOperations.java

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
/*
2+
* Copyright 2025 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package org.springframework.data.redis.core;
17+
18+
import java.time.Duration;
19+
import java.time.Instant;
20+
import java.util.concurrent.TimeUnit;
21+
22+
import org.springframework.data.redis.connection.ExpirationOptions;
23+
import org.springframework.data.redis.core.types.Expiration;
24+
import org.springframework.data.redis.core.types.Expirations;
25+
import org.springframework.lang.Nullable;
26+
27+
/**
28+
* Key Expiration operations bound to a key.
29+
*
30+
* @author Mark Paluch
31+
* @since 3.5
32+
*/
33+
public interface BoundKeyExpirationOperations {
34+
35+
/**
36+
* Apply {@link Expiration} to the bound key without any additional constraints.
37+
*
38+
* @param expiration the expiration definition.
39+
* @return changes to the key. {@literal null} when used in pipeline / transaction.
40+
*/
41+
default ExpireChanges.ExpiryChangeState expire(Expiration expiration) {
42+
return expire(expiration, ExpirationOptions.none());
43+
}
44+
45+
/**
46+
* Apply {@link Expiration} to the bound key given {@link ExpirationOptions expiration options}.
47+
*
48+
* @param expiration the expiration definition.
49+
* @param options expiration options.
50+
* @return changes to the key. {@literal null} when used in pipeline / transaction.
51+
*/
52+
@Nullable
53+
ExpireChanges.ExpiryChangeState expire(Expiration expiration, ExpirationOptions options);
54+
55+
/**
56+
* Set time to live for the bound key.
57+
*
58+
* @param timeout the amount of time after which the key will be expired, must not be {@literal null}.
59+
* @return changes to the key. {@literal null} when used in pipeline / transaction.
60+
* @throws IllegalArgumentException if the timeout is {@literal null}.
61+
* @see <a href="https://redis.io/docs/latest/commands/expire/">Redis Documentation: EXPIRE</a>
62+
* @since 3.5
63+
*/
64+
@Nullable
65+
ExpireChanges.ExpiryChangeState expire(Duration timeout);
66+
67+
/**
68+
* Set the expiration for the bound key as a {@literal date} timestamp.
69+
*
70+
* @param expireAt must not be {@literal null}.
71+
* @return changes to the key. {@literal null} when used in pipeline / transaction.
72+
* @throws IllegalArgumentException if the instant is {@literal null} or too large to represent as a {@code Date}.
73+
* @see <a href="https://redis.io/docs/latest/commands/expireat/">Redis Documentation: EXPIRE</a>
74+
* @since 3.5
75+
*/
76+
@Nullable
77+
ExpireChanges.ExpiryChangeState expireAt(Instant expireAt);
78+
79+
/**
80+
* Remove the expiration from the bound key.
81+
*
82+
* @return changes to the key. {@literal null} when used in pipeline / transaction.
83+
* @see <a href="https://redis.io/docs/latest/commands/persist/">Redis Documentation: PERSIST</a>
84+
* @since 3.5
85+
*/
86+
@Nullable
87+
ExpireChanges.ExpiryChangeState persist();
88+
89+
/**
90+
* Get the time to live for the bound key in seconds.
91+
*
92+
* @return the actual expirations in seconds for the key. {@literal null} when used in pipeline / transaction.
93+
* @see <a href="https://redis.io/docs/latest/commands/ttl/">Redis Documentation: TTL</a>
94+
* @since 3.5
95+
*/
96+
@Nullable
97+
Expirations.TimeToLive getTimeToLive();
98+
99+
/**
100+
* Get the time to live for the bound key and convert it to the given {@link TimeUnit}.
101+
*
102+
* @param timeUnit must not be {@literal null}.
103+
* @return the actual expirations for the key in the given time unit. {@literal null} when used in pipeline /
104+
* transaction.
105+
* @see <a href="https://redis.io/docs/latest/commands/ttl/">Redis Documentation: TTL</a>
106+
* @since 3.5
107+
*/
108+
@Nullable
109+
Expirations.TimeToLive getTimeToLive(TimeUnit timeUnit);
110+
111+
}

‎src/main/java/org/springframework/data/redis/core/BoundKeyOperations.java

+16
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,16 @@ public interface BoundKeyOperations<K> {
5151
@Nullable
5252
DataType getType();
5353

54+
/**
55+
* Returns a bound operations object to perform expiration operations on the bound key.
56+
*
57+
* @return the bound operations object to perform operations on the hash field expiration.
58+
* @since 3.5
59+
*/
60+
default BoundKeyExpirationOperations expiration() {
61+
return new DefaultBoundKeyExpirationOperations<>(getOperations(), getKey());
62+
}
63+
5464
/**
5565
* Returns the expiration of this key.
5666
*
@@ -127,4 +137,10 @@ default Boolean expireAt(Instant expireAt) {
127137
* @param newKey new key. Must not be {@literal null}.
128138
*/
129139
void rename(K newKey);
140+
141+
/**
142+
* @return never {@literal null}.
143+
*/
144+
RedisOperations<K, ?> getOperations();
145+
130146
}

‎src/main/java/org/springframework/data/redis/core/BoundOperationsProxyFactory.java

+5-2
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ public Object invoke(MethodInvocation invocation) throws Throwable {
143143
delegate.rename(invocation.getArguments()[0]);
144144
yield null;
145145
}
146-
case "getOperations" -> delegate.getOps();
146+
case "getOperations" -> delegate.getOperations();
147147
default ->
148148
method.getDeclaringClass() == boundOperationsInterface ? doInvoke(invocation, method, operationsTarget, true)
149149
: doInvoke(invocation, method, delegate, false);
@@ -234,12 +234,15 @@ public void rename(Object newKey) {
234234
key = newKey;
235235
}
236236

237+
@Override
237238
public DataType getType() {
238239
return type;
239240
}
240241

241-
public RedisOperations<Object, ?> getOps() {
242+
@Override
243+
public RedisOperations<Object, ?> getOperations() {
242244
return ops;
243245
}
246+
244247
}
245248
}

‎src/main/java/org/springframework/data/redis/core/DefaultBoundKeyExpirationOperations.java

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
/*
2+
* Copyright 2025 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package org.springframework.data.redis.core;
17+
18+
import java.time.Duration;
19+
import java.time.Instant;
20+
import java.util.concurrent.TimeUnit;
21+
22+
import org.springframework.data.redis.connection.ExpirationOptions;
23+
import org.springframework.data.redis.core.types.Expiration;
24+
import org.springframework.data.redis.core.types.Expirations;
25+
import org.springframework.lang.Nullable;
26+
27+
/**
28+
* Default {@link BoundKeyExpirationOperations} implementation.
29+
*
30+
* @author Mark Paluch
31+
* @since 3.5
32+
*/
33+
class DefaultBoundKeyExpirationOperations<K> implements BoundKeyExpirationOperations {
34+
35+
private final RedisOperations<K, ?> operations;
36+
private final K key;
37+
38+
public DefaultBoundKeyExpirationOperations(RedisOperations<K, ?> operations, K key) {
39+
this.operations = operations;
40+
this.key = key;
41+
}
42+
43+
@Nullable
44+
@Override
45+
public ExpireChanges.ExpiryChangeState expire(Expiration expiration, ExpirationOptions options) {
46+
return operations.expire(key, expiration, options);
47+
}
48+
49+
@Nullable
50+
@Override
51+
public ExpireChanges.ExpiryChangeState expire(Duration timeout) {
52+
53+
Boolean expire = operations.expire(key, timeout);
54+
55+
return toExpiryChangeState(expire);
56+
}
57+
58+
@Nullable
59+
@Override
60+
public ExpireChanges.ExpiryChangeState expireAt(Instant expireAt) {
61+
return toExpiryChangeState(operations.expireAt(key, expireAt));
62+
}
63+
64+
@Nullable
65+
@Override
66+
public ExpireChanges.ExpiryChangeState persist() {
67+
return toExpiryChangeState(operations.persist(key));
68+
}
69+
70+
@Nullable
71+
@Override
72+
public Expirations.TimeToLive getTimeToLive() {
73+
74+
Long expire = operations.getExpire(key);
75+
76+
return expire == null ? null : Expirations.TimeToLive.of(expire, TimeUnit.SECONDS);
77+
}
78+
79+
@Nullable
80+
@Override
81+
public Expirations.TimeToLive getTimeToLive(TimeUnit timeUnit) {
82+
83+
Long expire = operations.getExpire(key, timeUnit);
84+
85+
return expire == null ? null : Expirations.TimeToLive.of(expire, timeUnit);
86+
87+
}
88+
89+
@Nullable
90+
private static ExpireChanges.ExpiryChangeState toExpiryChangeState(@Nullable Boolean result) {
91+
92+
if (result == null) {
93+
return null;
94+
}
95+
96+
return ExpireChanges.ExpiryChangeState.of(result);
97+
}
98+
99+
}

‎src/main/java/org/springframework/data/redis/core/RedisOperations.java

+10
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,16 @@ default Boolean expireAt(K key, Instant expireAt) {
386386
@Nullable
387387
ExpireChanges.ExpiryChangeState expire(K key, Expiration expiration, ExpirationOptions options);
388388

389+
/**
390+
* Returns a bound operations object to perform expiration operations on the bound key.
391+
*
392+
* @return the bound operations object to perform operations on the hash field expiration.
393+
* @since 3.5
394+
*/
395+
default BoundKeyExpirationOperations expiration(K key) {
396+
return new DefaultBoundKeyExpirationOperations<>(this, key);
397+
}
398+
389399
/**
390400
* Remove the expiration from given {@code key}.
391401
*

‎src/main/java/org/springframework/data/redis/support/atomic/RedisAtomicDouble.java

+6
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,11 @@ public void rename(String newKey) {
399399
key = newKey;
400400
}
401401

402+
@Override
403+
public RedisOperations<String, ?> getOperations() {
404+
return generalOps;
405+
}
406+
402407
@Override
403408
public int intValue() {
404409
return (int) get();
@@ -418,4 +423,5 @@ public float floatValue() {
418423
public double doubleValue() {
419424
return get();
420425
}
426+
421427
}

‎src/main/java/org/springframework/data/redis/support/atomic/RedisAtomicInteger.java

+5
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,11 @@ public void rename(String newKey) {
399399
key = newKey;
400400
}
401401

402+
@Override
403+
public RedisOperations<String, ?> getOperations() {
404+
return generalOps;
405+
}
406+
402407
@Override
403408
public int intValue() {
404409
return get();

‎src/main/java/org/springframework/data/redis/support/atomic/RedisAtomicLong.java

+6
Original file line numberDiff line numberDiff line change
@@ -396,6 +396,11 @@ public void rename(String newKey) {
396396
key = newKey;
397397
}
398398

399+
@Override
400+
public RedisOperations<String, ?> getOperations() {
401+
return generalOps;
402+
}
403+
399404
@Override
400405
public int intValue() {
401406
return (int) get();
@@ -415,4 +420,5 @@ public float floatValue() {
415420
public double doubleValue() {
416421
return get();
417422
}
423+
418424
}

‎src/test/java/org/springframework/data/redis/core/RedisTemplateIntegrationTests.java

+43
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
import org.springframework.data.redis.Person;
3535
import org.springframework.data.redis.SettingsUtils;
3636
import org.springframework.data.redis.connection.DataType;
37+
import org.springframework.data.redis.connection.ExpirationOptions;
3738
import org.springframework.data.redis.connection.RedisClusterConnection;
3839
import org.springframework.data.redis.connection.RedisConnection;
3940
import org.springframework.data.redis.connection.StringRedisConnection;
@@ -42,11 +43,13 @@
4243
import org.springframework.data.redis.core.ZSetOperations.TypedTuple;
4344
import org.springframework.data.redis.core.query.SortQueryBuilder;
4445
import org.springframework.data.redis.core.script.DefaultRedisScript;
46+
import org.springframework.data.redis.core.types.Expiration;
4547
import org.springframework.data.redis.serializer.GenericToStringSerializer;
4648
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
4749
import org.springframework.data.redis.serializer.RedisSerializer;
4850
import org.springframework.data.redis.serializer.StringRedisSerializer;
4951
import org.springframework.data.redis.test.condition.EnabledIfLongRunningTest;
52+
import org.springframework.data.redis.test.condition.EnabledOnCommand;
5053
import org.springframework.data.redis.test.extension.LettuceTestClientResources;
5154
import org.springframework.data.redis.test.extension.parametrized.MethodSource;
5255
import org.springframework.data.redis.test.extension.parametrized.ParameterizedRedisTest;
@@ -503,6 +506,46 @@ void testExpireAndGetExpireMillis() {
503506
assertThat(redisTemplate.getExpire(key1, TimeUnit.MILLISECONDS)).isGreaterThan(0L);
504507
}
505508

509+
@ParameterizedRedisTest // GH-3114
510+
@EnabledOnCommand("SPUBLISH") // Redis 7.0
511+
void testBoundExpireAndGetExpireSeconds() {
512+
513+
K key = keyFactory.instance();
514+
V value1 = valueFactory.instance();
515+
redisTemplate.boundValueOps(key).set(value1);
516+
517+
BoundKeyExpirationOperations exp = redisTemplate.expiration(key);
518+
519+
assertThat(exp.expire(Duration.ofSeconds(5))).isEqualTo(ExpireChanges.ExpiryChangeState.OK);
520+
521+
assertThat(exp.getTimeToLive(TimeUnit.SECONDS)).satisfies(ttl -> {
522+
assertThat(ttl.isPersistent()).isFalse();
523+
assertThat(ttl.value()).isGreaterThan(1);
524+
});
525+
}
526+
527+
@ParameterizedRedisTest // GH-3114
528+
@EnabledOnCommand("SPUBLISH") // Redis 7.0
529+
void testBoundExpireWithConditionsAndGetExpireSeconds() {
530+
531+
K key = keyFactory.instance();
532+
V value1 = valueFactory.instance();
533+
redisTemplate.boundValueOps(key).set(value1);
534+
535+
BoundKeyExpirationOperations exp = redisTemplate.expiration(key);
536+
537+
assertThat(exp.expire(Duration.ofSeconds(5))).isEqualTo(ExpireChanges.ExpiryChangeState.OK);
538+
assertThat(exp.expire(Expiration.from(Duration.ofSeconds(1)), ExpirationOptions.builder().gt().build()))
539+
.isEqualTo(ExpireChanges.ExpiryChangeState.CONDITION_NOT_MET);
540+
assertThat(exp.expire(Expiration.from(Duration.ofSeconds(10)), ExpirationOptions.builder().gt().build()))
541+
.isEqualTo(ExpireChanges.ExpiryChangeState.OK);
542+
543+
assertThat(exp.getTimeToLive(TimeUnit.SECONDS)).satisfies(ttl -> {
544+
assertThat(ttl.isPersistent()).isFalse();
545+
assertThat(ttl.value()).isGreaterThan(5);
546+
});
547+
}
548+
506549
@ParameterizedRedisTest
507550
void testGetExpireNoTimeUnit() {
508551
K key1 = keyFactory.instance();

0 commit comments

Comments
 (0)