注解-入门

于 2021-09-28 15:29:02 发布
阅读量216 收藏
点赞数
分类专栏： # Java基础 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/footless_bird/article/details/120530068
版权

注解概述

  • 注解是JDK1.5的新特性。
  • 标记（注解）可以加在包，类，字段，方法，方法参数以及局部变量上。
  • 注解是给编译器或JVM看的，编译器或JVM可以根据注解来完成对应的功能。

注解的作用:

  • 使用javadoc生成帮助文档：里边可以包含注解**@author和@version**

  • 编译检查：@Override @FunctionalInterface

  • 框架的配置(框架=代码+配置)

自定义注解

定义一个没有属性的注解

格式：

public @interface 注解名{ }

注意：

  • 注解使用的也是.java文件，编译生成的也是.class文件

  • 注解和类和接口和枚举都是同一个层次的，都是一种数据类型

定义一个有属性的注解

注解中没有成员变量，也没有成员方法

注解中可以包含属性，属性看成和抽象方法一个格式，但是可以包含默认值

定义格式：

public @interface 注解名{
	修饰符 数据类型 属性名();
	修饰符 数据类型 属性名() default 默认值;
}

注意：

  • 注解的属性修饰符省略不写则默认为 public abstract ；建议写出，增强语句的可读性

  • 注解属性的数据类型：

    ​ a.基本数据类型（4类8种）：byte，short，int，long，float，double，char，boolean

    ​ b.引用数据类型：String类型，反射类型，注解类型，枚举类型

    ​ c.以及以上所有类型的一维数组

定义包含特殊属性value的注解：注解中只有一个属性，并且叫value；或者注解中有其他的属性，但是属性必须有默认值

示例

public @interface MyAnno02 {
    //定义一个int类型的属性
    //public abstract int a();
    //abstract int a();
    int a();

    //定义一个double类型的属性,给属性添加默认值8.8
    public abstract double d() default 8.8;

    //定义一个String类型的数组属性
    public abstract String[] arr();

    //定义反射类型的属性(了解)
    public abstract Class clazz();
    //定义注解类型的属性(了解)
    public abstract MyAnno01 my01();
    //定义枚举类型的属性(了解)
    public abstract Color c();
}


/* 定义包含特殊属性value的注解 */
public @interface MyAnno03 {
    public abstract String value();

    public abstract int aaa() default 10;
}

使用自定义注解

注解可以使用的位置：包上，类上|接口上，成员变量上，成员方法上，构造方法上，局部变量上，方法的的参数上…

注意：

  • 同一个位置，同名的注解只能使用一次

  • 不同的位置，同名的注解可以多次使用

注解的使用格式：

  • 没有属性的注解，通过 @注解名 可以直接使用。例如：@MyAnno01

  • 有属性的注解：必须使用键值对的方式，给注解中所有的属性都赋值之后，才能使用注解

    格式：

    ​ @注解名(属性名=属性值，属性名=属性值，属性名=属性值，…属性名=属性值)

    注：

    ​ a.有默认值的属性，可以不同赋值，使用默认值

    ​ b.给多个属性赋值，中间要使用逗号隔开

    ​ c.属性的数据类型是数组，属性的值需要使用 { } 包裹起来，说明这一组值是一个数组的属性值

    ​ 数组只有一个值，可以省略 { }

    ​ 示例：arr = {“a”，“b”，“c”} arr = {“a”} ==> arr = “a”

    ​ d.注解中只有一个属性，并且叫 value；或者注解中有其他的属性，但是属性均有默认值

    ​ 那么我们在使用注解的时候，给属性赋值，可以省略属性名，直接写属性值

    ​ 示例：(任意的数据类型)value=“aaa” ==> “aaa”

示例

@MyAnno01	// 没有属性的注解
@MyAnno02(a = 10, arr={"aaa","bbb","ccc"})	// 有多个属性的注解
public class UseMyAnno {
    @MyAnno01
    @MyAnno02(a=100, d=1.1, arr="aaa")	// arr属性的数据类型是数组，只有一个值的情况，可省略 {}
    private String name;

    @MyAnno01
    @MyAnno03(value="aaa")
    public UseMyAnno() {
    }

    @MyAnno01
    @MyAnno03("www")	// 可省略属性名的注解
    public UseMyAnno(String name) {
        this.name = name;
    }

    @MyAnno01
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

元注解

元注解：java已经定义好的注解，可以使用元注解修饰自定义的注解

1.java.lang.annotation.Target

作用：用来标识注解使用的位置，如果没有使用该注解标识，则自定义的注解可以使用在任意位置。

属性：

  • ElementType[] value ：只有一个属性，属性名叫value（使用的时候，就可以省略属性名，直接写属性值）

