一、概述
跟踪代码的依赖性,实现代替配置文件的功能。比较常见的是Spring等框架中的基于注解配置。
登陆、权限拦截、日志处理,以及各种Java框架,如Spring,Hibernate,JUnit 。
提到注解就不能不说反射,Java自定义注解是通过运行时靠反射获取注解。
实际开发中,例如我们要获取某个方法的调用日志,可以通过AOP(动态代理机制)给方法添加切面,
通过反射来获取方法包含的注解,如果包含日志注解,就进行日志记录。
如Hibernate,Jersey,Spring。注解相当于是一种嵌入在程序中的元数据,
可以使用注解解析工具或编译器对其进行解析,也可以指定注解在编译期或运行期有效。
二、在Java中创建自定义注解
package com.journaldev.annotations;
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 MethodInfo{
String author() default "Pankaj";
String date();
int revision() default 1;
String comments();
}
注解方法不能有参数。
注解方法的返回类型局限于原始类型,字符串,枚举,注解,或以上类型构成的数组。
注解方法可以包含默认值。
注解可以包含与其绑定的元注解,元注解为注解提供信息,有四种元注解类型:
1. @Documented – 表示使用该注解的元素应被javadoc或类似工具文档化,
2. @Target – 表示支持注解的程序元素的种类,一些可能的值有TYPE, METHOD, CONSTRUCTOR, FIELD等等。
如果Target元注解不存在,那么该注解就可以使用在任何程序元素之上。
3. @Inherited – 表示一个注解类型会被自动继承,如果用户在类声明的时候查询注解类型,
同时类声明中也没有这个类型的注解,那么注解类型会自动查询该类的父类,
这个过程将会不停地重复,直到该类型的注解被找到为止,或是到达类结构的顶层(Object)。
4. @Retention – 表示注解类型保留时间的长短,它接收RetentionPolicy参数,
可能的值有SOURCE, CLASS, 以及RUNTIME。
三、Java内置注解
Java提供3种内置注解。
1. @Override – 当我们想要覆盖父类的一个方法时,需要使用该注解告知编译器我们正在覆盖一个方法。
这样的话,当父类的方法被删除或修改了,编译器会提示错误信息。
2. @Deprecated – 当我们想要让编译器知道一个方法已经被弃用(deprecate)时,应该使用这个注解。
3. @SuppressWarnings – 这个注解仅仅是告知编译器,忽略它们产生了特殊警告,
比如:在java泛型中使用原始类型。它的保持性策略(retention policy)是SOURCE,在编译器中将被丢弃。
四、总结:
Java元注解:
(1)、@interface:声明注解
(2)、@Target:可以在什么地方使用
(3)、@Retention:注解的声明周期
<1>、SOURCE:
源码级别,注解只存在源码中,一般用于和编译器交互,用于检测代码。
如@Override, @SuppressWarings。
<2>、CLASS:字节码级别,注解存在于源码和字节码文件中,主要用于编译时生成额外的文件
<3>、RUNTIME:运行时级别,注解存在于源码、字节码、java虚拟机中,
主要用于运行时,可以使用反射获取相关的信息。
Java注解的内容:
数据类型 属性名() default 默认值
@Documented
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface RequiresLogin {
}
使用注解:
@RequiresLogin
@RequestMapping(value = "/list", produces = {"application/json;charset=UTF-8;"})
public String getUserList(){
System.out.println("--------------");
return "[{'id': 1, 'username':'zhangsan'}]";
}
使用AOP进行拦截,解析注解:
public class LoginAdvices {
public void before(JoinPoint joinPoint) throws Exception{
Object target = joinPoint.getTarget(); //获取被代理的对象
String methodName = joinPoint.getSignature().getName(); //获取目标方法名
System.out.println(target + "-------" + methodName);
Method method = target.getClass().getMethod(methodName); //根据目标方法名找代理对象的方法
boolean annotationPresent = method.isAnnotationPresent(RequiresLogin.class);//判断方法上是否有该注解
if (annotationPresent) {
// 用户必须登录
boolean isLogin = false;
if (!isLogin) {
throw new Exception("访问该接口必须先登录");
} else {
System.out.println("已登录...");
}
}
}
}