Java intern() 方法 以及 synchronized给对象加锁

本文介绍如何配合intern给对象来正确加锁,同时避免内存开销的.

Java intern() 方法

尽管在输出中调用intern方法并没有什么效果，但是实际上后台这个方法会做一系列的动作和操作。在调用”ab”.intern()方法的时候会返回”ab”，但是这个方法会首先检查字符串池中是否有”ab”这个字符串，如果存在则返回这个字符串的引用，否则就将这个字符串添加到字符串池中，然会返回这个字符串的引用。

可以看下面一个范例：

String str1 = "a";
String str2 = "b";
String str3 = "ab";
String str4 = str1 + str2;
String str5 = new String("ab");
 
System.out.println(str5.equals(str3));
System.out.println(str5 == str3);
System.out.println(str5.intern() == str3);
System.out.println(str5.intern() == str4);

得到的结果：

true
false
true
false

为什么会得到这样的一个结果呢？我们一步一步的分析。

第一、str5.equals(str3)这个结果为true，不用太多的解释，因为字符串的值的内容相同。
第二、str5 == str3对比的是引用的地址是否相同，由于str5采用new String方式定义的，所以地址引用一定不相等。所以结果为false。
第三、当str5调用intern的时候，会检查字符串池中是否含有该字符串。由于之前定义的str3已经进入字符串池中，所以会得到相同的引用。
第四，当str4 = str1 + str2后，str4的值也为”ab”，但是为什么这个结果会是false呢？先看下面代码：

String a = new String("ab");
String b = new String("ab");
String c = "ab";
String d = "a" + "b";
String e = "b";
String f = "a" + e;

System.out.println(b.intern() == a);
System.out.println(b.intern() == c);
System.out.println(b.intern() == d);
System.out.println(b.intern() == f);
System.out.println(b.intern() == a.intern());

运行结果：

false
true
true
false
true

由运行结果可以看出来，b.intern() == a和b.intern() == c可知，采用new 创建的字符串对象不进入字符串池，并且通过b.intern() == d和b.intern() == f可知，字符串相加的时候，都是静态字符串的结果会添加到字符串池，如果其中含有变量（如f中的e）则不会进入字符串池中。但是字符串一旦进入字符串池中，就会先查找池中有无此对象。如果有此对象，则让对象引用指向此对象。如果无此对象，则先创建此对象，再让对象引用指向此对象。

当研究到这个地方的时候，突然想起来经常遇到的一个比较经典的Java问题，就是对比equal和的区别，当时记得老师只是说“”判断的是“地址”，但是并没说清楚什么时候会有地址相等的情况。现在看来，在定义变量的时候赋值，如果赋值的是静态的字符串，就会执行进入字符串池的操作，如果池中含有该字符串，则返回引用。

执行下面的代码：

String a = "abc";
String b = "abc";
String c = "a" + "b" + "c";
String d = "a" + "bc";
String e = "ab" + "c";
        
System.out.println(a == b);
System.out.println(a == c);
System.out.println(a == d);
System.out.println(a == e);
System.out.println(c == d);
System.out.println(c == e);

运行的结果：

true
true
true
true
true
true

如何正确的使用intern

可以看下列文章在jdk7下慎用String.intern()作为synchronized的对象锁
文中推荐使用google-guava包来正确使用intern

Interner<String> pool = Interners.newWeakInterner();

synchronized ( pool.intern("BizCode"+userId)){

//TODO:something

}

API文档：https://guava.dev/releases/21.0/api/docs/com/google/common/collect/Interners.html

代码参考TEST类：https://chromium.googlesource.com/external/guava-libraries/+/release15/guava-tests/test/com/google/common/collect/InternersTest.java

为什么需要在对象锁时用intern

另外,Guava小工具之Interners提到的一个例子也是很有意思

public class InternsTest {
 
    public static void main(String[] args) {
        Interner<String> pool = Interners.newWeakInterner();
        for (int i = 0; i < 5; i++) {
            String lock=new String("lock");
            TestInterns testInterns = new TestInterns(pool,lock, i);
            Thread thread = new Thread(testInterns);
            thread.start();
        }
    }
}
 
class TestInterns implements Runnable {
    private String lock;
    private int out;
    private Interner<String> pool;
 
    public TestInterns(Interner<String> pool,String lock, int out) {
        this.lock = lock;
        this.out = out;
        this.pool=pool;
    }
 
    @Override
    public void run() {
        //重点感受下intern和无intern的区别
        //synchronized (lock.intern()) {
        synchronized (lock) {
            System.out.println("--"+out);
            System.out.println(out+lock);
            System.out.println();
        }
    }

intern和无intern的锁,会跑出不一样的结果.
将上边代码synchronized (lock) 换成synchronized (pool.intern(lock))也是可以起到加锁的作用的.

其主要结论如下:
String是final的，每次对它的操作都会产生新的String，这很大程度上是安全性的考虑，但是产生大量的String也是会有一些问题的，1.大量的String会对gc产生影响；2.两次 new String（“aa”）操作，产生的String不一样，如果用这两个去做synchronized（String）操作就达不到想要的效果，因为synchronized必须是对同一个对象进行加锁才有效果。

有两种办法可以让两次 new String（“aa”）的String指向同一对象：java的intern方法和guava Interners。

银行转账案例

银行转账案例请看文章How to Synchronize Blocks by the Value of the Object in Java .文中分析了如何给用户(例子中的用户是UUID类型)加锁,以及由此引发的内存开销.并通过WeakHashMap等创建了自己的框架,减少了内存开销,并很好的使用了锁机制.

---

参考原文:
[Java intern() 方法] https://www.runoob.com/java/java-string-intern.html
[JDK7里的String.intern的变化] http://www.chepoo.com/jdk7-string-intern-change.html
[在jdk7下慎用String.intern()作为synchronized的对象锁] https://www.cnblogs.com/yhlx/p/3498387.html
[Guava小工具之Interners] https://blog.csdn.net/qq_22912803/article/details/81260604
[How to Synchronize Blocks by the Value of the Object in Java ] https://dzone.com/articles/synchronized-by-the-value-of-the-object-in-java