为什么匿名内部类访问局部变量必须是final?

一个谜团

如果你用过类似 guava 这种 “伪函数式编程” 风格的 library 的话,那下面这种风格的代码对你来说应该不陌生:

1
2
3
4
5
6
7
8
9
public void tryUsingGuava() {
final int expectedLength = 4;
Iterables.filter(Lists.newArrayList("123", "1234"), new Predicate<String>() {
@Override
public boolean apply(String str) {
return str.length() == expectedLength;
}
});
}

这段代码对一个字符串的 list 进行过滤,从中找出长度为 4 的字符串。看起来很是平常,没什么特别的。

但是,声明 expectedLength 时用的那个 final 看起来有点扎眼,把它去掉试试:

error: local variable expectedLength is accessed from within inner class; needs to be declared final

结果 Java 编译器给出了如上的错误,看起来匿名内部类只能够访问 final 的局部变量。但是,为什么呢?其他的语言也有类似的规定吗?

在开始用其他语言做实验之前我们先把问题简化一下,不要再带着 guava 了,我们去除掉噪音,把问题归结为:

为什么 Java 中的匿名内部类只可以访问 final 的局部变量呢?其他语言中的匿名函数也有类似的限制吗?

Scala 中有类似的规定吗?

1
2
3
4
5
6
7
8
9
10
11
12
def tryAccessingLocalVariable {
var number = 123
println(number)

var lambda = () => {
number = 456
println(number)
}

lambda.apply()
println(number)
}

|

上面的 Scala 代码是合法的,number 变量是声明为 var 的,不是 val(类似于 Java 中的 final)。而且在匿名函数中可以修改 number 的值。

看来 Scala 中没有类似的规定

C# 中有类似的规定吗?

1
2
3
4
5
6
7
8
9
10
11
12
13
public void tryUsingLambda ()
{
int number = 123;
Console.WriteLine (number);

Action action = () => {
number = 456;
Console.WriteLine (number);
};

action ();
Console.WriteLine (number);
}

这段 C# 代码也是合法的,number 这个局部变量在 lambda 表达式内外都可以访问和赋值。

看来 C# 中也没有类似的规定

分析谜团

三门语言中只有 Java 有这种限制,那我们分析一下吧。先来看一下 Java 中的匿名内部类是如何实现的:

先定义一个接口:

1
2
3
public interface MyInterface {
void doSomething();
}

然后创建这个接口的匿名子类:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
public class TryUsingAnonymousClass {
public void useMyInterface() {
final Integer number = 123;
System.out.println(number);

MyInterface myInterface = new MyInterface() {
@Override
public void doSomething() {
System.out.println(number);
}
};
myInterface.doSomething();

System.out.println(number);
}
}

这个匿名子类会被编译成一个单独的类,反编译的结果是这样的:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
class TryUsingAnonymousClass$1
implements MyInterface {
private final TryUsingAnonymousClass this$0;
private final Integer paramInteger;

TryUsingAnonymousClass$1(TryUsingAnonymousClass this$0, Integer paramInteger) {
this.this$0 = this$0;
this.paramInteger = paramInteger;
}

public void doSomething() {
System.out.println(this.paramInteger);
}
}

可以看到名为 number 的局部变量是作为构造方法的参数传入匿名内部类的(以上代码经过了手动修改,真实的反编译结果中有一些不可读的命名)。

如果 Java 允许匿名内部类访问非 final 的局部变量的话,那我们就可以在 TryUsingAnonymousClass$1 中修改 paramInteger,但是这不会对 number 的值有影响,因为它们是不同的 reference。

这就会造成数据不同步的问题。

所以,谜团解开了:Java 为了避免数据不同步的问题,做出了匿名内部类只可以访问 final 的局部变量的限制。

但是,新的谜团又出现了:

Scala 和 C# 为什么没有类似的限制呢?它们是如何处理数据同步问题的呢?

上面出现过的那段 Scala 代码中的 lambda 表达式会编译成这样:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public final class TryUsingAnonymousClassInScala$$anonfun$1 extends AbstractFunction0.mcV.sp
implements Serializable {
public static final long serialVersionUID = 0L;
private final IntRef number$2;

public final void apply() {
apply$mcV$sp();
}

public void apply$mcV$sp() {
this.number$2.elem = 456;
Predef..MODULE$.println(BoxesRunTime.boxToInteger(this.number$2.elem));
}

public TryUsingAnonymousClassInScala$$anonfun$1(TryUsingAnonymousClassInScala $outer, IntRef number$2) {
this.number$2 = number$2;
}
}

可以看到 number 也是通过构造方法的参数传入的,但是与 Java 的不同是这里的 number 不是直接传入的,是被 IntRef 包装了一层然后才传入的。对 number 的值修改也是通过包装类进行的:this.number$2.elem = 456;

这样就保证了 lambda 表达式内外访问到的是同一个对象。

再来看看 C# 的处理方式,反编译一下,发现 C# 编译器生成了如下的一个类:

1
2
3
4
5
6
7
8
9
10
private sealed class <tryUsingLambda>c__AnonStorey0
{
internal int number;

internal void <>m__0 ()
{
this.number = 456;
Console.WriteLine (this.number);
}
}

把 number 包装在这个类内,这样就保证了 lambda 表达式内外使用的都是同一个 number,即便重新赋值也可以保证内外部的数据是同步的。

小结

Scala 和 C# 的编译器通过把局部变量包装在另一个对象中,来实现 lambda 表达式内外的数据同步。

而 Java 的编译器由于未知的原因(怀疑是为了图省事儿?)没有做包装局部变量这件事儿,于是就只好强制用户把局部变量声明为 final 才能在匿名内部类中使用来避免数据不同步的问题。

多谢支持