(译文)Java中使用var声明局部变量指南

原文链接：Style Guidelines for Local Variable Type Inference in Java
Stuart W.Marks
2018-03-22

简介

Java SE 10引入了局部变量的类型推断。早先，所有的局部变量声明都要在左侧声明明确类型。使用类型推断，一些显式类型可以替换为具有初始化值的局部变量保留类型var，这种作为局部变量类型的var类型，是从初始化值的类型中推断出来的。

关于此功能存在一定的争议。有些人对它的简洁性表示欢迎，其他人则担心它剥夺了阅读者看重的类型信息，从而损害了代码的可读性。这两边观点都是对的。它可以通过消除冗余信息使代码更具有可读性，也可以通过删除有用的信息来降低代码的可读性。另外一个观点是担心它会被滥用，从而导致编写更糟糕的Java代码。这也是事实，但它也可能会导致编写更好的代码。像所有功能一样，使用它必须要判断。何时该使用，何时不该使用，没有一系列规则。

局部变量声明不是孤立存在的；周边的代码可以影响甚至压倒使用var的影响。本文档的目的是检查周边代码对var声明的影响，解释一些权衡，并提供有效使用var的指南。

使用原则

P1. 阅读代码比编写代码更重要

代码的读取频率远高于编写代码。此外，在编写代码时，我们通常要有整体思路，并且要花费时间；在阅读代码的时候，我们经常是上下文浏览，而且可能更加匆忙。是否以及如何使用特定语言功能应该取决于它对未来读者的影响，而不是它的作者。较短的程序可能比较长的程序更可取，但是过多地简写程序会省略对于理解程序有用的信息。这里的核心问题是为程序找到合适的大小，以便最大化程序的可读性。

我们在这里特别关注在输入或编写程序时所需要的码字量。虽然简洁性可能会是对作者的一个很好的鼓励，但专注于它会忽略主要的目标，即提高程序的可读性。

P2. 在经过局部变量类型推断后，代码应该变得清晰

读者应该能够查看var声明，并且使用局部变量声明的时候可以立刻了解代码里正在发生了什么事情。理想情况下，只通过代码片段或上下文就可以轻松理解代码。如果读懂一个var声明需要读者去查看代码周边的若干位置代码，此时使用var可能不是一个好的情况。而且，它还表明代码本身可能存在问题。

P3. 代码的可读性不应该依赖于IDE

代码通常在IDE中编写和读取，所以很容易依赖IDE的代码分析功能。对于类型声明，在任何地方使用var,都可以通过IDE指向一个变量来确定它的类型，但是为什么不这么做呢？

这里有两个原因。代码经常在IDE外部读取。代码出现在IDE设施不可用的许多地方，例如文档中的片段，浏览互联网上的仓库或补丁文件。为了理解这些代码的作用，你必须将代码导入IDE。这样做是适得其反的。

第二个原因是即使是在IDE中读取代码时也是如此，通常需要明确的操作来查询IDE以获取有关变量的更多信息。例如，查询使用var声明的变量类型，可能必须将鼠标悬停在变量上并等待弹出信息，这可能只需要片刻时间，但是它会扰乱阅读流程。

代码应该是自动呈现的，它的表面应该是可以理解的，并且无需工具的帮助。

P4. 显式类型是一种权衡

Java历来要求局部变量声明里要明确包含显式类型，显然显式类型可能非常有用，但它们有时候不是很重要，有时候还可以忽略。要求一个明确的类型可能还会混乱一些有用的信息。

省略显式类型可以减少这种混乱，但只有在这种混乱不会损害其可理解性的情况下。这种类型不是向读者传达信息的唯一方式。其他方法包括变量的名称和初始化表达式也可以传达信息。在确定是否可以将其中一个频道静音时，我们应该考虑所有可用的频道。

指南

G1. 选择能够提供有用信息的变量名称

通常这是一个好习惯，不过在var的背景下它更为重要。在一个var的声明中，可以使用变量的名称来传达有关变量含义和用法的信息。使用var替换显式类型的同时也要改进变量的名称。例如：

//原始写法
List<Customer> x = dbconn.executeQuery(query);

//改进写法
var custList = dbconn.executeQuery(query);

