1、前言
测试验出一个bug,发现本来好好的业务,突然出错了。
排查日志发现,是在业务执行到一半的时候,关键字段的值被覆盖了,导致后面根据这个字段的查询结果出错了。
2、问题
返回查看代码,定位是多线程下引发的问题。两个业务同时进行,走的同一段代码,又没有加锁等措施,发生了相互覆盖的现象。
Consumer
类有成员变量name
,对外提供一个方法,将传入的参数赋值给name
。name
会在多个方法里使用到。下面是简化版本代码:
public class Consumer {
private String name;
public void printName(String param) {
name = param;
try {
// 模拟业务耗时
Thread.sleep(5);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
if (!name.equals(param)) {
System.out.println("内容不一致,已被覆盖!name:" + name + ", param:" + param);
}
}
}
在另外一个类中将Consumer
置为静态成员变量,然后在多线程下使用。
public class Main {
private static final Consumer consumer = new Consumer();
public static void main(String[] args) {
for (int i = 0; i < 100; i++) {
int finalI = i;
new Thread(() -> {
consumer.printName(finalI + "");
}).start();
}
}
}
执行结果:
内容不一致,已被覆盖!name:55, param:33
内容不一致,已被覆盖!name:55, param:34
内容不一致,已被覆盖!name:55, param:40
内容不一致,已被覆盖!name:61, param:52
内容不一致,已被覆盖!name:55, param:41
内容不一致,已被覆盖!name:55, param:4
内容不一致,已被覆盖!name:54, param:10
内容不一致,已被覆盖!name:55, param:39
...
问题出现在,在Main
类中Consumer
类是成员变量,多个线程共享同一个Consumer
实例的name
属性,在没有同步机制的情况下对它进行修改,导致了线程安全问题。
3、解决
3.1 局部变量
最简单的方法,将Consumer
放入多线程内,每个线程有自己的Consumer
实例,这样就不会有问题。
public class Main {
public static void main(String[] args) {
for (int i = 0; i < 100; i++) {
int finalI = i;
new Thread(() -> {
Consumer consumer = new Consumer();
consumer.printName(finalI + "");
}).start();
}
}
}
3.2 synchronized
当printName
方法被标记为synchronized
时,它会锁定Consumer
类的当前实例,这保证了在任何时候只有一个线程能够执行这个方法。
public class Consumer {
private String name;
public synchronized void printName(String param) {
name = param;
try {
Thread.sleep(500);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
if (!name.equals(param)) {
System.out.println("内容不一致,已被覆盖!name:" + name + ", param:" + param);
}
}
}
3.3 ReentrantLock
使用ReentrantLock
可以尝试获取锁再执行业务。
public class Consumer {
private final Lock lock = new ReentrantLock();
private String name;
public void printName(String param) {
lock.lock();
try {
name = param;
Thread.sleep(5);
if (!name.equals(param)) {
System.out.println("内容不一致,已被覆盖!name:" + name + ", param:" + param);
}
} catch (InterruptedException e) {
throw new RuntimeException(e);
} finally {
lock.unlock();
}
}
}
3.4 ThreadLocal
ThreadLocal
确保每个线程访问的是自己独立的String
副本,因此避免了线程间的数据共享与竞争。每个线程在调用printName
方法时都会在其本地线程存储中设置一个新的name
值。
public class Consumer {
private ThreadLocal<String> name = new ThreadLocal<>();
public void printName(String param) {
// 在当前线程内设置name的值
name.set(param);
try {
Thread.sleep(5);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
// 只会得到当前线程设置的name值,其他线程对其的更改不会影响到这里
if (!name.get().equals(param)) {
System.out.println("name:" + name.get() + ", param:" + param);
}
}
}
4、小结
此次问题出现在多个线程共享一个示例,而name
字段是实例字段而非线程局部变量。因此,在没有适当的同步措施的情况下,这种情况下会有线程安全问题,破坏业务逻辑的正确性。