Class Lock

鎖定

互斥鎖的表示法。

這個類別可讓指令碼確保一次只有一個指令碼執行個體執行特定程式碼區段。這對於回呼和觸發程序特別有用，因為使用者動作可能會導致共用資源發生變化，而您想確保不會發生衝突。

以下範例說明如何在表單提交處理常式中使用鎖定。 

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

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

  const scriptProperties = PropertiesService.getScriptProperties();

  const ticketNumber =
      Number(scriptProperties.getProperty('lastTicketNumber')) + 1;
  scriptProperties.setProperty('lastTicketNumber', ticketNumber);

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

  targetCell.setValue(ticketNumber);
}
 如果沒有 Lock 服務，假設兩位使用者大約在同一時間提交表單，票號可能會相同，因為 lastTicketNumber 屬性可能會在從 ScriptProperties 讀取後變更，但新值尚未寫回。

方法

方法傳回類型簡短說明
hasLock()Boolean如果已取得鎖定，則傳回 true。
releaseLock()void釋放鎖定，允許等待鎖定的其他程序繼續執行。
tryLock(timeoutInMillis)Boolean嘗試取得鎖定，並在提供的毫秒數後逾時。
waitLock(timeoutInMillis)void嘗試取得鎖定，在提供的毫秒數後逾時並發生例外狀況。

內容詳盡的說明文件

hasLock()

如果已取得鎖定，則傳回 true。如果從未呼叫 tryLock(timeoutInMillis) 或 waitLock(timeoutInMillis)、在擷取鎖定前逾時，或呼叫 releaseLock()，這個方法會傳回 false。

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

回攻員

Boolean：如果已取得鎖定，則為 true，否則為 false。

releaseLock()

釋放鎖定，允許等待鎖定的其他程序繼續執行。腳本終止時，鎖定會自動釋出，但為了提高效率，最好在不再需要獨占存取權時，立即釋出鎖定。如果尚未取得鎖定，這個方法就不會生效。

請注意，如果您使用試算表，應在釋放鎖定前呼叫 SpreadsheetApp.flush()，以便在您仍擁有專屬存取權時，將所有待處理的變更提交至試算表。

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

tryLock(timeoutInMillis)

嘗試取得鎖定，並在提供的毫秒數後逾時。如果已取得鎖定，這個方法就不會產生任何作用。 

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

參數

名稱類型說明
timeoutInMillisInteger等待取得鎖定的時間長度 (以毫秒為單位)。

回攻員

Boolean：如果已取得鎖定，則為 true，否則為 false。

waitLock(timeoutInMillis)

嘗試取得鎖定，在提供的毫秒數後逾時並發生例外狀況。這個方法與 tryLock(timeoutInMillis) 相同，差別在於無法取得鎖定時會擲回例外狀況，而非傳回 false。

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

參數

名稱類型說明
timeoutInMillisInteger等待取得鎖定的時間長度 (以毫秒為單位)。

擲回

Error - 如果方法在取得鎖定前逾時