泛型方法

泛型方法在开源项目中应用的非常广泛,通过本文的介绍希望帮助读者更快地理解源码以及可以在平时的开发中能够熟练使用泛型方法,以下对泛型方法的说明,摘录于《Thinking in Java》第四版

You can also parameterize methods within a class. The class itself may or may not be generic—this is independent of whether you have a generic method.
A generic method allows the method to vary independently of the class. As a guideline, you should use generic methods "whenever you can." That is, if it’s possible to make a method generic rather than the entire class, it’s probably going to be clearer to do so. In addition, if a method is static, it has no access to the generic type parameters of the class, so if it needs to use genericity it must be a generic method.
To define a generic method, you simply place a generic parameter list before the return value.

从上面的说明中可以总结出以下几点:

  1. 定义泛型方法,只需将泛型参数列表置于返回值之前;
  2. 泛型方法可以在泛型类中也可以在非泛型类中,与其所在的类是否是泛型没有关系;
  3. 对于一个static的方法,是无法访问泛型类的类型参数,也就是说,如果static方法需要使用泛型能力,就必须使其成为泛型方法;
  4. 如果使用泛型方法可以取代将整个类泛型化,就应该只使用泛型方法。

下面以Apache Flink 1.14.0源码为例来说明,泛型方法在flink中是如何使用的。

源码示例

泛型方法的定义

HadoopSecurityContext类中的runSecured方法就是一个泛型方法。
publicT之间加入了<T>说明runSecured是一个泛型方法;HadoopSecurityContext类不是泛型类而且SecurityContext接口也不是泛型接口,说明泛型方法的使用和类本身是否是泛型类无关。

package org.apache.flink.runtime.security.contexts;

public class HadoopSecurityContext implements SecurityContext {

    private final UserGroupInformation ugi;

    public HadoopSecurityContext(UserGroupInformation ugi) {
        this.ugi = Preconditions.checkNotNull(ugi, "UGI passed cannot be null");
    }

    public <T> T runSecured(final Callable<T> securedCallable) throws Exception {
        return ugi.doAs((PrivilegedExceptionAction<T>) securedCallable::call);
    }
}

runSecured到底返回的类型T是什么,是由该方法参数中的T决定的,例如
org.apache.flink.runtime.taskexecutor.TaskManagerRunner中runTaskManagerProcessSecurely方法中runSecured的返回值类型就是runTaskManager方法的返回值类型,即int类型

exitCode =
        SecurityUtils.getInstalledContext()
                .runSecured(() -> runTaskManager(configuration, pluginManager));

而在org.apache.flink.runtime.entrypoint.ClusterEntrypoint中startCluster方法中返回值就是runSecured的返回值类型就是runCluster方法的返回值类型,即void

securityContext.runSecured(
        (Callable<Void>)
                () -> {
                    runCluster(configuration, pluginManager);

                    return null;
                });

再看下org.apache.flink.api.java.tuple.Tuple2,这是一个泛型类,public class Tuple2<T0, T1> extends Tuple里面getField方法就是一个泛型方法

public <T> T getField(int pos) {
    switch (pos) {
        case 0:
            return (T) this.f0;
        case 1:
            return (T) this.f1;
        default:
            throw new IndexOutOfBoundsException(String.valueOf(pos));
    }
}

但是注意,这个方法的类型变量是T和这个类的类型变量T0T1并不一样,也就是说,泛型方法的类型变量与所在泛型类无关,可以与类的类型变量相同也可以不同。

静态泛型方法

最后看一下org.apache.flink.connector.kafka.source.KafkaSourceOptions中的getOption方法,是静态方法也是泛型方法

public static <T> T getOption(
        Properties props, ConfigOption<?> configOption, Function<String, T> parser) {
    String value = props.getProperty(configOption.key());
    return (T) (value == null ? configOption.defaultValue() : parser.apply(value));
}

同样此方法的返回值类型是由参数中的T决定的,可以看下这个方法是如何被调用的
KafkaPartitionSplitReader#maybeRegisterKafkaConsumerMetrics方法中返回的是Boolean类型

final Boolean needToRegister =
        KafkaSourceOptions.getOption(
                props,
                KafkaSourceOptions.REGISTER_KAFKA_CONSUMER_METRICS,
                Boolean::parseBoolean);

KafkaSourceEnumerator类的构造方法中返回的是Long类型

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