在 Eclipse 中自动生成 toString 方法的快捷方式是什么？

Question

为一些简单的类自动生成 toString 方法是好还是坏？

我正在考虑生成如下所示的内容，它采用变量名称并生成一个 toString 方法，该方法打印名称后跟它的值。

private String name;
private int age;
private double height;

public String toString(){
   return String.format("Name: %s Age: %d Height %f", name, age, height);
}

Answer 1

考虑到包括@Steve 在内的一些旧答案，我想根据最新库添加答案。

添加依赖

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.10</version>
        </dependency>

在你的课堂上

import org.apache.commons.lang3.builder.ReflectionToStringBuilder;

public class User {
     ... 

     @Override
     public String toString() {
          return ReflectionToStringBuilder.toString(this);
     }
}

您可以排除某些字段，如下所示

    ... 
    @Override
    public String toString() {
        return ReflectionToStringBuilder.toStringExclude(this, "name"); // Name will be excluded from toString output 
    }

Answer 2

添加到史蒂夫和唐的答案（为他们+1）：

让您的toString() 方法简单，确保它永远不会触发期望（尤其要注意可能为空的字段）。

如果可能，请不要调用您班级的其他方法。至少，请确保您的 toString() 方法不会修改您的对象。

并注意愚蠢的异常toString循环：

public class MyClass { 
       ... 
       public String toString() { 
          // BAD PRACTICE 1: this can throw NPE - just use field1
            return " field1=" + field1.toString() 
                + " extraData=" + getExtraData();
          // BAD PRACTICE 2: potential exception-toString loop
       }

       public MyExtraData getExtraData() {
           try { 
           .... do something
           } catch(Exception e) {
              throw new RuntimeException("error getting extradata - " + this.toString(),e);
           }

       }

}

Answer 3

在 IntelliJ Idea 中，您可以按 alt+insert，将打开 Generate 弹出窗口；现在选择字段并单击 OK 按钮；就是这样。

进一步提示：在 Generate toString 对话框中，您可以通过单击模板组合框上的下拉菜单来选择模板。如果需要，您可以在此处选择 StringBuffer 或根据需要选择任何其他模板。玩它来习惯。我喜欢它:)

Answer 4

刚刚注意到 -在 NetBeans IDE 中，您可以通过选择要为 right click->insert code 生成它的字段来生成 toString() 方法，或者使用快捷方式 ALT+INSERT 然后选择 toString()。

看起来是这样的：

@Override
public String toString() {
    return "ClassName{"+"fieldName="+fieldName+'}';
}

它是调试的好方法，不需要额外的库。

Answer 5

---

生成 toString() 方法的快捷方式

---

1. 按 Alt + Shift + S + S（双键）
2. 右键 -> Source -> Generate toString() ...
3. 转到 源菜单 -> 生成 toString() ...
4. 转到 Windows 菜单 -> 首选项 -> 常规 -> 键（在文本字段上写入 Generate toString）

Answer 6

如果您使用lombok，他们有一个@ToString 注释，它将为您生成toString。

使用这种方法比使用 eclipse 生成 toString 要好得多的原因是，如果您以后添加、删除或更改类的属性，您还必须重新生成 toString。如果您使用lombok，则不必这样做。

Answer 7

添加 toString() 时要明确生成文本的受众。一些框架使用 toString() 方法来生成最终用户可见文本（例如某些 Web 框架），而许多人使用 toString() 方法来生成调试/开发人员信息。无论哪种方式，请确保您在 toString 实现中具有足够的唯一性以满足您的要求。

toString() 的默认 JDK 实现会生成开发人员信息，所以如果可能的话，这通常是我推荐的模式，但如果您正在处理一个具有不同想法/期望的项目，您可能会感到困惑......

Answer 8

Eclipse 3.5.2（可能还有更早的版本）已经提供了这个特性。如果您在编辑器中右键单击，您会在 Source -> Generate toString()... 下找到它。

要回答您关于自动生成 toString() 是否是一种不好的做法的问题，我认为不是。如果生成的代码与您自己编写的代码非常相似，那何必费心把它打出来呢？

Answer 9

我个人喜欢为所有对象实现一个 toString 方法，因为它有助于调试。

我会考虑使用 Apache Commons ToStringBuilder。

您可以使用反射实现一个简单的 toString 方法，如下所示：

public String toString() {
   return ToStringBuilder.reflectionToString(this);
}

使用此方法，如果/当添加字段时，您将不必更新 toString 方法。