Java-注解

最新推荐文章于 2024-08-02 08:41:40 发布
最新推荐文章于 2024-08-02 08:41:40 发布
阅读量585 收藏 2
点赞数 1
文章标签： java 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_57404736/article/details/127463226
版权

前言

在JavaSE中，注解的使用目的比较简单，例如标记过时的功能、抑制警告等等。在JavaEE中，注解占据了更重要的角色，现在流行框架Spring... Mybatis等都支持注解开发

1、注解使用示例

Java中有很多注解，我们举例三个常见的注解

1.1、@Override

作用域：只能写在方法上

含义：表示这个方法是重写的父类的方法

重写了父类的方法，如果添加上这个注解，那么重写的方法如果方法名称错误或者返回值类型错误，编译就会报错提示，反之没加注解，则不会提示

案例(观察sayHi3、sayHi4方法，都想要重写sayHi2方法，但是方法名都写错了，查看结果)

package com.tcc.entity;

import java.io.Serializable;

/**
 * @author 宇辰
 * @date 2022/9/26-11:27
 **/
public class User extends Person {

    public static void main(String[] args) {
        User user = new User();
        user.sayHi(); // 我是用户
    }

    @Override
    public void sayHi() {
        System.out.println("我是用户");
    }

    @Override
    public void sayHi3() {
        System.out.println("想要重写父类方法sayHi2");
    }

    public void sayHi4() {
        System.out.println("想要重写父类方法sayHi2");
    }
}

class Person {
    private String name;
    private String sex;

    public void sayHi(){
        System.out.println("我是人");
    }

    public void sayHi2(){
        System.out.println("被重写的方法");
    }
}

结果(可以看到带注解的会报错，因为在父类中没有找到被重写的方法sayHi3)

在这里插入图片描述

1.2、@Deprecated

作用域：只能写在方法上

含义：表示这个方法已经过时，不建议使用，但仍可以使用

被这个注解描述过的方法，调用的时候会在上面会显示被划掉的特殊样式

案例(Date日期类型很多方法都过时了)

在这里插入图片描述

调用结果

在这里插入图片描述

1.3、@SuppressWarnings

作用域：可以写在任何位置，类、方法、属性…等

含义：抑制编译器的警告，不提示警告消息

参数

  • 抑制单类型警告@SuppressWarnings（“unchecked”）、
    抑制多类型警告@SuppressWarnings（“unchecked”，“rawtypes）、
    抑制所有类型警告：@SuppressWarnings（“all”）
  • all: 抑制所有警告
  • boxing :抑制装箱、拆箱操作时候的警告
  • cast: 抑制映射相关的警告
  • dep-ann: 抑制启用注解的警告
  • deprecation: 抑制过期方法警告
  • fallthrough: 抑制在 switch 中缺失 breaks 的警告
  • finally :抑制 finally 模块没有返回的警告
  • hiding: 抑制相对于隐藏变量的局部变量的警告
  • incomplete-switch: 忽略不完整的 switch 语句
  • nls: 忽略非 nls 格式的字符
  • null :忽略对 null 的操作
  • rawtypes: 使用 generics 时忽略没有指定相应的类型
  • restriction: 抑制禁止使用劝阻或禁止引用的警告
  • serial: 忽略在 serializable 类中没有声明 serialVersionUID 变量
  • static-access: 抑制不正确的静态访问方式警告
  • synthetic-access: 抑制子类没有按最优方法访问内部类的警告
  • unchecked: 抑制没有进行类型检查操作的警告
  • unqualified-field-access : 抑制没有权限访问的域的警告
  • unused: 抑制没被使用过的代码的警告

使用Eclipse的话，如果参数定义了没使用，会有个黄色警告。

使用Idea的话，则是参数名称颜色变灰，都表示一个意思，警告

没有被使用，并且没有添加注解

没有被使用，但是使用了注解

在这里插入图片描述

2、自定义注解

