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()

释放锁定，允许等待锁定的其他进程继续。锁定将在脚本终止时自动释放，但出于效率考虑，最好在不再需要对某部分代码进行独占访问时立即释放锁定。如果未获得锁定，此方法将不起作用。

请注意，如果您使用的是电子表格，则应该在取消锁定之前调用 SheetApp.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 - 如果方法在获取锁之前超时