zoukankan      html  css  js  c++  java
  • JAVA注解@Interface基础知识

    java注解是在JDK5时引入的新特性,大多数框架(SpringBoot、MyBatis、Quartz)背后都在大量使用注解开发。

    一、先进行一个小试验,了解注解开发流程

    建立maven项目annotation:

    1 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    2   <modelVersion>4.0.0</modelVersion>
    3   <groupId>org.guangsoft</groupId>
    4   <artifactId>annotation</artifactId>
    5   <version>1.0</version>
    6   <packaging>war</packaging>
    7   <name>annotation</name>
    8 </project>

    基础注解类:

     1 package org.guangsoft.annotation.entity;
     2 
     3 import java.lang.annotation.ElementType;
     4 import java.lang.annotation.Retention;
     5 import java.lang.annotation.RetentionPolicy;
     6 import java.lang.annotation.Target;
     7 
     8 @Target(ElementType.METHOD)
     9 @Retention(RetentionPolicy.RUNTIME)
    10 public @interface DBInfo {
    11     String driver() default "";
    12     String url() default "";
    13     String username() default "";
    14     String password() default "";
    15 }

    其中,@Target表示此注解只能用于方法上,@Retention表示该注解生存期是运行时

    测试类:

     1 package org.guangsoft.annotation.utils;
     2 
     3 import java.lang.reflect.Method;
     4 
     5 import org.guangsoft.annotation.entity.DBInfo;
     6 
     7 public class JDBCUtil1 {
     8 
     9     @DBInfo(url="guanghe:annotation")
    10     public static void getConnection() throws Exception {
    11         Method method = JDBCUtil1.class.getMethod("getConnection", null);
    12         DBInfo info = method.getAnnotation(DBInfo.class);
    13         System.out.println(info.url());
    14     }
    15     
    16     public static void main(String args[]) {
    17         try {            
    18             JDBCUtil1.getConnection();
    19         } catch(Exception e) {
    20             e.printStackTrace();
    21         }
    22     }
    23 }

    从这里我们可以看出,获取注解用的是反射。

    运行结果:

    二、注解开发基本知识

    @Target类型

     1 public enum ElementType {
     2     /**标明该注解可以用于类、接口(包括注解类型)或enum声明*/
     3     TYPE,
     4     /** 标明该注解可以用于字段(域)声明,包括enum实例 */
     5     FIELD,
     6     /** 标明该注解可以用于方法声明 */
     7     METHOD,
     8     /** 标明该注解可以用于参数声明 */
     9     PARAMETER,
    10     /** 标明注解可以用于构造函数声明 */
    11     CONSTRUCTOR,
    12     /** 标明注解可以用于局部变量声明 */
    13     LOCAL_VARIABLE,
    14     /** 标明注解可以用于注解声明(应用于另一个注解上)*/
    15     ANNOTATION_TYPE,
    16     /** 标明注解可以用于包声明 */
    17     PACKAGE,
    18     /**
    19      * 标明注解可以用于类型参数声明(1.8新加入)
    20      * @since 1.8
    21      */
    22     TYPE_PARAMETER,
    23     /**
    24      * 类型使用声明(1.8新加入)
    25      * @since 1.8
    26      */
    27     TYPE_USE
    28 }

    @Target使用方法:

    1 @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})

    @Retention类型:

    SOURCE:

      注解将被编译器丢弃(该类型的注解信息只会保留在源码里,源码经过编译后,注解信息会被丢弃,不会保留在编译好的class文件里)

    CLASS:

      注解在class文件中可用,但会被VM丢弃(该类型的注解信息会保留在源码里和class文件里,在执行的时候,不会加载到虚拟机中),请注意,当注解未定义Retention值时,默认值是CLASS,如Java内置注解,@Override、@Deprecated、@SuppressWarnning等

    RUNTIME:

      注解信息将在运行期(JVM)也保留,因此可以通过反射机制读取注解的信息(源码、class文件和执行的时候都有注解的信息),如SpringMvc中的@Controller、@Autowired、@RequestMapping等。

    @Retention使用方法:

    1 @Retention(RetentionPolicy.RUNTIME)  //只允许使用一种生命周期

    支持类型:

    所有基本类型(int,float,boolean,byte,double,char,long,short)String  Class  enum  Annotation  以及上述类型的数组

     1 public @interface AnnotationElement {
     2     //枚举类型
     3     enum Status {FIXED,NORMAL};
     4     //声明枚举
     5     Status status() default Status.FIXED;
     6     //布尔类型
     7     boolean showSupport() default false;
     8     //String类型
     9     String name()default "";
    10     //class类型
    11     Class<?> testCase() default Void.class;
    12     //注解嵌套
    13     Reference reference() default @Reference(next=true);
    14     //数组类型
    15     long[] value();
    16 }

    注解书写规定

      注解书写要求以(key1 = value1, key2 = value2)的形式书写。

      其中value如果是多个值要用{}将value括起来,即(key1 = value1, key2={value21,value22})的形式。

      当注解中定义了名为value的元素,并且在使用该注解时,如果该元素是唯一需要赋值的一个元素,那么此时无需使用key=value的语法,而只需在括号()内给出value元素所需的值即可。

    内置注解

      java提供了许多内置注解,主要介绍三个:

      @Override:用于标明此方法覆盖了父类的方法

      @Deprecated:用于标明已经过时的方法或类

      @SuppressWarnnings:用于有选择的关闭编译器对类、方法、成员变量、变量初始化的警告

     1 @Target(ElementType.METHOD)
     2 @Retention(RetentionPolicy.SOURCE)
     3 public @interface Override {
     4 }
     5 
     6 @Documented
     7 @Retention(RetentionPolicy.RUNTIME)
     8 @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
     9 public @interface Deprecated {
    10 }
    11 
    12 @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
    13 @Retention(RetentionPolicy.SOURCE)
    14 public @interface SuppressWarnings {
    15     String[] value();
    16 }

    利用反射获取注解

      <A extends Annotation> getAnnotation(Class<A> annotationClass) 该元素如果存在指定类型的注解,则返回这些注解,否则返回 null。
      Annotation[] getAnnotations() 返回此元素上存在的所有注解,包括从父类继承的
      boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) 如果指定类型的注解存在于此元素上,则返回 true,否则返回 false。
      Annotation[] getDeclaredAnnotations() 返回直接存在于此元素上的所有注解,注意,不包括父类的注解,调用者可以随意修改返回的数组;这不会对其他调用者返回的数组产生任何影响,没有则返回长度为0的数组

  • 相关阅读:
    Unity跳转场景进度条制作教程(异步加载)
    Unity LOD-Level of Detail(多层次细节)用法教程
    Unity查找物体的子物体、孙物体
    Unity导航系统Navigation使用教程
    Unity物品栏、商城3D物品的显示插件
    VIM编辑器常用命令
    linux系统常用命令
    CRITICAL:yum.cli:Config Error: Error accessing file for config file:///etc/yum.conf
    linux下使用tar命令详解
    Linux之安装软件
  • 原文地址:https://www.cnblogs.com/guanghe/p/10190150.html
Copyright © 2011-2022 走看看