由Collections.unmodifiableList引发的重构

青旅半醒 2021-06-24 16:10 414阅读 0赞

1、介绍：

public static <T> List<T> unmodifiableList(List<? extends T> list)

该方法是返回一个集合的不可修改视图。对该视图的修改，会报java.lang.UnsupportedOperationException异常。

看下面示例：

public class CollectionsListDemo {
      public static void main(String[] args) {
    
          List<String> list = new ArrayList<String>();
          list.add("aa");
         list.add("bb"); 
         
          System.out.println("初始化前: "+ list);
         
          //实现 unmodifiable
          List<Character> immutablelist = Collections.unmodifiableList(list);
         
          //修改 list
          immutablelist.add("zz");     
      }}
    
    结果：
    
    初始化前:: [aa, bb]
    
    Exception in thread "main" java.lang.UnsupportedOperationException

2、那为什么要有不可修改的集合呢？

在《重构——改善既有代码的设计》一书中，有一种重构手法叫Encapsulate Collection(封装集合)，定义是：让函数返回这个集合的副本，并在这个类中提供添加/移除集合的方法。解释：

1）假设在某个类中有一个集合（list、map、set...）属性，依据通常设计类中也会提供针对该集合的取值与设值函数，但是集合的处理方式和其他种类略有不同，取值函数不应该返回集合本身，因为这会让用户得以修改集合的内容而集合拥有者去一无所知。好的设计应该避免用户直接操作对象内保存的集合，并隐藏对象内与用户无关的的数据结构。

2）此外，不应该为这个集合提供一个设置函数，但是应该提供对象内集合本身添加/删除的函数，这样，集合拥有者（对象）就可以控制集合元素的添加与删除。

如果做到了上边两点，集合就很好的封装起来，这样就降低了集合拥有者和用户之间的耦合度。常用到的做法：

1.  加入为集合添加/移除元素的函数
2.  将保存的集合的字段初始化一个空的集合

import java.util.List;
    
    public class Student {
            private String userName ;
            private List<String> courses ;
           
    
            public Student (String userName , List<String> courses){
                   this.userName = userName;
                   this.courses = courses;
           }
    
            public String getUserName(){
                   return userName ;
           }
    
            public void setUserName(String userName){
                   this.userName = userName;
           }
    
            public List<String> getCourses(){
                   return courses ;
           }
    
            public void setCourses(List<String> courses){
                   this.courses = courses;
           }
    }

重构后代码：

import java.util.ArrayList;
    import java.util.Collections;
    import java.util.List;
    
    public class Student {
            private String userName ;
            private List<String> courses ;
    
            public Student (String userName , List<String> courses){
                   this.userName = userName;
                   this.courses = courses;
           }
    
            public String getUserName() {
                   return userName ;
           }
    
            public void setUserName(String userName){
                   this.userName = userName;
           }
    
            public void addCourse(String course){
                   courses.add(course);
           }
    
            public boolean removeCourse(String course){
                   return courses .remove(courses );
    
           }
    
            public List<String> getCourses(){
                   return Collections.unmodifiableList( courses);
           }
    
            public static void main(String[] args){
                  List<String> list = new ArrayList<String>();
                  list.add( "数学");
                  list.add( "语文");
                  Student s = new Student("lily" , list);
    
                  List<String> anotherList = s.getCourses();
    
                   /**
                   * throws java.lang.UnsupportedOperationException should replace with
                   * s.addCourse(String course)
                   */
                  anotherList.add( "英语");
    
                   // 不会走到这一步，因为上边抛出了异常
                  System. out.println("lily's course.length = " + s.getCourses().size());
           }
    }

4、总结

使用这种方法重构的意义：就好比我们网上购物一样，你可以往购物车添加自己想买的东西，但是商户不能在不通知顾客（我们）的情况下，就任意的添加商品，并修改商品的价格等，入口只能是一个，也就是在顾客手中。比喻可能不是很恰当，反正意思大概就是这样。