注解一般在反射机制中用的多

  • 定义新的Annotation类型使用@interface关键字
  • 自定义注解自动继承了java.lang.annotation.Annotation接口
  • Annotation的成员变量在Annotation定义中以无参数方法的形式来生命，其方法名和返回值定义了该成员的名字和类型。。我们成为配置参数。类型只能是八种基本数据类型：String、Class、Enum、Annotation以上所有类型的数组。
  • 可以在定义Annotation的成员变量是为其指定初始值，指定成员变量的初始值可使用default关键字
  • 如果只有一个参数成员，建议使用参数名为value
  • 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非有默认的值，格式是：参数名=参数值，如果只有一个参数成员，且名称为value，则可以省略value=，直接写值
  • 没有成员定义的Annotation成为标记，包含成员变量的注解称为元数据注解

自定义注解必须配上注解的含义才有意义(在注解上写文档注解表名该注解含义)

无参注解

定义

package com.tcc.anno;

/**
 * @author 宇辰
 * @date 2022/9/26-11:27
 **/
public @interface MyAnno {

}

使用

在这里插入图片描述

有参注解

定义

package com.tcc.anno;

/**
 * @author 宇辰
 * @date 2022/9/26-11:27
 **/
public @interface MyAnno {

    String value();

    // 有默认值的注解，有默认值的话，使用注解可以不写该参数的值
    //String value() default "demo";
}

使用

在这里插入图片描述

3、元注解

元注解是定义在注解上的注解，用于修饰其他注解

JDK5.0提供了4个标准的meta-annotation类型，分别是：

  • Retention：指定该注解的生命周期
  • Target：指定该注解使用的地方
  • Documented：指定是否在JavaDoc文档中显示
  • Inherited：指定子类是否继承父类的这个注解

3.1、Retention注解

只能用于修饰一个Annotation定义，用于指定该Annotation的生命周期，@Retention包含一个@RetentionPolicy类型的成员变量，使用@Rentention时，必须为该value成员变量指定值

  • RetentionPolicy.SOURCE：在源文件中有效(即源文件中保留)，编译器直接丢掉这种策略的注解
  • RetentionPolicy.CLASS(默认)：在class文件中保留(即编译文件中保留)，当运行Java程序时，JVM不会保留注解
  • RetentionPolicy.RUNTIME：在运行时有效(即运行时保留)，当运行Java程序时，JVM会保留注解，程序可以通过反射来获取该注解

下面分别举例

SOURCE

  1. 在自定义注解上，添加该注解，并且参数为RetentionPolicy.SOURCE

    package com.tcc.anno;

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

/**
 * @author 宇辰
 * @date 2022/9/26-11:27
 **/
@Retention(RetentionPolicy.SOURCE)
public @interface MyAnno {
}

  2. 把注解写到main方法上

    在这里插入图片描述

  3. 运行main方法，查看编译后的文件是否保留了该注解(并没有保留)

    在这里插入图片描述

CLASS

  1. 在自定义注解上，添加该注解，并且参数为RetentionPolicy.CLASS

    package com.tcc.anno;

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

/**
 * @author 宇辰
 * @date 2022/9/26-11:27
 **/
@Retention(RetentionPolicy.CLASS)
public @interface MyAnno {
}

  2. 把注解写到main方法上

  3. 运行main方法，查看编译后的文件是否保留了该注解(保留了)

    在这里插入图片描述

RUNTIME

  1. 在自定义注解上，添加该注解，并且参数为RetentionPolicy.RUNTIME

  2. 把注解写到自定义的实体类上

    package com.tcc.entity;

import com.tcc.anno.MyAnno;

/**
 * @author 宇辰
 * @date 2022/10/22-14:09
 **/
@MyAnno
public class User {
    private String name;
    private String sex;


}

  3. 在Main方法中，使用反射获得该注解(只有值为RUNTIME的才可以使用反射获取注解)

    package com.tcc.test;


import com.tcc.anno.MyAnno;
import com.tcc.entity.User;

/**
 * @author 宇辰
 * @date 2022/8/31-8:53
 **/
public class Test {
    public static void main(String[] args){
        Class<User> userClass = User.class;
        MyAnno annotation = userClass.getAnnotation(MyAnno.class);
        System.out.println(annotation.toString()); // @com.tcc.anno.MyAnno()
    }
}

3.2、Target注解

用于修饰Annotation定义，用于指定被修饰的Annotation能用于修饰那些程序元素

