注解Annotation

最新推荐文章于 2024-05-27 08:14:49 发布

文雨水

最新推荐文章于 2024-05-27 08:14:49 发布

阅读量2.3k

点赞数

分类专栏： java 文章标签： java spring jvm

本文链接：https://blog.csdn.net/weixin_42203131/article/details/130526864

版权

java 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

一. 什么是注解

Annotation（注解）就是Java提供了一种为程序元素关联任何信息或任何元数据（metadata）的途径和方法。Annotion(注解)是一个接口，程序可以通过反射来获取指定程序元素的Annotion对象，然后通过Annotion对象来获取注解里面的元数据。

注解出现的位置

Annotation(注解)是JDK5.0及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。从某些方面看，annotation就像修饰符一样被使用，并应用于包、类型、构造方法、方法、成员变量、参数、本地变量的声明中。这些信息被存储在Annotation的“name=value”结构对中。

注解的成员提供了程序元素的关联信息（成员称为参数或注解属性） Annotation的成员在Annotation类型中以无参数的方法的形式被声明。其方法名和返回值定义了该成员的名字和类型。在此有一个特定的默认语法：允许声明任何Annotation成员的默认值。一个Annotation可以将name=value对作为没有定义默认值的Annotation 成员的值，当然也可以使用name=value对来覆盖其它成员默认值。这一点有些近似类的继承特性，父类的构造函数可以作为子类的默认构造函数，但是也可以被子类覆盖。

注解不会影响程序代码的执行

Annotation能被用来为某个程序元素（类、方法、成员变量等）关联任何的信息。需要注意的是，这里存在着一个基本的规则：Annotation不能影响程序代码的执行，无论增加、删除 Annotation，代码都始终如一的执行。另外，尽管一些annotation通过java的反射api方法在运行时被访问，而java语言解释器在工作时忽略了这些annotation。正是由于java虚拟机忽略了Annotation，导致了annotation类型在代码中是“不起作用”的；只有通过某种配套的工具才会对annotation类型中的信息进行访问和处理

注解的作用是什么

注解（Annotation）为我们在代码中添加信息提供了一种形式化的方法，是我们可以在稍后某个时刻方便地使用这些数据（通过解析注解来使用这些数据），常见的作用有以下几种： (1).生成文档。这是最常见的，也是java 最早提供的注解。常用的有@see @param @return 等； (2).在编译时进行格式检查。如@Override放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出； (3).跟踪代码依赖性，实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量；

二.JDK自带的注解

@override 表示当前方法覆盖了父类的方法

此注释只适用于修饰方法，表示一个方法声明打算重写超类中的另一个方法声明。如果方法利用此注释类型进行注解但没有重写超类方法，则编译器会生成一条错误消息

    package java.lang;

import java.lang.annotation.*;

/**
 * Indicates that a method declaration is intended to override a
 * method declaration in a supertype. If a method is annotated with
 * this annotation type compilers are required to generate an error
 * message unless at least one of the following conditions hold:
 *
 * <ul><li>
 * The method does override or implement a method declared in a
 * supertype.
 * </li><li>
 * The method has a signature that is override-equivalent to that of
 * any public method declared in {@linkplain Object}.
 * </li></ul>
 *
 * @author  Peter von der Ah&eacute;
 * @author  Joshua Bloch
 * @jls 9.6.1.4 @Override
 * @since 1.5
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

@Deprecated 表示方法已经过时，方法上面有横线，使用是会警告

此注释可用于修饰方法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择。在使用不被赞成的程序元素或不被赞成的代码中执行重写时，编译器会发出警告


/**
 * A program element annotated &#64;Deprecated is one that programmers
 * are discouraged from using, typically because it is dangerous,
 * or because a better alternative exists.  Compilers warn when a
 * deprecated program element is used or overridden in non-deprecated code.
 *
 * @author  Neal Gafter
 * @since 1.5
 * @jls 9.6.3.6 @Deprecated
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}

@SuppressWarnings表示关闭一些警告信息（通知java编译器忽略特定的编译警告）

用来抑制编译时的警告信息。与前两个注释有所不同，你需要添加一个参数才能正常使用，这些参数都是已经定义好了的，我们选择性使用就好了

类型	说明
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	抑制没被使用过的代码的警告


/**
 *
 * @author Josh Bloch
 * @since 1.5
 * @jls 4.8 Raw Types
 * @jls 4.12.2 Variables of Reference Type
 * @jls 5.1.9 Unchecked Conversion
 * @jls 5.5.2 Checked Casts and Unchecked Casts
 * @jls 9.6.3.5 @SuppressWarnings
 */
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}

三.自定义注解

自定义语法规则

