Create Distributed Lock

Distributed Lock Generator

Creates distributed locking infrastructure for concurrency control and mutual exclusion.

When to Use

Component Characteristics

LockInterface

• Contract for lock implementations
• Methods: acquire, release, isAcquired, refresh
• Supports blocking and non-blocking acquisition

LockConfig

• Configuration Value Object
• TTL, auto-release flag, retry count, retry delay
• Immutable with sensible defaults

RedisLockAdapter

• Redis SETNX + TTL implementation
• Atomic acquire using SET NX EX
• Safe release using Lua script (compare-and-delete)
• Token-based ownership verification

LockFactory

• Creates locks by resource name
• Injects configured adapter and settings
• Supports per-lock TTL override

LockException

• Thrown on lock acquisition failure
• Contains resource name and reason

Generation Process

Step 1: Generate Core Components

Path: src/Infrastructure/Lock/

1. LockInterface.php — Lock contract
2. LockConfig.php — Configuration value object
3. LockException.php — Lock acquisition exception

Step 2: Generate Lock Adapter

Path: src/Infrastructure/Lock/

1. RedisLockAdapter.php — Redis SETNX + TTL lock implementation

Step 3: Generate Factory

Path: src/Infrastructure/Lock/

1. LockFactory.php — Creates configured lock instances

Step 4: Generate Tests

1. LockConfigTest.php — Configuration validation tests
2. RedisLockAdapterTest.php — Lock behavior tests

File Placement

Naming Conventions

Quick Template Reference

LockInterface

interface LockInterface
{
    public function acquire(string $resource): bool;
    public function release(string $resource): void;
    public function isAcquired(string $resource): bool;
    public function refresh(string $resource): bool;
}

LockConfig

final readonly class LockConfig
{
    public function __construct(
        public int $ttlSeconds = 30,
        public bool $autoRelease = true,
        public int $retryCount = 3,
        public int $retryDelayMs = 200
    ) {}
}

RedisLockAdapter

final class RedisLockAdapter implements LockInterface
{
    public function acquire(string $resource): bool;
    public function release(string $resource): void;
    public function isAcquired(string $resource): bool;
    public function refresh(string $resource): bool;
}

Usage Example

$lock = $lockFactory->create('order-processing');

try {
    if (!$lock->acquire('order:12345')) {
        throw LockException::cannotAcquire('order:12345');
    }

    $order->process();
} finally {
    $lock->release('order:12345');
}

Lock Lifecycle

acquire() ──→ SET resource token NX EX ttl
                │
         Success? ──→ Lock held (token stored)
                │              │
               NO         refresh() ──→ Extend TTL
                │              │
         Retry? ──→ Sleep → retry     release() ──→ Compare token → DEL
                │
         LockException

Anti-patterns to Avoid

References

For complete PHP templates and examples, see:

• references/templates.md — LockInterface, LockConfig, RedisLockAdapter, LockFactory templates
• references/examples.md — Usage examples and tests