Java中的toString

20 11月

本文版权归作者所有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。

转载自夜明的孤行灯

本文链接地址: https://www.huangyunkun.com/2018/11/20/to-string-in-java/

Java中的Object包含一个toString方法,该方法默认实现是输出类名+hashcode,所以一般业务上都需要覆盖此方法实现。

toString大部分时候都不影响功能,很大程度上是用于日志输出的时候,比如

logger.info("user {} query keyword:{}", userId, searchParams)

覆写该方法是必要的,我们以一个简单的类为例

public class Hello   {
    private long id;
    private String message;
}

常见方法主要有以下几种:

使用StringBuilder

@Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("Hello{");
        sb.append("id=").append(id);
        sb.append(", message='").append(message).append('\'');
        sb.append('}');
        return sb.toString();
    }

要求最低JDK 1.5,一般的IDE都是这种

使用StringJoiner

如果JDK版本在1.8上,可以使用StringJoiner

@Override
    public String toString() {
        return new java.util.StringJoiner(", ", Hello.class.getSimpleName() + "[", "]")
                .add("id=" + id)
                .add("message='" + message + "'")
                .toString();
    }

如果有第三方库,常见的guava或者apache common,那么还有一些别的方法

使用ToStringBuilder

@Override
    public String toString() {
        return new ToStringBuilder(this)
                .append("id", id)
                .append("message", message)
                .toString();
    }

这个是apache commons-lang中的方法,底层使用的是StringBuffer

使用MoreObjects.toStringHelper

@Override
    public String toString() {
        return MoreObjects.toStringHelper(this)
                .add("id", id)
                .add("message", message)
                .toString();
    }

这是guava中提供的工具,底层使用StringBuilder。

这几种方法都需要根据类的字段变动,还有一个ReflectionToStringBuilder工具,直接使用反射来做,省去了后期变动的成本。问题就是性能和一些意外情况。

本文版权归作者所有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。

转载自夜明的孤行灯

本文链接地址: https://www.huangyunkun.com/2018/11/20/to-string-in-java/

发表评论

电子邮件地址不会被公开。