Java中toString方法的推荐实现方式

超、凢脫俗 2022-01-27 07:13 367阅读 0赞

**目录**

Java中toString方法很重要

利用Apache Commons Lang3更好的实现toString方法

ToStringBuilder的简单用法

toString样式ToStringStyle

DEFAULT\_STYLE （常用）

MULTI\_LINE\_STYLE

NO\_FIELD\_NAMES\_STYLE

SHORT\_PREFIX\_STYLE

SIMPLE\_STYLE

NO\_CLASS\_NAME\_STYLE

JSON\_STYLE

IntelliJ IDEA设置toString生成模板，快速生成ToStringBuilder方式的toString方法

利用模板方法的设计模式实现toString更好的继承性

--------------------

# Java中toString方法很重要 #

所有数据类都要重写toString方法。

Java类的toString方法决定了打印日志时该类对象的实际输出。日志的打印很重要，对于这一点工作一段时间的同学应该都是深有体会和赞同的。打印日志有很多讲究，打印哪些信息，打印格式，怎么打印更节省空间，怎么打印更利于解读和使用等等。日志的打印和管理是个不小的话题，这里不细讲了，后面总结输出。

总之一句话，打印日志很重要，Java类的toString方法很重要。

# 利用Apache Commons Lang3更好的实现toString方法 #

导入commons lang3的jar包，或者添加commons lang3的maven依赖。

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

官网地址：[http://commons.apache.org/proper/commons-lang/][http_commons.apache.org_proper_commons-lang]

在线API地址：[http://commons.apache.org/proper/commons-lang/javadocs/api-3.9/index.html][http_commons.apache.org_proper_commons-lang_javadocs_api-3.9_index.html]

主要关注org.apache.commons.lang3.builder包下的两个类  
ToStringBuilder 协助实现Object.toString（）方法。  
ToStringStyle 控制ToStringBuilder的字符串格式。

## ToStringBuilder的简单用法 ##

和StringBilder类似，new一个ToStringBuilder对象，append方法添加属性名和属性值，最后toString。

推荐这样自己明确写出要打印的属性，有些**敏感信息**的属性可以不打印或者做**匿名化处理**，如个人数据手机号等。

示例：

@Override
        public String toString() {
            return new ToStringBuilder(this)
                    .append("id", id)
                    .append("name", name)
                    .append("price", price)
                    .append("pic", pic)
                    .append("createtime", createtime)
                    .append("detail", detail)
                    .toString();
        }

## toString样式ToStringStyle ##

ToStringBuilder构造函数传入ToStringStyle中样式的值指定toString样式，如ToStringBuilder(this, **ToStringStyle.DEFAULT\_STYLE**)，是使用默认样式。目前版本样式种类如下：

### **DEFAULT\_STYLE （常用）** ###

默认toString样式， 输出示例：Person@182f0db\[name=John Doe,age=33,smoker=false\]

### **MULTI\_LINE\_STYLE**  ###

多行toString样式， 输出示例：

Person@182f0db[
       name=John Doe
       age=33
       smoker=false
     ]

### **NO\_FIELD\_NAMES\_STYLE ** ###

无字段名的toString样式， 输出示例：

Person@182f0db[John Doe,33,false]

### SHORT\_PREFIX\_STYLE ###

简短前缀的toString样式， 输出示例：

Person[name=John Doe,age=33,smoker=false]

### SIMPLE\_STYLE ###

简单的toString样式， 输出示例：

John Doe,33,false

### NO\_CLASS\_NAME\_STYLE ###

没有类名的toString样式， 输出示例：

[name=John Doe,age=33,smoker=false]

### JSON\_STYLE ###

json字符串格式的toString样式， 输出示例：

{"name": "John Doe", "age": 33, "smoker": true}

## IntelliJ IDEA设置toString生成模板，快速生成ToStringBuilder方式的toString方法 ##

按下快捷键Alt+Insert，点击toString()，打开生成toString方法的弹窗。

![20190525204445885.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FPQk81MTY_size_16_color_FFFFFF_t_70][]

toString方法默认模板是String字符串拼接的方式实现，点击settings，选择其他toString方法模板或自定义模板，这里选择使用ToStringBuilder的模板就可以了。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FPQk81MTY_size_16_color_FFFFFF_t_70 1][]

点击ok，再选择字段点击ok就自动生成如上简单示例中的toString方法。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FPQk81MTY_size_16_color_FFFFFF_t_70 2][]

# 利用模板方法的设计模式实现toString更好的继承性 #

