java实体类重写toString()方法

实体类一般需要重写toString()方法,在打印日志时输出参数的信息。但是如果手动拼接实体类里每个属性和属性值又比较麻烦,以下是常用的几种方法。

利用Apache工具类ToStringBuilder

 //方法1 输出对象名称简写 属性 属性值(我常用这种方式)
@Override
public String toString() {
    return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_STYLE);
}

如果输出信息想过滤掉某些特殊字段,如password,可以采用如下方式:

@Override
public String toString() {
 return (new ReflectionToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE) {
        @Override
 protected boolean accept(Field f) {
            return super.accept(f) && !f.getName().equalsIgnoreCase("password"); //过滤掉特殊字段
        }

    }).toString();
}


ToStringBuilder工具类还有以下几种显示方式:

/对象及其属性一行显示

ToStringBuilder.reflectionToString(this);

ToStringBuilder.reflectionToString(u, ToStringStyle.DEFAULT_STYLE)

//属性换行显示

ToStringBuilder.reflectionToString(u, ToStringStyle.MULTI_LINE_STYLE)

//不显示属性名,只显示属性值,在同一行显示

ToStringBuilder.reflectionToString(u, ToStringStyle.NO_FIELD_NAMES_STYLE)

//对象名称简写

ToStringBuilder.reflectionToString(u, ToStringStyle.SHORT_PREFIX_STYLE)

//不显示对象名称 只显示属性

ToStringBuilder.reflectionToString(u, ToStringStyle.SIMPLE_STYLE)

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

另一种重写toString()的方法是利用反射机制,获取实体类的所有属性和方法,实现如下:

public class ToStringUtil{
    /**
     * 输出指定的某些字段fieldName, 如果不填则输出所有字段
     * @param entity
     * @param fieldName
     * @return
     */
    public static String toString(Entity entity, String... fieldName)
    {
        Class cls = entity.getClass();
        StringBuffer buffer = new StringBuffer(cls.getSimpleName() + ": ");

        try
        {
            //不获取私有方法
            Method[] methods = cls.getMethods();
            if(null != fieldName && fieldName.length != 0)
            {
                for(Method method: methods)
                {
                    String mn = method.getName();
                    for(String fn: fieldName)
                    {
                        if(mn.equalsIgnoreCase("get" + fn))
                        {
                            String value = method.invoke(entity).toString();
                            buffer.append(mn + "=" + value + " &");
                        }
                    }
                }
            }
            else
            {
                //得到所有field
                Field[] fields = cls.getDeclaredFields();
                for(Method method: methods)
                {
                    String mn = method.getName();
                    for(Field field: fields)
                    {
                        String name = field.getName().toString();
                        if(mn.equalsIgnoreCase("get" + name))
                        {
                            String value = method.invoke(entity).toString();

                            buffer.append(name + "=" + value + " &");
                        }
                    }
                }
            }

        }
        catch(Exception e)
        {
            e.printStackTrace();
        }

        return buffer.substring(0, buffer.length()-1).toString();
    }

}
SQL 查询后的结果类并不一定非要重写 `toString` 方法,但这通常是推荐的做法。下面详细解释一下原因: --- ### 为什么建议重写 `toString` 方法? 1. **便于调试** 当你在程序运行过程中需要打印 SQL 查询的结果时(例如通过日志记录或简单的 System.out.println 调试),如果没有重写 `toString` 方法,默认会显示类似 `[Ljava.lang.Object;@hashcode` 的内容,这很难直观地理解数据的具体值。 2. **提高可读性** 如果重写了 `toString` 方法,可以自定义输出格式,使得每个字段都清晰可见。这对于复杂的数据结构尤其重要。 3. **方便集成其他工具** 某些框架、库或者可视化工具可能会依赖于对象的字符串表示形式。如果未重写方法,则可能导致这些工具无法正常工作或者难以解读返回的信息。 4. **一致性维护** 统一为所有实体类添加有意义的 `toString()` 实现有助于保持项目的整洁性和标准化。 --- ### 那么是否强制要求呢? 并非强制性的需求,但如果希望代码更易于理解和管理的话,最好还是对其进行适当的覆盖处理。以下是几个场景分析: #### 场景 1 - 简单测试用途 如果你只是临时用于验证某些功能,并不需要特别关注最终用户界面呈现效果的情况下,也许可以直接忽略这一操作步骤; #### 场景 2 - 生产环境下的应用 一旦进入实际项目部署阶段后,为了保证良好的用户体验以及后续技术支持人员排查问题便利性等方面考虑,在这种环境下应该尽可能完善此类细节设计包括但不限于重载 toString() 函数等措施. --- ### 示例代码 ```java public class User { private int id; private String name; // Getter & Setter methods here... @Override public String toString(){ return "User [id=" + id + ", name=" + name + "]"; } } ``` 如上所示示例,当创建一个新的 `User` 对象并试图将其转换成字符串时将得到类似于 `"User[id=1,name=Alice]"` 这样的易懂表述而非原始地址指针信息了! --- ### 总结 虽然技术层面来说并没有规定说一定要对 SQL 结果集对应的 POJO 类型进行额外设置才允许正常使用它们的功能特性——但是从工程实践的角度出发,养成良好习惯对于长远发展而言是非常必要的!
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值