Java Getter&Setter 系列之一:基础

Getter和Setter方法在Java中广泛使用,看似简单,但不是所有人都能正确理解并实现这种方法。所以在本文中,我将深入探讨Java中的Getter和Setter方法——从基础到常见错误,再到最佳实践。

如果你已经掌握Getter/Setter方法基础知识,可以直接跳转到第4章节(系列之二和三),阅读关于常见错误和最佳实践相关内容。

1. 什么是Getter/Setter方法

Getter/Setter是Java中用于获取和更新一个变量的值的两个传统方法。

下面是含有一个私有变量及其getter/setter方法的简单类示例代码:

public class SimpleGetterAndSetter {
    private int number;

    public int getNumber() {
        return this.number;
    }
    public void setNumber(int num) {
        this.number = num;
    }
}

该类定义了一个私有变量,number。因为变量number是私有的,所以该类以外的代码是无法直接访问这个变量的,如下所示:

SimpleGetterAndSetter obj = new SimpleGetterAndSetter();
obj.number = 10;    // compile error, since number is private
int num = obj.number; // same as above

在外部代码为了获取和更新变量,而是应该使用getter方法getNumber(),和setter方法setNumber()。例如:

SimpleGetterAndSetter obj = new SimpleGetterAndSetter();
obj.setNumber(10);  // OK
int num = obj.getNumber();  // fine

因此,getter方法是用于读取变量值,setter方法是用于更新变量值的。Getter/Setter方法在Java中又被称作accessor(访问器)mutator(修改器)

2. 为什么要使用Getter/Setter

通过使用getter/setter方法,可以控制以适当的方式访问和更新重要的变量,例如在一个指定范围内更新变量值??悸窍旅嬉欢蝧etter方法:

public void setNumber(int num) {
    if (num < 10 || num > 100) {
        throw new IllegalArgumentException();
    }
    this.number = num;
}

这就保证了更新变量number的值始终在10到100之间。如果变量number的值可以直接被更新,则调用者可以设置为任意值:

obj.number = 3;

这便违反了number值在10到100之间的约束。当然,这不是我们希望发生的。因此,定义为私有类型以隐藏变量,并使用setter方法更新变量。

另一方面,getter方法是外部代码获取变量值的唯一途径:

public int getNumber() {
    return this.number;
}

下图说明了这种情况:

getter-and-setter visual

Getter和Setter方法?;ち吮淞坎槐煌獠看氲饔谜咭馔飧谋洹?/p>

当一个变量被private修饰符修饰,并只能通过getter和setter方法访问,那么这个变量被封装。封装是OOP(Object-Oriented Programming面向对象编程)的一个基本原理,因此实现getter/setter方法是程序中强制封装的方式之一。

一些框架,如Hibernate,Spring,Struts等是通过Getter/Setter获取信息或注入框架代码。因此在集成这些框架的时候,就必须要提供Getter/Setter方法。

3. Getter/Setter方法命名规范

Getter/Setter方法的命名需要符合Java bean命名规范,当变量名为xxx时,Getter/Setter方法命名分别为getXxx()setXxx()。例如变量名为name:

private String name;

则正确的getter/setter方法命名为:

public void setName(String name) { }

public String getName() { }

如果变量是boolean类型,则getter方法的命名可以是isXxx()getXxx(),推荐优先选择前者。例如:

private boolean single;

public String isSingle() { }

下表所示为符合命名规范的getter/setter命名示例:

变量定义 Getter方法 Setter方法
int quantity int getQuantity() void setQuantity(int quantity)
String firstName String getFirstName() void setFirstName(String firstName)
Date birthday Date getBirthday() void setBirthday(Date bornDate)
boolean rich boolean isRich()
boolean getRich()
void setRich(boolean rich)

系列文章

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

推荐阅读更多精彩内容