Sonar - 存储副本 - 不应直接存储或返回可变成员-解网

问：

我有一个列表，是我班上的私人成员。我使用 getter 和 setter 来获取和设置值。 SOnar 抛出错误 - 不应直接存储或返回可变成员。

例如：ABC 和 DEF 是两个类。

class ABC{
private List<DEF> defList;
public List<DEF> getDefList() { return defList; }
public void setDefList(List<DEF> defList) { this.defList = defList; }

经过大量的谷歌搜索和搜索，我了解到 getter 可以更改如下：

public List<DEF> getDefList() { return new ArrayList<>(defList); }

当我尝试类似地使用 setter 时，

public void setDefList(List<DEF> defList) { this.defList.addAll(defList); }

然后变量开始显示

'private field 'defList' is never assigned.

我可以知道当它是一个列表（另一个类的列表）时的正确方法吗？

注意：普拉萨德·卡鲁纳戈达（Prasad Karunagoda）和利奥·阿苏（Leo Aso）的答案都有效。我不能将两者都标记为接受的答案。所以在这里有一个注释

爪哇岛数组列表声纳库可变

class ABC {
    private List<DEF> defList = Collections.emptyList();

    public List<DEF> getDefList() { 
        return defList;
    }

    public void setDefList(List<DEF> defList) {
        // defensively copy, then make immutable
        defList = new ArrayList<>(defList);
        this.defList = Collections.unmodifiableList(defList);
    }

public class ABC {
  private List<DEF> defList = new ArrayList<>();

  public List<DEF> getDefList() {
    return new ArrayList<>(defList);
  }

  public void setDefList(List<DEF> defList) {
    if (defList == null)
        throw new IllegalArgumentException("Parameter defList is null");
    this.defList.clear();
    this.defList.addAll(defList);
  }
}

从设计的角度来看，一个更好的类 API 是：ABC

public List<DEF> getDefList()
public void clearDefList()
public void addAllDefs(List<DEF> defs) // Or method name appendDefs

@PrasadKarunagoda “例如，如果您这样做，使用您的列表的客户将无法对其进行排序。”就是这个想法。一般来说，客户端不应该直接修改其他对象的私有字段。想象一下，如果不同的客户端在多个线程中运行！想要排序列表的客户需要制作副本。

0赞 Bruno Martins 6/12/2023 #3

public class ABC {
    private List<DEF> defList = Collections.emptyList();

    public List<DEF> getDefList() { 
        List<DEF> defListCopy = new ArrayList();
        if(defList != null){
         defListCopy = Collections.unmodifiableList(defList);
        }
        return defListCopy;
    }

    public void setDefList(final List<DEF> defList) {
        this.defList = Optional.ofNullable(defList).orElse(new ArrayList<>());
    }
}

Sonar - 存储副本 - 不应直接存储或返回可变成员

Sonar - Store a copy - Mutable members should not be stored or returned directly

评论

评论

评论

评论