toString() 生成器:格式模板

简单机制将使用格式模板,它们允许您更改所生成方法的输出字符串的格式:开头、结尾和分隔符等等。它们看起来与 JDT 代码模板相似,但是它们不会直接影响所生成的代码(对所生成的代码使用代码样式)。下面是可用模板变量的列表:

${object.className}将类名作为一个简单字符串插入
${object.getClassName}插入对 this.getClass.getName() 的调用
${object.superToString}插入对 super.toString() 的调用
${object.hashCode}插入对 this.hashCode() 的调用
${object.identityHashCode}插入对 System.identityHashCode(this) 的调用
${member.name}插入第一个成员的名称
${member.name()}插入第一个成员的名称,如果是方法,后面紧接着还要添加一对圆括号
${member.value}插入第一个成员的值
${otherMembers}插入其余成员。对于每个成员,将对第一个 ${member.*} 变量与最后一个 ${member.*} 变量之间的模板片段进行求值并且追加至结果。最后一个 ${member.*} 与 ${otherMembers} 之间的字符用于定义在成员之间插入的分隔符(${otherMembers} 必须位于最后一个 ${member.*} 变量后面)。

为了使模板正常工作,${otherMembers} 变量在模板中必须仅使用一次,并且其后面不能存在任何 ${member.*} 变量。${object.*} 变量可以位于模板中的任意位置;但是,如果此变量位于一个与成员相关的片段中(即,位于第一个 ${member.*} 变量与 ${otherMembers} 之间),那么它将重复出现在每个成员中,这可能不是一种合理的解决方案。

以上描述可能看起来比较复杂,但是模板格式本身非常容易使用。在查看一些有用的示例之后,一切都明白了。

模板示例

  1. 缺省模板就是一个很好的示例:

    ${class.name} [${member.name()}=${member.value}, ${otherMembers}]

    此模板的输出字符串与以下内容类似:

    FooClass[aFloat=1.0, aString=hello, anInt=10, anObject=null, aCharMethod()=a]
  2. 还可以提供多行输出形式:

    ${object.getClassName} {
    	${member.name}: ${member.value}
    	${otherMembers}
    }

    示例结果:

    FooClass {
    	aFloat: 1.0
    	aString: hello
    	anInt: 10
    	anObject: null
    	aCharMethod: a
    }
  3. 如果您将一个成员用花括号括起来,那么不要忘记将 ${otherMembers} 变量也用花括号括起来:

    {${member.name}=${member.value}},
    {${otherMembers}}

    下面是获得的结果:

    {aFloat=1.0},
    {aString=hello},
    {anInt=10},
    {anObject=null},
    {aCharMethod=a}
  4. 可以在模板开头和末尾使用 ${object.*} 变量:

    ${object.getClassName} (hashcode:${object.hashCode})
    	members: ${member.name} = ${member.value}; ${otherMembers}
    [super: ${object.superToString}]

    此模板产生的输出将类似于以下内容:

    FooClass (hashCode:232198409832)
    	members: aFloat = 1.0; aString = hello; anInt = 10; anObject = null; aCharMethod = a
    [super: SuperFooClass[aField=null]]

相关参考

“生成 toString()”对话框
toString() 生成器:代码样式
toString() 生成器:内容列示