目录
Java 接口中的 @Public 和 @FunctionalInterface 注解详解
1. 概述
2. @Public 注解的作用
3. @Public 注解的使用
3.1 基本使用方式
3.2 应用于类和方法
4. @FunctionalInterface 注解的作用
4.1 主要作用
4.2 @FunctionalInterface 使用示例
4.3 允许默认方法
5. @Public 与 @Internal 的对比
6. @Public 与 @FunctionalInterface 适用场景
6.1 @Public 适用场景
6.2 @FunctionalInterface 适用场景
7. 最佳实践
7.1 @Public 最佳实践
7.2 @FunctionalInterface 最佳实践
8. 结论
Java 接口中的 @Public 和 @FunctionalInterface 注解详解
1. 概述
在 Java 开发中，@Public 和 @FunctionalInterface 注解用于标识接口的特定用途和可访问性。@Public 主要用于标识某些 API 或接口对外部用户是公开的，而 @FunctionalInterface 则用于表明该接口是一个符合 Java 8 及以上版本的函数式接口。本篇文章将详细介绍这两个注解的作用、使用场景以及最佳实践。
2. @Public 注解的作用
@Public 并非 Java 官方提供的标准注解，而是某些框架或 API（如 Apache Flink）中自定义的注解，用于表明某些接口或类是公共 API，供外部使用，而非内部实现。
在 Apache Flink 及类似的库中，@Public 主要用于：
标识稳定的 API，即可以供用户直接使用的 API。
避免内部 API 被误用，帮助开发者区分公共 API 和内部实现。
提供 API 兼容性保障，确保带有 @Public 注解的 API 在未来版本中不会轻易变更。
3. @Public 注解的使用
3.1 基本使用方式
通常，@Public 注解会应用于接口、类或方法，以表明它们是公共 API。例如：
import org.apache.flink.annotation.Public;
@Public
public interface MyPublicInterface {
void execute();
}
在上述示例中，@Public 注解表明 MyPublicInterface 是一个稳定的 API，供外部用户使用。
3.2 应用于类和方法
@Public 也可以用于类或方法，标识哪些部分对外部可用。例如：
import org.apache.flink.annotation.Public;
@Public
public class MyPublicClass {
@Public
public void myPublicMethod() {
System.out.println("This is a public API method.");
}
}