JAVA文件锁之保证仅有一个实例运行

思路

在实际项目开发中，要求一台主机上同时只能运行一个程序示例的情况并不少见，而这样的程序基本都是使用C/C++等语言开发

作为毕业后不久就一直使用JAVA开发的我来讲，最近就遇到了一台主机上同时只能运行一个JAVA实例（Runable JAR）的问题

JAVA不像C/C++等其他编译型语言，程序运行后可以通过进程名来区分是否已经有示例正在运行，JAVA程序（不论Runable JAR还是Web Container）运行后，其进程名都是java/java.exe，只能通过JAVA进程的args来区分

如何通过一种简单的方法保证一台主机上同时只运行一个Runable JAR实例，经过一些百度Google之后，最终选定文件锁的方案，基本思路如下

Created with Raphaël 2.1.0程序启动锁文件是否存在?获取文件锁是否能获取到锁?程序正常流程退出创建锁文件yesnoyesno

程序实现

程序实现如下

获取文件锁

/**
* <p>
* <b>文件锁</b>
* <p>
* <pre>
* 文件锁，起到只能有一个实例运行的效果
* 使用 getLock，若为null则锁失败，反之锁成功
* 锁失败，则有可能已有程序对此文件加独占锁，既已有程序正在运行
* </pre>
*
* @author  ManerFan 2015年6月10日
*/
public class InstanceLock {

private RandomAccessFile rf;
private FileLock lock;

public InstanceLock(File file) {
try {
if (null == file) {
return;
}

if (!file.exists()) {
file.createNewFile();
}

if (!file.isFile()) {
return;
}

rf = new RandomAccessFile(file, "rws");
FileChannel channel = rf.getChannel();
lock = channel.tryLock(0, Long.MAX_VALUE, false);
} catch (IOException e) {
e.printStackTrace();
return;
}
}

public void release() {
if (null != rf) {
try {
rf.close();
} catch (IOException e) {
e.printStackTrace();
}
}

if (null != lock) {
try {
lock.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}

public FileLock getLock() {
return lock;
}
}

实际使用

在程序启动的地方监测是否已有实例在运行

/**
* 判断是否已经有实例启动
*/

final InstanceLock lock = new InstanceLock(new File(ExePath, "lock"));

if (null == lock.getLock()) {
LOGGER.warn("Already Run.");
System.exit(1);
}

在程序退出的地方释放文件锁

new ShutdownHook() {
@Override
public void release() {
/* 释放文件锁资源 */
lock.release();
}
}.register();