Class Lock

锁定

互斥锁的表示形式。

此类可让脚本确保一次仅有一个脚本实例执行给定的代码段。这对于回调和触发器特别有用,在回调和触发器中,用户操作可能会导致共享资源发生变化,并且您希望确保没有冲突。

以下示例展示了如何在表单提交处理程序中使用锁。

// Generates a unique ticket number for every form submission.
function onFormSubmit(e) {
  var targetCell = e.range.offset(0, e.range.getNumColumns(), 1, 1);

  // Gets a script lock before modifying a shared resource.
  var lock = LockService.getScriptLock();
  // Waits for up to 30 seconds for other processes to finish.
  lock.waitLock(30000);

  var ticketNumber = Number(ScriptProperties.getProperty('lastTicketNumber')) + 1;
  ScriptProperties.setProperty('lastTicketNumber', ticketNumber);

  // Releases the lock so that other processes can continue.
  lock.releaseLock();

  targetCell.setValue(ticketNumber);
}
在不使用锁定服务的情况下,如果两位用户大约同时提交表单,则票号可能最终相同,因为 lastTicketNumber 属性在从 ScriptProperties 中读取之后到新值被写回之前可能会发生变化。

方法

方法返回类型简介
hasLock()Boolean如果获取了锁,则返回 true。
releaseLock()void释放锁,允许等待该锁的其他进程继续。
tryLock(timeoutInMillis)Boolean尝试获取锁,在指定的毫秒数后超时。
waitLock(timeoutInMillis)void尝试获取锁,在提供的毫秒数后超时并抛出异常。

详细文档

hasLock()

如果获取了锁,则返回 true。如果从未调用 tryLock(timeoutInMillis)waitLock(timeoutInMillis)、在检索锁前超时或者调用了 releaseLock(),此方法将返回 false。

var lock = LockService.getScriptLock();
lock.tryLock(10000);
if (!lock.hasLock()) {
  Logger.log('Could not obtain lock after 10 seconds.');
}

弃踢回攻

Boolean - 如果获取了锁定,则为 true,否则为 false


releaseLock()

释放锁,允许等待该锁的其他进程继续。脚本终止时锁定会自动释放,但为了提高效率,最好在不再需要对某段代码进行独占访问时立即释放。如果尚未获取锁,则此方法不会产生任何影响。

请注意,如果您使用的是电子表格,则应在解除锁定之前调用 电子表格应用.flush() 以提交所有待更改项到电子表格,而您仍然拥有该电子表格的独占访问权限。

var lock = LockService.getScriptLock();
lock.waitLock(10000);
// Do some work on a shared resource.
lock.releaseLock();

tryLock(timeoutInMillis)

尝试获取锁,在指定的毫秒数后超时。如果已获取锁,则此方法不会产生任何影响。

var lock = LockService.getScriptLock();
var success = lock.tryLock(10000);
if (!success) {
  Logger.log('Could not obtain lock after 10 seconds.');
}

参数

名称类型说明
timeoutInMillisInteger获取锁的等待时间(以毫秒为单位)

弃踢回攻

Boolean - 如果获取了锁定,则为 true,否则为 false


waitLock(timeoutInMillis)

尝试获取锁,在提供的毫秒数后超时并抛出异常。此方法与 tryLock(timeoutInMillis) 相同,只是它会在无法获取锁时抛出异常,而不是返回 false。

var lock = LockService.getScriptLock();
try {
  lock.waitLock(10000);
} catch (e) {
  Logger.log('Could not obtain lock after 10 seconds.');
}

参数

名称类型说明
timeoutInMillisInteger获取锁的等待时间(以毫秒为单位)

抛出

Error - 如果方法在获取锁定之前超时