lockfile

package

v0.8.0 Latest Latest Go to latest Published: May 17, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Package lockfile 提供项目级与全局级文件锁。

基于 flock(2) 实现，进程退出或文件关闭时内核自动释放锁，无残留问题。Linux 与 macOS 均支持。

// 项目级锁
lk, ok, err := lockfile.TryLockLocal()
if ok {
	defer lk.Close()
	// 持有锁，执行主逻辑
}

// 全局锁
lk, ok, err := lockfile.TryLockGlobal()

This section is empty.

This section is empty.

func PID(configDir string) int

PID 读取锁文件中记录的进程 PID。仅在锁未被持有时有意义（用于调试，判断谁持有了锁）。返回 0 表示无法读取（文件不存在或格式错误）。

type Lock struct {
	// contains filtered or unexported fields
}

Lock 表示一个排他文件锁。调用方在不再需要锁时必须调用 Close 释放。

func TryLockGlobal() (*Lock, bool, error)

TryLockGlobal 获取全局级排他锁。锁文件位于 ~/.dscli/locks/dscli.lock。

func TryLockLocal() (*Lock, bool, error)

TryLockLocal 获取项目级排他锁。使用 context.ProjectRoot 确定项目根目录，锁文件位于 <projectDir>/.dscli/locks/dscli.lock。

func (l *Lock) Close() error

Close 释放锁并关闭文件。