[Effective Java] Item 19: Use interfaces only to define types

Item 19告诉我们Interfaces should be used only to define types. They should not be used to export constants.
也就是说,定义interface的目的一定是有个实现类的实例可以通过这个interface来调用,interface代表了某种类型,实现类实现这个interface,便属于这种类型,从而可以通过interface来调用实现类的实例。

比如说,List是interface,ArrayList是一个实现类,当我们写List<Integer> list = new ArrayList<>()时,就是创建了一个属于List的实例。

Constant Interface

什么是used to export constants?这里引入一个constant interface的概念。

Wikipedia上说:

In the Java programming language, the constant interface pattern describes the use of an interface solely to define constants, and having classes implement that interface in order to achieve convenient syntactic access to those constants. However, since constants are very often merely an implementation detail, and the interfaces implemented by a class are part of its exported API, this practice amounts to putting implementations details into the API, which was considered inappropriate .

简而言之,constant interface就是只有static final fields,没有method的interface。

举例说明什么是constant interface:

public interface NumberConstants {
    static final int ONE = 1;
    static final int TWO = 2;
    static final int THREE = 3;
}

Interface中声明的成员变量为什么默认为final static的?

关于这个问题stackoverflow上也有一些相关的说明比较有价值:

Interfaces are meant to give only specification. It can not contain any implementations. So To avoid implementing classes to change the specification, it is made final. Since Interface cannot be instantiated, they are made static to access the field using interface name.

Interface就是一些协议的定义,它不能够包含任何的实现。所以为了避免实现类去修改这个协议,它以他必须被声明为final,另外因为接口不能够被实例化,所以只有通过声明为static,才能使用接口名+字段的这样一种方式来访问该成员变量。

Constant Interface的缺点

  1. 如果一个non-final类实现了一个constant interface,那么这个constant interface中定义的常量将会污染它的所有子类的的命名空间。比如constant interface里面定义了一个常量ONE,那么所有实现这个interface的class都不能用ONE作为变量名。
  2. 如果在未来的发行版中不需要再使用那些常量,但是为了兼容性,该类还是需要实现这个接口。
  3. 如果没有IDE帮助,自己寻找constant是在哪里定义的是很耗时间的事情。
  4. 因为constant interface本身没有method,那么一个这个interface的实例就没有什么意义。
  5. interface里面的constant可能会被悄悄地改变,没有任何报错(比如下面的例子)。
public interface NumberConstants {
    public static final int ONE = 1;
    public static final int TWO = 2;
}

public class Class1 implements NumberConstants {
    public static final int ONE = 2;     // Line 1

    public static void main(String args[]) throws Exception {
        System.out.println(ONE);
    }
}

当我们在Class1里面试着打印常量ONE的时候,它并不是interface里面的1,而是Line 1里面覆盖成的2。

作者说很多人仅仅使用interface来导出常量,甚至JDK的作者也这么干(比如java.io.ObjectStreamConstants),这是一种反模式,是不对的。

替代方法

如果想要export constants,可以使用final class:

public final class NumberConstants {
    private NumberConstants() {
        // prevent instantiation
    }

    public static final int ONE = 1;
    public static final int TWO = 2;
}

Note:

  1. class的类型为final,表示该类是不可以继承的
  2. 定义了一个私有的构造函数,避免实例化该类
  3. 常量的类型为public final static

这样在使用这些常量时如下:

import static NumberConstants.ONE;
import static NumberConstants.TWO;

public class Calculations {

    public int getThree() {
        return ONE + TWO;
    }
}

如果变量名有很多,可以直接写成

import static NumberConstants.*;

这样就能export constants,同时避免很多潜在的危险。


Reference

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

推荐阅读更多精彩内容