Java 注解

已于 2022-12-19 17:23:19 修改
阅读量408 收藏
点赞数
分类专栏： # Java基础 文章标签： java
于 2022-12-07 22:25:18 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u012965203/article/details/128226450
版权

目录

一、简介

二、注解分类

2.1、由编译器使用的注解

2.2、由工具处理.class 文件的注解

2.3、程序运行期能够读取到注解，加载后一直存在 JVM 的注解

三、定义注解

3.1、元注解

3.2、注解配置参数类型

3.3、@Target

3.4、@Retention

3.5、@Repeatable

3.6、@Inherited

3.7、定义注解        

3.7.1、用@interface 定义注解

3.7.2、添加参数和默认值

3.7.3、用元注解配置注解

四、处理注解

4.1、使用注解

一、简介

        注解是放在 Java 源码类、方法、字段、参数前的一种特殊 ”注释“ 。

        注释是被编译器直接忽略，注解则可以被编译器打包进 class 文件，因此，注解是一种用作标注的 ”元数据“。

二、注解分类

        从 JVM 的角度看，注解本身对代码逻辑没有任何影响，如何使用注解完全由工具决定。

2.1、由编译器使用的注解

        例如：

        @Override：让编译器检查该方法是否正确地实现了覆写。
        @SuppressWarnings：告诉编译器忽略此处代码产生的警告。

        这类注解救不活被编译进入 .class 文件，它们在编译后就被编译器扔掉了。

        示例        

       Main.java 类


public class Main{

    public static void main(String[] args) {
        A a = new B();
        a.say();
    }

}

interface A{
    void say();
}
class B implements A{

    @Override
    public void say() {

    }
}

       编译后的文件

        Main.class

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

public class Main {
    public Main() {
    }

    public static void main(String[] args) {
        A a = new B();
        a.say();
    }
}

        A.class

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

interface A {
    void say();
}

        B.class

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

class B implements A {
    B() {
    }

    public void say() {
    }
}

        B.class 文件里 @Override 注解编译后就被编译器扔掉了。

2.2、由工具处理.class 文件的注解

        比如工具会在加载class的时候，对class做动态修改，实现一些特殊功能。

        例如：

        @Data   IntelliJ IDEA 工具可以自动生成get与set方法并且重写equals和toString方法

        示例

        Person.java

import lombok.Data;

@Data
public class Person {

    private String username;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }
}

        Person.class

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

public class Person {
    private String username;

    public String getUsername() {
        return this.username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public Person() {
    }

    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof Person)) {
            return false;
        } else {
            Person other = (Person)o;
            if (!other.canEqual(this)) {
                return false;
            } else {
                Object this$username = this.getUsername();
                Object other$username = other.getUsername();
                if (this$username == null) {
                    if (other$username != null) {
                        return false;
                    }
                } else if (!this$username.equals(other$username)) {
                    return false;
                }

                return true;
            }
        }
    }

    protected boolean canEqual(Object other) {
        return other instanceof Person;
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        Object $username = this.getUsername();
        int result = result * 59 + ($username == null ? 43 : $username.hashCode());
        return result;
    }

    public String toString() {
        return "Person(username=" + this.getUsername() + ")";
    }
}

2.3、程序运行期能够读取到注解，加载后一直存在 JVM 的注解

        在程序运行期能够读取的注解，它们加载后一直存在于 JVM 中， 这也是最常用的注解。

        例如：

        @Controller  Spring 标记控制类注解

        @Service   Spring 标记业务层注解

@Controller
public class ApiController {
}

         ApiController.java文件 和 编译后文件ApiController.class 是一样的。@Controller 也一直存在。

三、定义注解

        Java 语言使用 @Interface 语法来定义注解（Annotation）。

        示例

public @interface Report {
    int type() default 0;

    String level() default "info";

    String value() default "";
}

        注解参数类似无参数方法，可以用 default 设置一个默认值（推荐）。比较常用参数名为value 。

3.1、元注解

        有一些注解可以修饰其他的注解，这些注解就称为元注解（meta annotation）。Java 标准库已经定义了一些元注解，只需使用注解，通常不需要自己写元注解。

3.2、注解配置参数类型

        定义一个注解时，还可以配置参数，配置参数可以包括

  •         Java基本类型
  •         String
  •         枚举类型
  •         基本类型、String、Class以及枚举的数组

3.3、@Target

        最常用的元注解是 @Target 。作用是定义的注解能够应用源码的哪些位置。

  •         类或接口：ElementType.TYPE
  •         字段：ElementType.FIELD
  •         方法：ElementType.METHOD
  •         构造方法：ElementType.CONSTRUCTOR
  •         方法参数：ElementType.PARAMETER 

        示例

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

@Target({
        ElementType.METHOD,
        ElementType.FIELD
})
public @interface Report {
}

        定义注解 Report 可以使用在方法和字段上。

