Skip to content

Latest commit

 

History

History
110 lines (82 loc) · 3.9 KB

README.md

File metadata and controls

110 lines (82 loc) · 3.9 KB
Raw

Redisson-util-starter

GitHub tag (latest SemVer) License REUSE status

Spring boot starter that given a redisson client bean provides additional services for working with redisson locks and queues:

  • RedissonLockService A service that provied a tryWithLock method that uses a redisson lock. A bean will be provided if redisson-util.lock.name-prefix property is set.
  • RedissonLibQeueue If redisson-util.queue.name property is set, a redisson priority queue will be provided.

This library is written in kotlin. It is a rework of the now deprecated library "redisson-starter".

Usage

Add the lib as a dependency to your Gradle build file.

implementation("se.svt.oss:redisson-util-starter:1.0.1")

You also need to provide a redisson client, for instance by adding a dependency on the redisson spring boot starter

implementation("org.redisson:redisson-spring-boot-starter:3.17.2")

Configure in application.yml (or other property source) :

redisson-util:
  lock:
    name: ${service.name}-lock
    wait-time: 0s
    lease-time: 60m
  queue:
    name: ${service.name}-queue

For the lock service, name, wait-time and lease-time only configures default values that can be overriden when calling the lock service:

redissonLockService.tryWithLock(name = "my-other-lock", 
                                waitTime = Duration.ofSeconds(10),
                                leaseTime = Duration.ofHours(1)) {
   // DO SOME STUFF WITH LOCK
}

Migrating from redisson-starter

If your application was previously using the "redisson starter", and you now want to use redisson-util-starter instead, you need to apply the following changes

  1. Change your dependency on the old redisson-starter lib to point to redisson-util-starter.
  2. Provide a redisson client, preferably by using redisson-spring-boot-starter, update build.gradle by adding the below dependencies
implementation("org.redisson:redisson-spring-boot-starter:${redissonVersion}")
implementation("org.redisson:redisson-spring-data-23:${redissonVersion}") // replace 23 to match spring boot version

to build.gradle.

  1. Update your imports to reflect that the classes in the library have been moved from package se.svt.oss.redisson.starter to se.svt.oss.redisson.util.starter.
  2. Update your configuration to reflect that the configuration properties are now under redisson-util instead of redis.redisson .
  3. Depending on your usecase, you may also need to configure the default codec used by redisson. To get the same behaviour as the old library, you can add a bean like below.
    @Bean
    public RedissonAutoConfigurationCustomizer redissonAutoConfigurationCustomizer(ObjectMapper objectMapper) {
        return configuration -> configuration.setCodec(new JsonJacksonCodec(objectMapper));
    }

Mocking the RedissonLockService with mockk

Calling RedissonLockService.tryWithLock on a mockk object without specifying all parameters will fail, because the default parameter values reference an instance field that will not be available. To get around this, a spy can be used instead:

private val redissonLockService = spyk(RedissonLockService(mockk(), mockk(relaxed = true)))

A similar strategy can be used with Mockito as well.

Tests

run ./gradlew clean check for unit tests and code quality checks

License

Copyright 2020 Sveriges Television AB

This software is released under the:

Apache License 2.0

Primary Maintainers

SVT Videocore team videocore@teams.svt.se