深入JAVA注解(Annotation)：自定义注解 (转)

zoukankan html css js c++ java

深入JAVA注解(Annotation)：自定义注解 (转)
原文出自：http://blog.csdn.net/yjclsx/article/details/52101922

一、基础知识：元注解

要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前，我们就必须要了解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注解是用于对标注的方法在进行请求访问时进行登录判断。
[java] view plain copy

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中存储起来。
[java] view plain copy

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注解修饰的方法名的。
[java] view plain copy

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中，如果是，则需要进行登录校验。
[java] view plain copy

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;

    }

}
查看全文

相关阅读:
openvas漏洞扫描
 MSF基础应用
 MS11-050安全漏洞
 MS08_067漏洞渗透攻击实践
 Adobe阅读器渗透攻击
 详解CentOS7安装配置vsftp搭建FTP
zabbix英文切换成中文
 代理抛出异常 : java.net.MalformedURLException: Local host name unknown: java.net.UnknownHostException: 你的主机名: 你的主机名
 安装zabbix客户端
 Docker报错：“WARNING: IPv4 forwarding is disabled. Networking will not work.”解决。

原文地址：https://www.cnblogs.com/bingosblog/p/5852510.html