Java注解详解

最新推荐文章于 2024-06-13 16:25:42 发布
最新推荐文章于 2024-06-13 16:25:42 发布
阅读量3.6k 收藏 41
点赞数 13
分类专栏： java 文章标签： 注解 自定义注解
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37334135/article/details/94325213
版权

​ 这部分内容是网上找的资源学的，之前也看过一些博客和书，但是个人觉得这篇算是讲的最清楚，最容易理解的。花一个小时学完基本都能猜到Spring注解（比如@Controller,@AutoWired）的运行机制了。

文章目录

1. 概念和分类

概念：说明程序的。给计算机看的

  • 注释：用文字描述程序的。给程序员看的

  • 定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

  • 概念描述：

    • JDK1.5之后的新特性
    • 说明程序的
    • 使用注解：@注解名称

  • 作用分类：
    ①编写文档：通过代码里标识的注解生成文档【生成文档doc文档】我们自己不能改的，比如@since
    ②代码分析：通过代码里标识的注解对代码进行分析【使用反射】
    ③编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】我们自己不能改的,比如@override

对于编写文档，下面来使用javadoc生成哥文档，做个小测试如下：

package com.scu.annotation;

/**
 * 关于商品操作的Dao，提供给服务层调用
 * @author 127067
 * @since jdk 1.8
 */
public class ItemDao {
    /**
     *根据商品id查询商品信息
     * @param id  商品id
     * @return  商品信息
     */
    public String findById(int id){
        return "小米手机9"+"3299"+"6G+128G"+"王源代言";
    }
}

在桌面新建立个文件夹，将这个ItemDao.java文件复制到文件夹中，把类中的包com.scu.annotation删掉(不删其实也行，但是生成的文档就出现了所在的包)。还需要将文件编码设置为ANSI编码否则编译时中文会乱码并且报错。使用命令行 cmd进入，使用命令javadoc ItemDao.java生成文档。接下来该文件夹下会多出很多文件

在这里插入图片描述

点击index.html，这就是我们生成的完整doc文档

在这里插入图片描述

注意到，@Since,@Author的信息都在类的介绍上面，关于方法的信息也有，这里就不贴出来了。

2. jdk中预定义的注解

  • JDK中预定义的一些注解
    • @Override ：检测被该注解标注的方法是否是继承自父类(接口)的
    • @Deprecated：该注解标注的内容，表示已过时
    • @SuppressWarnings：压制警告
      • 一般传递参数all @SuppressWarnings(“all”)

​ @Override就是为了防止方法重写的时候名字写错了，比如父类方法名findById子类本来打算重写的，但是手误写成了fnidById，此时加上@Override注解，那么编译就会报错，因为父类并没有fnidById方法。

​ java.util.Date类中就有很多方法被标注了@Deprecated注解，表示这个方法将来会被弃用，如果我们强行使用，那么会出现如下提示:

Date date = new Date();
int day = date.getDay();//getDate()中间会多一横杠

​ @SuppressWarnings注解用来压制警告，比如之前写的ItemDao类上会出现提示，该类没有被使用。如果想不出现提示的话就使用该注解。通常使用到类，方法，域（局部变量上也行），构造方法上。

3. 自定义注解

格式：

元注解
public @interface 注解名称{
	属性列表;
}

本质：注解本质上就是一个接口，该接口默认继承Annotation接口 创建MyAnno注解 先编译然后再使用反编译，如下

public @interface MyAnno {
}

将该java文件复制到文件夹下，先编译（多出来MyAnno.class文件）再反编译

PS C:\Users\lenovo\Desktop\demo> javac .\MyAnno.java
PS C:\Users\lenovo\Desktop\demo> javap .\MyAnno.class
Compiled from "MyAnno.java"
public interface com.scu.annotation.MyAnno extends java.lang.annotation.Annotation {
}

可以看到注解本质上就是一个接口。

