java基础之重点注解

一、基础知识&＃xff1a;元注解

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

元注解&＃xff1a;

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

　　&＃64;Target&＃xff1a;

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

　　作用&＃xff1a;用于描述注解的使用范围&＃xff08;即&＃xff1a;被描述的注解可以用在什么地方&＃xff09;

　　取值(ElementType)有&＃xff1a;

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

　　使用实例&＃xff1a;　　

1.  

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

    

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

　　&＃64;Retention&＃xff1a;

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

　　作用&＃xff1a;表示需要在什么级别保存该注释信息&＃xff0c;用于描述注解的生命周期&＃xff08;即&＃xff1a;被描述的注解在什么范围内有效&＃xff09;

　　取值&＃xff08;RetentionPoicy&＃xff09;有&＃xff1a;

　　　　1.SOURCE:在源文件中有效&＃xff08;即源文件保留&＃xff09;
　　　　2.CLASS:在class文件中有效&＃xff08;即class保留&＃xff09;
　　　　3.RUNTIME:在运行时有效&＃xff08;即运行时保留&＃xff09;

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

1.  

   &＃64;Target(ElementType.FIELD)&＃64;Retention(RetentionPolicy.RUNTIME)public &＃64;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,这样注解处理器可以通过反射&＃xff0c;获取到该注解的属性值&＃xff0c;从而去做一些运行时的逻辑处理

　　&＃64;Documented:

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

　　&＃64;Inherited 元注解是一个标记注解&＃xff0c;&＃64;Inherited阐述了某个被标注的类型是被继承的。如果一个使用了&＃64;Inherited修饰的annotation类型被用于一个class&＃xff0c;则这个annotation将被用于该class的子类。

　　注意&＃xff1a;&＃64;Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation&＃xff0c;方法并不从它所重载的方法继承annotation。

　　当&＃64;Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME&＃xff0c;则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个&＃64;Inherited annotation类型的annotation时&＃xff0c;反射代码检查将展开工作&＃xff1a;检查class和其父类&＃xff0c;直到发现指定的annotation类型被发现&＃xff0c;或者到达类继承结构的顶层。

实例代码&＃xff1a;

1.  

   /**** &＃64;author peida**/&＃64;Inheritedpublic &＃64;interface Greeting {public enum FontColor{ BULE,RED,GREEN};String name();FontColor fontColor() default FontColor.GREEN;}

    

二、基础知识&＃xff1a;自定义注解

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

　　定义注解格式&＃xff1a;
　　public &＃64;interface 注解名 {定义体}

　　注解参数的可支持数据类型&＃xff1a;

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

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

　　简单的自定义注解和使用注解实例&＃xff1a;

1.  

   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;/*** 水果名称注解* &＃64;author peida**/&＃64;Target(ElementType.FIELD)&＃64;Retention(RetentionPolicy.RUNTIME)&＃64;Documentedpublic &＃64;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;/*** 水果颜色注解* &＃64;author peida**/&＃64;Target(ElementType.FIELD)&＃64;Retention(RetentionPolicy.RUNTIME)&＃64;Documentedpublic &＃64;interface FruitColor {/*** 颜色枚举* &＃64;author peida**/public enum Color{ BULE,RED,GREEN};/*** 颜色属性* &＃64;return*/Color fruitColor() default Color.GREEN;}

注解元素的默认值&＃xff1a;

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

三、自定义注解实例

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

1.  

   1 package testAnnotation;23 import java.lang.annotation.Documented;4 import java.lang.annotation.Retention;5 import java.lang.annotation.RetentionPolicy;67 &＃64;Documented8 &＃64;Retention(RetentionPolicy.RUNTIME)9 public &＃64;interface Person{10 String name();11 int age();12 }

    

