Java toString方法重写工具之ToStringBuilder案例详解

 更新时间:2021年08月26日 10:24:33   作者:vince_zw  
这篇文章主要介绍了Java toString方法重写工具之ToStringBuilder案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下

apache的commons-lang3的工具包里有一个ToStringBuilder类,这样在打日志的时候可以方便的打印出类实例中的各属性的值。

具体用法如下:

import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
 
public class Message {
 
	private String from;
 
	private String to;
 
	private String body;
 
	public String getFrom() {
		return from;
	}
 
	public void setFrom(String from) {
		this.from = from;
	}
 
	public String getTo() {
		return to;
	}
 
	public void setTo(String to) {
		this.to = to;
	}
 
	public String getBody() {
		return body;
	}
 
	public void setBody(String body) {
		this.body = body;
	}
 
	@Override
	public String toString() {
		return ToStringBuilder.reflectionToString(this, ToStringStyle.MULTI_LINE_STYLE);
	}
	
	public static void main(String[] args) {
		Message msg = new Message();
		msg.setFrom("vince");
		msg.setTo("mike");
		msg.setBody("hello");
		System.out.println(msg.toString());
	}
}

而且支持多种打印格式

多行输出的:

com.vince.im.dto.Message@af72d8[
from=vince
to=mike
body=hello
]

默认一行的:

com.vince.im.dto.Message@af72d8[from=vince,to=mike,body=hello]

NO_FIELD_NAMES_STYLE:

com.vince.im.dto.Message@af72d8[vince,mike,hello]

SHORT_PREFIX_STYLE:

Message[from=vince,to=mike,body=hello]

SIMPLE_STYLE:

vince,mike,hello

原理其实就是通过JAVA的reflect(反射)获取值,然后组成一个Buffer。

里面部分源码:

    /**
     * <p>Append to the <code>toString</code> the start of data indicator.</p>
     * 拼装结果的
     * @param buffer  the <code>StringBuffer</code> to populate
     * @param object  the <code>Object</code> to build a <code>toString</code> for
     */
    public void appendStart(final StringBuffer buffer, final Object object) {
        if (object != null) {
            appendClassName(buffer, object);
            appendIdentityHashCode(buffer, object);
            appendContentStart(buffer);
            if (fieldSeparatorAtStart) {
                appendFieldSeparator(buffer);
            }
        }
    }
 
    /**
     * <p>Append the {@link System#identityHashCode(java.lang.Object)}.</p>
     * 拼装对象hashcode
     * @param buffer  the <code>StringBuffer</code> to populate
     * @param object  the <code>Object</code> whose id to output
     */
    protected void appendIdentityHashCode(final StringBuffer buffer, final Object object) {
        if (this.isUseIdentityHashCode() && object!=null) {
            register(object);
            buffer.append('@');
            buffer.append(Integer.toHexString(System.identityHashCode(object)));
        }
    }

需要注意的是:

Builds a toString value using the default ToStringStyle through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.

Transient members will be not be included, as they are likely derived. Static fields will not be included. Superclass fields will be appended.

也就是说transient和static修饰的属性不能打印出来,但是父类的是可以打印出来的,使用的时候一定要注意了。

到此这篇关于Java toString方法重写工具之ToStringBuilder案例详解的文章就介绍到这了,更多相关Java toString方法重写工具之ToStringBuilder内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java实现的计算稀疏矩阵余弦相似度示例

    Java实现的计算稀疏矩阵余弦相似度示例

    这篇文章主要介绍了Java实现的计算稀疏矩阵余弦相似度功能,涉及java基于HashMap的数值计算相关操作技巧,需要的朋友可以参考下
    2018-07-07
  • Java实现级联下拉结构的示例代码

    Java实现级联下拉结构的示例代码

    在开发过程中,会遇到很多的实体需要将查出的数据处理为下拉或者级联下拉的结构,提供给前端进行展示。本文为大家介绍了java封装下拉和级联下拉的通用工具类,需要的可以参考一下
    2022-06-06
  • Spring根据XML配置文件注入属性的方法

    Spring根据XML配置文件注入属性的方法

    下面小编就为大家带来一篇Spring根据XML配置文件注入属性的方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-11-11
  • Java中定义Logger的三种常用方式介绍

    Java中定义Logger的三种常用方式介绍

    在 Java 开发中,日志记录是不可或缺的一部分,它帮助我们跟踪程序的运行状态、调试问题以及记录重要信息本文将详细介绍 Java 中定义 Logger 的三种方式,大家可以根据需求进行选择
    2025-03-03
  • spring boot打jar包发布的方法

    spring boot打jar包发布的方法

    这篇文章主要介绍了spring boot打jar包发布的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • Java面向对象之单例设计模式详解

    Java面向对象之单例设计模式详解

    这篇文章主要介绍了Java面向对象之单例设计模式详解,所谓类的单例设计模式,就是采取一定的方法保证在整个的软件系统中,对某个类只能存在一个对象实例,并且该类只提供一个取得其对象实例的方法,需要的朋友可以参考下
    2024-01-01
  • VSCode搭建Java开发环境的超详细步骤

    VSCode搭建Java开发环境的超详细步骤

    VSCode是一款多平台的源代码编辑器,支持多种编程语言,它轻量级、功能强大,通过丰富的插件生态系统可以支持更多语言和运行时,如C++、C#、Java、Python等,这篇文章主要介绍了VSCode搭建Java开发环境的超详细步骤,需要的朋友可以参考下
    2024-10-10
  • java selenium操作弹出对话框示例讲解

    java selenium操作弹出对话框示例讲解

    本文主要介绍java selenium操作弹出对话框,这里给大家整理了相关资料,并附示例代码和实现效果图,有兴趣的小伙伴可以参考下
    2016-08-08
  • 详解Spring框架---IOC装配Bean

    详解Spring框架---IOC装配Bean

    本篇文章主要介绍了详解Spring框架---IOC装配Bean,提供了三种方式实例化Bean,具有一定的参考价值,有兴趣的可以了解一下。
    2017-03-03
  • Spring实现HikariCP连接池的示例代码

    Spring实现HikariCP连接池的示例代码

    在SpringBoot 2.0中,我们使用默认连接池是HikariCP,本文讲一下HikariCP的具体使用,具有一定的参考价值,感兴趣的可以了解一下
    2021-08-08

最新评论