Java 内置注解

迈不过友情╰ 2023-10-15 08:23 71阅读 0赞

## 一、内置注解 ##

Java内置注解 也称 Java标准注解，是Java [JDK][] 中自带的注解。Java 中有许多标准注解，以下是一些常见的标准注解：

1. @Override：用于表示一个方法是重写父类中的方法。

2. @Deprecated：用于标记已经过时的方法或类，提醒开发者不再使用。

3. @SuppressWarnings：用于抑制编译器产生的警告信息。

4. @FunctionalInterface：用于标记一个接口是函数式接口，即只包含一个抽象方法的接口。

5. @SafeVarargs：用于消除关于可变参数方法的警告。

这只是一小部分 Java 中的标准注解，还有更多其他的注解可供使用。

## 二、示例介绍 ##

### 2.1.@Override ###

#### 2.1.1.测试案例 ####

接口层代码：

![79352094db374f19a3212e2cae2ae078.png][]

接口的实现：

![83c74938d1ee4fd98581e17bf2575364.png][]

#### 2.1.2.使用注意 ####

@Override 用于标识该方法是重写父类的方法，通常用于标识接口的实现方法；

如果试图使用 @Override 标记一个实际上并没有覆写父类的方法时，java 编译器会告警。

#### 2.1.3.源码 ####

![edd5afd80b3543f9b27bae29c048454e.png][]

### 2.2.@Deprecated ###

#### 2.2.1.测试案例 ####

package com.cp.test3;
    
    import org.springframework.stereotype.Component;
    
    import javax.annotation.PostConstruct;
    import java.util.ArrayList;
    import java.util.List;
    
    @Component
    public class TD01 {
    
        @PostConstruct
        public List<String> setData() {
            List<String> list = new ArrayList<>();
            t_test(list);
            t_prod(list);
            System.out.println("list = " + list);
            return list;
        }
    
        @Deprecated
        public void t_test(List<String> list){
            list.add("我存放了测试数据!");
        }
        public void t_prod(List<String> list){
            list.add("我存放了生产数据!");
        }
    }

#### 2.2.2.运行结果 ####

list = [我存放了测试数据!, 我存放了生产数据!]

#### 2.2.3.使用注意 ####

**被标注的方法，在使用时如下所示，提示中会出现线条。被注解标注的方法，表示方法已过时或已弃用，提醒开发者谨慎使用，但依旧可以用。**

![2f27d3342da040cd9d5caae4cc517b94.png][]

#### 2.2.4.源码 ####

![7beafd9db4a547d9ab1bfe4968f93fd2.png][]

### 2.3.@SuppressWarnings ###

#### 2.3.1.测试案例(一) ####

![39915b197a0a4f0fbffbe54653df6c64.png][]

此时代码在强制转换时，编译器给了**高亮显示**的警告，在鼠标放到高亮显示处时，右下侧给出了警告原因和建议。此时提醒的是：Unchecked cast(未检查的强制转换)

#### 2.3.2.使用示例 ####

![813a04764aeb468387fd522e38165db4.png][]

上面使用【**单类型抑制警告**】，加了注解以后，高亮显示就没了。**一般来说，编译器提醒什么，value的值就是什么；例如下面**

<table style="width:700px;"> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>deprecation</td> 
   <td>使用了不赞成使用的类或方法时的警告</td> 
  </tr> 
  <tr> 
   <td>unchecked</td> 
   <td>执行了未检查的转换时的警告，例如当使用集合时没有用泛型(Generics)来指定集合保存的类型</td> 
  </tr> 
  <tr> 
   <td>fallthrough</td> 
   <td>当Switch程序块直接通往下一种情况而没有Break 时的警告</td> 
  </tr> 
  <tr> 
   <td>path</td> 
   <td>在类路径、源文件路径等中有不存在的路径时的警告</td> 
  </tr> 
  <tr> 
   <td>serial</td> 
   <td>当在可序列化的类上缺少serialVersionUID定义时的警告</td> 
  </tr> 
  <tr> 
   <td>finally</td> 
   <td>任何finally子句不能正常完成时的警告</td> 
  </tr> 
  <tr> 
   <td>all</td> 
   <td>所有的警告</td> 
  </tr> 
 </tbody> 
