精华内容
参与话题
问答
  • 深入JAVA注解(Annotation):自定义注解

    万次阅读 多人点赞 2019-07-31 18:40:53
    要深入学习注解,我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前,我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。 元注解:  元注解的作用就是负责注解其他注解Java5.0定义了4...

    一、基础知识:元注解

     

    要深入学习注解,我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前,我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。

    元注解:

      元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解:
        1.@Target,
        2.@Retention,
        3.@Documented,
        4.@Inherited
      这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

      @Target:

       @Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

      作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

      取值(ElementType)有:

        1.CONSTRUCTOR:用于描述构造器
        2.FIELD:用于描述域
        3.LOCAL_VARIABLE:用于描述局部变量
        4.METHOD:用于描述方法
        5.PACKAGE:用于描述包
        6.PARAMETER:用于描述参数
        7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

      使用实例:  

    复制代码

    @Target(ElementType.TYPE)
    public @interface Table {
        /**
         * 数据表名称注解,默认值为类名称
         * @return
         */
        public String tableName() default "className";
    }
    
    @Target(ElementType.FIELD)
    public @interface NoDBColumn {
    
    }

    复制代码

      注解Table 可以用于注解类、接口(包括注解类型) 或enum声明,而注解NoDBColumn仅可用于注解类的成员变量。

      @Retention:

      @Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

      作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)

      取值(RetentionPoicy)有:

        1.SOURCE:在源文件中有效(即源文件保留)
        2.CLASS:在class文件中有效(即class保留)
        3.RUNTIME:在运行时有效(即运行时保留)

      Retention meta-annotation类型有唯一的value作为成员,它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下:

    复制代码

    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Column {
        public String name() default "fieldName";
        public String setFuncName() default "setField";
        public String getFuncName() default "getField"; 
        public boolean defaultDBValue() default false;
    }

    复制代码

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

      @Documented:

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

    复制代码

    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Column {
        public String name() default "fieldName";
        public String setFuncName() default "setField";
        public String getFuncName() default "getField"; 
        public boolean defaultDBValue() default false;
    }

    复制代码

      @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类型被发现,或者到达类继承结构的顶层。

     

    实例代码:

    复制代码

    /**
     * 
     * @author peida
     *
     */
    @Inherited
    public @interface Greeting {
        public enum FontColor{ BULE,RED,GREEN};
        String name();
        FontColor fontColor() default FontColor.GREEN;
    }

    二、基础知识:自定义注解

     

    使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。

      定义注解格式:
      public @interface 注解名 {定义体}

      注解参数的可支持数据类型:

        1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)
        2.String类型
        3.Class类型
        4.enum类型
        5.Annotation类型
        6.以上所有类型的数组

      Annotation类型里面的参数该怎么设定: 
      第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型;   
      第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;  
      第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

      简单的自定义注解和使用注解实例:

    复制代码

    package annotation;
    
    import java.lang.annotation.Documented;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /**
     * 水果名称注解
     * @author peida
     *
     */
    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface FruitName {
        String value() default "";
    }

    复制代码

    复制代码

    package annotation;
    
    import java.lang.annotation.Documented;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /**
     * 水果颜色注解
     * @author peida
     *
     */
    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface FruitColor {
        /**
         * 颜色枚举
         * @author peida
         *
         */
        public enum Color{ BULE,RED,GREEN};
        
        /**
         * 颜色属性
         * @return
         */
        Color fruitColor() default Color.GREEN;
    
    }

    复制代码

    复制代码

    package annotation;
    
    import annotation.FruitColor.Color;
    
    public class Apple {
        
        @FruitName("Apple")
        private String appleName;
        
        @FruitColor(fruitColor=Color.RED)
        private String appleColor;
        
        
        
        
        public void setAppleColor(String appleColor) {
            this.appleColor = appleColor;
        }
        public String getAppleColor() {
            return appleColor;
        }
        
        
        public void setAppleName(String appleName) {
            this.appleName = appleName;
        }
        public String getAppleName() {
            return appleName;
        }
        
        public void displayName(){
            System.out.println("水果的名字是:苹果");
        }
    }

    复制代码


    注解元素的默认值:

      注解元素必须有确定的值,要么在定义注解的默认值中指定,要么在使用注解时指定,非基本类型的注解元素的值不可为null。因此, 使用空字符串或0作为默认值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态,因为每个注解的声明中,所有元素都存在,并且都具有相应的值,为了绕开这个约束,我们只能定义一些特殊的值,例如空字符串或者负数,一次表示某个元素不存在,在定义注解时,这已经成为一个习惯用法。

    三、自定义注解实例

         以上都是一些注解的基础知识,这里讲一下自定义注解的使用。一般,注解都是搭配反射的解析器共同工作的,然后利用反射机制查看类的注解内容。如下:

     

    复制代码

     1 package testAnnotation;
     2 
     3 import java.lang.annotation.Documented;
     4 import java.lang.annotation.Retention;
     5 import java.lang.annotation.RetentionPolicy;
     6 
     7 @Documented
     8 @Retention(RetentionPolicy.RUNTIME)
     9 public @interface Person{
    10     String name();
    11     int age();
    12 }

    复制代码

     

     package testAnnotation;
     2 
     3 @Person(name="xingoo",age=25)
     4 public class test3 {
     5     public static void print(Class c){
     6         System.out.println(c.getName());
     7         
     8         //java.lang.Class的getAnnotation方法,如果有注解,则返回注解。否则返回null
     9         Person person = (Person)c.getAnnotation(Person.class);
    10         
    11         if(person != null){
    12             System.out.println("name:"+person.name()+" age:"+person.age());
    13         }else{
    14             System.out.println("person unknown!");
    15         }
    16     }
    17     public static void main(String[] args){
    18         test3.print(test3.class);
    19     }
    20 }

     

    运行结果:

    testAnnotation.test3
    name:xingoo age:25

    接下来再讲一个工作中的例子就可以收篇啦!

    LoginVerify注解是用于对标注的方法在进行请求访问时进行登录判断。

     

    package com.newsee.annotation;
    
    import java.lang.annotation.Documented;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Inherited;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /**
     * 是否已登录判断
     *
     */
    @Documented
    @Target(ElementType.METHOD)
    @Inherited
    @Retention(RetentionPolicy.RUNTIME)
    public @interface LoginVerify {
    
    }

     

    ScanningLoginVerifyAnnotation里的scanning()方法被@PostConstruct修饰,说明它在服务器加载Servlet的时候运行,并且只会被服务器执行一次。

     

    这里再科普一下:

     

    @PostConstruct和@PreDestroy。这两个注解被用来修饰一个非静态的void()方法 。写法有如下两种方式:

    @PostConstruct

    Public void someMethod() {}                                                                       
    或者

    public @PostConstruct void someMethod(){}

    被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行,并且只会被服务器执行一次。PostConstruct会在构造函数之后,init()方法之前执行。PreDestroy()方法在destroy()方法执行之后执行

     

    scanning方法是在servlet加载完毕后获取所有被加载类,遍历其中的方法,如果有被LoginVerify注解修饰,则该方法名放到一个static的map中存储起来。

     

     

    package com.newsee.annotation;
    
    import java.io.IOException;
    import java.lang.reflect.Method;
    import javax.annotation.PostConstruct;
    import org.springframework.core.io.Resource;
    import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
    import org.springframework.core.io.support.ResourcePatternResolver;
    import org.springframework.stereotype.Component;
    import org.springframework.util.ClassUtils;
    import com.newsee.constant.LoginVerifyMapping;
    
    @Component
    public class ScanningLoginVerifyAnnotation {
    	private static final String PACKAGE_NAME = "com.newsee.face";
    
    	private static final String RESOURCE_PATTERN = "/**/*.class";
    
    	@PostConstruct
    	public void scanning() throws IOException, SecurityException,
    			ClassNotFoundException {
    		String pattern = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX
    				+ ClassUtils.convertClassNameToResourcePath(PACKAGE_NAME)
    				+ RESOURCE_PATTERN;
    		ResourcePatternResolver resourcePatternResolver = new PathMatchingResourcePatternResolver();
    		Resource[] resources = resourcePatternResolver.getResources(pattern);
    		for (Resource resource : resources) {
    			if (resource.isReadable()) {
    				String className = getClassName(resource.getURL().toString());
    				Class cls = ScanningRequestCodeAnnotation.class.getClassLoader().loadClass((className));
    				for (Method method : cls.getMethods()) {
    					LoginVerify requestCode = method.getAnnotation(LoginVerify.class);
    					if (requestCode != null) {
    						</span>LoginVerifyMapping.add(className + "."+ method.getName());
    					}
    				}
    			}
    		}
    	}
    
    	private String getClassName(String resourceUrl) {
    		String url = resourceUrl.replace("/", ".");
    		url = url.replace("\\", ".");
    		url = url.split("com.newsee")[1];
    		url = url.replace(".class", "");
    		return "com.newsee" + url.trim();
    	}
    }
    

    LoginVerifyMapping就是存放被LoginVerify注解修饰的方法名的。

    public class LoginVerifyMapping {
    	private static Map<String, Boolean> faceFunctionIsNeedLoginVerify = new HashMap<String, Boolean>();
    
    	public static void add(String functionName) {
    		faceFunctionIsNeedLoginVerify.put(functionName, Boolean.TRUE);
    	}
    
    	public static Boolean getFaceFunctionIsNeedLoginVerify(String functionName) {
    		return faceFunctionIsNeedLoginVerify.get(functionName);
    	}
    }

    以下方法就是请求过来时判断请求的方法是不是在LoginVerifyMapping中,如果是,则需要进行登录校验。

    private ResponseContent handleRequests(RequestContent requestContent) throws ClassNotFoundException,
    			NoSuchMethodException, SecurityException, IllegalAccessException, IllegalArgumentException,
    			InvocationTargetException {
    		String requestCode = requestContent.getRequest().getHead().getNWCode();
    		String className = RequestCodeMapping.getClassName(requestCode);
    		String beanName = RequestCodeMapping.getBeanName(requestCode);
    		String functionName = RequestCodeMapping.getFunctionName(requestCode);
    		Boolean loginVerify = LoginVerifyMapping.getFaceFunctionIsNeedLoginVerify(className + "." + functionName);
    		if (loginVerify != null && loginVerify) {//需要进行登录校验
    			boolean isAuthenticated = SecurityUtils.getSubject().isAuthenticated();
    			if (!isAuthenticated) {
    				String exId=requestContent.getRequest().getHead().getNWExID();
    				SystemMobileTokenKeyServiceInter systemMobileTokenKeyServiceInter = (SystemMobileTokenKeyServiceInter) SpringContextUtil
    					.getBean("systemMobileTokenKeyServiceInter");
    				SystemMobileTokenKey systemMobileTokenKey=systemMobileTokenKeyServiceInter.getByExId(exId);
    				if(systemMobileTokenKey==null)
    					throw new BaseException(ResponseCodeEnum.NO_LOGIN);
    				Date keyTime = systemMobileTokenKey.getKeyTime();
    				if (System.currentTimeMillis() - keyTime.getTime() > 1000 * 60 * 60 * 24 * 3)
    					throw new BaseException(ResponseCodeEnum.NO_LOGIN);
    			}
    		}
    		if (className == null || beanName == null || functionName == null)
    			throw new BaseException(ResponseCodeEnum.REQUEST_CODE_NOT_EXIST);
    		Object object = SpringContextUtil.getBean(beanName);
    		Class cls = Class.forName(className);
    		Method method = cls.getMethod(functionName, RequestContent.class);
    		Object response = method.invoke(object, requestContent);
    		return (ResponseContent) response;
    	}
    }

     

     

     

     

    展开全文
  • 秒懂,Java 注解 (Annotation)你可以这样学

    万次阅读 多人点赞 2017-06-27 21:48:30
    文章开头先引入一处...Annotation 中文译过来就是注解、标释的意思,在 Java注解是一个很重要的知识点,但经常还是有点让新手不容易理解。 我个人认为,比较糟糕的技术文档主要特征之一就是:用专业名词来...

    文章开头先引入一处图片。

    这里写图片描述
    这处图片引自老罗的博客。为了避免不必要的麻烦,首先声明我个人比较尊敬老罗的。至于为什么放这张图,自然是为本篇博文服务,接下来我自会说明。好了,可以开始今天的博文了。

    Annotation 中文译过来就是注解、标释的意思,在 Java 中注解是一个很重要的知识点,但经常还是有点让新手不容易理解。

    我个人认为,比较糟糕的技术文档主要特征之一就是:用专业名词来介绍专业名词。

    比如:

    Java 注解用于为 Java 代码提供元数据。作为元数据,注解不直接影响你的代码执行,但也有一些类型的注解实际上可以用于这一目的。Java 注解是从 Java5 开始添加到 Java 的。

    这是大多数网站上对于 Java 注解,解释确实正确,但是说实在话,我第一次学习的时候,头脑一片空白。这什么跟什么啊?听了像没有听一样。因为概念太过于抽象,所以初学者实在是比较吃力才能够理解,然后随着自己开发过程中不断地强化练习,才会慢慢对它形成正确的认识。

    我在写这篇文章的时候,我就在思考。如何让自己或者让读者能够比较直观地认识注解这个概念?是要去官方文档上翻译说明吗?我马上否定了这个答案。

    后来,我想到了一样东西————墨水,墨水可以挥发、可以有不同的颜色,用来解释注解正好。

    不过,我继续发散思维后,想到了一样东西能够更好地代替墨水,那就是印章。印章可以沾上不同的墨水或者印泥,可以定制印章的文字或者图案,如果愿意它也可以被戳到你任何想戳的物体表面。

    但是,我再继续发散思维后,又想到一样东西能够更好地代替印章,那就是标签。标签是一张便利纸,标签上的内容可以自由定义。常见的如货架上的商品价格标签、图书馆中的书本编码标签、实验室中化学材料的名称类别标签等等。

    并且,往抽象地说,标签并不一定是一张纸,它可以是对人和事物的属性评价。也就是说,标签具备对于抽象事物的解释。

    这里写图片描述

    所以,基于如此,我完成了自我的知识认知升级,我决定用标签来解释注解。

    注解如同标签

    回到博文开始的地方,之前某新闻客户端的评论有盖楼的习惯,于是 “乔布斯重新定义了手机、罗永浩重新定义了傻X” 就经常极为工整地出现在了评论楼层中,并且广大网友在相当长的一段时间内对于这种行为乐此不疲。这其实就是等同于贴标签的行为。

    在某些网友眼中,罗永浩就成了傻X的代名词。

    广大网友给罗永浩贴了一个名为“傻x”的标签,他们并不真正了解罗永浩,不知道他当教师、砸冰箱、办博客的壮举,但是因为“傻x”这样的标签存在,这有助于他们直接快速地对罗永浩这个人做出评价,然后基于此,罗永浩就可以成为茶余饭后的谈资,这就是标签的力量。

    而在网络的另一边,老罗靠他的人格魅力自然收获一大批忠实的拥泵,他们对于老罗贴的又是另一种标签。
    这里写图片描述

    老罗还是老罗,但是由于人们对于它贴上的标签不同,所以造成对于他的看法大相径庭,不喜欢他的人整天在网络上评论抨击嘲讽,而崇拜欣赏他的人则会愿意挣钱购买锤子手机的发布会门票。

    我无意于评价这两种行为,我再引个例子。

    《奇葩说》是近年网络上非常火热的辩论节目,其中辩手陈铭被另外一个辩手马薇薇攻击说是————“站在宇宙中心呼唤爱”,然后贴上了一个大大的标签————“鸡汤男”,自此以后,观众再看到陈铭的时候,首先映入脑海中便是“鸡汤男”三个大字,其实本身而言陈铭非常优秀,为人师表、作风正派、谈吐举止得体,但是在网络中,因为娱乐至上的环境所致,人们更愿意以娱乐的心态来认知一切,于是“鸡汤男”就如陈铭自己所说成了一个撕不了的标签。

    我们可以抽象概括一下,标签是对事物行为的某些角度的评价与解释。

    到这里,终于可以引出本文的主角注解了。

    初学者可以这样理解注解:想像代码具有生命,注解就是对于代码中某些鲜活个体的贴上去的一张标签。简化来讲,注解如同一张标签。

    在未开始学习任何注解具体语法而言,你可以把注解看成一张标签。这有助于你快速地理解它的大致作用。如果初学者在学习过程有大脑放空的时候,请不要慌张,对自己说:

    注解,标签。注解,标签。

    注解语法

    因为平常开发少见,相信有不少的人员会认为注解的地位不高。其实同 classs 和 interface 一样,注解也属于一种类型。它是在 Java SE 5.0 版本中开始引入的概念。

    注解的定义

    注解通过 @interface关键字进行定义。

    public @interface TestAnnotation {
    }
    

    它的形式跟接口很类似,不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 TestAnnotaion 的注解。

    你可以简单理解为创建了一张名字为 TestAnnotation 的标签。

    注解的应用

    上面创建了一个注解,那么注解的的使用方法是什么呢。

    @TestAnnotation
    public class Test {
    }
    

    创建一个类 Test,然后在类定义的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解这个类了。

    你可以简单理解为将 TestAnnotation 这张标签贴到 Test 这个类上面。

    不过,要想注解能够正常工作,还需要介绍一下一个新的概念那就是元注解。

    元注解

    元注解是什么意思呢?

    元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面。

    如果难于理解的话,你可以这样理解。元注解也是一张标签,但是它是一张特殊的标签,它的作用和目的就是给其他普通的标签进行解释说明的。

    元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

    @Retention

    Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。

    它的取值如下:

    • RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
    • RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
    • RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。

    我们可以这样的方式来加深理解,@Retention 去给一张标签解释的时候,它指定了这张标签张贴的时间。@Retention 相当于给一张标签上面盖了一张时间戳,时间戳指明了标签张贴的时间周期。

    @Retention(RetentionPolicy.RUNTIME)
    public @interface TestAnnotation {
    }
    

    上面的代码中,我们指定 TestAnnotation 可以在程序运行周期被获取到,因此它的生命周期非常的长。

    @Documented

    顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

    @Target

    Target 是目标的意思,@Target 指定了注解运用的地方。

    你可以这样理解,当一个注解被 @Target 注解时,这个注解就被限定了运用的场景。

    类比到标签,原本标签是你想张贴到哪个地方就到哪个地方,但是因为 @Target 的存在,它张贴的地方就非常具体了,比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值

    • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
    • ElementType.CONSTRUCTOR 可以给构造方法进行注解
    • ElementType.FIELD 可以给属性进行注解
    • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
    • ElementType.METHOD 可以给方法进行注解
    • ElementType.PACKAGE 可以给一个包进行注解
    • ElementType.PARAMETER 可以给一个方法内的参数进行注解
    • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举

    @Inherited

    Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。
    说的比较抽象。代码来解释。

    @Inherited
    @Retention(RetentionPolicy.RUNTIME)
    @interface Test {}
    
    
    @Test
    public class A {}
    
    
    public class B extends A {}
    
    

    注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 Test 这个注解。

    可以这样理解:

    老子非常有钱,所以人们给他贴了一张标签叫做富豪。

    老子的儿子长大后,只要没有和老子断绝父子关系,虽然别人没有给他贴标签,但是他自然也是富豪。

    老子的孙子长大了,自然也是富豪。

    这就是人们口中戏称的富一代,富二代,富三代。虽然叫法不同,好像好多个标签,但其实事情的本质也就是他们有一张共同的标签,也就是老子身上的那张富豪的标签。

    @Repeatable

    Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。

    什么样的注解会多次应用呢?通常是注解的值可以同时取多个。

    举个例子,一个人他既是程序员又是产品经理,同时他还是个画家。

    
    @interface Persons {
    	Person[]  value();
    }
    
    
    @Repeatable(Persons.class)
    @interface Person{
    	String role default "";
    }
    
    
    @Person(role="artist")
    @Person(role="coder")
    @Person(role="PM")
    public class SuperMan{
    	
    }
    
    

    注意上面的代码,@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。

    什么是容器注解呢?就是用来存放其它注解的地方。它本身也是一个注解。

    我们再看看代码中的相关容器注解。

    @interface Persons {
    	Person[]  value();
    }
    

    按照规定,它里面必须要有一个 value 的属性,属性类型是一个被 @Repeatable 注解过的注解数组,注意它是数组。

    如果不好理解的话,可以这样理解。Persons 是一张总的标签,上面贴满了 Person 这种同类型但内容不一样的标签。把 Persons 给一个 SuperMan 贴上,相当于同时给他贴了程序员、产品经理、画家的标签。

    我们可能对于 @Person(role=“PM”) 括号里面的内容感兴趣,它其实就是给 Person 这个注解的 role 属性赋值为 PM ,大家不明白正常,马上就讲到注解的属性这一块。

    注解的属性

    注解的属性也叫做成员变量。注解只有成员变量,没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface TestAnnotation {
    	
    	int id();
    	
    	String msg();
    
    }
    

    上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候,我们应该给它们进行赋值。

    赋值的方式是在注解的括号内以 value="" 形式,多个属性之前用 ,隔开。

    @TestAnnotation(id=3,msg="hello annotation")
    public class Test {
    
    }
    

    需要注意的是,在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。

    注解中属性可以有默认值,默认值需要用 default 关键值指定。比如:

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface TestAnnotation {
    	
    	public int id() default -1;
    	
    	public String msg() default "Hi";
    
    }
    
    

    TestAnnotation 中 id 属性默认值为 -1,msg 属性默认值为 Hi。
    它可以这样应用。

    @TestAnnotation()
    public class Test {}
    

    因为有默认值,所以无需要再在 @TestAnnotation 后面的括号里面进行赋值了,这一步可以省略。

    另外,还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时,应用这个注解时可以直接接属性值填写到括号内。

    public @interface Check {
    	String value();
    }
    

    上面代码中,Check 这个注解只有 value 这个属性。所以可以这样应用。

    @Check("hi")
    int a;
    

    这和下面的效果是一样的

    @Check(value="hi")
    int a;
    

    最后,还需要注意的一种情况是一个注解没有任何属性。比如

    public @interface Perform {}
    
    

    那么在应用这个注解的时候,括号都可以省略。

    @Perform
    public void testMethod(){}
    

    Java 预置的注解

    学习了上面相关的知识,我们已经可以自己定义一个注解了。其实 Java 语言本身已经提供了几个现成的注解。

    @Deprecated

    这个元素是用来标记过时的元素,想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告,告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

    public class Hero {
    	
    	@Deprecated
    	public void say(){
    		System.out.println("Noting has to say!");
    	}
    	
    	
    	public void speak(){
    		System.out.println("I have a dream!");
    	}
    	
    
    }
    
    

    定义了一个 Hero 类,它有两个方法 say() 和 speak() ,其中 say() 被 @Deprecated 注解。然后我们在 IDE 中分别调用它们。
    这里写图片描述

    可以看到,say() 方法上面被一条直线划了一条,这其实就是编译器识别后的提醒效果。

    @Override

    这个大家应该很熟悉了,提示子类要复写父类中被 @Override 修饰的方法

    @SuppressWarnings

    阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后,编译器会警告提醒,而有时候开发者会忽略这种警告,他们可以在调用的地方通过 @SuppressWarnings 达到目的。

    @SuppressWarnings("deprecation")
    public void test1(){
    	Hero hero = new Hero();
    	hero.say();
    	hero.speak();
    }
    

    @SafeVarargs

    参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

    @SafeVarargs // Not actually safe!
    	static void m(List<String>... stringLists) {
    	Object[] array = stringLists;
    	List<Integer> tmpList = Arrays.asList(42);
    	array[0] = tmpList; // Semantically invalid, but compiles without warnings
    	String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
    }
    

    上面的代码中,编译阶段不会报错,但是运行时会抛出 ClassCastException 这个异常,所以它虽然告诉开发者要妥善处理,但是开发者自己还是搞砸了。

    Java 官方文档说,未来的版本会授权编译器对这种不安全的操作产生错误警告。

    @FunctionalInterface

    函数式接口注解,这个是 Java 1.8 版本引入的新特性。函数式编程很火,所以 Java 8 也及时添加了这个特性。

    函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。

    比如

    @FunctionalInterface
    public interface Runnable {
        /**
         * When an object implementing interface <code>Runnable</code> is used
         * to create a thread, starting the thread causes the object's
         * <code>run</code> method to be called in that separately executing
         * thread.
         * <p>
         * The general contract of the method <code>run</code> is that it may
         * take any action whatsoever.
         *
         * @see     java.lang.Thread#run()
         */
        public abstract void run();
    }
    
    

    我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口,上面源码可以看到它就被 @FunctionalInterface 注解。

    可能有人会疑惑,函数式接口标记有什么用,这个原因是函数式接口可以很容易转换为 Lambda 表达式。这是另外的主题了,有兴趣的同学请自己搜索相关知识点学习。

    注解的提取

    博文前面的部分讲了注解的基本语法,现在是时候检测我们所学的内容了。

    我通过用标签来比作注解,前面的内容是讲怎么写注解,然后贴到哪个地方去,而现在我们要做的工作就是检阅这些标签内容。 形象的比喻就是你把这些注解标签在合适的时候撕下来,然后检阅上面的内容信息。

    要想正确检阅注解,离不开一个手段,那就是反射。

    注解与反射。

    注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解

    public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
    
    

    然后通过 getAnnotation() 方法来获取 Annotation 对象。

     public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
    
    

    或者是 getAnnotations() 方法。

    
    public Annotation[] getAnnotations() {}
    

    前一种方法返回指定类型的注解,后一种方法返回注解到这个元素上的所有注解。

    如果获取到的 Annotation 如果不为 null,则就可以调用它们的属性方法了。比如

    @TestAnnotation()
    public class Test {
    	
    	public static void main(String[] args) {
    		
    		boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
    		
    		if ( hasAnnotation ) {
    			TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
    			
    			System.out.println("id:"+testAnnotation.id());
    			System.out.println("msg:"+testAnnotation.msg());
    		}
    
    	}
    
    }
    
    

    程序的运行结果是:

    id:-1
    msg:
    
    

    这个正是 TestAnnotation 中 id 和 msg 的默认值。

    上面的例子中,只是检阅出了注解在类上的注解,其实属性、方法上的注解照样是可以的。同样还是要假手于反射。

    @TestAnnotation(msg="hello")
    public class Test {
    	
    	@Check(value="hi")
    	int a;
    	
    	
    	@Perform
    	public void testMethod(){}
    	
    	
    	@SuppressWarnings("deprecation")
    	public void test1(){
    		Hero hero = new Hero();
    		hero.say();
    		hero.speak();
    	}
    
    
    	public static void main(String[] args) {
    		
    		boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
    		
    		if ( hasAnnotation ) {
    			TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
    			//获取类的注解
    			System.out.println("id:"+testAnnotation.id());
    			System.out.println("msg:"+testAnnotation.msg());
    		}
    		
    		
    		try {
    			Field a = Test.class.getDeclaredField("a");
    			a.setAccessible(true);
    			//获取一个成员变量上的注解
    			Check check = a.getAnnotation(Check.class);
    			
    			if ( check != null ) {
    				System.out.println("check value:"+check.value());
    			}
    			
    			Method testMethod = Test.class.getDeclaredMethod("testMethod");
    			
    			if ( testMethod != null ) {
    				// 获取方法中的注解
    				Annotation[] ans = testMethod.getAnnotations();
    				for( int i = 0;i < ans.length;i++) {
    					System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName());
    				}
    			}
    		} catch (NoSuchFieldException e) {
    			// TODO Auto-generated catch block
    			e.printStackTrace();
    			System.out.println(e.getMessage());
    		} catch (SecurityException e) {
    			// TODO Auto-generated catch block
    			e.printStackTrace();
    			System.out.println(e.getMessage());
    		} catch (NoSuchMethodException e) {
    			// TODO Auto-generated catch block
    			e.printStackTrace();
    			System.out.println(e.getMessage());
    		}
    		
    		
    
    	}
    
    }
    
    

    它们的结果如下:

    id:-1
    msg:hello
    check value:hi
    method testMethod annotation:Perform
    
    

    需要注意的是,如果一个注解要在运行时被成功提取,那么 @Retention(RetentionPolicy.RUNTIME) 是必须的。

    注解的使用场景

    我相信博文讲到这里大家都很熟悉了注解,但是有不少同学肯定会问,注解到底有什么用呢?

    对啊注解到底有什么用?

    我们不妨将目光放到 Java 官方文档上来。

    文章开始的时候,我用标签来类比注解。但标签比喻只是我的手段,而不是目的。为的是让大家在初次学习注解时能够不被那些抽象的新概念搞懵。既然现在,我们已经对注解有所了解,我们不妨再仔细阅读官方最严谨的文档。

    注解是一系列元数据,它提供数据用来解释程序代码,但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。

    注解有许多用处,主要如下:

    • 提供信息给编译器: 编译器可以利用注解来探测错误和警告信息
    • 编译阶段时的处理: 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。
    • 运行时的处理: 某些注解可以在程序运行的时候接受代码的提取

    值得注意的是,注解不是代码本身的一部分。

    如果难于理解,可以这样看。罗永浩还是罗永浩,不会因为某些人对于他“傻x”的评价而改变,标签只是某些人对于其他事物的评价,但是标签不会改变事物本身,标签只是特定人群的手段。所以,注解同样无法改变代码本身,注解只是某些工具的的工具。

    还是回到官方文档的解释上,注解主要针对的是编译器和其它工具软件(SoftWare tool)。

    当开发者使用了Annotation 修饰了类、方法、Field 等成员之后,这些 Annotation 不会自己生效,必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为 APT(Annotation Processing Tool)。

    现在,我们可以给自己答案了,注解有什么用?给谁用?给 编译器或者 APT 用的。

    如果,你还是没有搞清楚的话,我亲自写一个好了。

    亲手自定义注解完成某个目的

    我要写一个测试框架,测试程序员的代码有无明显的异常。

    —— 程序员 A : 我写了一个类,它的名字叫做 NoBug,因为它所有的方法都没有错误。
    —— 我:自信是好事,不过为了防止意外,让我测试一下如何?
    —— 程序员 A: 怎么测试?
    —— 我:把你写的代码的方法都加上 @Jiecha 这个注解就好了。
    —— 程序员 A: 好的。

    NoBug.java

    package ceshi;
    import ceshi.Jiecha;
    
    
    public class NoBug {
    	
    	@Jiecha
    	public void suanShu(){
    		System.out.println("1234567890");
    	}
    	@Jiecha
    	public void jiafa(){
    		System.out.println("1+1="+1+1);
    	}
    	@Jiecha
    	public void jiefa(){
    		System.out.println("1-1="+(1-1));
    	}
    	@Jiecha
    	public void chengfa(){
    		System.out.println("3 x 5="+ 3*5);
    	}
    	@Jiecha
    	public void chufa(){
    		System.out.println("6 / 0="+ 6 / 0);
    	}
    	
    	public void ziwojieshao(){
    		System.out.println("我写的程序没有 bug!");
    	}
    
    }
    

    上面的代码,有些方法上面运用了 @Jiecha 注解。

    这个注解是我写的测试软件框架中定义的注解。

    package ceshi;
    
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Jiecha {
    
    }
    

    然后,我再编写一个测试类 TestTool 就可以测试 NoBug 相应的方法了。

    package ceshi;
    
    import java.lang.reflect.InvocationTargetException;
    import java.lang.reflect.Method;
    
    
    
    public class TestTool {
    
    	public static void main(String[] args) {
    		// TODO Auto-generated method stub
    		
    		NoBug testobj = new NoBug();
    		
    		Class clazz = testobj.getClass();
    		
    		Method[] method = clazz.getDeclaredMethods();
    		//用来记录测试产生的 log 信息
    		StringBuilder log = new StringBuilder();
    		// 记录异常的次数
    		int errornum = 0;
    		
    		for ( Method m: method ) {
    			// 只有被 @Jiecha 标注过的方法才进行测试
    			if ( m.isAnnotationPresent( Jiecha.class )) {
    				try {
    					m.setAccessible(true);
    					m.invoke(testobj, null);
    				
    				} catch (Exception e) {
    					// TODO Auto-generated catch block
    					//e.printStackTrace();
    					errornum++;
    					log.append(m.getName());
    					log.append(" ");
    					log.append("has error:");
    					log.append("\n\r  caused by ");
    					//记录测试过程中,发生的异常的名称
    					log.append(e.getCause().getClass().getSimpleName());
    					log.append("\n\r");
    					//记录测试过程中,发生的异常的具体信息
    					log.append(e.getCause().getMessage());
    					log.append("\n\r");
    				} 
    			}
    		}
    		
    		
    		log.append(clazz.getSimpleName());
    		log.append(" has  ");
    		log.append(errornum);
    		log.append(" error.");
    		
    		// 生成测试报告
    		System.out.println(log.toString());
    
    	}
    
    }
    
    

    测试的结果是:

    1234567890
    1+1=11
    1-1=0
    3 x 5=15
    chufa has error:
    
      caused by ArithmeticException
    
    / by zero
    
    NoBug has  1 error.
    
    

    提示 NoBug 类中的 chufa() 这个方法有异常,这个异常名称叫做 ArithmeticException,原因是运算过程中进行了除 0 的操作。

    所以,NoBug 这个类有 Bug。

    这样,通过注解我完成了我自己的目的,那就是对别人的代码进行测试。

    所以,再问我注解什么时候用?我只能告诉你,这取决于你想利用它干什么用。

    注解应用实例

    注解运用的地方太多了,因为我是 Android 开发者,所以我接触到的具体例子有下:

    JUnit

    JUnit 这个是一个测试框架,典型使用方法如下:

    public class ExampleUnitTest {
        @Test
        public void addition_isCorrect() throws Exception {
            assertEquals(4, 2 + 2);
        }
    }
    

    @Test 标记了要进行测试的方法 addition_isCorrect().

    ButterKnife

    ButterKnife 是 Android 开发中大名鼎鼎的 IOC 框架,它减少了大量重复的代码。

    public class MainActivity extends AppCompatActivity {
    
        @BindView(R.id.tv_test)
        TextView mTv;
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
    
            ButterKnife.bind(this);
        }
    }
    
    

    Dagger2

    也是一个很有名的依赖注入框架。

    Retrofit

    很牛逼的 Http 网络访问框架

    public interface GitHubService {
      @GET("users/{user}/repos")
      Call<List<Repo>> listRepos(@Path("user") String user);
    }
    
    Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("https://api.github.com/")
        .build();
    
    GitHubService service = retrofit.create(GitHubService.class);
    
    

    当然,还有许多注解应用的地方,这里不一一列举。

    总结

    1. 如果注解难于理解,你就把它类同于标签,标签为了解释事物,注解为了解释代码。
    2. 注解的基本语法,创建如同接口,但是多了个 @ 符号。
    3. 注解的元注解。
    4. 注解的属性。
    5. 注解主要给编译器及工具类型的软件用的。
    6. 注解的提取需要借助于 Java 的反射技术,反射比较慢,所以注解使用时也需要谨慎计较时间成本。

    Java 反射机制中另外一个比较重要的概念就是动态代理了,写下这篇文章后,我一鼓作气,又写了这篇 《轻松学,Java 中的代理模式及动态代理》,有兴趣的同学可以一并阅读一下。

    最后致敬老罗和陈铭,拿你们的事例为博文主题提供论点,只是基于技术视角,并没有一丝恶意和冒犯之心。

    读者们都在下面的二维码所示的免费的知识星球问我问题:
    在这里插入图片描述

    展开全文
  • Java注解

    千次阅读 多人点赞 2019-08-31 23:28:04
    为什么要引入注解? 使用【注解】之前(甚至在使用之后),【XML】被广泛的应用于描述元数据,得到各大框架的青睐,它以松耦合的方式完成了框架中几乎所有的配置,但是随着项目越来越庞大,【XML】的内容也越来越复杂...

    詹姆斯·高斯林

    为什么要引入注解?

    使用【注解】之前(甚至在使用之后),【XML】被广泛的应用于描述元数据,得到各大框架的青睐,它以松耦合的方式完成了框架中几乎所有的配置,但是随着项目越来越庞大,【XML】的内容也越来越复杂,一些应用开发人员和架构师发现维护成本变高。他们希望使用一些和代码紧耦合的东西,于是就有人提出来一种标记式高耦合的配置方式【注解】。方法上可以进行注解,类上也可以注解,字段属性上也可以注解,反正几乎需要配置的地方都可以进行注解。

    下面我们通过一个例子来理解这两者的区别。

    假如你想为应用设置很多的常量或参数,这种情况下,【XML】是一个很好的选择,因为它不会同特定的代码耦合。如果你想把某个方法声明为服务,那么使用【注解】会更好一些,因为这种情况下需要注解和方法紧密耦合起来,开发人员也必须认识到这点。

    同时,【注解】定义了一种标准的描述元数据的方式。

    关于【注解】和【XML】两种不同的配置模式,争论了好多年,各有各的优劣,注解可以提供更大的便捷性,易于维护修改,但耦合度高,而 【XML】 相对于注解则是相反的。追求低耦合就要抛弃高效率,追求效率必然会遇到耦合。目前,许多框架将【XML】和【注解】两种方式结合使用,平衡两者之间的利弊。

    本文不再辨析两者谁优谁劣,而在于以最简单的语言介绍注解相关的基本知识。

    什么是注解

    注解也叫元数据,即一种描述数据的数据。例如我们常见的@Override和@Deprecated,注解是JDK1.5版本开始引入的一个特性,用于对代码进行说明,可以对包、类、接口、字段、方法参数、局部变量等进行注解

    Annotation接口中有下面这句话来描述注解:Annotation 是所有注解继承的公共接口

    The common interface extended by all annotation types.
    

    注解的本质就是一个继承了 Annotation 接口的接口。有关这一点,你可以去反编译任意一个注解类得到结果。

    一个注解准确意义上来说,只不过是一种特殊的注释而已,如果没有解析它的代码,它可能连注释都不如。

    而解析一个类或者方法的注解往往有两种形式,一种是编译期直接的扫描,一种是运行期反射。反射的事情我们先不讨论,而编译器的扫描指的是编译器在对 Java 代码编译成字节码的过程中会检测到某个类或者方法被一些注解修饰,这时它就会对于这些注解进行某些处理。

    @Override
    public String toString() {
        return "Hello Annotation";
    }
    

    上面的代码中,我重写了toString()方法并使用了@Override注解。但是,即使我不使用@Override注解标记代码,程序也能够正常执行。那么,该注解表示什么?这么写有什么好处吗?事实上,@Override告诉编译器这个方法是一个重写方法(描述方法的元数据),如果父类中不存在该方法,编译器便会报错,提示该方法没有重写父类中的方法。如果我不小心拼写错误,例如将toString()写成了toStrring(),而且我也没有使用@Override注解,那程序依然能编译运行。但运行结果会和我期望的大不相同。现在我们了解了什么是注解,并且使用注解有助于提高代码的可读性。

    注解的用途

    1. 生成文档,通过代码里标识的元数据生成javadoc文档。
    2. 编译检查,通过代码里标识的元数据让编译器在编译期间进行检查验证。
    3. 编译时动态处理,编译时通过代码里标识的元数据动态处理,例如动态生成代码。
    4. 运行时动态处理,运行时通过代码里标识的元数据动态处理,例如使用反射注入实例

    注解的分类

    1. Java自带的标准注解,包括@Override(标明重写某个方法)、@Deprecated(标明某个类或方法过时)和@SuppressWarnings(标明要忽略的警告),使用这些注解后编译器就会进行检查
    2. 元注解,元注解是用于定义注解的注解,包括@Retention(标明注解被保留的阶段)、@Target(标明注解使用的范围)、@Inherited(标明注解可继承)、@Documented(标明是否生成javadoc文档)
    3. 自定义注解,可以根据自己的需求定义注解

    元注解

    要想真正掌握怎么使用注解,还需要先学习一下元注解。

    元注解是用于修饰注解的注解

    元注解有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

    @Retention

    Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。

    它的取值如下:

    • RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
    • RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。如Java内置注解,@Override、@Deprecated、@SuppressWarnning等
    • RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。如SpringMvc中的@Controller、@Autowired、@RequestMapping等。

    @Documented

    顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

    @Target

    Target 是目标的意思,@Target 指定了注解运用的地方。

    你可以这样理解,当一个注解被 @Target 注解时,这个注解就被限定了运用的场景。

    类比到标签,原本标签是你想张贴到哪个地方就到哪个地方,但是因为 @Target 的存在,它张贴的地方就非常具体了,比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值

    • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
    • ElementType.CONSTRUCTOR 可以给构造方法进行注解
    • ElementType.FIELD 可以给属性进行注解
    • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
    • ElementType.METHOD 可以给方法进行注解
    • ElementType.PACKAGE 可以给一个包进行注解
    • ElementType.PARAMETER 可以给一个方法内的参数进行注解
    • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举

    @Inherited

    Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类使用了@Inherited 注解,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。

    说的比较抽象。代码来解释。

    @Repeatable

    Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。

    Repeatable使用场景:在需要对同一种注解多次使用时,往往需要借助@Repeatable。

    下面举例说明一下,在生活中一个人往往是具有多种身份,如果我把每种身份当成一种注解该如何使用

    先声明一个Persons类用来包含所有的身份

    @Target(ElementType.TYPE) 
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Persons {
    	Person[] value();
    }
    

    这里@Target是声明Persons注解的作用范围,参数ElementType.Type代表可以给一个类进行注解

    @Retention是注解的有效时间,RetentionPolicy.RUNTIME是指程序运行的时候。

    Person注解

    @Repeatable(Persons.class)
    public @interface Person{
    	String role() default "";
    }
    

    @Repeatable括号内的就相当于用来保存该注解内容的容器。

    声明一个Man类,给该类加上一些身份。

    @Person(role="CEO")
    @Person(role="husband")
    @Person(role="father")
    @Person(role="son")
    public   class Man {
    	String name="";
    }
    

    在主方法中访问该注解。

    public static void main(String[] args) {
        Annotation[] annotations = Man.class.getAnnotations();  
        System.out.println(annotations.length);
        Persons p1=(Persons) annotations[0];
        for(Person t:p1.value()){
        	System.out.println(t.role());
        }
    }
    

    运行结果

    1
    CEO
    husband
    father
    son
    

    注解的属性

    注解的属性也叫做成员变量。注解只有成员变量,没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface TestAnnotation{
        
        int id();
        
        String msg();
    
    }
    

    上面代码定义了 @TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候,我们应该给它们进行赋值。

    赋值的方式是在注解的括号内以 value="" 形式,多个属性之前用 ,隔开。

    @TestAnnotation(id=3, msg="hello annotation")
    public class Test {
    
    }
    

    快捷方式

    所谓的快捷方式就是注解中定义了名为value的元素,并且在使用该注解时,如果该元素是唯一需要赋值的一个元素,那么此时无需使用key=value的语法,而只需在括号内给出value元素所需的值即可。这可以应用于任何合法类型的元素,记住,这限制了元素名必须为value,简单案例如下

    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    @interface IntegerVaule{
       int value() default 0;
       String name() default "";
    }
    
    public class QuicklyWay {
       
       @IntegerVaule(20)
       public int age;
       
       @IntegerVaule(value = 10000, name = "MONEY")
       public int money;
     
    }
    

    注解不支持继承

    注解是不支持继承的,因此不能使用关键字extends来继承某个@interface,但注解在编译后,编译器会自动继承java.lang.annotation.Annotation接口

    声明注解

    这里总共定义了4个注解来演示注解的声明

    1. 定义一个可以注解在Class,interface,enum上的注解
    2. 定义一个可以注解在METHOD上的注解
    3. 定义一个可以注解在FIELD上的注解
    4. 定义一个可以注解在PARAMETER上的注解
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnTargetType {
    
        /**
         * 定义注解的一个元素 并给定默认值
         * @return
         */
        String value() default "定义在类接口枚举类上的注解元素value的默认值";
    
    }
    
    @Target({ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnTargetMethod {
    
        /**
         * 定义注解的一个元素 并给定默认值
         * @return
         */
        String value() default "定义在方法上的注解元素value的默认值";
    
    }
    
    @Target({ElementType.FIELD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnTargetField {
    
        /**
         * 定义注解的一个元素 并给定默认值
         * @return
         */
        String value() default "定义在字段上的注解元素value的默认值";
    
    }
    
    @Target({ElementType.PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnTargetParameter {
    
        /**
         * 定义注解的一个元素 并给定默认值
         * @return
         */
        String value() default "定义在参数上的注解元素value的默认值";
    
    }
    

    编写一个测试处理类处理以上注解

    @MyAnTargetType
    public class AnnotationTest {
    
        @MyAnTargetField
        private String field = "我是字段";
    
        @MyAnTargetMethod("测试方法")
        public void test(@MyAnTargetParameter String args) {
            System.out.println("参数值 === " + args);
        }
    
        public static void main(String[] args) {
            // 获取类上的注解MyAnTargetType
            MyAnTargetType t = AnnotationTest.class.getAnnotation(MyAnTargetType.class);
            System.out.println("类上的注解值 === " + t.value());
            MyAnTargetMethod tm = null;
            try {
                // 根据反射获取AnnotationTest类上的test方法
                Method method = AnnotationTest.class.getDeclaredMethod("test", String.class);
                // 获取方法上的注解MyAnTargetMethod
                tm = method.getAnnotation(MyAnTargetMethod.class);
                System.out.println("方法上的注解值 === " + tm.value());
                // 获取方法上的所有参数注解  循环所有注解找到MyAnTargetParameter注解
                Annotation[][] annotations = method.getParameterAnnotations();
                for (Annotation[] tt : annotations) {
                    for (Annotation t1 : tt) {
                        if (t1 instanceof MyAnTargetParameter) {
                            System.out.println("参数上的注解值 === " + ((MyAnTargetParameter) t1).value());
                        }
                    }
                }
                method.invoke(new AnnotationTest(), "改变默认参数");
                // 获取AnnotationTest类上字段field的注解MyAnTargetField
                MyAnTargetField fieldAn = AnnotationTest.class.getDeclaredField("field").getAnnotation(MyAnTargetField.class);
                System.out.println("字段上的注解值 === " + fieldAn.value());
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    
    }
    

    输出结果

    类上的注解值 === 定义在类接口枚举类上的注解元素value的默认值
    方法上的注解值 === 测试方法
    参数上的注解值 === 定义在参数上的注解元素value的默认值
    参数值 === 改变默认参数
    字段上的注解值 === 定义在字段上的注解元素value的默认值
    

    Java预置的注解

    学习了上面相关的知识,我们已经可以自己定义一个注解了。其实 Java 语言本身已经提供了几个现成的注解。

    @Deprecated

    这个元素是用来标记过时的元素,想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告,告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

    @Override

    这个大家应该很熟悉了,用于标明此方法覆盖了父类的方法。

    @SuppressWarnings

    用于有选择的关闭编译器对类、方法、成员变量、变量初始化的警告。之前说过调用被 @Deprecated 注解的方法后,编译器会警告提醒,而有时候开发者会忽略这种警告,他们可以在调用的地方通过 @SuppressWarnings 达到目的。

    @SafeVarargs

    参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

    @FunctionalInterface

    函数式接口注解,这个是 Java 1.8 版本引入的新特性。函数式编程很火,所以 Java 8 也及时添加了这个特性。

    函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。

    我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口,从源码可以看到它使用了@FunctionalInterface 注解。

    注解应用实例

    注解的功能很强大,Spring和Hebernate这些框架在日志和有效性中大量使用了注解功能。

    注解通常配合反射或者切面一起使用来实现相应的业务逻辑。

    我这里向大家演示使用注解和切面进行日志记录的案例

    定义一个系统日志注解

    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface SysLog {
    
        /**
         * 操作说明
         */
        String value() default "";
    
    }
    

    找到使用了注解的方法,利用切面进行日志记录

    这里有些类或者参数只做演示,没有给出具体的实现(如SysLogMapper、SysLogEntity等),以看懂注解配合切面使用为目的

    @Aspect
    @Component
    public class SysLogAspect {
    
        @Autowired
        private SysLogMapper sysLogMapper;
    
        @Pointcut("@annotation(com.jourwon.annotation.SysLog)")
        public void logPointCut() {
    
        }
    
        @Around("logPointCut()")
        public Object around(ProceedingJoinPoint point) throws Throwable {
            long beginTime = System.currentTimeMillis();
            //执行方法
            Object result = point.proceed();
            //执行时长(毫秒)
            long time = System.currentTimeMillis() - beginTime;
    
            //保存日志
            saveSysLog(point, time);
    
            return result;
        }
    
        private void saveSysLog(ProceedingJoinPoint joinPoint, long time) {
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            Method method = signature.getMethod();
    
            SysLogEntity sysLog = new SysLogEntity();
            SysLog syslog = method.getAnnotation(SysLog.class);
            if (syslog != null) {
                //注解上的描述
                sysLog.setOperation(syslog.value());
            }
    
            //保存系统日志
            sysLogMapper.insertSelective(sysLog);
        }
    
    }
    

    在方法中使用注解

    @SysLog("保存用户")
    @PostMapping("/save")
    public Result save(@RequestBody SysUserEntity user) {
        sysUserService.save(user);
    
        return Result.ok();
    }
    

    总结

    本文首先讲述了为什么要引入注解,注解是什么,注解的用途和分类,了解什么是元注解,怎么自定义注解,最后演示了使用注解和切面进行日志记录的案例。本人知识水平有限,只进行了Java注解的简单介绍,如有不正确的地方还请大神指教,希望对注解有更深入的了解掌握的话,可以自行进行更深入的学习。

    展开全文
  • java注解与反射01_注解

    万次阅读 2020-09-16 09:48:18
    java注解与反射 注解 内置注解: @Override 定义在java.lang.Override中,声明该方法重写了超类中的方法 @Deprecated 定义在java.lang.Deprecated中,可修饰方法、属性、类。 表示不鼓励,不推荐使用该元素,通常...

    java注解与反射01_注解


    注解

    内置注解:

    @Override
    定义在java.lang.Override中,声明该方法重写了超类中的方法
    
    @Deprecated
    定义在java.lang.Deprecated中,可修饰方法、属性、类。
    表示不鼓励,不推荐使用该元素,通常认为它很危险或已过时,存在更好的选择。
    
    @SuppressWarnings
    定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息,比如变量未使用的警告
    该注解需要添加参数:
    抑制所有类型的警告:@SuppressWarnings("all")
    抑制单类型的警告:@SuppressWarnings("unchecked")
    抑制多类型的警告:@SuppressWarnings(value={"unchecked","deprecation"})
    

    元注解(负责解释其他注解的注解):

    @Target
    描述注解的使用范围
    
    @Retention
    表示需要在什么级别保存该注释信息,用于描述注解的生命周期
    (SOURCE < CLASS < RUNTIME)
    
    @Documented
    说明该注解将被包含在javadoc中
    
    @Inherited
    说明子类可以继承父类中的该注解
    

    自定义注解示例:

    package com.blu.demo5;
    
    import java.lang.annotation.Documented;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Inherited;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /**
     * @Target 描述注解的可用范围,METHOD表示方法上可用,TYPE表示类、接口或enum上可用
     * @Retention 描述注解的生命周期,RUNTIME表示在运行时有效
     * @Documented 表示该注解将生成在javadoc文件中
     * @Inherited 表示子类可以继承父类的注解
     */
    @Target(value= {ElementType.METHOD,ElementType.TYPE})
    @Retention(value=RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    public @interface BLU {
    	//定义注解的参数:参数类型 参数名();
    	//如果只有一个参数,建议用value命名,使用时可以省略value=的写法
    	String name();
    	//定义参数并指定默认值,如果不指定默认值,使用时必须显式赋值
    	int age() default 22;
    	String[] hobbys();
    }
    

    使用注解示例:

    package com.blu.demo5;
    
    public class Test {
    
    	@BLU(name="blu",hobbys= {"sleeping","eatting","thinking"})
    	public void test() {
    		
    	}
    }
    
    展开全文
  • java注解

    千次阅读 2014-09-12 10:40:59
    java注解

空空如也

1 2 3 4 5 ... 20
收藏数 60,916
精华内容 24,366
关键字:

java注解

java 订阅