在方法中返回一个文档

Question

当在方法中返回一个对象（如Document）并且创建不是implements AutoCloseable 时，我经常看到在第一行声明对象并在最后返回它：

public Document myMethod() {
 Document document = null
 try {
    document  = docFactory.newDocumentBuilder().newDocument();
    //...work on document 
 } catch(Exception e) {
   // Handle Exception
 }
 return document;
}

似乎下面的规则总是正确的，在try子句中创建并返回（并且可以将这段代码提取到方法中）

public Document myMethod() {

 try {
    Document document  = docFactory.newDocumentBuilder().newDocument();
    //...work on document
    return document;
 } catch(Exception e) {
    // Handle Exception
 }
 return null;
}

我错过了什么吗？ （您可以将null 可以是默认值但不那么重要的情况联系起来）

Answer 1

除了第二个代码块有一个catch(Exception e) 子句之外，它们实际上是等效的。

对于这段代码，是否愿意是一个偏好问题

• 在try块外初始化变量为null，并在最后返回对象
• 在try块内声明变量，最后返回null

如果您想在 try 块外对 Object o 进行操作，那么您需要在块外初始化变量，使其具有适当的作用域并可用。

一些编码人员遵守约定，他们尝试每个方法只有 1 个返回语句。 （我不是其中之一）。

对于您的要求，这似乎是个人喜好问题。

Answer 2

在方法的末尾只有一个 return 语句曾经被教导为提高可读性的风格指南。或许只是出于习惯，在从事没有既定风格的项目时，我仍然偏爱它。

然而，唯一真正发挥作用的情况是长而复杂的方法，无论如何都应该分解。

鉴于良好的编码实践（例如，测试适当的单元测试覆盖率，以便您知道在任何相关条件下返回正确的东西，包括异常），这实际上只是团队/项目偏好的问题。

Answer 3

这里的大多数答案/cmets 表明这两种方法之间没有真正的区别，并且它们在功能上是相同的，这只是一个偏好问题。

这不是真的，有一个非常重要的功能区别。如果//...work on document 发生异常，第一个解决方案将返回一个未完成或可能损坏的文档（除非// Handle Exception 块中的return null;），而第二个选项将返回null。

因此，我建议使用选项 2)，因为它降低了从您可能不会立即注意到的方法返回的损坏文档的风险，并可能导致其他地方出现问题，而返回 null 则明确表明你的方法出了点问题。