3.4、@Retention

        @Retention 作用是定义注解的生命周期。

  •         仅编译期：RetentionPolicy.SOURCE
  •         仅class文件：RetentionPolicy.CLASS
  •         运行期：RetentionPolicy.RUNTIME

        如果注解@Retention不存在，默认 仅class文件：RetentionPolicy.CLASS 。通常自定义注解都是运行期RetentionPolicy.RUNTIME这个元注解。

        示例

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

@Retention(RetentionPolicy.RUNTIME)
public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

3.5、@Repeatable

        @Repeatable作用是这个注解是否可以重复使用。

        示例

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Target;

@Report(type=1, level="debug")
@Report(type=2, level="warning")
public class Main{

    public static void main(String[] args) {

    }



}
@Repeatable(Reports.class)
@Target(ElementType.TYPE)
@interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

@Target(ElementType.TYPE)
@interface Reports {
    Report[] value();
}

3.6、@Inherited

        @Inherited作用 子类是否可以继承父类定义的注解。注意@Inherited只对@Target(ElementType.TYPE)类型的注解有效，并且对继承的类有效，对接口的继承无效。

        示例

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Target;

@Inherited
@Target(ElementType.TYPE)
public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

        在使用的时候，如果一个类用到了@Report

@Report(type=1)
public class Person {
}

        则它的子类默认也定义了该注解：

public class Student extends Person {
}

3.7、定义注解        

3.7.1、用@interface 定义注解

public @interface Report {
}

3.7.2、添加参数和默认值

public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

3.7.3、用元注解配置注解

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Report {
    int type() default 0;
    String level() default "info";
    String value() default "";
}

        其中必须设置@Target 和@Retention 。 @Retention 一般设置为运行期（RetentionPolicy.RUNTIME）,@Inherited 和 @ Repeatable一般可以不写。

四、处理注解

        判断某个注解是否存在于类、字段、方法或构造器。

  •         Class.isAnnotationPresent(Class)
  •         Field.isAnnotationPresent(Class)
  •         Method.isAnnotationPresent(Class)
  •         Constructor.isAnnotationPresent(Class)

        示例

// 判断@Report是否存在于Person类:
Person.class.isAnnotationPresent(Report.class);

         使用反射API读取注解

  •         Class.getAnnotation(Class)
  •         Field.getAnnotation(Class)
  •         Method.getAnnotation(Class)
  •         Constructor.getAnnotation(Class)

        示例

// 获取Person定义的@Report注解:
Report report = Person.class.getAnnotation(Report.class);
int type = report.type();
String level = report.level();

4.1、使用注解

        定义一个Range.java注解类。 

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

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Range {
    int min() default 0;
    int max() default 255;
}

        Person.java使用注解

public class Person {
    @Range(min=1, max=20)
    public String name;

    @Range(max=10)
    public String city;
}

        测试

import java.lang.reflect.Field;

public class Main{

    public static void main(String[] args) {
        Person p = new Person();
        p.name="张无忌";
        p.city="深圳";

        try {
            Main.check(p);
        } catch (ReflectiveOperationException e) {
            e.printStackTrace();
        }

    }

    static void check(Person person) throws IllegalArgumentException, ReflectiveOperationException {
        // 遍历所有Field:
        for (Field field : person.getClass().getFields()) {
            // 获取Field定义的@Range:
            Range range = field.getAnnotation(Range.class);
            // 如果@Range存在:
            if (range != null) {
                // 获取Field的值:
                Object value = field.get(person);
                // 如果值是String:
                if (value instanceof String) {
                    String s = (String) value;
                    // 判断值是否满足@Range的min/max:
                    if (s.length() < range.min() || s.length() > range.max()) {
                        throw new IllegalArgumentException("Invalid field: " + field.getName());
                    }
                }
            }
        }
    }




}

        通过@Range 注解，配合 check() 方法就可以完成Person 示例的检查。

