注解

1-注解的介绍

2021-07-07 374 4

简介 注解的使用(基础重要)

1.  注解Annotation的重要性

从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)

Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。 代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

Annotation 可以像修饰符一样被使用, 可用于修饰包,, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation的 “name=value” 对中。

在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE/Android中注解占据了更重要的角色,例如用来配置应用程序的任何切面, 代替JavaEE旧版中所遗留的繁冗代码和XML配置等。

未来的开发模式都是基于注解的, JPA是基于注解的, Spring2.5以上都是基于注解的, Hibernate3.x以后也是基于注解的,现在的Struts2有一部分也是基于注解的了,注解是一种趋势,一定程度上可以说: 框架 = 注解 + 反射 + 设计模式。

2.文档相关的注解

@author 标明开发该类模块的作者, 多个作者之间使用,分割

@version 标明该类模块的版本

@see 参考转向, 也就是相关主题

@since 从哪个版本开始增加的

@param 对方法中某参数的说明, 如果没有参数就不能写

@return 对方法返回值的说明, 如果方法的返回值类型是void就不能写

@exception 对方法可能抛出的异常进行说明 , 如果方法没有用throws显式抛出的异常就不能写

其中

    @param @return 和 @exception 这三个标记都是只用于方法的。

    @param的格式要求: @param 形参名 形参类型 形参说明

    @return 的格式要求: @return 返回值类型 返回值说明

    @exception的格式要求: @exception 异常类型 异常说明

    @param和@exception可以并列多个

3.JDK内置的三个基本注解

在编译时进行格式检查

@Override: 限定重写父类方法, 该注解只能用于方法,用于校验所写的方法是否重写了父类的方法。

@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择

@SuppressWarnings: 抑制编译器警告


4.跟踪代码依赖性,实现替代配置文件功能

Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。

@WebServlet("/login")
    public class LoginServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws
    ServletException, IOException { }
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws
    ServletException, IOException {
    doGet(request, response);
} }

5. Override注解的好处

//AnnotationTest.java
package com.ylaihui.annotations;

class Order{
    String name;

    public Order() {
    }

    public Order(String name) {
        this.name = name;
    }

    public void show(){
        System.out.println("Order show()...");
    }
}

class YlaihuiOrder extends Order{
    //@Override
    public void shows() {
        System.out.println("YlaihuiOrder show()...");
    }
}

public class AnnotationTest {
    public static void main(String[] args) {
        YlaihuiOrder ylaihuiOrder = new YlaihuiOrder();
        // 本意是想在 YlaihuiOrder 类中重写 Order 类中的 show方法,但是show写为shows了
        // 如果没有使用注解,那么不会报错,也不会有任何提示,容易犯错
        // 有了注解以后, 在shows方法前提供 @Override, 那么会强制检查方法是否真正的重写了父类中的方法
        ylaihuiOrder.show();  // Order show()...
    }
}

6. SuppressWarnings

// Deprecated 已过时的
Date date = new Date(2020, 10, 11);
System.out.println(date);

@SuppressWarnings("unused")
int num = 10;

@SuppressWarnings({ "unused", "rawtypes" })
ArrayList list = new ArrayList();


7. 自定义注解

定义新的 Annotation 类型使用 @interface 关键字,自定义注解时,可以参照Java中现有的注解,例如:@SuppressWarnings

自定义注解自动继承了java.lang.annotation.Annotation接口


Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。 其方法名和返回值定义了该成员的名字和类型。 我们称为配置参数。 类型只能是八种基本数据类型、 String类型、 Class类型、 enum类型、 Annotation类型、以上所有类型的数组。


可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字

如果只有一个参数成员, 建议使用参数名为value


如果定义的注解含有配置参数, 那么使用时必须指定参数值, 除非它有默认值。 格式是“参数名 = 参数值” , 如果只有一个参数成员, 且名称为value,可以省略“value=”

没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation

注意: 自定义注解必须配上注解的信息处理流程才有意义。


如何自定义注解:参照@SuppressWarnings定义

① 注解声明为:@interface

② 内部定义成员,通常使用value表示,

    例如String[]  value() default "myanno";  注解的值可以有多个

    或者 String  value() default "myanno";  注解的值只能有一个, 默认为 myanno

③ 可以指定成员的默认值,使用default定义

④ 如果自定义注解没有成员,表明是一个标识作用。

如果注解有成员,在使用注解时,需要指明成员的值。

自定义注解必须配上注解的信息处理流程(使用反射)才有意义。