使用@interface关键字定义注解，注意关键字的位置使用@interface自定义注解时，自动继承java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口
成员已无参数无异常的方式声明，注意区别一般类成员变量的声明,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称
可以使用default为成员指定默认值
成员类型是受限的，合法的类型包括原始类型以及String,Class,Annotation,Enumeration(JAVA的基本数据类型有8种： byte(字节)、short(短整型)、int(整数型)、long(长整型)、float(单精度浮点数类型)、double(双精度浮点数类型)、char(字符类型)、boolean(布尔类型）
注解类可以没有成员，没有成员的注解称为标识注解，例如JDK注解中的@Override、@Deprecation
如果注解只有一个成员，并且把成员取名为value()，则在使用时可以忽略成员名和赋值号“=” ,例如JDK注解的@SuppviseWarnings ；如果成员名不为value，则使用时需指明成员名和赋值号"="

@Target( ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface lxt {
    String name()default "";
}

元注解

何为元注解？就是注解的注解，就是给你自己定义的注解添加注解，你自己定义了一个注解，但你想要你的注解有什么样的功能，此时就需要用元注解对你的注解进行说明了。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。

@Target

@Target说明了Annotation所修饰的范围：即注解的作用域，用于说明注解的使用范围（即注解可以用在什么地方，比如类的注解，方法注解，成员变量注解等等）注意：如果Target元注解没有出现，那么定义的注解可以用于程序的任何元素。取值从java.lang.annotation.ElementType这个枚举中规定的

类型	说明
CONSTRUCTOR	构造器
FIELD	用于描述域
LOCAL_VARIABLE	用于描述局部变量
METHOD	用于描述方法
PACKAGE	用于描述包
PARAMETER	用于描述参数
TYPE	用于描述类、接口（包括注解类型）或enum声明

@Retention

@Retention定义了该Annotation被保留的时间长短

某些Annotation仅出现在源码中，而被编译器丢弃
另一些却被编译器在class文件中，编译在class文件中的Annotation可能被虚拟机忽略
而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation于Class在使用是分离的）。

@Retention的取值是在RetentionPoicy这个枚举中规定的

类型	说明
SOURCE	在源文件中有效（即源文件保留）
CLASS	在class文件中有效（即class保留）
RUNTIME	在运行时有效（即运行时保留）

注意：注解的RetentionPolicy的属性值是RUNTIME,这样注解处理器可以通过反射，获取该注解值的属性值，从而去做一些运行时的逻辑处理

@Documented

@Documented用于描述其他类型的annotation应该被作为标注的程序成员的公共api,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员

@Inherited

@Inherited元注解是一个标记注解，@Inherited阐述了某个被标记的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。注意：@Inherited annotation类型是被标记过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation 当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

@Target( ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface lxt {
    String name()default "";
}

@lxt
public class Test {
    @Deprecated
    public  void sumD(){

    }
}

public class TestChild extends Test{
    public void add(){
    }
}

    public static void main(String[] args) {
        Class c=TestChild.class;
         Field[] fields= c.getFields();
        Annotation[] a=c.getAnnotations();
        for(Annotation annotation:a){
            System.out.println(annotation);
        }
    }

运行结果：@test.java8.annontion.lxt(name=)

注解开发实例：通过注解创建数据库表

表注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
    //用于指明表名
    String tableName();
}

列注解

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    // 列名
    String columnName();
    //字段类型，必须要指明
    @NotNull
    DataTypeEnum dataType();
    //字段长度，默认20
    int dataLength() default 20;
    //字段上的约束
    String constraint() default "";
}

bean类

@Table(tableName = "USER")
public class User {
    @Column(columnName = "id",dataType = DataTypeEnum.INT,dataLength = 11,constraint = "primary key")
    private int id;
    @Column(columnName = "name",dataType =DataTypeEnum.VARCHAR,dataLength = 20)
    private String name;
    @Column(columnName = "password",dataType = DataTypeEnum.VARCHAR,dataLength = 20)
    private String password;

创建表

 public static void main(String[] args) {
        StringBuffer sql=new StringBuffer();
        sql.append("create table ");
        User user=new User();
        Class userClass=user.getClass();
        Table table= (Table) userClass.getAnnotation(Table.class);
        String tableName= table.tableName();
        sql.append(tableName+" (");
        Field[] fields=userClass.getDeclaredFields();
        for(Field field:fields){
            Column column=field.getAnnotation(Column.class);
            System.out.println(column.columnName()+"-"+column.dataType().getType()+"-"+column.dataLength()+"-"+column.constraint());
            sql.append(column.columnName()+" ");
            sql.append(column.dataType().getType()+"");
            sql.append("(").append(column.dataLength()).append(") ");
            sql.append(column.constraint()).append(",");
        }
        String s=sql.substring(0,sql.length()-1)+")";
        System.out.println(s);
    }

执行结果 create table USER (id int(11) primary key,name varchar(20) ,password varchar(20) )

文雨水

关注

0
点赞
踩
7

收藏

觉得还不错? 一键收藏
0
评论
注解Annotation

Annotation（注解）就是Java提供了一种为程序元素关联任何信息或任何元数据（metadata）的途径和方法。Annotion(注解)是一个接口，程序可以通过反射来获取指定程序元素的Annotion对象，然后通过Annotion对象来获取注解里面的元数据。使用@interface关键字定义注解，注意关键字的位置使用@interface自定义注解时，自动继承java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。
复制链接

扫一扫

专栏目录