Property Detail

• static Object constraints

• String key

  锁名：唯一标识符

• Date lockTime

  创建时间

• String lockUser

  属主用户名

• Long lockUserId

  属主：用户ID，或者为0（锁和用户无关的情况）

• static Object mapping

• Integer timeout

  失效时间间隔

• Date timeoutTime

  失效时间

• Date updateTime

  更新时间

• String updateUser

  更新用户名

Method Detail

• @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static Map getLocker(String key)

  获得锁的详细信息

  Returns:

  如果锁存在，则返回锁的详细信息，Map 的键名同 Locker 的属性名；否则返回 null。

• @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static boolean isLocked(String key, boolean userAware = true)

  判断是否被加锁

  Returns:

  true/false

  Parameters:

  key

  userAware - 如果为真，则被其他用户加锁返回true，如果是被自己加锁，则返回false

• @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static boolean lock(String key, boolean userAware = true, Integer timeout = null, Integer waitTime = 0, Integer waitInterval = 200)

  加锁

  Returns:

  true则表示成功，false表示失败

  Parameters:

  key - 锁名，每把锁的唯一关键字

  userAware -

  是否和用户关联，默认为真。
      true: 如果用户之前已加锁，则更新时间戳后返回true；如果其他用户加锁，则返回false或等待；
      false: 只要和锁名匹配的锁存在，则返回false或等待。

  timeout - 失效时间（毫秒），默认为30分钟，如果为null也等于采用默认时间

  waitTime -

  等待时间（毫秒），如果发现已加锁，是否等待解锁。
      默认为0即不等待；如果为大于0的整数，则最多等待该时间后返回；
      如果为负数，则一直等待：注意不要发生死锁，包括数据库链接此时也不会被释放的！

  waitInterval - 等待过程中，轮询的时间间隔，单位为毫秒，默认为200ms

• @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static boolean lockExit(String key, boolean userAware = true, Integer timeout = null)

  加锁。如果发现已被其他用户加锁，则直接返回false，不等待。

  Parameters:

  key

• @CompileDynamic@groovy.transform.CompileDynamic static void test()

• String toString()

• @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static Integer unlock(String key, boolean userAware = true)

  解锁

  Returns:

  1=解锁成功或锁不存在；-1=锁已被其他人占用，解锁失败（仅限于userAware）

  Parameters:

  key - 锁名

  userAware - 注意要和lock时的参数保持一致，否则可能发生锁不会被删除（为 true 时）、或误删除其他人加的锁（为 false 时）的错误情况

• @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static Integer update(String key, boolean userAware = true, Integer timeout = null)

  更新锁的时间戳，包括updateTime、updateUser

  Returns:

  1=更新成功；0=锁不存在；-1=锁已被其他人占用，更新失败（仅限于userAware）

  Parameters:

  key - 锁名

  userAware - 注意要和lock时的参数保持一致，会返回-1

  timeout - 失效时间（毫秒），默认为null，即采用锁的原始失效时间设置

• @GrailsCompileStatic@grails.compiler.GrailsCompileStatic static boolean wait(String key, boolean userAware, Integer waitTime, Integer waitInterval = 200)

  等待锁被释放

  Returns:

  锁不存在或者在 waitTime 时间内被释放，则返回 true，否则返回 false