在这种情况下，无用的变量名x已被替换为一个能够唤起变量类型的名称custList，该名称现在隐含在var的声明中。根据方法的逻辑结果对变量的类型进行编码，得出了”匈牙利表示法”形式的变量名custList。就像显式类型一样，这样有时是有帮助的，有时候只是杂乱无章。在此示例中，名称custList表示正在返回List。这也可能不重要。和显式类型不同，变量的名称有时可以更好地表达变量的角色或性质，比如”customers”:

//原始写法    
try (Stream<Customer> result = dbconn.executeQuery(query)) {
     return result.map(...)
                  .filter(...)
                  .findAny();
 }
//改进写法
try (var customers = dbconn.executeQuery(query)) {
    return customers.map(...)
                    .filter(...)
                    .findAny();
}

G2.最小化局部变量的使用范围

最小化局部变量的范围通常也是一个好的习惯。这种做法在 Effective Java (第三版)，第57项中有所描述。如果你要使用var，它会是一个额外的助力。

在下面的例子中，add方法正确地将特殊项添加到list集合的最后一个元素，所以它按照预期最后处理。

var items = new ArrayList<Item>(...);
items.add(MUST_BE_PROCESSED_LAST);
for (var item : items) ...

现在假设为了删除重复的项目，程序员要修改此代码以使用HashSet而不是ArrayList：

var items = new HashSet<Item>(...);
items.add(MUST_BE_PROCESSED_LAST);
for (var item : items) ...

这段代码现在有个bug，因为Set没有定义迭代顺序。不过，程序员可能会立即修复这个bug，因为items变量的使用与其声明相邻。

现在假设这段代码是一个大方法的一部分，相应地items变量具有很大的使用范围：

var items = new HashSet<Item>(...);

// ... 100 lines of code ...

items.add(MUST_BE_PROCESSED_LAST);
for (var item : items) ...

将ArrayList更改为HashSet的影响不再明显，因为使用items的代码与声明items的代码离得很远。这意味着上面所说的bug似乎可以存活更长时间。

如果items已经明确声明为List，还需要更改初始化程序将类型更改为Set。这可能会提示程序员检查方法的其余部分是否存在受此类更改影响的代码。(问题来了，他也可能不会检查)。如果使用var会消除这类影响，不过也可能会增加在此类代码中引入错误的风险。

这似乎是反对使用var的论据，但实际上并非如此。使用var的初始化程序非常精简。仅当变量的使用范围很大时才会出现此问题。你应该更改代码来减少局部变量的使用范围，然后用var声明它们，而不是简单地避免在这些情况下使用var。

G3. 当初始化程序为读者提供足够的信息时，请考虑使用var

局部变量通常在构造函数中进行初始化。正在创建的构造函数名称通常与左侧显式声明的类型重复。如果类型名称很长，就可以使用var提升简洁性而不会丢失信息：

// 原始写法：
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
// 改进写法
var outputStream = new ByteArrayOutputStream();

在初始化程序是方法调用的情况下，使用var也是合理的，例如静态工厂方法，并且其名称包含足够的类型信息：

//原始写法
BufferedReader reader = Files.newBufferedReader(...);
List<String> stringList = List.of("a", "b", "c");
// 改进写法
var reader = Files.newBufferedReader(...);
var stringList = List.of("a", "b", "c");

在这些情况下，方法的名称强烈暗示其特定的返回类型，然后用于推断变量的类型。

G4. 使用var局部变量分解链式或嵌套表达式

考虑使用字符串集合并查找最常出现的字符串的代码，可能如下所示：

return strings.stream()
               .collect(groupingBy(s -> s, counting()))
               .entrySet()
               .stream()
               .max(Map.Entry.comparingByValue())
               .map(Map.Entry::getKey);

这段代码是正确的，但它可能令人困惑，因为它看起来像是一个单一的流管道。事实上，它先是一个短暂的流，接着是第一个流的结果生成的第二个流，然后是第二个流的可选结果映射后的流。表达此代码的最易读的方式是两个或三个语句；第一组实体放入一个Map,然后第二组过滤这个Map，第三组从Map结果中提取出Key，如下所示：

Map<String, Long> freqMap = strings.stream()
                                   .collect(groupingBy(s -> s, counting()));
Optional<Map.Entry<String, Long>> maxEntryOpt = freqMap.entrySet()
                                                       .stream()
                                                       .max(Map.Entry.comparingByValue());
return maxEntryOpt.map(Map.Entry::getKey);