  • java.lang.annotation.ElementType：是一个枚举，枚举中的变量都是常量，可以通过枚举名.变量名直接使用

    ElementType枚举中的常量：

    TYPE,		// 类，接口
FIELD,		// 成员变量
METHOD, 	// 成员方法
PARAMETER, 			// 方法参数
CONSTRUCTOR, 		// 构造方法
LOCAL_VARIABLE		// 局部变量

2.java.lang.annotation.Retention

作用：用来标识注解的生命周期（有效范围）

属性：

  • RetentionPolicy value： 只有一个属性，属性名叫value（使用的时候，就可以省略属性名，直接写属性值）

  • java.lang.annotation.RetentionPolicy：是一个枚举，枚举中的变量都是常量，可以通过枚举名.变量名直接使用

    RetentionPolicy枚举中的常量：

    SOURCE,  	// 注解只作用在源码(.java)阶段，生成的字节码文件(.class)中不存在
CLASS,		// 注解作用在源码阶段，字节码文件阶段，运行阶段不存在，默认值
RUNTIME		// 注解作用在源码阶段，字节码文件阶段，运行阶段

示例

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

//声明自定义注解Book可以使用的位置:类上|接口上，构造方法上，成员变量上
//@Target(value={ElementType.TYPE, ElementType.CONSTRUCTOR, ElementType.FIELD})
@Target({ElementType.TYPE,ElementType.CONSTRUCTOR,ElementType.FIELD})
//声明自定义注解Book:在.java文件中，在.class文件中和在内存中都有效
@Retention(RetentionPolicy.RUNTIME)
public @interface Book {
    //书名
    public abstract String value();
    //价格，默认值为 100
    public abstract double price() default 100;
    //多位作者
    public abstract String[] authors();
}

注解解析

作用：获取注解的属性值

原理：注解的解析底层使用的反射技术

java.lang.reflect.AnnotatedElement接口：在接口中定义了注解解析的方法

AnnotatedElement接口的实现类都重写了接口中的方法，都可以使用这些方法

​ 实现类：AccessibleObject，Class，Constructor，Field，Method，Package

AnnotatedElement接口中的常用方法：

boolean isAnnotationPresent(Class<?> annotationClass)	// 判断指定的对象(Class，Method...)上，是否包含指定的注解
/* 参数：
		Class<?> annotationClass：判断哪个注解，就传递哪个注解的class文件对象
								  判断类上，方法上有没有Book注解，就需要传递Book.class
   返回值：boolean
		 有指定的注解，返回true
		 没有指定的注解，返回false
*/
    
T getAnnotation(Class<T> annotationClass)	// 获取对象(Class，Method...)上指定的注解
/* 参数：
		Class<T> annotationClass：获取哪个注解，就传递哪个注解的class文件对象
								  获取类上，方法上的Book注解，就需要传递Book.class
   返回值：
		T：返回获取到的注解，获取的注解不存在，返回null
*/
    
Annotation[] getAnnotations() 			// 返回此元素上存在的所有公共注释。
Annotation[] getDeclaredAnnotations() 	// 返回直接存在于此元素上的所有注释，包含其他修饰符的注解

示例

import org.junit.Test;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Arrays;

@Book(value = "西游记",authors = {"吴承恩"})
public class Demo01ParseAnnotation {
    @Book(value = "水浒传",authors = {"施耐庵","林冲"},price = 88.8)
    public void method(){}

    /* 解析类上的注解:获取类上注解的属性值 */
    @Test
    public void show01() throws ClassNotFoundException {
        //1.获取当前类Demo01ParseAnnotation的class文件对象
        Class clazz = Class.forName("com.itheima.demo09Annotation.Demo01ParseAnnotation");
        //2.使用class文件对象中的方法isAnnotationPresent判断类上是否包含指定的Book注解
        boolean b = clazz.isAnnotationPresent(Book.class);
        System.out.println(b);//true
        if(b){
            //3.如果类上包含Book注解,使用class文件对象中的方法getAnnotation获取Book注解
            Book book = (Book)clazz.getAnnotation(Book.class);
            //4.使用注解名.属性名(),获取属性值
            String value = book.value();
            System.out.println(value);
            double price = book.price();
            System.out.println(price);
            String[] authors = book.authors();
            System.out.println(Arrays.toString(authors));
        }
    }

