JAVA提高之注解

清疚 2022-12-20 03:30 87阅读 0赞

最近学JAVA注解相关知识，写篇博客记录一下，主要从四个方面来介绍注解（1）为什么要用注解？（2）什么是注解？（3）注解的类型及其简介（4）如何自定义注解？

（1）为什么要用注解？

1>解决代码之间的松耦合问题：在设计程序时，强调高内聚，低耦合，如何时不同程序代码之间保持强的耦合性，通常使用Annotation和方法紧密的耦合起来，

2>注解定义了一种标准描述元数据的方法，避免不同的元数据定义方式带来的混乱。

简单来说：本来可能需要很多配置文件，需要很多逻辑才能实现的内容，就可以使用一个或者多个注解来替代，这样就使得编程更加简洁，代码更加清晰。

（2）什么是注解？

在阅读别人的程序的时候，经常会看到在方法体前面有@override等，那么，这个符号表示的是什么呢？经查资料之后，这个符号为注解，那么，什么是注解呢？注解，即元数据，描述数据的数据，为我们在代码中添加信息提供了一种形式化的方法，使我们能够在稍后某个时刻使用这些数据，换句来说，使用注解，我们能够完整的理解程序需要的信息，为某个方法提供说明或功能。**代码具有生命，注解就是对于代码中某些鲜活个体的贴上去的一张标签。简化来讲，注解如同一张标签，**

@Override
    public String toString() {
        return "This is String Representation of current object.";
    }

上面的代码中，我重写了`toString()`方法并使用了`@Override`注解。不用`@Override注解标记代码，程序也能够正常执行。那么，该注解表示什么？这么写有什么好处吗？事实上，`@Override`告诉编译器这个方法是一个重写方法(描述方法的元数据)，如果父类中不存在该方法，编译器便会报错，提示该方法没有重写父类中的方法。如果我不小心拼写错误，例如将toString()`写成了`toStrring(){double r}`，而且我也没有使用`@Override`注解，那程序依然能编译运行。但运行结果会和我期望的大不相同。现在我们了解了什么是注解，并且使用注解有助于阅读程序。

简而言之  对程序进行解释说明，使读者更好地阅读程序

（3）注解的类型和简介

Java定义了一套自己的注解，总共七个，其中，基本注解有三个，@Override、@Deprecated、@SuppressWarnnings，元注解有四个， @Retention、@Documented、@Target、@Inherited。

基本注解介绍：

*  @Override: 限定重写父类方法, 该注解只能用于方法，当我们想要复写父类中的方法时，我们需要使用该注解去告知编译器我们想要复写这个方法。这样一来当父类中的方法移除或者发生更改时编译器将提示错误信息。
 *  @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择，当我们希望编译器知道某一方法不建议使用时，我们应该使用这个注解。Java在javadoc 中推荐使用该注解，我们应该提供为什么该方法不推荐使用以及替代的方法
 *  @SuppressWarnings: 抑制编译器警告，这个仅仅是告诉编译器忽略特定的警告信息，例如在泛型中使用原生数据类型。它的保留策略是SOURCE（译者注：在源文件中有效）并且被编译器丢弃。

元注解介绍

*  @Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。
 *  @Documented - 标记这些注解是否包含在用户文档中。
 *  @Target - 标记这个注解应该是哪种 Java 成员。
 *  @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

@Retention简介：

> @Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命 周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值:
> 
>  *  RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的 注释
>  *  RetentionPolicy.CLASS:在class文件中有效（即class保留） ， 当运行 Java 程序时, JVM 不会保留注解。 这是默认值
>  *  RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会 保留注释。程序可以通过反射获取该注释。
> 
> ![202011102000060.png][]

@Target简介

> @Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于 修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量
> 
> ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTc5MjE2Mg_size_16_color_FFFFFF_t_70][]

其他元注解简介

>  *  @Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。
>  *  定义为Documented的注解必须设置Retention值为RUNTIME。
>  *  @Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
>  *  比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以 继承父类类级别的注解

Java常用的注解：

>     @Deprecated  -- @Deprecated 所标注内容，不再被建议使用。
>     @Override    -- @Override 只能标注方法，表示该方法覆盖父类中的方法。
>     @Documented  -- @Documented 所标注内容，可以出现在javadoc中。
>     @Inherited   -- @Inherited只能被用来标注“Annotation类型”，它所标注的Annotation具有继承性。
>     @Retention   -- @Retention只能被用来标注“Annotation类型”，而且它被用来指定Annotation的RetentionPolicy属性。
>     @Target      -- @Target只能被用来标注“Annotation类型”，而且它被用来指定Annotation的ElementType属性。
>     @SuppressWarnings -- @SuppressWarnings 所标注内容产生的警告，编译器会对这些警告保持静默。

（4）自定义注解

>  *  定义新的 Annotation 类型使用 @interface 关键字
>  *   自定义注解自动继承了java.lang.annotation.Annotation接口
>  *   Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其 方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能 是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、 以上所有类型的数组。
>  *   可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始 值可使用 default 关键字
>  *   如果只有一个参数成员，建议使用参数名为value
>  *   如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认 值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value， 可以省略“value=” 
>  *   没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数 据 Annotation 注意：自定义注解必须配上注解的信息处理流程才有意义。

@Target({ElementType.FIELD, ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Info {
          String value() default "tracy";
          boolean isDelete();
    }

[202011102000060.png]: /images/20221120/a9e1830ab107463390d0bac0a59611ec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTc5MjE2Mg_size_16_color_FFFFFF_t_70]: /images/20221120/f60598a224e44f8987ae63723ffcb3ae.png