package testAnnotation;23 &＃64;Person(name&＃61;"xingoo",age&＃61;25)4 public class test3 {5 public static void print(Class c){6 System.out.println(c.getName());78 //java.lang.Class的getAnnotation方法&＃xff0c;如果有注解&＃xff0c;则返回注解。否则返回null9 Person person &＃61; (Person)c.getAnnotation(Person.class);1011 if(person !&＃61; null){12 System.out.println("name:"&＃43;person.name()&＃43;" age:"&＃43;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 }

​​

运行结果&＃xff1a;

1. testAnnotation.test3

2. name:xingoo age:25

接下来再讲一个工作中的例子就可以收篇啦&＃xff01;

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;/*** 是否已登录判断**/&＃64;Documented&＃64;Target(ElementType.METHOD)&＃64;Inherited&＃64;Retention(RetentionPolicy.RUNTIME)public &＃64;interface LoginVerify {}


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

这里再科普一下&＃xff1a;

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

&＃64;PostConstruct

Public void someMethod() {}                                                                       
或者

public &＃64;PostConstruct void someMethod(){}

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

scanning方法是在servlet加载完毕后获取所有被加载类&＃xff0c;遍历其中的方法&＃xff0c;如果有被LoginVerify注解修饰&＃xff0c;则该方法名放到一个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;&＃64;Componentpublic class ScanningLoginVerifyAnnotation {private static final String PACKAGE_NAME &＃61; "com.newsee.face";private static final String RESOURCE_PATTERN &＃61; "/**/*.class";&＃64;PostConstructpublic void scanning() throws IOException, SecurityException,ClassNotFoundException {String pattern &＃61; ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX&＃43; ClassUtils.convertClassNameToResourcePath(PACKAGE_NAME)&＃43; RESOURCE_PATTERN;ResourcePatternResolver resourcePatternResolver &＃61; new PathMatchingResourcePatternResolver();Resource[] resources &＃61; resourcePatternResolver.getResources(pattern);for (Resource resource : resources) {if (resource.isReadable()) {String className &＃61; getClassName(resource.getURL().toString());Class cls &＃61; ScanningRequestCodeAnnotation.class.getClassLoader().loadClass((className));for (Method method : cls.getMethods()) {LoginVerify requestCode &＃61; method.getAnnotation(LoginVerify.class);if (requestCode !&＃61; null) {LoginVerifyMapping.add(className &＃43; "."&＃43; method.getName());}}}}}private String getClassName(String resourceUrl) {String url &＃61; resourceUrl.replace("/", ".");url &＃61; url.replace("\\", ".");url &＃61; url.split("com.newsee")[1];url &＃61; url.replace(".class", "");return "com.newsee" &＃43; url.trim();}}

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

2.  

   public class LoginVerifyMapping {private static Map faceFunctionIsNeedLoginVerify &＃61; new HashMap();public static void add(String functionName) {faceFunctionIsNeedLoginVerify.put(functionName, Boolean.TRUE);}public static Boolean getFaceFunctionIsNeedLoginVerify(String functionName) {return faceFunctionIsNeedLoginVerify.get(functionName);}}以下方法就是请求过来时判断请求的方法是不是在LoginVerifyMapping中&＃xff0c;如果是&＃xff0c;则需要进行登录校验。private ResponseContent handleRequests(RequestContent requestContent) throws ClassNotFoundException,NoSuchMethodException, SecurityException, IllegalAccessException, IllegalArgumentException,InvocationTargetException {String requestCode &＃61; requestContent.getRequest().getHead().getNWCode();String className &＃61; RequestCodeMapping.getClassName(requestCode);String beanName &＃61; RequestCodeMapping.getBeanName(requestCode);String functionName &＃61; RequestCodeMapping.getFunctionName(requestCode);Boolean loginVerify &＃61; LoginVerifyMapping.getFaceFunctionIsNeedLoginVerify(className &＃43; "." &＃43; functionName);if (loginVerify !&＃61; null && loginVerify) {//需要进行登录校验boolean isAuthenticated &＃61; SecurityUtils.getSubject().isAuthenticated();if (!isAuthenticated) {String exId&＃61;requestContent.getRequest().getHead().getNWExID();SystemMobileTokenKeyServiceInter systemMobileTokenKeyServiceInter &＃61; (SystemMobileTokenKeyServiceInter) SpringContextUtil.getBean("systemMobileTokenKeyServiceInter");SystemMobileTokenKey systemMobileTokenKey&＃61;systemMobileTokenKeyServiceInter.getByExId(exId);if(systemMobileTokenKey&＃61;&＃61;null)throw new BaseException(ResponseCodeEnum.NO_LOGIN);Date keyTime &＃61; systemMobileTokenKey.getKeyTime();if (System.currentTimeMillis() - keyTime.getTime() > 1000 * 60 * 60 * 24 * 3)throw new BaseException(ResponseCodeEnum.NO_LOGIN);}}if (className &＃61;&＃61; null || beanName &＃61;&＃61; null || functionName &＃61;&＃61; null)throw new BaseException(ResponseCodeEnum.REQUEST_CODE_NOT_EXIST);Object object &＃61; SpringContextUtil.getBean(beanName);Class cls &＃61; Class.forName(className);Method method &＃61; cls.getMethod(functionName, RequestContent.class);Object response &＃61; method.invoke(object, requestContent);return (ResponseContent) response;}}

    

3.