记录一段 Object wait()、notifyAll() 方法不当使用的经历

本文来源于实际项目。

项目需求：某段逻辑需要过滤注册用户，而每时每刻都可能会有新的注册用户加入进来。注册用户的存在与否是通过查询数据库表中是否存在记录判断的。由于不希望频繁的读数据库表，所以考虑定时从数据库加载一份用户列表到内存里，这样可以减少读库的次数并且可以提高查询的效率。

 

过滤用户逻辑代码简单抽象成下面的测试代码。

package test.java;

import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

public class UserFilter implements Runnable {
	private static IUserDAO dao = ServiceFactory.getUserDao(); 
	public static Map<String, String> userIDMap = new HashMap<String, String>();
	
	public static void start() {
		// 将数据库表中的用户数据加载到内存（以HashMap存放）
		// 赋值userIDMap
		userIDMap = dao.queryAllUsers();
		synchronized(userIDMap) {
			// 已经赋值，唤醒所有处于等待状态的线程
			userIDMap.notifyAll();
		}
	}
	
	public static boolean isValidUser(String key) {
		synchronized(userIDMap) {
			if (userIDMap.size() == 0) {
				try {
					// 等待主线程调用start()方法对userIDMap赋值 
					userIDMap.wait();
				} catch (InterruptedException e) {
					e.printStackTrace();
				}
			}
			return userIDMap.containsKey(key);
		}
	}
	
	@Override
	public void run() {
		if (isValidUser("test")) {
			System.out.println("this is a valid user.");
		}
	}
	
	public static void main(String[] args) {
		// 主线程调用start方法
		start();
		ExecutorService exec = Executors.newCachedThreadPool();
		// 使用线程池创建10个线程
		for (int i = 0; i < 10; i++) {
			exec.execute(new UserFilter());
		}
	}
}

 

这段代码希望完成的事情如下：

1. 使用全局变量userIDMap,它是一个HashMap类型的变量。希望通过调用map.containsKey(String)方法判断用户是否为合法用户。
2. 主线程调用start()方法，将所有用户列表从数据库里加载到内存里，并赋值给userIDMap。
3. 用线程池创建10个UserFilter任务，UserFilter任务只做一件事情，即通过调用isValidUser(String)方法检查用户是否是合法用户
4. isValidUser方法实现时会调用userIDMap.containsKey(String)方法，如果返回true，即userIDMap里存在相应的用户，表示用户合法。
5. 在调用userIDMap.containsKey(String)方法之前需要保证userIDMap里已经存放了数据库中的所有用户列表。为此考虑使用java.lang.Object.wait()和java.lang.Object.notifyAll()方法。
6. 在isValidUser方法开始处判断userIDMap中是否有值（if userIDMap.size()==0），如果userIDMap还是空的，则调用wait方法，让线程等待。
7. 在start()方法中，将通过数据库dao调用查询接口返回的map赋值给userIDMap。之后调用notifyAll()方法唤醒所有等待的线程。

但是，测试发现，所有线程进入等待状态后都不能被正常唤醒。能看出问题出在哪儿么？

---------------------------------------------------------------------------------------------

在上面的代码中，我使用userIDMap作为调用wait()和notifyAll()方法的Object对象，并且调用放在了两个synchronized(userIDMap) 块中。

 

来看下wait()和notifyAll()方法的具体用法（下面是根据jdk中的方法注释概括出来的）

在某个线程方法中对wait()和notifyAll()的调用必须指定一个Object对象，而且该线程必须拥有该Object对象的monitor。最简单的获取到对象monitor的办法是，在对象上使用synchronized关键字。当调用wait()方法后，当前线程会释放掉对象锁，并进入sleep状态。其他线程在调用notifyAll()方法时必须使用同一个Object对象，notifyAll()方法成功调用后，所有在同一Obejct对象上等待的线程被唤醒。

 

这里有个很关键的点，即两个方法在不同线程里被调用时必须作用在同一个对象上。

 

然后再仔细看下上面代码中start()方法是怎么写的。

public static void start() {
		// 将数据库表中的用户数据加载到内存（以HashMap存放）
		// 赋值userIDMap
		userIDMap = dao.queryAllUsers();
		synchronized(userIDMap) {
			// 已经赋值，唤醒所有处于等待状态的线程
			userIDMap.notifyAll();
		}
	}

 

是的，userIDMap被赋值了！导致下面的synchronized作用到另一个对象上面，即使该对象现在也叫userIDMap。这里的本意是想将查询得到的用户列表放入全局维护的userIDMap中，通过赋值虽然可以实现这个需求，但却让usreIDMap引用了一个全新的对象。从这个上下文看，为了保证userIDMap引用同一个对象，需要考虑其他的途径。

 

那么，如何将一个Map的值复制到另一个Map？我最初想到了下面两种方式：

1. 直接使用赋值语句。会使得左侧变量引用新的对象。
2. 使用 Map.clear() 方法清除 map中的数据，然后 Map.putAll(Map)

很遗憾一开始使用了“简洁”一点的赋值操作，导致花了很长时间排查bug。

 

最后对代码做如下修改，问题解决：

public static void start() {
		// 修改后的userIDMap“赋值”方式
		userIDMap.clear();
		userIDMap.putAll(userIDMap);
		// userIDMap = dao.queryAllUsers();
		synchronized(userIDMap) {
			// 已经赋值，唤醒所有处于等待状态的线程
			userIDMap.notifyAll();
		}
	}