方法——必要时进行保护性拷贝

不念不忘少年蓝@ 2024-03-16 09:58 9阅读 0赞

程序的问题可能来自故意的破坏，也可能来自无意的破坏。大多数情况下，我们需要考虑基本的无意性破坏，这种问题很多时候是来自于对象的传递。

如下例子

尽管 Period 已经设置 start 和 finish 为 final，但在其他地方可以通过 period.getStart() 。这时候，如果无意间设置了获取的时间后， Period 也受到影响，发生了错误

public final class Period {
    
        private final Date start;
        private final Date finish;
    
        public Period(Date start, Date finish) {
            if (start == null) {
                throw new IllegalArgumentException("date 不能为 null");
            }
            if (start.after(finish)) {
                throw new RuntimeException("开始时间不能大于结束时间");
            }
            this.start = start;
            this.finish = finish;
        }
    
        public Date getStart() {
            return start;
        }
    
        public Date getFinish() {
            return finish;
        }
    
        public boolean inPeriod(Date date) {
            return !date.after(finish) && !date.before(start);
        }
    
    
        public static void main(String[] args) throws Exception {
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            Period period = new Period(sdf.parse ("2012-01-01 00:00:00"), sdf.parse("2012-12-31 23:59:59"));
            Date start = period.getStart();
            start.setTime(sdf.parse ("2013-01-01 00:00:00").getTime());
            System.out.println(sdf.format(period.getStart()));
          }
    }

为了处理此方法，需要进行保护性拷贝，所有与外部有关的数据都要处理，将数据真正与外部隔离

public Period(Date start, Date finish) {
            if (start == null) {
                throw new IllegalArgumentException("date 不能为 null");
            }
            if (start.after(finish)) {
                throw new RuntimeException("开始时间不能大于结束时间");
            }
            // 避免入参在外部被修改，导致内部时间错误
            this.start = new Date(start.getTime());
            this.finish = new Date(finish.getTime());
        }
    
        public Date getStart() {
            //避免返回值在外部被修改，导致内部时间错误
            return new Date(start.getTime());
        }
    
        public Date getFinish() {
            // 避免返回值在外部被修改，导致内部时间错误
            return new Date(finish.getTime());
        }

保护性拷贝有两种级别，一种是避免无意的破坏，另一种是尽可能避免任何有意的破坏。

本篇的重点在于第一种

对于前者，我们只需要注意在 public 方法中使用副本数据处理或者使用。

后者的情况比较罕见，毕竟对于恶意破坏的程序，我们其实更合适的是根本不给对方访问权限，比如将 Period 定义为某个类的内部类，所有与外部的交互都严格校验，防止反射等修改手段，并且不会返回任何内部的引用，只返回数据的复制对象或复制的基本数据。

本篇的真正启示在于，如果可能，尽量使用基本类型或者final类型，这样就不存在引用问题了，比如上面方法可以改为

public final class Period {
    
        private final long start;
        private final long finish;
    
        public Period(long start, long finish) {
            if (start>finish) {
                throw new RuntimeException("开始时间不能大于结束时间");
            }
            this.start = start;
            this.finish = finish;
        }
    
        public long getStart() {
            return start;
        }
    
        public long getFinish() {
            return finish;
        }
    
        public boolean inPeriod(Date date) {
            long time = date.getTime();
            return time >= start && time <= finish;
        }
    
        public static void main(String[] args) throws Exception {
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            Period period = new Period(sdf.parse ("2012-01-01 00:00:00").getTime(), sdf.parse("2012-12-31 23:59:59").getTime());
            System.out.println(sdf.format(period.getStart()));
          }
    }