Java中的三种标准注解和四种元注解说明

Java的三种标准注解和四种元注解

先来说说什么是注解

注解(也被称为元数据)为我们在代码中添加信息提供了一种形式化的方法,使我们可以在稍后某个时刻非常方便地使用这些数据。

注解的语法比较简单,除了@符号的使用之外,它基本与Java固有的语法一致。

Java内置了三种注解,定义在java.lang中的注解

  • @Override:表示当前的方法定义将覆盖超类中的方法。如果你不小心拼写错误,或者方法签名对不上被覆盖的方法,编译器就会发出错误提示。
  • @Deprecated:如果程序员使用了注解为它的元素,那么编译器会发出警告信息。
  • @SuppressWarnings:关闭不当的编译器警告信息。在java SE5之前的版本中,也可以使用该注解,不过会被忽略不起作用。

我们来看一下注解@Test的定义:

Java中的三种标准注解和四种元注解说明_第1张图片

定义注解时,会需要一些元注解(meta-annotation),如@Target和@Retention。

  • @Target 用来定义你的注解将应用于什么地方(例如是一个方法或者一个域)。
  • @Retention 用来定义该注解在哪一个级别可用,在源代码中(SOURCE)、类文件中(CLASS)或者运行时(RUNTIME)。

Java除了内置了三种标准注解,还有四种元注解

@Target 表示该注解用于什么地方,可能的值在枚举类 ElemenetType 中,包括:

  • ElemenetType.CONSTRUCTOR 构造器声明 
  • ElemenetType.FIELD 域声明(包括 enum 实例) 
  • ElemenetType.LOCAL_VARIABLE 局部变量声明 
  • ElemenetType.METHOD 方法声明 
  • ElemenetType.PACKAGE 包声明 
  • ElemenetType.PARAMETER 参数声明 
  • ElemenetType.TYPE 类,接口(包括注解类型)或enum声明 

@Retention 表示在什么级别保存该注解信息。可选的参数值在枚举类型 RetentionPolicy 中,包括:

  • RetentionPolicy.SOURCE 注解将被编译器丢弃 
  • RetentionPolicy.CLASS 注解在class文件中可用,但会被VM丢弃 
  • RetentionPolicy.RUNTIME VM将在运行期也保留注释,因此可以通过反射机制读取注解的信息。

@Documented 将此注解包含在 javadoc 中 ,它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同。相当与@see,@param 等。

@Inherited 允许子类继承父类中的注解。

元注解和自己写一个注解

一、元注解

  • @Target 表示这个注解可以用在什么地方
  • @Retention 表示我们的注解在什么地方还有效(runtime>class>sources)
  • @Documented 表示是否将我们的注解生成在javaDoc中
  • @Inherited 子类可以继承父类的注解
package com.epoch.customproject.utils;
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface DataSource {
    String value() default "dataSourceMdm";
}

二、自己写注解

public class test {
    @Myobject2(age = 18)
    public void test1(){ }
    @Myobject("默认")
    public void test2(){ }
}
@Target(value = {ElementType.TYPE,ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface  Myobject{
    //只有一个参数,所以传一个值就行  @Myobject("默认")
    String value();
}
@Target(value = {ElementType.TYPE,ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface  Myobject2{
        //   @Myobject2(age = 18)  其他参数不用传的原因是给过默认值
    //注释的参数   参数类型   参数名()
    String name() default "默认名字";
    int age()  ;
    double height() default  -1;//如果默认值-1,代表不存在
    String[] school() default {"默认学校1","默认学校2"};
}

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

你可能感兴趣的:(Java中的三种标准注解和四种元注解说明)