InterfaceAudience 简单介绍

InterfaceAudience 简单介绍

背景

学习hbase源码中，经常看到有这样的注解InterfaceAudience, 不太理解是什么意思，所以进行资料查阅，并结合hbase中的源码进行总结一下

介绍

源码

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.apache.hadoop.hbase.classification;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import org.apache.hadoop.hbase.classification.InterfaceStability.Evolving;

@InterfaceAudience.Public
@Evolving
public class InterfaceAudience {
    private InterfaceAudience() {
    }

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Private {
    }

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    public @interface LimitedPrivate {
        String[] value();
    }

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Public {
    }
}

解释

InterfaceAudience类包含三个注解类型，用来表示被注解的类的使用范围

1. InterfaceAudience.Public:对所有工程和应用可见
2. InterfaceAudience.LimitedPrivate: 仅限于某些本项目的衍生外围项目
3. InterfaceAudience.Private: 仅限于本项目自身

interfaceAudience 实际提供的则是逻辑层面的注解，以一种规范告诉使用者原开发者的意图，但不具有强制性， 是作为一种良好的项目风格的选择