2014Team
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
【JVM知识】插入式注解处理器实现java编程规范检测
dylan的博客
12-17 591
插入式注解处理器实现java编程规范检测,实现插件有findbug、lombok、mapstruct等
Java|注解之使用注解
weixin_67497686的博客
03-05 58
Java程序的一种——注解（Annotation）。什么是注解（Annotation）？是放在类、方法、字段、参数前//不知道为什么我的idea上面没有Inject Resource编译器直接解则可以编译器，因此，
JVM详解，让你一文吃透
最新发布
深圳市多克创新科技有限公司
10-12 1137
你比别人强的地方，不是你做过多少年的CRUD工作，而是你比别人掌握了更多深入的技能。不要总停留在CRUD的表面工作，理解并掌握底层原理并熟悉源码实现，并形成自己的抽象思维能力，做到灵活运用，才是你突破瓶颈，脱颖而出的重要方向！ 你在刷抖音，玩游戏的时候，别人都在这里学习，成长，提升，人与人最大的差距其实就是思维。你可能不信，优秀的人，总是在一起
IDEA 如何查看 class 文件反编译后的内容
热门推荐
沉默王二
12-03 2万+
有时候，我们需要查看 IDEA 编译后的 class 文件是什么样子的，字节码不太能看得懂，就需要再进行反编译。怎么做呢？ 项目的目录下有一个 target，根据报名找到对应的 class 文件双击打开即可。 IDEA 默认会使用 Fernflower 对字节码文件进行反编译。反编译后的内容如下所示。 // // Source code recreated from a .class file ...
java Lock 源码分析
lxlmycsdnfree的博客
07-11 2511
java 中的lock 先关的类路径：Lock 是个接口，源码：// // Source code recreated from a .class file by IntelliJ IDEA // (powered by Fernflower decompiler) // package java.util.concurrent.locks; import java.util.concurre...
java 注解
10-15
===如果你想对 java有 更多 的理 解你 可以 下载 看 看
Java注解简单使用实例解析
08-18
主要介绍了Java注解简单使用实例解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
java注解和反射的个人学习笔记
03-01
java注解和反射的个人学习笔记
全面解析Java注解
12-22
　对于Java开发人员来说，在编写代码时，除了源程序以外，我们还会使用Javadoc标签对类、方法或成员变量进行注释，以便使用Javadoc工具生成和源代码配套的Javadoc文档。这些@param、@return等Javadoc标签是注解标签...
ResultDTO返回封装工具类
07-13
// // Source code recreated from a .class file by IntelliJ IDEA // (powered by Fernflower decompiler) //
idea 反编译插件启用
qq_37891961的博客
01-04 6168
当你发现你的idea无法正常查看源码的时候就需要启用他 启用之后会在代码的顶部发现这个提示 // // Source code recreated from a .class file by IntelliJ IDEA // (powered by Fernflower decompiler) // ...
java 注解的注解_深入浅出Java注解
weixin_36114091的博客
02-20 282
什么是注解注解对于开发人员来讲既熟悉又陌生，熟悉是因为只要你是做开发，都会用到注解(常见的@Override)；陌生是因为即使不使用注解也照常能够进行开发；注解不是必须的，但了解注解有助于我们深入理解某些第三方框架(比如Android Support Annotations、JUnit、xUtils、ActiveAndroid等)，提高工作效率。Java注解又称为标注，是Java从1.5开始支持加...
Java注解处理器
avclk66666的专栏
03-03 893
Java注解处理器 2015/03/03 | 分类：基础技术|0 条评论| 标签：注解 分享到：1 译文出处：race604.com原文出处：Hannes Dorfmann Java中的注解(Annotation)是一个很神奇的东西，特别现在有很多Android库都是使用注解的方式来实现的。一直想详细了解一下其中的原理。很有幸阅读到一篇详细解...
java 编译时注解处理
tinysakura的博客
07-26 4283
转载自fei20121106的博客 一、注解 Annotations是一种元数据，其作用在于提供程序本身以外的一些数据信息，也就是说Annotation他不会属于程序代码本身，不参与逻辑运算，故而不会对原程序代码的操作产生直接的影响。 一般来说Annotation有如下三种使用情形： Information for the compiler — Annotations can be used b...
JVM--插入式注解处理器
书香水墨
01-22 2081
@Target({ElementType.METHOD}) @Retention(RetentionPolicy.SOURCE) @Documented public @interface TakeTime { /** * 标记前缀,无实质作用,只是为了方便查找 * @return */ String tag() default ""; } package cn.kanyun.annotation_processor.taketime; import com
JVM原理--注解的实现原理
chulumou4012的博客
07-11 511
... 转载于:https://my.oschina.net/u/3896435/blog/1844558
Java 注解与注解处理器基础总结与实操步骤分析
记录移动开发相关的知识
12-09 586
Java 注解与注解处理器的核心知识点。
java 注解处理器的作用_JVM进阶 -- 浅谈注解处理器
weixin_35941686的博客
02-25 296
注解是 Java 5引入，用来为类、方法、字段和参数等Java结构 提供额外信息 的机制@Override 仅对 Java编译器 有用，为Java编译器 引用一条新的编译规则 ，编译完成后，它的使命也结束了Java的注解机制允许开发人员 自定义注解 ，这些自定义注解同样可以为Java编译器 添加编译规则这种功能需要由开发人员提供，并且以 插件的形式 接入Java编译器中，这些插件被称之为 注解处...
java 注解
06-02
Java注解是Java语言的一个重要特性，它是一种代码级别的元数据，可以为Java程序元素(如类、方法、变量等)添加信息和标记。Java注解可以在编译时、运行时或者两者都有使用。 Java中的注解使用@符号作为标识符，例如...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

2014Team

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值