</table>

**但有时提醒没准确表达，也可以自定义，只要共同开发者知道也行；可以使用all，直接标识所有**，例如下面使用【**所有类型抑制警告**】：

![0916614c66624096addaab4a042f9b8b.png][]

all 是抑制所有报错，但不规范的使用可能会为程序带来风险，所以一般不推荐用 all 。

#### 2.3.3.测试案例(二) ####

![13d95377d55440ada1264d80fa588dd1.png][]

#### 2.3.4.使用示例 ####

![7885538f7e524010b0637be4036187ee.png][]

此时是使用**多种类型的抑制警告**，可以比较清晰的看到实用前后的代码对比。

#### 2.3.5源码 ####

![11a28362ef494bd7934361a253290dc5.png][]

### 2.4.@FunctionalInterface ###

#### 2.4.1.注解释义 ####

@FunctionalInterface 即 Functional Interface (函数式接口)。函数式接口的定义是：如果接口中只有一个抽象方法（可以包含多个默认方法或多个 static 方法），那么该接口就是函数式接口。@FunctionalInterface 就是用来指定某个接口必须是函数式接口，所以 **@FunInterface 只能修饰接口，不能修饰其它程序元素。**

#### 2.4.2.源码 ####

![95728e36f3c54545ba633d9f12d8218d.png][]

由源码可知，这个注解是JDK1.8 以后新增的，区别于上面JDK1.5的注解。函数式接口就是为 [Java][] 8 的 Lambda 表达式准备的，Java 8 允许使用 Lambda 表达式创建函数式接口的实例，因此 Java 8 专门增加了 @FunctionalInterface。下面是注释说明的翻译：

An informative annotation type used to indicate that an interface type 
    declaration is intended to be a functional interface as defined by the 
    Java Language Specification. 
    一种信息注释类型，用于指示接口类型声明旨在成为Java语言规范定义的功能接口。
    
    Conceptually, a functional interface has exactly one abstract method. 
    Since default methods have an implementation, they are not abstract. 
    从概念上讲，功能接口恰好有一种抽象方法。由于默认方法具有实现，因此它们不是抽象的。
    
    If an interface declares an abstract method overriding one of the public 
    methods of java.lang.Object, that also does not count toward the interface's 
    abstract method count since any implementation of the interface will have 
    an implementation from java.lang.Object or elsewhere.
    如果接口声明一个抽象方法覆盖java.lang.Object的公共方法之一，则该方法也不计入接口
    的抽象方法计数，因为该接口的任何实现都将具有java.lang.Object或其他地方的实现。
    
    
    Note that instances of functional interfaces can be created with lambda 
    expressions, method references, or constructor references.
    请注意，可以使用lambda表达式，方法引用或构造函数引用创建功能接口的实例。
    
    
    If a type is annotated with this annotation type, compilers are required 
    to generate an error message unless:
    如果使用此注释类型注释了类型，则需要编译器生成错误消息，除非:
    
        The type is an interface type and not an annotation type, enum, or class.
        类型是接口类型，而不是注释类型、枚举或类。
        The annotated type satisfies the requirements of a functional interface.
        注释类型满足功能接口的要求。
    
    
    However, the compiler will treat any interface meeting the definition of 
    a functional interface as a functional interface regardless of whether or 
    not a FunctionalInterface annotation is present on the interface declaration.
    但是，无论接口声明中是否存在功能接口注释，编译器都会将满足功能接口定义的任何接口视为功能接口。

从【注解说明】中，可以看到以下几点：

1、 @FunctionalInterface 注解的作用只是告诉编译器检查这个接口，保证该接口只能包含一个抽象方法。如果出现会报错。

2、 这个注解适用于Lambda 表达式创建函数式接口。

3、这个注解不是必须的，当接口满足 函数式接口时，不使用注解也会被编译器视为函数式接口。