但编写者可能会拒绝这样做，因为编写中间变量的类型似乎太过于繁琐，相反他们篡改了控制流程。使用var允许我们更自然地表达代码，而无需付出显式声明中间变量类型的高代价：

var freqMap = strings.stream()
                     .collect(groupingBy(s -> s, counting()));
var maxEntryOpt = freqMap.entrySet()
                         .stream()
                         .max(Map.Entry.comparingByValue());
return maxEntryOpt.map(Map.Entry::getKey);

有些人可能更倾向于第一段代码中单个长的链式调用。但是，在某些条件下，最好分解长的方法链。对这些情况使用var是一种可行的方法，而在第二个段中使用中间变量的完整声明会是一个不好的选择。和许多其他情况一样，正确使用var可能会涉及到扔掉一些东西（显示类型）和加入一些东西（更好的变量名称，更好的代码结构）。

G5. 不用过分担心”使用接口编程” 中局部变量的使用问题

Java编程中常见的习惯用法是构造具体类型的实例，但要将其分配给接口类型的变量。这将代码绑定到抽象上而不是具体实现上，为代码以后的维护保留了灵活性。

//原始写法, list类型为接口List类型
List<String> list = new ArrayList<>()

如果使用var,可以推断出list具体的实现类型ArrayList而不是接口类型List

// 推断出list的类型是 ArrayList<String>.
var list = new ArrayList<String>();

这里要再次重申一次，var只能用于局部变量。它不能用于推断属性类型，方法参数类型和方法返回类型。”使用接口编程”的原则在这些情况下仍然和以往一样重要。

主要问题是使用该变量的代码可以形成对具体实现的依赖性。如果变量的初始化程序以后要改变，这可能导致其推断类型发生变化，在使用该变量的后续代码中产生异常或bug。

如果，如指南G2中所建议的那样，局部变量的范围很小，可能影响后续代码的具体实现的”漏洞”是有限的。如果变量仅用于几行之外的代码，应该很容易避免这些问题或者缓解这些出现的问题。

在这种特殊情况下，ArrayList只包含一些不在List上的方法，如ensureCapacity()和trimToSize()。这些方法不会影响到List,所以调用他们不会影响程序的正确性。这进一步降低了推断类型作为具体实现类型而不是接口类型的影响。

G6. 使用带有<>和泛型方法的var时候要小心

var和<>功能允许您在可以从已存在的信息派生时，省略具体的类型信息。你能在同一个变量声明中使用它们吗？

考虑一下以下代码：

PriorityQueue<Item> itemQueue = new PriorityQueue<Item>();

这段代码可以使用var或<>重写，并且不会丢失类型信息:

// 正确：两个变量都可以声明为PriorityQueue<Item>类型
PriorityQueue<Item> itemQueue = new PriorityQueue<>();
var itemQueue = new PriorityQueue<Item>();

同时使用var和<>是合法的，但推断类型将会改变：

// 危险: 推断类型变成了 PriorityQueue<Object>
var itemQueue = new PriorityQueue<>();

从上面的推断结果来看，<>可以使用目标类型（通常在声明的左侧）或构造函数作为<>里的参数类型。如果两者都不存在，它会追溯到最宽泛的适用类型，通常是Object。这通常不是我们预期的结果。

泛型方法早已经提供了类型推断，使用泛型方法很少需要提供显式类型参数，如果是没有提供足够类型信息的实际方法参数，泛型方法的推断就会依赖于目标类型。在var声明中没有目标类型，所以也会出现类似的问题。例如：

// 危险: list推断为 List<Object>
var list = List.of();

使用<>和泛型方法，可以通过构造函数或方法的实际参数提供其他类型信息，允许推断出预期的类型，从而有：

// 正确: itemQueue 推断为 PriorityQueue<String>
Comparator<String> comp = ... ;
var itemQueue = new PriorityQueue<>(comp);

// 正确: infers 推断为 List<BigInteger>
var list = List.of(BigInteger.ZERO);

如果你想要将var与<>或泛型方法一起使用，你应该确保方法或构造函数参数能够提供足够的类型信息，以便推断的类型与你想要的类型匹配。否则，请避免在同一声明中同时使用var和<>或泛型方法。

G7.使用基本类型的var要小心

基本类型可以使用var声明进行初始化。在这些情况下使用var不太可能提供很多优势，因为类型名称通常很短。不过，var有时候也很有用，例如，可以使变量的名称对齐。