让子类可以更好的继承和打印自己的属性，可以采用模板方法的设计模式实现。在父类中新建一个createToStringBuilder（可以是其他名称，但是最好不要以get开头）的保护方法，创建和返回一个ToStringBuilder对象，包含当前类的所有属性；重写toString方法，调用this.createToStringBuilder().toString()。子类继承父类，只要重写createToStringBuilder方法，调用父类的createToStringBuilder方法继续append添加子类的属性即可，不必再次重写toString方法。

示例：

父类BaseResponse中：

/**
         * 构造ToStringBuilder
         *
         * @return ToStringBuilder
         */
        protected ToStringBuilder createToStringBuilder() {
            return new ToStringBuilder(this, ToStringStyle.DEFAULT_STYLE)
                    .append("retCode", retCode)
                    .append("msg", msg);
        }
    
        @Override
        public String toString() {
            return this.createToStringBuilder().toString();
        }

子类GetUserInfoResponse继承BaseResponse，重写createToStringBuilder方法：

@Override
        protected ToStringBuilder createToStringBuilder() {
            return super.createToStringBuilder().append("user", user);
        }

结束语：有很多好的开源框架值得我们学习和使用，其中Apache Commons是佼佼者，使用开源框架和学习他们的各种实现，可以使你更快的进步。

[http_commons.apache.org_proper_commons-lang]: http://commons.apache.org/proper/commons-lang/
[http_commons.apache.org_proper_commons-lang_javadocs_api-3.9_index.html]: http://commons.apache.org/proper/commons-lang/javadocs/api-3.9/index.html
[20190525204445885.png]: /images/20220127/6174a12048644501ab4cab69ce46a023.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FPQk81MTY_size_16_color_FFFFFF_t_70]: /images/20220127/32f11930433a4ca2a83685ef2fd5c4d3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FPQk81MTY_size_16_color_FFFFFF_t_70 1]: /images/20220127/da30f0101c33448897fedb404ba1e6c9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FPQk81MTY_size_16_color_FFFFFF_t_70 2]: /images/20220127/e15d447302984466a2a8bee990531b3d.png

发表评论取消回复

表情：

评论列表（有 0 条评论，367人围观）

还没有评论，来说两句吧...

相关阅读

相关 Java中的toString()方法

一、toString()方法介绍 toString() 方法是 Object 类中的方法，toString() 方法源代码如下： //(1)getClass()

喜欢ヅ旅行/ 2024年03月31日 18:02/ 0 赞/ 35 阅读

相关 Java中的toString()方法及其使用

toString()方法是Java中Object类的一个方法，用于将对象转换为字符串表示形式。当我们在打印对象时，实际上是打印了该对象的toString()方法返回的字符串。默

深碍√TFBOYSˉ_/ 2024年02月21日 09:18/ 0 赞/ 24 阅读

相关 tostring方法_ToString方法

tostring方法 The ToString method is one of the fundamental methods in the root of the ent

Bertha 。/ 2022年12月06日 15:39/ 0 赞/ 258 阅读

相关 JS中的toString()方法

你是否遇到这样的疑惑？代码： <!DOCTYPE html> <html lang="zh"> <head> <meta charse

墨蓝/ 2022年10月29日 09:18/ 0 赞/ 161 阅读

相关 Java——toString()方法简介

toString()方法：它是Object里面已经有了的方法，所有类都是继承Object，所以“所有对象都有这个方法” 简单的说，toString()方法是为了方便输

谁践踏了优雅/ 2022年06月10日 14:21/ 0 赞/ 201 阅读

相关 Java类里面的toString方法

在Java里面所有的类都有一个共同的父类Object，不管你愿不愿意都得继承他（默认继承，不用加extends）。那么我们今天要说的toString方法就是存在于Obj

旧城等待，/ 2022年05月23日 08:49/ 0 赞/ 220 阅读

相关 java中toString方法运用场景

public class Test { //main方法既是程序的入口也是程序的出口 public static void main(S

￡神魔★判官ぃ/ 2022年03月27日 13:21/ 0 赞/ 194 阅读

相关 Java中toString方法的推荐实现方式

目录 Java中toString方法很重要利用Apache Commons Lang3更好的实现toString方法 ToStringBuilder的简单用法 toS

超、凢脫俗/ 2022年01月27日 07:13/ 0 赞/ 368 阅读

相关 java中重写toString()方法的意义

public String toString() > 返回该对象的字符串表示。通常， `toString` 方法会返回一个“以文本方式表示”此对象的字符串。结果应是一

约定不等于承诺〃/ 2021年09月15日 02:26/ 0 赞/ 402 阅读

相关 JAVA中toString方法的作用

因为它是Object里面已经有了的方法，而所有类都是继承Object，所以“所有对象都有这个方法”。它通常只是为了方便输出，比如System.out.println(xx)

淩亂°似流年/ 2021年09月14日 08:08/ 0 赞/ 335 阅读