#### 2.4.3.测试案例 ####

![516ae9d2df534acc9ce9c4895f9c558c.png][]

可以看到，现在我接口中存在两个抽象函数时，注解会报错。但下面的是没关系的：

![bf3c9d09cd674c2b9a09519825fd84d3.png][]

现在可以看到，只要注掉一个抽象函数，这个接口就不会报错了，哪怕你再添加其他默认方法或静态方法，也不影响注解的使用。

个人拙见，@FunctionalInterface 注解主要是帮助程序员避免一些低级错误 ，但这个错误，中高级程序员一般不会犯，而初级或小白一般没听说过这个注解，所以，实用性比较低。

### 2.5.@SafeVarargs ###

#### 2.5.1.源码 ####

![65d3a5a2fb014a169472b20d10dd8ad8.png][]

注解说明翻译如下：

A programmer assertion that the body of the annotated method or constructor 
    does not perform potentially unsafe operations on its varargs parameter. 
    Applying this annotation to a method or constructor suppresses unchecked 
    warnings about a non-reifiable variable arity (vararg) type and suppresses 
    unchecked warnings about parameterized array creation at call sites.
    程序员断言注释的方法或构造函数的主体不会对其varargs参数执行潜在的不安全操作。将此注释
    应用于方法或构造函数会抑制有关不可重复变量arity (vararg) 类型的未检查警告，并抑制
    有关在调用站点创建参数化数组的未检查警告。
    
    
    In addition to the usage restrictions imposed by its @Target meta-annotation,
     compilers are required to implement additional usage restrictions on this 
    annotation type; it is a compile-time error if a method or constructor 
    declaration is annotated with a @SafeVarargs annotation, and either:
    除了其 @ Target元注释所施加的使用限制外，还要求编译器对该注释类型实施其他使用限制; 
    如果使用 @ SafeVarargs注释注释方法或构造函数声明，则是编译时错误，并且:
    
        the declaration is a fixed arity method or constructor
        声明是一个固定的arity方法或构造函数
        the declaration is a variable arity method that is neither static nor final.
        声明是一个变量arity方法，它既不是静态的(static)也不是最终的(final)。
    
    
    Compilers are encouraged to issue warnings when this annotation type is 
    applied to a method or constructor declaration where:
    鼓励编译器在将此注释类型应用于方法或构造函数声明时发出警告，其中:
    
        The variable arity parameter has a reifiable element type, which includes 
    primitive types, Object, and String. (The unchecked warnings this annotation 
    type suppresses already do not occur for a reifiable element type.)
    变量arity参数具有可重复的元素类型，该类型包括原始类型，对象和字符串。(对于可重复的元素
    类型，此注释类型已抑制的未检查警告不会发生。)
        The body of the method or constructor declaration performs potentially 
    unsafe operations, such as an assignment to an element of the variable arity
    parameter's array that generates an unchecked warning. Some unsafe operations 
    do not trigger an unchecked warning.
    方法或构造函数声明的主体执行潜在的不安全操作，例如分配给变量arity参数的数组的元素，该元素
    生成未检查的警告。一些不安全的操作不会触发未检查的警告。
    
    For example, the aliasing in *** leads to a ClassCastException at runtime.
    例如，示例中的别名导致在运行时出现ClassCastException。
    
        @SafeVarargs // Not actually safe!
        static void m(List<String>... stringLists) {
            Object[] array = stringLists;
            List<Integer> tmpList = Arrays.asList(42);
            // Semantically invalid, but compiles without warnings
            // 语义上无效，但编译时没有警告
            array[0] = tmpList;
            // Oh no, ClassCastException at runtime!
            String s = stringLists[0].get(0);
        }
    
    Future versions of the platform may mandate compiler errors for such 
    unsafe operations.
    平台的未来版本可能会要求编译器错误来执行此类不安全操作。

程序员认定带有注释的主体或者构造函数不会对其执行潜在的不安全操作将此注释应用于未经检查的方法或者构造器在"不可具体化"的和未经检查的参数类型警告关于所有数组参数创建的时候。