boolean,character,long,string的基本类型使用var没有问题，这些类型的推断是精确的，因为var的含义是明确的

// 原始做法
boolean ready = true;
char ch = '\ufffd';
long sum = 0L;
String label = "wombat";

// 改进做法
var ready = true;
var ch    = '\ufffd';
var sum   = 0L;
var label = "wombat";

当初始值是数字时，应该特别小心，特别是int类型。如果左侧有显示类型，那么右侧会通过向上或向下转型将int数值默默转为左边对应的类型。如果左边使用var，那么右边的值会被推断为int类型。这可能是无意的。

// 原始做法
byte flags = 0;
short mask = 0x7fff;
long base = 17;

// 危险: 所有的变量类型都是int
var flags = 0;
var mask = 0x7fff;
var base = 17;

如果初始值是浮点型，推断的类型大多是明确的：

// 原始做法
float f = 1.0f;
double d = 2.0;

// 改进做法
var f = 1.0f;
var d = 2.0;

注意，float类型可以默默向上转型为double类型。使用显式的float变量（如3.0f）为double变量做初始化会有点迟钝。不过，如果是使用var对double变量用float变量做初始化，要注意：

// 原始做法
static final float INITIAL = 3.0f;
...
double temp = INITIAL;

// 危险: temp被推断为float类型了
var temp = INITIAL;

（实际上，这个例子违反了G3准则，因为初始化程序里没有提供足够的类型信息能让读者明白其推断类型。）

示例

本节包含一些示例，这些例子中使用var可以收到良好的效果。

下面这段代码表示的是根据最多匹配数max从一个Map中移除匹配的实体。通配符（?）类型边界可以提高方法的灵活性，但是长度会很长。不幸的是，这里Iterator的类型还被要求是一个嵌套的通配符类型，这样使它的声明更加的冗长，以至于for循环标题长度在一行里都放不下。也使代码更加的难懂。

// 原始做法
void removeMatches(Map<? extends String, ? extends Number> map, int max) {
    for (Iterator<? extends Map.Entry<? extends String, ? extends Number>> iterator =
             map.entrySet().iterator(); iterator.hasNext();) {
        Map.Entry<? extends String, ? extends Number> entry = iterator.next();
        if (max > 0 && matches(entry)) {
            iterator.remove();
            max--;
        }
    }
}

在这里使用var就可以删除掉局部变量一些干扰的类型声明。在这种循环中显式的类型Iterator,Map.Entry在很大程度上是没有必要的，
使用var声明就能够让for循环标题放在同一行。代码也更易懂。

// 改进做法
void removeMatches(Map<? extends String, ? extends Number> map, int max) {
    for (var iterator = map.entrySet().iterator(); iterator.hasNext();) {
        var entry = iterator.next();
        if (max > 0 && matches(entry)) {
            iterator.remove();
            max--;
        }
    }
}

考虑使用try-with-resources语句从Socket读取单行文本的代码。网络和IO类一般都是装饰类。在使用时，必须将每个中间对象声明为资源变量，以便在打开后续的装饰类的时候能够正确关闭这个资源。常规编写代码要求在变量左右声明重复的类名，这样会导致很多混乱：

// 原始做法
try (InputStream is = socket.getInputStream();
     InputStreamReader isr = new InputStreamReader(is, charsetName);
     BufferedReader buf = new BufferedReader(isr)) {
    return buf.readLine();
}

使用var声明会减少很多这种混乱：

// 改进做法
try (var inputStream = socket.getInputStream();
     var reader = new InputStreamReader(inputStream, charsetName);
     var bufReader = new BufferedReader(reader)) {
    return bufReader.readLine();
}

结语

使用var声明可以通过减少混乱来改善代码，从而让更重要的信息脱颖而出。另一方面，不加选择地使用var也会让事情变得更糟。使用得当，var有助于改善良好的代码，使其更短更清晰，同时又不影响可理解性。

参考

JEP 286: Local-Variable Type Inference
Wikipedia: Hungarian Notation
Bloch, Joshua. Effective Java, 3rd Edition. Addison-Wesley Professional, 2018.

原创文章，转载请注明： 转载自并发编程网 – ifeve.com本文链接地址: (译文)Java中使用var声明局部变量指南

并发编程网 - ifeve.com

让天下没有难学的技术