    /* 解析方法上的注解:获取方法上注解的属性值 */
    @Test
    public void show02(){
        //1.获取当前类Demo01ParseAnnotation的class文件对象
        Class clazz = Demo01ParseAnnotation.class;
        //2.使用class文件对象中的方法getMethods获取类中所有的方法,返回一个Method数组
        Method[] methods = clazz.getMethods();
        //3.遍历Method数组,获取每一个Method对象
        for (Method method : methods) {
            //4.使用Method对象中的方法isAnnotationPresent判断方法上是否包含指定的Book注解
            boolean b = method.isAnnotationPresent(Book.class);
            System.out.println(method.getName()+"-->"+b);
            if(b){
                //5.如果方法上有Book注解,使用Method对象中的方法getAnnotation,获取Book注解
                Book book = method.getAnnotation(Book.class);
                //6.使用注解名.属性名(),获取属性的值
                System.out.println(book.value());
                System.out.println(book.price());
                System.out.println(Arrays.toString(book.authors()));
            }
        }
    }
}

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

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Book {
    //书名
    public abstract String value();
    //价格，默认值为 100
    public abstract double price() default 100;
    //多位作者
    public abstract String[] authors();
}

注解和反射的综合案例

import java.lang.reflect.Method;

/*
    注解和反射的综合案例
    需求:
        模拟Junit单元测试的@Test注解：作用可以单独的运行某一个方法
        方法上添加了@Test注解，可以运行
        方法上没有添加@Test注解，不可以运行
 */
public class Demo01Test {
    public static void main(String[] args) throws Exception {
        //3.获取测试类的class文件对象
        Class clazz = Class.forName("com.itheima.demo10test.DemoMyTest");
        //4.使用class文件对象中的方法newInstance实例化对象
        Object obj = clazz.newInstance();
        //5.使用class文件对象中的方法getMethods,获取类中所有的成员方法,返回一个Method数组
        Method[] methods = clazz.getDeclaredMethods();//只会获取本类的方法,包含任意修饰符的,没有父类的方法
        //6.遍历数组,获取每一个Method对象
        for (Method method : methods) {
            //7.使用Method对象中的方法isAnnotationPresent判断Method对象上是否有MyTest注解
            boolean b = method.isAnnotationPresent(MyTest.class);
            //8.如果Method对象上有MyTest注解,使用invoke运行方法
            if(b){
                method.invoke(obj);
            }
        }
    }
}

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

//1.定义一个注解叫MyTest,使用元注解修饰(a.只能在方法上使用,b.运行时有效)
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTest {
}

//2.定义一个测试类,在测试类中定义多个方法,让部分方法使用MyTest注解修饰
public class DemoMyTest {
    @MyTest
    public void show01(){
        System.out.println("show01方法");
    }
    public void show02(){
        System.out.println("show02方法");
    }
    public void show03(){
        System.out.println("show03方法");
    }
    @MyTest
    public void show04(){
        System.out.println("show04方法");
    }
}
墨鸦_Cormorant
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
JAVA注解的入门
u010028461的专栏
01-17 339
学习注解的第一件事情，搞清楚什么是注解？ 什么是注解？先来看一下什么是注释 注释：注释就是我们添加在程序的源代码之中为了方便自己和他人阅读代码而添加的用于解释说明的文本，在编译时会过滤掉注释的内容。 注解（Annotation）一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面用于关联信息和
注解入门
Api Player的博客
06-15 1989
注解入门 注解和注释 注释是给人看的，注解是给机器（编译器，虚拟机）看的。 注解的概念 注解是一个标识，或者说是标签。 注解是一系列元数据，它提供数据用来解释程序代码，但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。 注解有许多用处，主要如下： - 提供信息给编译器： 编译器可以利用注解来探测错误和警告信息 - 编译阶段时的处理： 软件工具可...
Spring入门(注解方式)
BlueSkyInMyMind的博客
02-28 1301
一概述 二代码 1.导入jar包 2.类路径下创建applicationContext.xml配置文件 &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/...
深入理解Java：注解（Annotation）自定义注解入门
life is wonderful
11-29 5473
原文：http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html        要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前，我们就必须要了解Java 为我们提供的元注解和相关定义注解的语法。 元注解： 　　元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的met
Java注解入门
吹大的草的博客
05-21 195
Java的自定义注解使用自定义注解的用法 自定义注解的用法 注解目前非常的流行，很多主流框架都支持注解，而且自己编写代码的时候也会尽量的去用注解，一时方便，而是代码更加简洁。 注解的语法比较简单，除了@符号的使用之外，它基本与Java固有语法一致。Java SE5内置了三种标准注解： @Override，表示当前的方法定义将覆盖超类中的方法。 @Deprecated，使用了注解为它的元素...
Java基础语法测试-基础数据类型-注解-数组-inet-反射-oop-Java代码实现
03-09
适合人群：初学java语法入门测试代码 能学到什么：①注解、数组、数据类型、inet、method的实现；②多线程、oop、反射、scanner、struct等的 阅读建议：按照例子照着做或者直接运行起来，理解吸收代码
浅谈Spring自定义注解从入门到精通
08-25
浅谈Spring自定义注解从入门到精通 在业务开发过程中，我们经常会遇到形形色色的注解，但是框架自有的注解并不是总能满足复杂的业务需求。这时，我们可以自定义注解来满足我们的需求。根据注解使用的位置，文章将...
Mybatis 开发注解快速入门
09-01
MyBatis 使用简单的 XML 或注解进行配置和原始映射，将接口和 Java 的 POJO（Plain Old Java Objects）映射到数据库中的记录，使得开发工作更为便捷高效。 MyBatis 的主要功能架构包括： 1. **动态 SQL**：MyBatis...
Spring 注解 入门
03-01
Spring注解是Spring框架中的一个重要特性，它极大地简化了配置，提高了代码的可读性和可维护性。在本文中，我们将深入探讨如何使用Spring注解进行属性注入，并重点关注`@Autowired`和`@Qualifier`这两个关键注解。 ...
mybatis学习01-入门
最新发布
03-22
9. **最佳实践**：为了提高代码可维护性和可读性，建议将 SQL 语句与业务逻辑分离，即使用注解式编程或 MyBatis 的动态 SQL 功能。 通过以上步骤，你已经完成了 MyBatis 的基本入门。接下来，你可以深入学习 ...
java注解____注解的入门demo
-
03-15 1646
package com.annotation.test; import static java.lang.annotation.ElementType.CONSTRUCTOR; import static java.lang.annotation.ElementType.FIELD; import static java.lang.annotation.ElementType.LOCAL_VAR
注解使用入门（一）
徐公，微信公众号同名
07-24 5848
注解使用入门（一）本篇博客要讲解主要分为以下几个问题 注解的相关知识点 基于运行时的注解的例子解析说明 注解的相关知识点提到注解，大多数人应该都不默认，在我们程序中见到的@Override，@Deprected，@SupressWarnings等等，这些都是注解，只不过是系统自己封装好的，而我们平时比较少去深入理解是怎样实现的？1）什么是注解（Annotation）：Annotation（注解）就是
Java学习笔记-注解
Aaaabt的博客
04-19 105
Java学习笔记-注解 什么是注解 Annotation是从JDK5.0开始引入的新技术 Annotation的作用： 不是程序本身，可以对程序作出解释（这一点和注释（comment）没什么区别） 可以被其他程序（比如：编译器等）读取 Annotation的格式: 注解是以"@注释名"在代码中存在的，还可以添加一些参数值，例如：@RequestMapping("/index") Annotation在哪里使用？ 可以附加在package,class,method,field等上面，
注解（Annotation）自定义注解入门
zw1069626272的博客
06-20 1383
前几天面试遇到关于自定义注解的一些认识，虽然我们在开发的过程中很少遇到，但我觉得作为一名开发者我们还是很有必要了解一些java自定义注解的定义与使用！ 元注解： 　　元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解： 　　　　1.@Targe
Java注解入门介绍
lb850747906的博客
08-07 4579
注解为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些数据。
注解（Annotation）入门
06-22 3936
1.@Target, 作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方） 　　取值(ElementType)有： 　　　　1.CONSTRUCTOR:用于描述构造器 　　　　2.FIELD:用于描述域 　　　　3.LOCAL_VARIABLE:用于描述局部变量 　　　　4.METHOD:用于描述方法 　　　　5.PACKAGE:用于描述包 　　　　6.PARAMETER:用于描述参...
Java基础 -- 06注解Annotation
mmlz00的博客
12-24 238
注解：携带额外信息的标签
注解
qq_38364250的博客
02-21 521
1.什么是注解 语法：@注解名称 注解的作用：替代xml配置文件！ servlet3.0中，就可以不再使用web.xml文件，而是所有配置都用注解！ 注解是有框架来读取的！ 例如web.xml是由tomcat来读取；2.注解的使用 *定义注解类：框架的工作 *使用注解：我们的工作 *读取注解（反射）：框架的工作（例如 web.xml是由tomcat来读取；@Test 是Junit读取） 例如：@O...
中文注解详解：uCOS-II入门与挑战
本文档详细介绍了uCOS-II 2.52版本的源码中文注解，由钟常慰作者编写。uCos-II 是一款备受推崇的嵌入式操作系统，尽管相比于其他成熟系统（如Linux或RTOS如eCos）它在功能上可能稍显不足，比如缺乏内存分配模块和...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

墨鸦_Cormorant

大家喜欢的话可以点个关注投币哟

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

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

打赏作者

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

抵扣说明：

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

余额充值