@Target也包含一个名为value的成员变量，参数类型为ElementType的枚举类

ElementType

参数有很多，这里就不一一讲解， 这里只演示ElementType.METHOD，作用在方法上

package com.tcc.test;


import com.tcc.anno.MyAnno;
import com.tcc.entity.User;

/**
 * @author 宇辰
 * @date 2022/8/31-8:53
 **/
// @MyAnno  写在类上，报错
public class Test {

    @MyAnno // 只能写在方法上面
    public static void main(String[] args){
        Class<User> userClass = User.class;
        MyAnno annotation = userClass.getAnnotation(MyAnno.class);
        System.out.println(annotation.toString()); // @com.tcc.anno.MyAnno()
    }
}

3.3、Documented注解

表明该注解是否显示在生成的JavaDoc文档中，没有参数，用作标识

默认情况下JavaDoc是不包括注解的

举例

在这里插入图片描述

如何生成JavaDoc文档

在这里插入图片描述

3.4、Inherited注解

被它修饰的Annotation将具有继承性，如果某个类使用了被@Inherited修饰的Annotation，则其子类自动具有该注解

举例

  1. 在自定义注解上添加该注解

    package com.tcc.anno;

import java.lang.annotation.*;

/**
 * @author 宇辰
 * @date 2022/9/26-11:27
 **/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE_USE)
@Documented
@Inherited
public @interface MyAnno {
}

  2. 在实体类(User)中使用该注解

    package com.tcc.entity;

import com.tcc.anno.MyAnno;

/**
 * @author 宇辰
 * @date 2022/10/22-14:09
 **/
@MyAnno
public class User {
    private String name;
    private String sex;

}

  3. 在Main方法所在的类(Test)中继承User实体类，然后使用反射获取(Test)类上的注解

    package com.tcc.test;


import com.tcc.anno.MyAnno;
import com.tcc.entity.User;

/**
 * @author 宇辰
 * @date 2022/8/31-8:53
 **/
public class Test extends User {
    public static void main(String[] args){
        Class<Test> testClass = Test.class;
        MyAnno annotation = testClass.getAnnotation(MyAnno.class);
        System.out.println(annotation.toString()); // @com.tcc.anno.MyAnno()    因为继承了User类，这个类上有MyAnno注解，所以它自己也有
    }
}

4、JDK8新特性(可重复注解)

@Repeatable(MyAnnos.class)里面参数使用自己定义的注解

准备

在一个地方重复使用两次注解，查看结果(会报错)

在这里插入图片描述

4.1、JDK8之前解决办法

思路：

​ 创建一个注解，参数为想重复写的注解数组，然后在想要写的地方使用该注解，参数填入注解数组即可实现写多个重复注解

  1. 创建一个MyAnnos注解，定义类型为MyAnno数组的参数

    package com.tcc.anno;

/**
 * @author 宇辰
 * @date 2022/10/22-15:34
 **/
public interface MyAnnos {
    MyAnno[] value();
}

  2. 在User类上使用MyAnnos注解，参数传入两个相同的MyAnno注解

    package com.tcc.entity;

import com.tcc.anno.MyAnno;
import com.tcc.anno.MyAnnos;

/**
 * @author 宇辰
 * @date 2022/10/22-14:09
 **/
/*@MyAnno("test1")
@MyAnno("test2")*/
@MyAnnos({@MyAnno("test1"),@MyAnno("test2")})
public class User {
    private String name;
    private String sex;

}

4.2、JDK8解决办法

使用注解：@Repeatable(MyAnnos.class)

注意：

  • 参数里面自定义的注解的元注解，要与里面的参数里面的注解的元要保持一致，即子有，父也要有
  • 作用域可以不保持一致，但是一定要比参数注解的生命周期长

  1. 使用我们上面定义的MyAnnos注解

    package com.tcc.anno;

/**
 * @author 宇辰
 * @date 2022/10/22-15:34
 **/
public @interface MyAnnos {
    MyAnno[] value();
}

  2. 在需要重复使用的注解上面添加：@Repeatable(MyAnnos.class)注解即可

    package com.tcc.anno;

