Java Getter&Setter 系列之二:常见错误

4. 实现Getter/Setter方法常见错误

没有无过错的人,没有无bug的代码。本节将描述实现getter/setter时的常见错误,以及解决方案。

常见错误一

实现了getter/setter,但是变量声明访问类型不够严格

考虑如下代码片段:

public String firstName;

public void setFirstName(String fname) {
    this.firstName = fname;
}

public String getFirstName() {
    return this.firstName;
}

变量firstName被声明为public,所以可以使用.运算符直接访问,因此getter/setter就没有实际意义了。一个解决方案是使用更加严格的访问修饰词,比如protectedprivate

private String firstName;

在《Effective Java》一书中,Joshua Bloch在第14条中指出这个问题:

"In public classes, use accessor methods, not public fields."

常见错误二

在setter中直接分配对象引用。

考虑如下代码片段:

private int[] scores;
public void setScores(int[] scr) {
    this.scores = scr;
}

如下示例代码说明了问题:

int[] myScores = {5, 5, 4, 3, 2, 4};
setScores(myScores);
displayScores();   
myScores[1] = 1;
displayScores();

一个int类型的数组myScores,使用6个元素初始化后执行第2行代码setScores()方法。displayScores()方法将数据元素简单打印出来:

public void displayScores() {
    for (int i = 0; i < this.scores.length; i++) {
        System.out.print(this.scores[i] + " ");
    }
    System.out.println();
}

第3行代码将打印如下结果:

5 5 4 3 2 4

数组myScores所有元素被打印出来。现在,通过第4行代码,我们修改数组myScores中的第二个元素:

myScores[1] = 1;

如果我们通过第5行代码再次调用displayScores()方法会发生什么呢?好,让我们看下输出结果:

5 1 4 3 2 4

可以看到,通过第四行的赋值语句,第二个元素的值从5变成了1。这就意味着在setter方法以外的代码也可以修改数据,这违反了setter方法封装变量的目的。为什么会出现这种情况呢?让我们再看看setScores()方法:

public void setScores(int[] scr) {
    this.scores = scr;
}

变量scores被直接赋值为方法入参变量scr。这意味着这两个变量都指向内存中的同一个对象——myScores数组。所以无论是对scores还是myScores变量的修改实际上都是在同一个对象上的。

这种情况的一个解决方案是逐一拷贝scr数组中的元素到scores数组中。修改后的setter方法如下:

public void setScores(int[] scr) {
    this.scores = new int[scr.length];
    System.arraycopy(scr, 0, this.scores, 0, scr.length);
}

这有什么不同呢?现在,变量scores不再指向scr变量所指向的对象了。而是scores数组被初始化为与scr数组相同大小的一个新数组。然后,我们使用System.arraycopy()方法,将scr数组中的元素都拷贝到scores数组中。

再次运行示例代码,得到如下输出结果:

5 5 4 3 2 4
5 5 4 3 2 4

现在,两次displayScores()方法调用产生了相同的结果。这就意味着scores数组独立于通过setter方法赋值的scr数组,因此我们调用如下语句:

myScores[1] = 1;

不会影响到scores数组。

所以,拇指规则是:如果传递一个。对象引用到setter方法中,不要直接把引用拷贝给对象的内部变量。而是应该使用一些方法将传递过来的对象的值拷贝给对象内部变量,就像我们使用System.arraycopy()方法将一个数组的元素拷贝给另外一个数组一样。

常见错误三

直接在getter方法中返回对象引用。

考虑如下的getter方法:

private int[] scores;
public int[] getScores() {
    return this.scores;
}

然后再看下面一段示例代码:

int[] myScores = {5, 5, 4, 3, 2, 4};
setScores(myScores);
displayScores();
int[] copyScores = getScores();
copyScores[1] = 1;
displayScores();

将会产生如下输出结果:

5 5 4 3 2 4
5 1 4 3 2 4

可以看到,通过第5行示例代码,数组scores的第二个元素被setter方法以外的代码修改了。因为getter方法直接返回了内部变量scores的引用,外部代码就可以获取该变量引用并修改这个内部变量。

这个问题的一个解决方案是,在getter方法中不要直接返回对象的引用,而是应该返回对象的一个副本。这样外部代码只能获取到对象的副本,而不是内部变量对象本身。

我们将getter方法修改如下:

public int[] getScores() {
    int[] copy = new int[this.scores.length];
    System.arraycopy(this.scores, 0, copy, 0, copy.length);
    return copy;
}

所以,拇指规则是:不要在getter方法中直接返回源对象的引用,而是应该返回其对象的副本。

系列文章

  1. Java Getter&Setter 系列之一:基础
  2. Java Getter&Setter 系列之二:常见错误
  3. Java Getter&Setter 系列之三:最佳实践
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容