Findbugs中的BUG:May expose internal representation by returning reference to mutable object 引发问题说明

在使用IDEA的findbugs的插件检测model层类的时候发生如下错误：

May expose internal representation by returning reference to mutable object
Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.  If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.

这里提示的BUG的测试结果如下：

实体类BusGeologicalDrilling部分代码：

public class BusGeologicalDrilling{
 private Date enddt;

// 此处省略构造函数


//下面为IDE自动为我们生成的get和set方法

 public Date getEnddt() {
        return   enddt  ;
    }

 public void setEnddt(Date enddt) {
        this.enddt =   enddt  ;
    }
}

部分测试代码如下：

 BusGeologicalDrilling busGeologicalDrilling=new BusGeologicalDrilling();
 Date date=new Date();
 busGeologicalDrilling.setEnddt(date);
 System.out.println(busGeologicalDrilling.getEnddt().toString());
 date.setYear(5);
 System.out.println(busGeologicalDrilling.getEnddt().toString());

测试结果如下：

通过结果对比发现：

日期的对象在经过改变后，原本之前赋予实体的enddt属性的值也跟着被修改掉了，这样显然是不对的，这里涉及到引用传递值的问题。此处不再深究。

解决方案：

一：修改实体的属性的get和set方法如下:

public class BusGeologicalDrilling{
 private Date enddt;

// 此处省略构造函数


//下面为IDE自动为我们生成的get和set方法

 public Date getEnddt() {
        return (Date)enddt.clone();
    }

 public void setEnddt(Date enddt) {
        this.enddt = (Date)enddt.clone();
    }
}

备注：这种方式虽然可以解决引用值传递的问题，但是当在属性上使用【com.fasterxml.jackson.annotation包下面的JsonFormat】如：注解控制Date的格式或者时区，如果当前属性绑定的是非格式或者空值会发生绑定错误，所以此种方法并不完美，如下：

 @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
 private Date enddt;

二、使用官方推荐的Date获取方式为实体进行赋值，测试如下：

上面测试我们看到是没有任何问题的，原因在于Calendar类和Date的实体获取机制不同导致。

Findbugs中的BUG:May expose internal representation by returning reference to mutable object 引发问题说明

猜你喜欢