java注解从入门到入土

最新推荐文章于 2024-04-25 21:16:40 发布

java冢狐

最新推荐文章于 2024-04-25 21:16:40 发布

阅读量499

点赞数 2

分类专栏： java 文章标签： java 反射注解

本文链接：https://blog.csdn.net/issunmingzhi/article/details/105660232

版权

java 专栏收录该内容

45 篇文章 0 订阅

订阅专栏

java注解

理解java注解

注解是java提供的一种对元重新中元素关联信息和元数据的途径和方法。

Annatation（注解）是一个接口，重新可以通过反射来获取指定程序中元素的Annatation对象，然后通过该对象来获取注解中的元数据信息

基本语法

声明注解与元注解

示例：

// 声明 Test注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test{
    
}

我们使用了@interface声明了Test注解，并使用@Target注解传入ElementType.METHOD参数来标明。@Test只能用于方法上，@Retention（RetentionPolicy.RUNTIME）则用来表示该注解的生存期是运行时。

从代码上看注解的定义很想接口的定义，毕竟在编译后也会生成Test.class文件。对于@Targer和@Retention是由java提供的元注解（标记其他注解的注解）。

@Target用来约束注解可以应用的地方（如方法、类或字段），其中ElementType是枚举类型其定义如下：表示可能的取值范围

public enum ElementType{
     // 标明该注解可以用于类、接口（包括注解类型）或enum声明
    TYPE,

    // 标明该注解可以用于字段(域)声明，包括enum实例 
    FIELD,

    // 标明该注解可以用于方法声明 
    METHOD,

    // 标明该注解可以用于参数声明 
    PARAMETER,

    // 标明注解可以用于构造函数声明 
    CONSTRUCTOR,

    // 标明注解可以用于局部变量声明 
    LOCAL_VARIABLE,

    // 标明注解可以用于注解声明(应用于另一个注解上)
    ANNOTATION_TYPE,

    // 标明注解可以用于包声明 
    PACKAGE,

    //标明注解可以用于类型参数声明（1.8新加入）
    TYPE_PARAMETER,

    // 类型使用声明（1.8新加入)
    TYPE_USE
}

当注解为指定Target值时，此注解可以用于任何元素之上，多个值使用{}包含并用逗号隔开。

@Retention用来约束注解的生命周期
- SOURCE：源码级别，注解将会被编译器丢弃，不会保留在编译好的class文件中
- CLASS：类文件级别，注解在class文件中可用，但是会被JVM丢弃，在执行的时候不会加载到虚拟机中。当注解未定义Retention值时，默认值是CLASS，如Java内置注解，@Override、@Deprecated、@SuppressWarnning等
- RUNTIME：运行时级别，将在运行期（JVM）也保留，因此可用通过反射机制去读取注解的内容。如SpringMvc中的@Controller、@Autowired、@RequestMapping等。

注解元素以及其数据类型

标记注解：注解内部没有定义其他元素，唯一作用就是标记声明

在自定义注解中，一般会包含一些元素以表示某些值，方便处理器使用。

定义一个DBTable的注解，主要用于数据库表与Bean类的映射，在其中声明一个String类型的name元素，其默认值是空字符，但是必须注意到对应对应元素的证明用采用方法的声明方式，同时可选择使用default提供默认值

@Target(Element.TYPE)// 只能应用于类上
@Retention(RetentionPolicy.RUNTIME)// 保存到运行时
public @interface DBTable{
    String name() default "";
}

@DBTable使用方式

//在类上使用该注解
@DBTable(name = "MEMBER")
public class Member{
    
}

支持的数据类型：

所有基本类型
String
Class
enum
Annotation
上述类型的数组

注意：声明注解元素时可以使用基本类型，但是不允许使用任何包装类型，注解也是可以作为元素的类型，也就是嵌套注解

编译器对默认值的限制

元素不能有不确定的值：要么有默认值，要么在使用注解时提供元素的值
对于非基本类型的元素，无论是在源代码中声明，还是在注解接口中定义默认值，都不能以null作为值
所以说只能定义一些特殊的值来表示某个元素不存在

注解不支持继承

注解不支持继承，因此不能使用关键字extends来继承某个@interface，但是注解在编译后会自动继承java.lang.annotation.Annotation接口。