属性：接口中的抽象方法
* 要求：
1. 属性的返回值类型有下列取值

	1. 基本数据类型
	
	2. String类型
	
	3. 枚举
	
	4. 注解   不要带`@`
	
	5. 以上类型的数组
	
	   注意：属性名称（即方法名称）最好定义成属性名的形式，因为使用的时候是`方法名

​

public @interface MyAnno {
	       int age();//注意：不能带参数age(int x)不行
	       String name();
	       MyAnno2 anno();//注解
	       Animal dog();//枚举  DOG,CAT;
	       int[] arrs();
}
  1. 定义了属性，在使用时需要给属性赋值
    1. 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。
    1. 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。
    2. 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略

对于2.1 使用注解的时候，属性必须赋值，如下:

@MyAnno(age = 18)//18表示返回值
public class ItemDao {

    public String findById(int id){
        return "小米手机9"+"3299"+"6G+128G"+"王源代言";
    }
}

如果定义的时候加了default则不需要赋值,如下。但是如果有多个属性的话，没有default的属性，再使用的时候仍然要赋值。

public @interface MyAnno {
    int age() default 18;
}

@MyAnno
public class ItemDao {

    public String findById(int id){
        return "小米手机9"+"3299"+"6G+128G"+"王源代言";
    }
}

对于2.2 如果定义的属性名为value那么使用的时候就不需要指定属性名。但是如果要使用多个属性的时候需要指明value=xxx。如下：

public @interface MyAnno {
    String value();
}

@MyAnno("hello")// 不需要指定value="hello"
public class ItemDao {

    public String findById(int id){
        return "小米手机9"+"3299"+"6G+128G"+"王源代言";
    }
}

对于2.3，举例如下：

public @interface MyAnno {
    String value();
    String[] strs();
}

@MyAnno(value = "hello",strs = {"Tom","Jack","Lucy"})
public class ItemDao {

    public String findById(int id){
        return "小米手机9"+"3299"+"6G+128G"+"王源代言";
    }
}

4. 元注解

元注解：用于描述注解的注解

@Target：描述注解能够作用的位置

  1. ElementType取值：

    • TYPE：可以作用于类上
    • METHOD：可以作用于方法上
    • FIELD：可以作用于成员变量上

  2. @Retention：描述注解被保留的阶段 三个阶段

    @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到 如果是CLASS则也会保留到字节码文件中但是不会被jvm读取到 SOURCE则都不可以 (Override就是SOURCE这个阶段)

  3. @Documented：描述注解是否被抽取到api文档中 使用javadoc生成后能够看到

  4. @Inherited：描述注解是否被子类继承

对于Target，来看源码中仅有的一个属性value：

ElementType[] value();

ElementType枚举中的类型主要是TYPE,METHOD,FIELD。

对于3，如果自定义注解使用了元注解@Documented，那么使用了该自定义注解的类再生成javadoc的时候会保留该注解。通常我们主要使用前两个即可。

5. 解析注解

在程序使用(解析)注解：获取注解中定义的属性值 替换反射中使用的配置文件，配置文件中指定类名和方法名
1. 获取注解定义的位置的对象 （Class，Method,Field）
2. 获取指定的注解
* getAnnotation(Class)
//其实就是在内存中生成了一个该注解接口的子类实现对象

            public class ProImpl implements Pro{
                public String className(){
                    return "com.scu.annotation.User";
                }
                public String methodName(){
                    return "show";
                }
            }
  1. 调用注解中的抽象方法获取配置的属性值

根据以上步骤和反射知识来实现

public class User {
    public void show(){
        System.out.println("hello world!");
    }
}



@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Prop {
    String className();
    String methodName();
}


/**
 * 框架类
 * 前提：不能改变该类的任何代码。可以创建任意类的对象，可以执行任意方法
 */
@Prop(className = "com.scu.annotation.User",methodName = "show")
public class PropTest {
    public static void main(String[] args) throws Exception {
        //1.解析注解
        //1.1获取该类的字节码文件对象
        Class<PropTest> clazz = PropTest.class;
        //2.获取上边的注解对象
        //其实就是在内存中生成了一个该注解接口的子类实现对象
        /*
            public class ProImpl implements Pro{
                public String className(){
                    return "com.scu.annotation.User";
                }
                public String methodName(){
                    return "show";
                }

            }
        */
        Prop annotation = clazz.getAnnotation(Prop.class);
        //3.调用注解对象中定义的抽象方法，获取返回值
        String className = annotation.className();
        String methodName = annotation.methodName();
        //3.加载该类进内存
        Class cls = Class.forName(className);
        //4.创建对象
        Object instance = cls.newInstance();
        //5.获取方法对象
        Method method = cls.getMethod(methodName);
        //6.执行方法
        method.invoke(instance);

    }
}
//运行后输出 "hello world!"

这样就使用Prop来替换掉了配置文件prop.properties，需要修改类名和方法名的时候，只需要再使用的地方（解析的地方）进行属性指定即可。

6. 测试框架案例

现有注解Check和计算器类Calculator如下，其中定义了4个运算方法以及一个show方法，我们需要做的是，测试这四个方法中哪个有问题。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}

/**
 * 计算器类
 */
public class Calculator {

    //加法
    @Check
    public void add(){
        String str = null;
        str.toString();
        System.out.println("1 + 0 =" + (1 + 0));
    }
    //减法
    @Check
    public void sub(){
        System.out.println("1 - 0 =" + (1 - 0));
    }
    //乘法
    @Check
    public void mul(){
        System.out.println("1 * 0 =" + (1 * 0));
    }
    //除法
    @Check
    public void div(){
        System.out.println("1 / 0 =" + (1 / 0));
    }


    public void show(){
        System.out.println("永无bug...");
    }

}

我们需要通过解析注解来测试哪些方法有问题，并且写到日志当中。

public class CheckTest {
    public static void main(String[] args) throws Exception{
        Class cls = Class.forName("com.scu.annotation.Calculator");
        Object instance = cls.newInstance();
        Method[] methods = cls.getMethods();
        int count = 0;
        PrintWriter pw = new PrintWriter("bug.txt");
        for (Method method : methods) {//使用iter快捷方式
            if(method.isAnnotationPresent(Check.class)) {
                try {
                    method.invoke(instance);
                }catch (Exception e) {
                    count++;
                    pw.println("出现异常了");
                    pw.println("异常的名称:" + e.getCause().getClass().getName());
                    pw.println("异常的原因:" + e.getCause().getMessage());
                    pw.println("-----------------------");
                }
            }
        }
        pw.println("本次测试以一共出现:"+count+"次异常");
        pw.close();
    }
}

运行后控制台输出

src同级目录下出现bug.txt，内容如下:

出现异常了
异常的名称:java.lang.NullPointerException
异常的原因:null
-----------------------
出现异常了
异常的名称:java.lang.ArithmeticException
异常的原因:/ by zero
-----------------------
本次测试以一共出现:2次异常

小结

  1. 以后大多数时候，我们会使用注解，而不是自定义注解

  2. 注解给谁用？

    1. 编译器
    2. 给解析程序用 比如上面的CheckTest

  3. 注解不是程序的一部分，可以理解为注解就是一个标签 还有就是属性不能带参数

成都往右
关注
  • 13
    点赞
  • 踩
  • 41
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
JAVA 注解详解及简单实例
08-30
* @Deprecated：如果程序员使用被这个注解注释的元素，则编译器会进行提示 * @Suppress Warnings：忽略编译器的警告 四种元注解分别是： * @Target：表示注解的适用范围，例如 @Target(ElementType.FIELD) * @...
java中注解的定义、创建和使用
qq_45752401的博客
12-24 3259
1，注解概述 什么是注解：Annotation注解，是一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次 对比注释： ​ 注释是给程序员看的，注解是给程序看的。（注解不会影响代码的正常执行） 注解的作用： ​ 主要用于取代 XML 和 properties 配置文件 2，JDK提供的注解 注解 说明 @Deprecated 表示被修饰的方法已经过时。过时的方法不建议使用，但仍可以使用 @Override JDK5.0 表示复写父类的方法；jdk6
什么是Java注解，如何创建和使用注解？
scjrw的博客
07-11 519
简单来说，Java注解就是给代码加上一些注释，但是这些注释不是给编译器看的，而是给Java虚拟机（JVM）看的。上面的代码定义了一个MyAnnotation注解，它有一个属性value表示一个字符串，还有一个属性count表示一个默认值为0的整数。上面的代码定义了一个注解类型MyAnnotation，它有一个属性value，表示一个字符串。上面的代码获取了MyAnnotation注解中的count属性，并输出了这个属性提供的次数。在使用注解的时候，我们需要在方法名后面加上@注解名的方式来引用注解。
Java基础之注解机制 - 详解
最新发布
m0_74440466的博客
06-13 779
当我们理解了解了标准注解与元注解之后，就可以进行撰写自定义注解了。定义注解/*** 自定义注解*///默认为""//默认为""使用定义的注解@Override用反射接口获取注解信息main方法定义在使用注解的类中进行测试try {// 获取所有methods// 遍历// 方法上是否有MyMethodAnnotation注解try {// 获取并遍历方法上的所有注解+ method +// 获取MyMethodAnnotation对象信息。
Java注解总结
weixin_51001722的博客
06-01 4551
Bean注解主要用于方法上，有点类似于工厂方法，当使用了@Bean注解，我们可以连续使用多种定义bean时用到的注解，譬如用@Qualifier注解定义工厂方法的名称，用@Scope注解定义该bean的作用域范围，譬如是singleton还是prototype等。这个是Spring5.0里面新加入的一个注解，它是一个加速注解，也就是说默认Spring容器一启动的时候，所有的组件才会进行加载创建对象，如果有大量的组件经常要用到，又不想等Spring容器启动的时候才加载并创建对象，那么就可以标注。
java注解大全
Mr. Ding的小博客
05-18 9066
java 1、最基础注解（spring-context包下的org.springframework.stereotype） 1.1、@Controller @Service @Repository @Configuration @Component 1.2、 @Bean 2、最基础注解（spring-web包下的org.springframework.web.bind.annotation） 2.1、@ResponseBody 2.2、@RequestBody 2.3、@RequestMap.
Java注解开发
m0_53151031的博客
01-19 5143
一、自定义注解 二、
java注解详解，十分有用。
04-03
Java 注解详解 Java 注解（Annotation）是 JDK 5.0 及以后版本引入的一个特性，它是一个新的类型，与类、接口、枚举是在同一个层次。注解可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些...
java注解详解
11-15
Java 注解详解 Java 注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。 一、元注解 元注解是指注解...
java注解详解[文].pdf
10-11
Java 注解详解 Java 注解（Annotation）是 JDK 5.0 及以后版本引入的一个特性。它是一个新的类型，与接口类似，位于同一个层次，称为 Java 的一个类型（TYPE）。注解可以声明在包、类、字段、方法、局部变量、方法...
注解的本质
无
01-19 1113
参考文章 什么是注解 java注解的本质与基本原理 一、何为注解 注解，可以看作是对 一个 类/方法 的一个扩展的模版，每个 类/方法 按照注解类中的规则，来为 类/方法 注解不同的参数，在用到的地方可以得到不同的 类/方法 中注解的各种参数与值。 二、分类 普通注解、元注解、自定义注解。 普通注解 常见的主要有三个 ：@Override、@Deprecated、@SuppressWarnings @Override注解我们可能见到的比较多，主要用于子类对父类方法的重写。 @Deprecated主要
万字长文带你详聊Java注解本质
Hi，我是sharkchili，CSDN Java领域博客专家，开源项目JavaGuide维护人员，我想写一些有意思的东西，希望对你有帮助。
01-25 731
Target@Retention@Inherited首先定义check注解Retention;Target;
【Java 基础篇】Java 注解详解
繁依Fanyi的博客
09-26 1337
注解是一种标记在 Java 类、方法、字段和其他程序元素上的特殊标签。这些标签提供了有关元素的额外信息，通常以注解的方式存储在 Java 源代码中。注解通常不影响程序的运行，但可以在编译时、运行时或通过工具进行处理。Java 注解以符号开头，后跟注解的名称，如@Override等。注解可以有元素，元素以键值对的形式存储信息。// 类的内容在上面的示例中，@Author是一个自定义注解，具有两个元素name和date，它们存储了有关类MyClass的信息。
Java 注解使用
琅琊之榜
07-14 521
..或者比如我们常用，Spring中用来标记为Bean的注解定义：其中包含一个元素：value所有的注解接口都隐式的扩展自java.lang.annotation.Annotation接口，这个接口是一个常规接口，不是一个注解接口。你无法扩展注解接口，换句话说，所有的注解接口都直接扩展自java.lang.annotation.Annotation。基本类型（int、short、long、byte、char、double、boolean）String。
注解的作用
weixin_30533797的博客
06-25 198
编译检查 Annotation具有“让编译器进行编译检查的作用”。 例如，@SuppressWarnings, @Deprecated和@Override都具有编译检查作用。 在反射中使用Annotation 在反射的Class, Method, Field等函数中，有许多于Annotation相关的接口。 这也意味着，我们可以在反射中解析并使用Annotation。 根据Annotation生...
Java自定义注解
热门推荐
weixin_67450855的博客
11-05 1万+
注解分类（根据Annotation是否包含成员变量,可以把Annotation分为两类）:标记Annotation:没有成员变量的Annotation;这种Annotation仅利用自身的存在与否来提供信息元数据Annotation:包含成员变量的Annotation;它们可以接受(和提供)更多的元数据;
Java 文档注释
深圳市多克创新科技有限公司
05-24 496
Java 文档注释
java 常用注解
hui1350的博客
05-30 817
1. jdk **### spring 注解 ** 1.声明bean的注解 @Component 组件，没有明确的角色 @Service 在业务逻辑层使用（service层） @Repository 在数据访问层使用（dao层） @Controller 在展现层使用，控制器的声明（C） 2.注入bean的注解 @Autowired：由Spring提供 @Inject：由JSR-330提供 @Resource：由JSR-250提供 都可以注解在set方法和属性上，推荐注解在属性上（一目了然，少写代码）。 3.
java注解的原理
学亮编程手记
11-20 67
在Java中，注解本身并不具备任何功能，它只是一种元数据，可以用来为程序的各个元素（类、方法、字段等）添加额外的信息。在运行时，通过反射机制，可以获取到这些注解，并根据注解的信息执行相应的操作。通过反射，可以获取到类、方法、字段等元素上的注解，并获取注解的属性值。通过注解，我们可以在不修改源代码的情况下，为程序添加额外的信息和行为，提供了一种灵活和可扩展的方式来实现特定的逻辑和功能。编译期处理：在编译过程中，编译器会扫描源代码中的注解，并将注解信息写入编译后的字节码文件。
Java注解详解与动态性探索
"吴天雄-Java注解及动态性详解文档涵盖了Java注解的详细内容，包括内置注解、自定义注解、元注解的使用，以及如何通过反射机制读取注解信息。此外，文档还深入讨论了Java的动态性，包括静态与动态语言的区别，反射...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值