import java.lang.annotation.*;

/**
 * @author 宇辰
 * @date 2022/10/22-15:34
 **/
// 因为参数注解也有这些属性，所以父注解也需要有
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE_USE)
@Documented
@Inherited
public @interface MyAnnos {
    MyAnno[] value();
}

  3. 使用

    package com.tcc.entity;

import com.tcc.anno.MyAnno;

/**
 * @author 宇辰
 * @date 2022/10/22-14:09
 **/
@MyAnno("test1")
@MyAnno("test2") // 不报错了
//@MyAnnos({@MyAnno("test1"),@MyAnno("test2")})
public class User {
    private String name;
    private String sex;

}

5、JDK8新特性(类型注解)

在Java8中，ElementType新增了两个值

  • TYPE_PARAMETER：作用在类型参数上( 比如：泛型)
  • TYPE_USE：作用在类型上(包含上面那个)

举例

  1. 修改MyAnno注解上的@Target元注解参数

    package com.tcc.anno;

import java.lang.annotation.*;

/**
 * @author 宇辰
 * @date 2022/9/26-11:27
 **/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE_USE)
@Documented
@Inherited
public @interface MyAnno {
}

  2. 使用

    在这里插入图片描述

大米☋
关注
Java8新增的类型注解
实践求真知
07-14 1207
一点睛 Java 8为ElementType枚举增加了TYPE_PARAMETER、TYPE_USE两个枚举值，这样就允许定义枚举时使用@Target(ElementType.TYPE_USE)修饰，这种注解被称为Type Annotation（类型注解），Type Annotation可用在任何用到类型的地方。 从Java 8开始，Type Annotation可以在任何用到类型的地方使用...
类型注解
fishgeneral的博客
08-29 1790
Java 8为ElementType枚举增加了TYPE_PARAMETER和TYPE_USE两个枚举值。这样就允许定义注解时使用@Target(ElementType.TYPE_USE)修饰，这种注解就是类型注解。 在Java 8以前，注解只能在定义程序元素的时候使用。从Java 8开始，类型注解可以在任何使用类型的地方使用。例如如下位置 ： 创建对象 类型转换 使用implements实...
Java 8类型注释
最佳 Java 编程
05-20 369
Lambda表达式是迄今为止Java 8讨论最多和最受促进的功能。虽然我同意Lambda是一个很大的改进，但我认为其他一些Java 8功能由于Lambda的炒作而有所欠缺。 在这篇文章中，我想展示另一个来自Java 8的出色特性的示例：Type Annotations。 类型注释是可以在使用类型的任何位置放置的注释。 这包括new运算符，类型强制转换，Implements子句和throw...
Java 自定义注解中ElementType介绍
suk_java的博客
08-02 328
Java 自定义注解中ElementType介绍
java type use_java – 如何在泛型边界上获取TYPE_USE注释
weixin_31645409的博客
02-28 607
除了TypeVariable之外,可以通过AnnotatedType层次结构检索所有类型注释,其注释可以通过AnnotatedTypeVariable.getType()检索,AnnotatedTypeVariable.getType()将是TypeVariable的实例,它现在扩展AnnotatedElement并且恰好与Method返回的对象相同. getGenericReturnType()...
Java 自定义注解详解
qq_24612753的博客
03-14 1496
Java 自定义注解
java se 进阶_JavaSE进阶
weixin_31005047的博客
02-13 212
2、类型注解JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：publicenumElementType{/** Class, interface (including annotation type), or enum declaration */TYPE,/** Field declaration (includes enum constants)...
Java-注解@JsonProperty、@JsonNaming解决出入参驼峰与下划线相互转换.html
07-01
java郑
15.java-注解与java新特性.md
最新发布
08-18
15.java-注解与java新特性
java-注解总结【从入门到项目总结】
10-18
关于java注解的总结： 从入门介绍到项目使用的实际经验归纳总结得出！ 从jdk5到jdk8！
Java基础语法测试-基础数据类型-注解-数组-inet-反射-oop-Java代码实现
03-09
内容概要：通过带着读者编写Java基础语法测试代码，理解基础数据类型-注解-数组-inet-反射-oop-Java代码实现过程和测试代码 适合人群：初学java语法入门测试代码 能学到什么：①注解、数组、数据类型、inet、method...
Java - 注解使用示例（解析注解生成创建SQL表语句）
用时间去蜕变
02-22 1948
当你觉得你用反射的情况非常少的时候，通常就是因为注解接触的少。 目的 使用注解来自动生成一个建数据库表的SQL命令。 注解 我们会创建如下的四个注解，用于进行数据库表，以及字段本身表述的注解。 @DBTable 代表数据库表，注解元素name表示表名； @Constraints 代表对数据表每一列的条件补充，有primaryKey是不是主键，默认false，allowNu...
深入理解Java注解类型(@Annotation)
qq_39093474的博客
03-03 4574
文章目录1. 什么是Java注解2. 基本语法2.1 声明注解和元注解2.2 @Target2.3 @Retention2.4 注解元素及其数据类型2.5 编译器对默认值的限制2.6 注解不支持继承2.6 快捷方式（value）3. Java内置注解与其它元注解4. 注解和反射机制 1. 什么是Java注解 Java注解（Annotation）又称为Java标注，是JDK5引入的一种机制，Java语言中的类，方法，变量，参数和包等都可以标注。鉴于目前大部分框架(如Spring)都使用了注解简化代码并提高编
Java、Kotlin、Android中的注解(Annotation)
手写我对你的温柔
02-23 4859
注解机制: JDK1.5后，Java引入了一种新的注释机制（Annotation）,其一般作为说明信息，与程序的业务逻辑无关。 注解仅仅是一种说明信息，它广泛的应用于一些工具或框架中。 （官方定义）注解Annotation就是Java提供了一种元程序中的元素关联任何信息和任何元数据(metadata)的途径和方法。 什么是注解？ “元数据”可以描述它，即一种描述数据的数据。所以，可以说注解就...
java8 注解_Java8新特性回顾---注解能力增强
weixin_34168834的博客
02-12 163
今天回顾在Java8中注解增强的新特性，类型注解和重复注解。什么是类型注解？在Java8之前，注解只能用于声明中使用注解，比如定义类的时候、定义方法的时候或者bean中的变量上，但是没法在方法内使用。在Java8中，注解可以被用到任何使用类型的地方，比如说创建实体(new)、类型转化、implements和throws。这种可以用于类型声明和类型使用的注解，被称为类型注解。Java8 Elemen...
(二十)注解基本理解
kentlhxy的博客
03-05 190
注解Annotation 什么是注解 注解是用来修饰类中的成员信息的,例如 @Test ,@override就是注解的一种,注解就像学校的盖章一样,当盖章盖在了毕业证书上,那么你才能表示毕业,但是当你不毕业的时候压根就不需要他(没有赋予盖章的意义) 所以反应到程序中,注解贴在程序元素上,想要拥有一些功能,必须要有对应的角色参与 注解本身 被贴的程序元素 第三方程序(使用反射给注释赋予功能) 元注解 注解要想拥有功能,首先需要被元注解所赋予 元注解:在定义注解的时候用来贴在注解上的注解,用来限定注解的用法
JDK8新特性11——重复注解与类型注解
武汉小喽啰
02-24 410
1. 重复注解——@Repeatable 自从JDK5中引入注解以来，注解变得非常流行，并在各个框架和项目中被广泛使用，不过注解有一个很大的限制，在同一个地方不能多次使用同一个注解。JDK8引入了重复注解的概念，允许在同一个地方多次使用同一个注解。在JDK8中使用@Repeatable注解定义重复注解。 1.1 使用步骤 1.1.1 定义重复的注解容器注解——@Retenti...
Java 8 新特性：扩展注解（类型注解和重复注解）
热门推荐
Promise Sun special column
05-04 2万+
一.注解（JDK1.5） 二.注解更新（JDK1.8） 类型注解和重复注解…………
深入理解Java注解
"这篇文档详细介绍了Java注解的原理和使用方法，涵盖了元注解的类型和作用，以及如何自定义注解。" 在Java编程中，注解（Annotation）是一种强大的工具，它允许程序员在代码中添加元数据，这些元数据可以被编译器或...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值