ahoo-wang/simba

Distributed lock service | 分布式锁服务

Simba(Distributed Mutex)

Introduction

Simba aims to provide easy-to-use and flexible distributed lock services and supports multiple storage implementations: relational databases, Redis, and Zookeeper.

Installation

Gradle

Kotlin DSL

    implementation("me.ahoo.simba:simba-spring-boot-starter:${simbaVersion}")

Maven

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>
    <artifactId>demo</artifactId>
    <properties>
        <simba.version>simbaVersion</simba.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>me.ahoo.simba</groupId>
            <artifactId>simba-spring-boot-starter</artifactId>
            <version>${simba.version}</version>
        </dependency>
    </dependencies>
    
</project>

application.yaml

simba:
  jdbc:
    enabled: true
#  redis:
#    enabled: true

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/simba_db
    username: root
    password: root

Optional-1: JdbcMutexContendService

Kotlin DSL

    implementation("me.ahoo.simba:simba-jdbc:${simbaVersion}")

create table simba_mutex
(
    mutex             varchar(66)     not null primary key comment 'mutex name',
    acquired_at       bigint unsigned not null,
    ttl_at         bigint unsigned not null,
    transition_at bigint unsigned not null,
    owner_id          char(32)        not null,
    version           int unsigned    not null
);

Optional-2: RedisMutexContendService

Kotlin DSL

    implementation("me.ahoo.simba:simba-redis:${simbaVersion}")

Optional-3: ZookeeperMutexContendService

Kotlin DSL

    implementation("me.ahoo.simba:simba-zookeeper:${simbaVersion}")

Examples

Simba-Examples

Usage

MutexContender

        MutexContendService contendService = contendServiceFactory.createMutexContendService(new AbstractMutexContender(mutex) {
            @Override
            public void onAcquired(MutexState mutexState) {
                    log.info("onAcquired");
            }
            
            @Override
            public void onReleased(MutexState mutexState) {
                    log.info("onReleased");
            }
        });
        contendService.start();

SimbaLocker

        try (Locker locker = new SimbaLocker("mutex-locker", this.mutexContendServiceFactory)) {
            locker.acquire(Duration.ofSeconds(1));
        /**
         * doSomething
         */
        } catch (Exception e) {
            log.error(e.getMessage(), e);
        }

Scheduler

public class ExampleScheduler extends AbstractScheduler implements SmartLifecycle {

    public ExampleScheduler(MutexContendServiceFactory contendServiceFactory) {
        super("example-scheduler", ScheduleConfig.ofDelay(Duration.ofSeconds(0), Duration.ofSeconds(10)), contendServiceFactory);
    }

    @Override
    protected String getWorker() {
        return "ExampleScheduler";
    }

    @Override
    protected void work() {
        if (log.isInfoEnabled()) {
            log.info("do some work!");
        }
    }
}

Use Cases

• Govern-EventBus
• CoSky

simba's Issues

Support using `spring-data-redis` as a dependency library for the `redis` storage implementation to integrate with spring

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions

.github/workflows/codecov.yml

• actions/setup-java v4
• codecov/codecov-action v4

.github/workflows/integration-test.yml

• actions/setup-java v4
• actions/setup-java v4
• actions/setup-java v4
• actions/setup-java v4

.github/workflows/package-deploy.yml

• actions/setup-java v4
• actions/setup-java v4

gradle

gradle.properties

settings.gradle.kts

build.gradle.kts

code-coverage-report/build.gradle.kts

gradle/libs.versions.toml

• org.springframework.boot:spring-boot-dependencies 3.2.5
• org.springframework.cloud:spring-cloud-dependencies 2023.0.1
• me.ahoo.cosid:cosid-bom 2.8.1
• org.testcontainers:testcontainers-bom 1.19.8
• com.google.guava:guava 33.2.0-jre
• commons-io:commons-io 2.16.1
• org.hamcrest:hamcrest 2.2
• io.mockk:mockk 1.13.11
• io.gitlab.arturbosch.detekt:detekt-formatting 1.23.6
• io.gitlab.arturbosch.detekt 1.23.6
• org.jetbrains.dokka 1.9.20
• org.jetbrains.kotlin.jvm 2.0.0
• org.jetbrains.kotlin.plugin.spring 2.0.0
• org.jetbrains.kotlin.kapt 2.0.0
• io.github.gradle-nexus.publish-plugin 2.0.0

simba-bom/build.gradle.kts

simba-core/build.gradle.kts

simba-dependencies/build.gradle.kts

simba-example/build.gradle.kts

simba-jdbc/build.gradle.kts

simba-spring-boot-starter/build.gradle.kts

simba-spring-redis/build.gradle.kts

simba-test/build.gradle.kts

simba-zookeeper/build.gradle.kts

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

• gradle 8.7

---

• Check this box to trigger a request for Renovate to run again on this repository