快捷方式

注解中定义了名为value的元素，并且在使用该注解时，如果该元素时唯一需要赋值的一个元素，那么此时无需使用key=value的语法，只需要在括号内给出所需的值。

可以应用于人格合法类型的元素，但是限制了元素名必须为value。

示例：

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface IntegerValue{
    int value() default 0;
    String name() default "";
}
public class test {
    // 只想给value赋值
    @IntegerValue(20)
    private int age;
    // 都需要赋值是只能使用key=value
    @IntegerValue(value=1000,name="zhonghu")
    public int money;

}

java内置注解与其他元注解

java提供的内置注解，主要有三种

@Override：用于标明此方法覆盖了父类的方法

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

@Deprecated：用于标明以及过时的方法或者类

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

@SuppressWarnnings:用于有选择的关闭编译器对类、方法、成员变量、变量初始化的警告
```
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}
```
其内部有一个String数组主要接收值如下
- deprecation：使用了不赞成使用的类或方法时的警告；
- unchecked：执行了未检查的转换时的警告，例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型;
- fallthrough：当 Switch 程序块直接通往下一种情况而没有 Break 时的警告;
- path：在类路径、源文件路径等中有不存在的路径时的警告;
- serial：当在可序列化的类上缺少 serialVersionUID 定义时的警告;
- finally：任何 finally 子句不能正常完成时的警告;
- all：关于以上所有情况的警告。

元注解

@Target
@Retention
@Documented：被修饰的注解会生成到javadoc中
@Inherited：可以让注解被“继承”，只是通过使用其让子类Class对象使用getAnnotations()获取父类被@Inherited修饰的注解

注解与反射机制

java使用Annotation接口代表注解元素，该接口是所有注解类型的父接口。

同时为了运行时能准确获取到注解的相关信息，java在java.lang.reflect反射包下新增了AnnotatedElement接口，用于表示目前正在JVM运行的程序中已使用注解的元素，通过此接口提供的方法可以利用反射技术，读取注解的信息。

注解处理器

使用注解的过程中很重要的一部分就是创建于使用注解处理器

示例：

定义注解：

import java.lang.annotation.*;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider{
    public int id() default -1;
    public String name() default "";
    public String address() default "";
}

注解使用：

public class Apple {
    @FruitProvider(id=1,name="zhonghu",address = "china")
    private String appleProvider;

    public String getAppleProvider() {
        return appleProvider;
    }

    public void setAppleProvider(String appleProvider) {
        this.appleProvider = appleProvider;
    }
}

注解处理器：

import java.lang.reflect.Field;


public class FruitInfoUtil {
    public static void getFruitInfo(Class<?> clazz){
        String strFruitProvicer = "供应商信息：";
        Field[] fields = clazz.getDeclaredFields();//通过反射获取处理注解
        for (Field field : fields) {
            if (field.isAnnotationPresent(FruitProvider.class)) {
                FruitProvider fruitProvider = (FruitProvider) field.getAnnotation(FruitProvider.class);
                //注解信息的处理地方
                strFruitProvicer = " 供应商编号：" + fruitProvider.id() + " 供应商名称："
                        + fruitProvider.name() + " 供应商地址："+ fruitProvider.address();
                System.out.println(strFruitProvicer);
            }
        }
    }
}

输出

public class FruitRun {
    public static void main(String[] args) {
        FruitInfoUtil.getFruitInfo(Apple.class);
    }
}

结果：

java8中注解增强

元注解Repeatable

表示在同一位置重复相同的注解。

新增的两种ElementType

TYPE_PARAMETER
- 用于标注类型参数
TYPE_USE
- 可以用于标注除class以外的任意类型

java冢狐

关注

2
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
java注解从入门到入土

目录java注解理解java注解基本语法声明注解与元注解注解元素以及其数据类型编译器对默认值的限制注解不支持继承快捷方式java内置注解与其他元注解注解与反射机制注解处理器java8中注解增强元注解Repeatable新增的两种ElementTypejava8中注解增强元注解Repeatable新增的两种ElementTypejava注解理解java注解注解是java提供的一种对元重新中...
复制链接

扫一扫