Java toString方法使用超全讲解

什么是toString方法

toString()是Java中的一个非常重要的方法，它的作用是返回对象的字符串表示形式。通常来说，我们在使用Java时，需要在特定的场景下输出对象的字符串形式，例如：

• 在日志中输出对象的信息
• 在控制台中输出对象的信息
• 在界面中展示对象的信息等等

这时，就可以使用对象的toString()方法，将对象转换为字符串并输出。

实现toString方法

所有的Java对象都继承了Object类，因此在所有Java对象中都可以使用toString()方法。由于Object类中的toString()方法的默认返回值并不好用，因此通常需要在我们自定义的类中重写toString()方法，以便输出有用的信息。

为了证明以上说法，我们可以定义一个简单的Person类：

public class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    // 重写toString方法
    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

在上面的代码中，我们定义了一个Person类，并重写了toString()方法。在方法中，我们返回了一个包含了name和age属性的字符串。

现在，我们可以创建一个Person对象，并使用toString()方法打印它：

Person p = new Person("Tom", 20);
System.out.println(p.toString());

输出结果如下：

Person{name='Tom', age=20}

示例解析

接下来，我们通过两个示例来详细讲解toString()方法的使用。

示例1：使用toString输出对象信息

假设我们正在编写一个在线购物网站，当前的需求是完成一个“购物车”功能，用于向用户展示他们当前选购的产品。当用户添加一个产品时，我们需要重新计算购物车中的总价，并将该总价以字符串形式返回。

为了实现这个功能，我们需要先定义一个Product类，并在Product类中重写toString()方法：

public class Product {
    private String id;           // 商品ID
    private String name;         // 商品名称
    private Double price;        // 商品单价
    private Integer quantity;    // 商品数量

    public Product(String id, String name, Double price, Integer quantity) {
        this.id = id;
        this.name = name;
        this.price = price;
        this.quantity = quantity;
    }

    // 重写toString方法，在输出时展示商品信息
    @Override
    public String toString() {
        return "Product{" +
                "id='" + id + '\'' +
                ", name='" + name + '\'' +
                ", price=" + price +
                ", quantity=" + quantity +
                '}';
    }

    // 计算总价
    public Double getTotalPrice() {
        return price * quantity;
    }
}

在上面的代码中，我们定义了一个Product类，并重写了toString()方法，用于在输出时展示商品信息。我们还定义了一个getTotalPrice()方法，用于计算商品在购物车中的总价。

接下来，我们在ShoppingCart类中记录用户的购物车，并在ShoppingCart类中定义一个getTotalPrice()方法，用于计算用户的购物车总价。

import java.util.ArrayList;
import java.util.List;

public class ShoppingCart {
    private List<Product> products = new ArrayList<>();

    // 添加商品
    public void addProduct(Product product) {
        products.add(product);
    }

    // 计算总价并返回字符串形式
    public String getTotalPrice() {
        Double totalPrice = 0.0;

        for (Product product : products) {
            totalPrice += product.getTotalPrice();
        }

        return String.format("%.2f", totalPrice);
    }
}

在上述代码中，我们定义了一个ShoppingCart类，并在其中维护了一个List<Product>类型的products属性，用于记录用户购物车中的商品信息。我们还定义了一个addProduct()方法，用于添加商品，在getTotalPrice()方法中，我们计算购物车中所有商品的总价，并使用String.format()方法将其以字符串形式返回。

最后，我们使用下面的代码对购物车进行测试：

Product p1 = new Product("0001", "iPhone X", 7999.0, 2);
Product p2 = new Product("0002", "Macbook Pro", 14999.0, 1);

ShoppingCart cart = new ShoppingCart();
cart.addProduct(p1);
cart.addProduct(p2);

System.out.println("Total Price: " + cart.getTotalPrice());

运行以上代码，输出结果如下：

Total Price: 30997.00

示例2：使用toString在日志中记录对象信息

假设我们正在编写一个高并发的Web应用程序，现在需要记录访问服务器的用户信息、终端类型、请求URL、访问时间等基本信息。

为了实现以上功能，我们首先需要定义一个Log类，并在其中记录相关信息：

public class Log {
    private String userId;      // 用户ID
    private String terminal;    // 终端类型
    private String url;         // 请求URL
    private Date accessTime;    // 访问时间

    public Log(String userId, String terminal, String url, Date accessTime) {
        this.userId = userId;
        this.terminal = terminal;
        this.url = url;
        this.accessTime = accessTime;
    }

    // 重写toString方法，用于日志打印输出
    @Override
    public String toString() {
        return String.format("%s,%s,%s,%s",
                userId, terminal, url, accessTime);
    }
}

在上面的代码中，我们定义了一个Log类，并使用userId、terminal、url、accessTime属性记录用户ID、终端类型、请求URL、访问时间等基本信息。我们还重写了toString()方法，用于在日志中输出对象信息。

接下来，我们在MyFilter类中记录用户的访问信息，并使用toString()方法实现日志打印。MyFilter是一个自定义的过滤器，用于在用户请求的时候记录请求信息：

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Date;

public class MyFilter implements Filter {
    private ServletContext context;

    @Override
    public void init(FilterConfig config) throws ServletException {
        context = config.getServletContext();
        context.log("MyFilter initialized");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest req = (HttpServletRequest) request;

        Log log = new Log(
                getUserId(req),
                getTerminal(req),
                req.getRequestURL().toString(),
                new Date()
        );

        context.log(log.toString());

        chain.doFilter(request, response);
    }

    // 获取用户ID
    private String getUserId(HttpServletRequest request) {
        // 省略获取用户ID的代码
        return "user001";
    }

    // 获取终端类型
    private String getTerminal(HttpServletRequest request) {
        // 省略获取终端类型的代码
        return "PC";
    }

    @Override
    public void destroy() {
        // do nothing
    }
}

在上述代码中，我们定义了一个MyFilter类，并在其中重写了doFilter()方法，用于记录用户的访问信息。在方法中，我们构造了一个Log对象，并传入相关信息。然后，我们通过ServletContext.log()方法将日志打印出来，并调用chain.doFilter()方法，继续处理用户请求。

最后，我们在web.xml中配置MyFilter过滤器，用于记录用户访问信息：

<filter>
    <filter-name>MyFilter</filter-name>
    <filter-class>com.example.filter.MyFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>MyFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

总结

本文详细介绍了Java中的toString()方法，并通过两个示例展示了如何使用toString()方法在不同场景中打印对象信息。在实际开发中，我们需要注意日志的输出方式，确保输出的日志足够详细，方便调试和问题定位。