This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

分布式锁

分布式锁为应用程序提供对共享资源的独占访问。

1: 分布式锁概述
2: 操作指南：使用锁

1 - 分布式锁概述

分布式锁API构建模块概述

介绍

锁用于确保资源的互斥访问。例如，您可以使用锁来：

独占访问数据库的行、表或整个数据库
顺序锁定从队列中读取消息

任何需要更新的共享资源都可以被锁定。锁通常用于改变状态的操作，而不是读取操作。

每个锁都有一个名称。应用程序决定锁定哪些资源。通常，同一应用程序的多个实例使用这个命名锁来独占访问资源并进行更新。

例如，在竞争消费者模式中，应用程序的多个实例访问一个队列。您可以选择在应用程序执行其业务逻辑时锁定队列。

在下图中，同一应用程序的两个实例，App1，使用Redis锁组件来锁定共享资源。

第一个应用程序实例获取命名锁并获得独占访问权。
第二个应用程序实例无法获取锁，因此在锁被释放之前不允许访问资源，释放方式可以是：
- 通过应用程序显式调用解锁API，或
- 由于租约超时而在一段时间后自动释放。

*此API目前处于Alpha状态。

特性

资源的互斥访问

在任何给定时刻，只有一个应用程序实例可以持有命名锁。锁的范围限定在Dapr应用程序ID内。

使用租约防止死锁

Dapr分布式锁使用基于租约的锁定机制。如果应用程序获取锁后遇到异常，无法释放锁，则锁将在一段时间后通过租约自动释放。这防止了在应用程序故障时发生资源死锁。

演示

观看此视频以了解分布式锁API的概述：

下一步

请参阅以下指南：

如何在您的应用程序中使用分布式锁

2 - 操作指南：使用锁

学习如何使用分布式锁来提供对资源的独占访问

了解了Dapr分布式锁API构建块的功能后，学习如何在服务中使用它。在本指南中，我们将通过一个示例应用程序演示如何使用Redis锁组件获取锁。有关支持的锁存储类型，请参阅此参考页面。

下图展示了相同应用程序的两个实例尝试获取锁，其中一个成功，另一个被拒绝。

下图展示了相同应用程序的两个实例，其中一个实例释放锁，另一个实例随后成功获取锁。

下图展示了不同应用程序的两个实例在同一资源上获取不同的锁。

配置锁组件

将以下组件文件保存到您机器上的默认组件文件夹。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: lockstore
spec:
  type: lock.redis
  version: v1
  metadata:
  - name: redisHost
    value: localhost:6379
  - name: redisPassword
    value: <PASSWORD>

获取锁

curl -X POST http://localhost:3500/v1.0-alpha1/lock/lockstore
   -H 'Content-Type: application/json'
   -d '{"resourceId":"my_file_name", "lockOwner":"random_id_abc123", "expiryInSeconds": 60}'

using System;
using Dapr.Client;

namespace LockService
{
    class Program
    {
        [Obsolete("Distributed Lock API is in Alpha, this can be removed once it is stable.")]
        static async Task Main(string[] args)
        {
            string DAPR_LOCK_NAME = "lockstore";
            string fileName = "my_file_name";
            var client = new DaprClientBuilder().Build();
    
            await using (var fileLock = await client.Lock(DAPR_LOCK_NAME, fileName, "random_id_abc123", 60))
            {
                if (fileLock.Success)
                {
                    Console.WriteLine("Success");
                }
                else
                {
                    Console.WriteLine($"Failed to lock {fileName}.");
                }
            }
        }
    }
}

package main

import (
    "fmt"

    dapr "github.com/dapr/go-sdk/client"
)

func main() {
    client, err := dapr.NewClient()
    if err != nil {
        panic(err)
    }
    defer client.Close()
    
    resp, err := client.TryLockAlpha1(ctx, "lockstore", &dapr.LockRequest{
			LockOwner:         "random_id_abc123",
			ResourceID:      "my_file_name",
			ExpiryInSeconds: 60,
		})

    fmt.Println(resp.Success)
}

解锁现有锁

curl -X POST http://localhost:3500/v1.0-alpha1/unlock/lockstore
   -H 'Content-Type: application/json'
   -d '{"resourceId":"my_file_name", "lockOwner":"random_id_abc123"}'

using System;
using Dapr.Client;

namespace LockService
{
    class Program
    {
        static async Task Main(string[] args)
        {
            string DAPR_LOCK_NAME = "lockstore";
            var client = new DaprClientBuilder().Build();

            var response = await client.Unlock(DAPR_LOCK_NAME, "my_file_name", "random_id_abc123"));
            Console.WriteLine(response.status);
        }
    }
}

package main

import (
    "fmt"

    dapr "github.com/dapr/go-sdk/client"
)

func main() {
    client, err := dapr.NewClient()
    if err != nil {
        panic(err)
    }
    defer client.Close()
    
    resp, err := client.UnlockAlpha1(ctx, "lockstore", &UnlockRequest{
			LockOwner:    "random_id_abc123",
			ResourceID: "my_file_name",
		})

    fmt.Println(resp.Status)
}

下一步

阅读分布式锁API概述以了解更多信息。