Java注解定义
Java注解又称Java标注，是在 JDK5 时引入的新特性，注解（也被称为元数据）。
Java注解它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。
注解分类
元注解、内置注解、自定义注解
一、元注解
元注解是用于定义注解的注解，包括@Retention、@Target、@Inherited、@Documented、@Repeatable 等。Java 8 又增加了 @Repeatable 和 @Native 两个注解
元注解也是Java自带的标准注解，只不过用于修饰注解，比较特殊
其中各个元注解的作用
@Documented
@Documented 是一个标记注解，没有成员变量。用 @Documented 注解修饰的注解类会被 JavaDoc 工具提取成文档。默认情况下，JavaDoc 是不包括注解的，但如果声明注解时指定了 @Documented，就会被 JavaDoc 之类的工具处理，所以注解类型信息就会被包括在生成的帮助文档中。
@Target
@Target 注解用来指定一个注解的使用范围，即被 @Target 修饰的注解可以用在什么地方。@Target 注解有一个成员变量(value)用来设置适用目标，value 是 java.lang.annotation.ElementType 枚举类型的数组，下表为 ElementType 常用的枚举常量。
| 名称 | 说明 |
| CONSTRUCTOR | 用于构造方法 |
| FIELD | 用于成员变量(包括枚举常量) |
| LOCAL_VARIABLE | 用于局部变量 |
| METHOD | 用于方法 |
| PACKAGE | 用于包 |
| PARAMETER | 用于类型参数(JDK 1.8新增) |
| TYPE | 用于类、接口(包括注解类型)或 enum 声明 |
@Retention 用于描述注解的生命周期，也就是该注解被保留的时间长短。@Retention 注解中的成员变量(value)用来设置保留策略，value 是 java.lang.annotation.RetentionPolicy 枚举类型，RetentionPolicy 有 3 个枚举常量，如下所示。
SOURCE：在源文件中有效(即源文件保留)
CLASS：在 class 文件中有效(即 class 保留)
RUNTIME：在运行时有效(即运行时保留)
@Inherited
@Inherited 是一个标记注解，用来指定该注解可以被继承。使用 @Inherited 注解的 Class 类，表示这个注解可以被用于该 Class 类的子类。就是说如果某个类使用了被 @Inherited 修饰的注解，则其子类将自动具有该注解。
@Repeatable
@Repeatable 注解是 Java 8 新增加的，它允许在相同的程序元素中重复注解，在需要对同一种注解多次使用时，往往需要借助 @Repeatable 注解。Java 8 版本以前，同一个程序元素前最多只能有一个相同类型的注解，如果需要在同一个元素前使用多个相同类型的注解，则必须使用注解“容器”。
二、内置注解
| 注解名称 | 功能描述 |
| @Override | 检查方法是否是重写方法，如果发现父类或者是接口中没有定义该方法时，会报编译错误 |
| @Deprecated | 标记过时的方法，在使用过时方法时会有划线的提示 |
| @SuppressWarnings | 用于关闭对类、方法、成员编译时产生的特定警告 1、抑制单类型警告("unchecked") 2、抑制多类型警告value={"unchecked","rawtypes"} 3、抑制全类型警告("all") |
| @FunctionalInterface | 被修饰的接口是函数式接口，是指一个接口中只能有一个抽象的方法，但是可以有多个非抽象的方法 |
三、自定义注解
知道了元注解与内置注解后，我们就可以自己定义注解了 ，在平时的开发中通过自定义注解
可以实现一些通用的处理，方法的标注，日志切面，通过aop拦截自定义注解来实现一个通用的功能：比如事务，日志，接口的幂等性校验等等
其中自定义注解可以参照内置注解来编写，之后修改一些元注解的信息
一个简单的注解如下 其中里面定义的变量需要以 类型+变量名+()的格式，在default后面可以添加默认值，如果没有默认值，在使用时就需要设置值。
package com.example.springwebdomo.service.annotations;
import java.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SimpleAnno {
String name();
String type() default "A";
int age() default 3;
}
注解的使用，需要对注解中没有设置默认值的属性进行赋值
package com.example.springwebdomo.service.annotations;
public class AnnoDemo {
@SimpleAnno(name = "zhangsan")
public void testAnno(){
}
}
那定义了这个注解又有什么用呢？
orm框架我们都用过，其中里面有很多对表关系还有字段关系的映射，他就是通过反射来获取到了这些注解的映射值，然后再进行对象跟表和字段之间的关系映射，反射获取注解例子：
package com.example.springwebdomo.service.annotations;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
public class AnnoDemo {
public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException {
Class<?> aClass = Class.forName("com.example.springwebdomo.service.annotations.AnnoUser");
Annotation[] annotations = aClass.getAnnotations();
for (Annotation annotation : annotations) {
System.out.println(annotation);
}
//获取类上的所有注解
SimpleAnno annotation1 = aClass.getAnnotation(SimpleAnno.class);
System.out.println(annotation1.name());
// 获取方法上注解的value值
Method test = aClass.getDeclaredMethod("test");
SimpleAnno annotation = test.getAnnotation(SimpleAnno.class);
System.out.println(annotation.name());
}
@SimpleAnno(name = "zhangsan")
public void testAnno(){
}
}
@SimpleAnno(name="zhangsan")
class AnnoUser{
@SimpleAnno(name="lisi")
public void test(){
}
}
知道了怎样来获取注解后，下面再举两个注解比较常用的例子：
1、通过自定义注解+拦截器 实现权限的校验
①、定义一个注解
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LoginAnno {
}②、定义controller跳转页面
@RestController
public class HelloController {
@GetMapping("pageA")
@LoginAnno
public String pageA(){
return "pageA";
}
@GetMapping("pageB")
public String loginB(){
return "pageB";
}
}③、定义拦截器，并通过反射获取方法上是否有@LoginAnno注解，如果有的话返回false，并给出拦截提示信息
package com.example.springwebdomo.util;
import com.example.springwebdomo.service.annotations.LoginAnno;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Slf4j
public class PageInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
log.info("进入拦截器方法了");
HandlerMethod handlerMethod=(HandlerMethod) handler;
LoginAnno annotation = handlerMethod.getMethod().getAnnotation(LoginAnno.class);
if(annotation==null){
return true;
}
response.setContentType("application/json; charset=utf-8");
response.getWriter().write("请登录后再访问");
return false;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
}
}
④、创建配置类，将拦截器配置到拦截器链中，捕获所有地址
package com.example.springwebdomo.config;
import com.example.springwebdomo.util.PageInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class InterceptorConfiguration implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new PageInterceptor()).addPathPatterns("/**");
}
}
访问pageA会被拦截
pageB能够正常访问
2、自定义注解+AOP实现注解标注增强
①、引入aop依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>②、定义日志注解
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogAnno {
}③、定义切面类，进行功能增强
package com.example.springwebdomo.config;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
@Component
@Aspect
public class LogAspect {
@Pointcut("@annotation(com.example.springwebdomo.service.annotations.LogAnno)")
public void logPoint(){}
@Around("logPoint()")
public void logAround(ProceedingJoinPoint joinPoint){
// 获取方法名称
String methodName = joinPoint.getSignature().getName();
// 获取入参
Object[] param = joinPoint.getArgs();
StringBuilder sb = new StringBuilder();
for(Object o : param){
sb.append(o + "; ");
}
System.out.println("进入[" + methodName + "]方法,参数为:" + sb.toString());
// 继续执行方法
try {
joinPoint.proceed();
} catch (Throwable throwable) {
throwable.printStackTrace();
}
System.out.println(methodName + "方法执行结束");
}
}
切面日志
总结：
用自己的理解总结下，注解就像是一个追踪器，可以只对一个物品进行标记，也可以在标记的位置进行一些功能的增强和处理。
扫一扫
951
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