自定义注解通常都会指明两个元注解:Retention、Target


package com.ylaihui.annotations;

 

public @interface MyAnnotations {
    String[]  value() default "myanno";
}


//MyAnnotationTest.java
package com.ylaihui.annotations;

 

//@MyAnnotations("myanno")
@MyAnnotations
interface Info{
    public void show();
}

 

public class MyAnnotationTest {
    public static void main(String[] args) {

 

    }
}


8. 4种元注解的使用

    元注解:对现有的注解进行解释说明的注解

    JDK5.0提供了4个标准的meta-annotation类型, 分别是:

    Retention

    Target

    Documented

    Inherited


8.1 Retention

@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值:

RetentionPolicy.SOURCE:在源文件中有效(即源文件保留) , 编译器直接丢弃这种策略的注释

RetentionPolicy.CLASS:在class文件中有效(即class保留) , 当运行 Java 程序时, JVM不会保留注解。 这是默认值

RetentionPolicy.RUNTIME:在运行时有效(即运行时保留) , 当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释

Retention:指定所修饰的 Annotation 的生命周期:SOURCE\CLASS(默认行为)\RUNTIME 只有声明为RUNTIME生命周期的注解,才能通过反射获取。

SOURCE: Annotations are to be discarded by the compiler. 编译后的class文件不会有注解信息

CLASS: Annotations are to be recorded in the class file by the compiler but need not be retained by the VM at run time. class文件有注解信息,但是运行时无法得到注解信息

RUNTIME:   Annotations are to be recorded in the class file by the compiler and  retained by the VM at run time,运行时可以获取注解信息,反射的时候用到

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {


8.2 Target

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

Target:用于指定所修饰的 Annotation 能用于修饰哪些程序元素

用法举例

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {




注解 SuppressWarnings 上面用Target修饰, 表示 SuppressWarnings 可以修饰 类型、属性、方法、参数、构造器、局部变量, 如果 某个注解声明为 @Target({TYPE}), 那么只可以修饰类型,不可以修饰属性方法等

8.3 Documented

Documented:表示所修饰的注解在被javadoc解析时,保留下来。

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。 默认情况下, javadoc是不包括注解的。

定义为Documented的注解必须设置Retention值为RUNTIME。


@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}



Date类的构造器,过时的, 被javadoc解析时, 保留到了文档中。

@Deprecated
public Date(int year, int month, int date) {
    this(year, month, date, 000);
}



upfile


8.4 Inherited

@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。

比如:如果把标有@Inherited注解的自定义的注解标注在类级别上,子类则可以继承父类类级别的注解,实际应用中,使用较少

Inherited:被它修饰的 Annotation 将具有继承性。

某个类使用了注解 MyAnnotations,如果注解MyAnnotations有继承性,也就是被 @Inherited修饰,那么子类也继承了父类的注解。


package com.ylaihui.annotation1;
 
import java.lang.annotation.*;
 
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.TYPE;
 
@Documented  // 所修饰的注解 MyAnnotation 在被javadoc解析时,保留下来
@Retention(RetentionPolicy.RUNTIME)  // MyAnnotation 注解信息 保留到运行时,反射可以获取注解信息
@Target({TYPE, FIELD})   // MyAnnotation 注解可以修饰 类型、属性
@Inherited  // 被它修饰 MyAnnotation 将具有继承性,父类是 MyAnnotation,其子类也是 MyAnnotation
public @interface MyAnnotation {
    String[] value() default "ylaihui";
}


//AnnotationTest.java
package com.ylaihui.annotation1;
 
import java.lang.annotation.Annotation;
 
@MyAnnotation
class Person{
    @MyAnnotation
    String name;
    int age;
 
    // '@MyAnnotation' not applicable to method
    //@MyAnnotation
    public void show(){
        System.out.println();
    }
}
 
class Student extends Person{
 
}
 
public class AnnotationTest {
    public static void main(String[] args) {
        // 子类 Student 继承了父类 Person的注解 MyAnnotation,因为 MyAnnotation 具有继承性是声明为 Inherited 的
        Annotation[] annotations = Student.class.getAnnotations();
        for (int i = 0; i < annotations.length; i++) {
            System.out.println(annotations[i]);
        }
    }
}


点赞 4

文章评论

欢迎您:

纸上得来终觉浅,绝知此事要躬行!

112 文章 36783 浏览 3 评论

联系我

  •   QQ:    361352119
  •  Email:  lisimmy@sina.com
  • 微信: