注释入门

注解

注解入门

例如注释是给人看的，而注解不仅可以给人看，还可以给程序看。

1.什么是注解？

注解单词：Annotation(恩乐太省)

• Annotation是JDK5.0引入的新技术。（不过jdk已经到12多了，已经不算新技术了）

• Annotation的作用：

  1. 不是程序本身，可以对程序作出解释。（这一点和注释（comment）没有什么区别）
  2. 可以被其他程序（比如：编辑器等）读取。

• Annotation的格式：

  1. 注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：

     @SuppressQarnings(value=“unchecked”)

• Annotation在哪里使用?

  1. 可以附加在package，class，method。field等上面。相当于给他们添加了额外的铺筑信息，

     我们可以通过反射机制 编辑实现对这些元数据的访问。

实例1

随意创建一个类，继承一个老祖宗类Object，写一个tostring方法

public class Domel extends Object{

      /**
     * @Override  重写的注解
     *注解有检查和约束的作用，必须按照规范去写。比如改toString中S改为小s就会报错
     * @return
     */
    @Override
    public String toString() {
        return super.toString();
    }
}

内置注解

• @Override：定义在java.lang.Override中，此注解只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明。

• @Deprecated：定义在java.lang.Deprecated中，此注解可以用于修辞方法，属性，类，表示不鼓励程序员使用这些的元素，通常是因为它很危险或者存在更好的选择。

• @SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息。一般不用。

  和前两个不同，需参数。

以上是java中最常见的内置·注解

实例2

   //@Deprecated 不推荐使用，但可以使用，或者存在更好的方式
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }

    public static void main(String[] args) {
        test();
    }

自定义注解，元注解

• 元注解的作用就是负责注解其他注解, Java定义了4个标准的meta-annotation类型,他们被用来提供对其他annotation类型作说明。

• 这些类型和它们所支持的类在java.lang.annotation包中可以找到( @Target , @Retention ,@Documented, @Inherited )

  1. @Target :用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

  2. @Retention :表示需要在什么级别保存该注释信息,用于描述注解的生命周期

     (SOURCE （源码）< CLASS （类）< RUNTIME（运行）)

     如定义RUNTLME在SOURCE和CLASS中也有效

  3. @Document:说明该注解将被包含在javadoc中。

  4. @Inherited:说明子类可以继承父类中的该注解。

• 使用@interface自定义注解是，自动继承java.lang.annotation.Annotation接口

• 分析：

  • @ interface用来声明一个注解,格式: public @ interface注解名(定义内容}
  • 其中的每一个方法实际上是声明了一个配置参数.
  • 方法的名称就是参数的名称
  • 返回值类型就是参数的类型(返回值只能是基本类型,Class , String , enum ).
  • 可以通过default来声明参数的默认值
  • 如果只有一个参数成员,一般参数名为value
  • 注解元素必须要有值,我们定义注解元素时,经常使用空字符串,0作为默认值

实例3

package com.yinbangchi;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author因果
 * @site www.xiaomage.com
 * @company xxx公司
 * @create  2021-01-12 10:55
 */
//测试元注解
public class Test1 {
    //因为是定义的范围实在方法和类，可写在这两个上。
    @MyAnnotation
    public void test(){

    }
}


//定义一个注解，一个类里只有一个公共的方法public 否则报错

/**
 * @Target 用于描述注解的使用范围
 * ElementType[] 是数组可以传多个参数
 * METHOD 方法
 * TYPE 类
 * @Retention 表示我们的注解在什么地方有效。
 */
@Target(value = {ElementType.METHOD, ElementType.TYPE})
@Retention(value =RetentionPolicy.RUNTIME)
@interface MyAnnotation{

}

自定义注解

package com.yinbangchi;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author因果
 * @site www.xiaomage.com
 * @company xxx公司
 * @create  2021-01-12 14:44
 */
//自定义注解
public class Test02 {

    /**
     * 注解可以显示赋值，如果没有默认值，我们必须给注解赋值
     * 在自定义注解时去掉默认值则，必须在 @MyAnnotation2()注解中传参数，否则报错
     * 参数时无序的。
     */
    @MyAnnotation2()
    public void test(){}

    /**
     * 如果时value，就是默认时""号，不需要写参数名
     */
    @MyAnnotation3("")
    public void test2(){}

}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    /**
     * 参数类型：参数类型+参数名（）；
     * default 默认值  ""
     *
     */
    String name() default "";
    int age() default 0;
    int id() default -1;//如果默认职位-1，则代表不存在。
    String[] schools() default {"fdoaifd","dfadf"};
}

@interface MyAnnotation3{
    String value();
}

小结

• 什么时注解？

1. 是jdk5.0引进的新技术
2. 英文名 Annotation
3. 能对程序作出解释，能被程序读取。
4. 格式：@+注解名
5. 附加在package，class，method。field上

• 内置注解（略）
• 自定义元注解（略）