除了强加使用@Target 元注解的限制之外，编译器还被用在注解类型上来实现额外的限制下面几种情况会在使用@SafeVarags 注解的时候产生编译时错误：在声明一个固定参数的方法或者构造函数的时候

也就是说如果你认为你的方法或者构造方法是类型安全的，那么你也就可以使用@SafeVarargs 来跳过@SuppressWarnings("unchecked")检查。

所以，这个注解是可以和@SuppressWarnings 配合使用的。

#### 2.5.2.源码示例 ####

![1eaaf7e8405c40d9b70481e142df97b6.png][]

方法 m 是源码中给的示例，可以看到，编译时是没问题的，但在运行时是会出现ClassCastException 异常的。

#### 2.5.3.个人测试 ####

![63c2424e22284c0c993671da6d10823f.png][]

[JDK]: https://blog.csdn.net/weixin_52255395/article/details/132430699?csdn_share_tail=%7B%22type%22%3A%22blog%22%2C%22rType%22%3A%22article%22%2C%22rId%22%3A%22132430699%22%2C%22source%22%3A%22weixin_52255395%22%7D
[79352094db374f19a3212e2cae2ae078.png]: https://img-blog.csdnimg.cn/79352094db374f19a3212e2cae2ae078.png
[83c74938d1ee4fd98581e17bf2575364.png]: https://img-blog.csdnimg.cn/83c74938d1ee4fd98581e17bf2575364.png
[edd5afd80b3543f9b27bae29c048454e.png]: https://img-blog.csdnimg.cn/edd5afd80b3543f9b27bae29c048454e.png
[2f27d3342da040cd9d5caae4cc517b94.png]: https://img-blog.csdnimg.cn/2f27d3342da040cd9d5caae4cc517b94.png
[7beafd9db4a547d9ab1bfe4968f93fd2.png]: https://img-blog.csdnimg.cn/7beafd9db4a547d9ab1bfe4968f93fd2.png
[39915b197a0a4f0fbffbe54653df6c64.png]: https://img-blog.csdnimg.cn/39915b197a0a4f0fbffbe54653df6c64.png
[813a04764aeb468387fd522e38165db4.png]: https://img-blog.csdnimg.cn/813a04764aeb468387fd522e38165db4.png
[0916614c66624096addaab4a042f9b8b.png]: https://img-blog.csdnimg.cn/0916614c66624096addaab4a042f9b8b.png
[13d95377d55440ada1264d80fa588dd1.png]: https://img-blog.csdnimg.cn/13d95377d55440ada1264d80fa588dd1.png
[7885538f7e524010b0637be4036187ee.png]: https://img-blog.csdnimg.cn/7885538f7e524010b0637be4036187ee.png
[11a28362ef494bd7934361a253290dc5.png]: https://img-blog.csdnimg.cn/11a28362ef494bd7934361a253290dc5.png
[95728e36f3c54545ba633d9f12d8218d.png]: https://img-blog.csdnimg.cn/95728e36f3c54545ba633d9f12d8218d.png
[Java]: http://c.biancheng.net/java/
[516ae9d2df534acc9ce9c4895f9c558c.png]: https://img-blog.csdnimg.cn/516ae9d2df534acc9ce9c4895f9c558c.png
[bf3c9d09cd674c2b9a09519825fd84d3.png]: https://img-blog.csdnimg.cn/bf3c9d09cd674c2b9a09519825fd84d3.png
[65d3a5a2fb014a169472b20d10dd8ad8.png]: https://img-blog.csdnimg.cn/65d3a5a2fb014a169472b20d10dd8ad8.png
[1eaaf7e8405c40d9b70481e142df97b6.png]: https://img-blog.csdnimg.cn/1eaaf7e8405c40d9b70481e142df97b6.png
[63c2424e22284c0c993671da6d10823f.png]: https://img-blog.csdnimg.cn/63c2424e22284c0c993671da6d10823f.png