谈谈Java中自定义注解及使用场景

Java自定义注解一般使用场景为：自定义注解+拦截器或者AOP，使用自定义注解来自己设计框架，使得代码看起来非常优雅。本文将先从自定义注解的基础概念说起，然后开始实战，写小段代码实现自定义注解+拦截器，自定义注解+AOP。

来宾网站建设公司创新互联,来宾网站设计制作，有大型网站制作公司丰富经验。已为来宾近千家提供企业网站建设服务。企业网站搭建\外贸网站制作要多少钱，请找那个售后服务好的来宾做网站的公司定做！

一. 什么是注解(Annotation)

Java注解是什么，以下是引用自维基百科的内容

Java注解又称Java标注，是JDK5.0版本开始支持加入源代码的特殊语法元数据。

Java语言中的类、方法、变量、参数和包等都可以被标注。和Javadoc不同，Java标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java虚拟机可以保留标注内容，在运行时可以获取到标注内容。当然它也支持自定义Java标注。

二. 注解体系图

元注解：java.lang.annotation中提供了元注解，可以使用这些注解来定义自己的注解。主要使用的是Target和Retention注解

注解处理类：既然上面定义了注解，那得有办法拿到我们定义的注解啊。java.lang.reflect.AnnotationElement接口则提供了该功能。注解的处理是通过java反射来处理的。

如下，反射相关的类Class, Method, Field都实现了AnnotationElement接口。

因此，只要我们通过反射拿到Class, Method, Field类，就能够通过getAnnotation(Class)拿到我们想要的注解并取值。

搜索Java知音公众号，回复“后端面试”，送你一份Java面试题宝典

三. 常用元注解

Target：描述了注解修饰的对象范围，取值在java.lang.annotation.ElementType定义，常用的包括：

  •  METHOD：用于描述方法
  •  PACKAGE：用于描述包
  •  PARAMETER：用于描述方法变量
  •  TYPE：用于描述类、接口或enum类型

Retention: 表示注解保留时间长短。取值在java.lang.annotation.RetentionPolicy中，取值为：

  •  SOURCE：在源文件中有效，编译过程中会被忽略
  •  CLASS：随源文件一起编译在class文件中，运行时忽略
  •  RUNTIME：在运行时有效

只有定义为RetentionPolicy.RUNTIME时，我们才能通过注解反射获取到注解。

所以，假设我们要自定义一个注解，它用在字段上，并且可以通过反射获取到，功能是用来描述字段的长度和作用。

 
 
 
 
    
  
  
  
  
  1. @Target(ElementType.FIELD)  //  注解用于字段上 
    2. 
  
  
  
  
  2. @Retention(RetentionPolicy.RUNTIME)  // 保留到运行时，可通过注解获取 
    3. 
  
  
  
  
  3. public @interface MyField { 
    4. 
  
  
  
  
  4.     String description(); 
    5. 
  
  
  
  
  5.     int length(); 
    6. 
  
  
  
  
  6. }
    7.

四. 示例-反射获取注解

先定义一个注解：

 
 
 
 
    
  
  
  
  
  1. @Target(ElementType.FIELD) 
    2. 
  
  
  
  
  2. @Retention(RetentionPolicy.RUNTIME) 
    3. 
  
  
  
  
  3. public @interface MyField { 
    4. 
  
  
  
  
  4.     String description(); 
    5. 
  
  
  
  
  5.     int length(); 
    6. 
  
  
  
  
  6. }
    7.

通过反射获取注解

 
 
 
 
    
  
  
  
  
  1. public class MyFieldTest { 
    2. 
  
  
  
  
  2.     //使用我们的自定义注解 
    3. 
  
  
  
  
  3.     @MyField(description = "用户名", length = 12) 
    4. 
  
  
  
  
  4.     private String username; 
    5. 
  
  
  
  
  5.     @Test 
    6. 
  
  
  
  
  6.     public void testMyField(){ 
    7. 
  
  
  
  
  7.         // 获取类模板 
    8. 
  
  
  
  
  8.         Class c = MyFieldTest.class; 
    9. 
  
  
  
  
  9.         // 获取所有字段 
    10. 
  
  
  
  
  10.         for(Field f : c.getDeclaredFields()){ 
    11. 
  
  
  
  
  11.             // 判断这个字段是否有MyField注解 
    12. 
  
  
  
  
  12.             if(f.isAnnotationPresent(MyField.class)){ 
    13. 
  
  
  
  
  13.                 MyField annotation = f.getAnnotation(MyField.class); 
    14. 
  
  
  
  
  14.                 System.out.println("字段:[" + f.getName() + "], 描述:[" + annotation.description() + "], 长度:[" + annotation.length() +"]"); 
    15. 
  
  
  
  
  15.             } 
    16. 
  
  
  
  
  16.         } 
    17. 
  
  
  
  
  17.     } 
    18. 
  
  
  
  
  18. }
    19.

运行结果

应用场景一：自定义注解+拦截器 实现登录校验

接下来，我们使用springboot拦截器实现这样一个功能，如果方法上加了@LoginRequired，则提示用户该接口需要登录才能访问，否则不需要登录。

首先定义一个LoginRequired注解

 
 
 
 
    
  
  
  
  
  1. @Target(ElementType.METHOD) 
    2. 
  
  
  
  
  2. @Retention(RetentionPolicy.RUNTIME) 
    3. 
  
  
  
  
  3. public @interface LoginRequired { 
    4. 
  
  
  
  
  4. }
    5.

然后写两个简单的接口，访问sourceA，sourceB资源

 
 
 
 
    
  
  
  
  
  1. @RestController 
    2. 
  
  
  
  
  2. public class IndexController { 
    3. 
  
  
  
  
  3.     @GetMapping("/sourceA") 
    4. 
  
  
  
  
  4.     public String sourceA(){ 
    5. 
  
  
  
  
  5.         return "你正在访问sourceA资源"; 
    6. 
  
  
  
  
  6.     }
    7. 
  
  
  
  
  7.     @GetMapping("/sourceB") 
    8. 
  
  
  
  
  8.     public String sourceB(){ 
    9. 
  
  
  
  
  9.         return "你正在访问sourceB资源"; 
    10. 
  
  
  
  
  10.     } 
    11. 
  
  
  
  
  11. }
    12.

没添加拦截器之前成功访问

实现spring的HandlerInterceptor 类先实现拦截器，但不拦截，只是简单打印日志，如下：

 
 
 
 
    
  
  
  
  
  1. public class SourceAccessInterceptor implements HandlerInterceptor { 
    2. 
  
  
  
  
  2.     @Override 
    3. 
  
  
  
  
  3.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { 
    4. 
  
  
  
  
  4.         System.out.println("进入拦截器了"); 
    5. 
  
  
  
  
  5.         return true;
    6. 
  
  
  
  
  6.      } 
    7. 
  
  
  
  
  7.     @Override 
    8. 
  
  
  
  
  8.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { 
    9. 
  
  
  
  
  9.     } 
    10. 
  
  
  
  
  10.     @Override 
    11. 
  
  
  
  
  11.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { 
    12. 
  
  
  
  
  12.     } 
    13. 
  
  
  
  
  13. }
    14.

实现spring类WebMvcConfigurer，创建配置类把拦截器添加到拦截器链中

 
 
 
 
    
  
  
  
  
  1. @Configuration 
    2. 
  
  
  
  
  2. public class InterceptorTrainConfigurer implements WebMvcConfigurer { 
    3. 
  
  
  
  
  3.     @Override 
    4. 
  
  
  
  
  4.     public void addInterceptors(InterceptorRegistry registry) { 
    5. 
  
  
  
  
  5.         registry.addInterceptor(new SourceAccessInterceptor()).addPathPatterns("/**"); 
    6. 
  
  
  
  
  6.     } 
    7. 
  
  
  
  
  7. }
    8.

拦截成功如下

在sourceB方法上添加我们的登录注解@LoginRequired

 
 
 
 
    
  
  
  
  
  1. @RestController 
    2. 
  
  
  
  
  2. public class IndexController { 
    3. 
  
  
  
  
  3.     @GetMapping("/sourceA") 
    4. 
  
  
  
  
  4.     public String sourceA(){ 
    5. 
  
  
  
  
  5.         return "你正在访问sourceA资源"; 
    6. 
  
  
  
  
  6.     } 
    7. 
  
  
  
  
  7.     @LoginRequired 
    8. 
  
  
  
  
  8.     @GetMapping("/sourceB") 
    9. 
  
  
  
  
  9.     public String sourceB(){ 
    10. 
  
  
  
  
  10.         return "你正在访问sourceB资源"; 
    11. 
  
  
  
  
  11.     } 
    12. 
  
  
  
  
  12. }
    13.

简单实现登录拦截逻辑

 
 
 
 
    
  
  
  
  
  1. @Override 
    2. 
  
  
  
  
  2.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { 
    3. 
  
  
  
  
  3.         System.out.println("进入拦截器了"); 
    4. 
  
  
  
  
  4.         // 反射获取方法上的LoginRequred注解 
    5. 
  
  
  
  
  5.         HandlerMethod handlerMethod = (HandlerMethod)handler; 
    6. 
  
  
  
  
  6.         LoginRequired loginRequired = handlerMethod.getMethod().getAnnotation(LoginRequired.class); 
    7. 
  
  
  
  
  7.         if(loginRequired == null){ 
    8. 
  
  
  
  
  8.             return true; 
    9. 
  
  
  
  
  9.         }
    10. 
  
  
  
  
  10.         // 有LoginRequired注解说明需要登录，提示用户登录 
    11. 
  
  
  
  
  11.         response.setContentType("application/json; charset=utf-8"); 
    12. 
  
  
  
  
  12.         response.getWriter().print("你访问的资源需要登录"); 
    13. 
  
  
  
  
  13.         return false; 
    14. 
  
  
  
  
  14.     }
    15.

运行成功，访问sourceB时需要登录了，访问sourceA则不用登录

应用场景二：自定义注解+AOP 实现日志打印

先导入切面需要的依赖包

 
 
 
 
    
  
  
  
  
  1.  
    2. 
  
  
  
  
  2.       org.springframework.boot 
    3. 
  
  
  
  
  3.      spring-boot-starter-aop 
    4. 
  
  
  
  
  4.

定义一个注解@MyLog

 
 
 
 
    
  
  
  
  
  1. @Target(ElementType.METHOD) 
    2. 
  
  
  
  
  2. @Retention(RetentionPolicy.RUNTIME) 
    3. 
  
  
  
  
  3. public @interface MyLog {  
    4. 
  
  
  
  
  4. }
    5.

定义一个切面类，见如下代码注释理解：

 
 
 
 
    
  
  
  
  
  1. @Aspect // 1.表明这是一个切面类 
    2. 
  
  
  
  
  2. @Component 
    3. 
  
  
  
  
  3. public class MyLogAspect { 
    4. 
  
  
  
  
  4.     // 2. PointCut表示这是一个切点，@annotation表示这个切点切到一个注解上，后面带该注解的全类名 
    5. 
  
  
  
  
  5.     // 切面最主要的就是切点，所有的故事都围绕切点发生 
    6. 
  
  
  
  
  6.     // logPointCut()代表切点名称 
    7. 
  
  
  
  
  7.     @Pointcut("@annotation(me.zebin.demo.annotationdemo.aoplog.MyLog)") 
    8. 
  
  
  
  
  8.     public void logPointCut(){}; 
    9. 
  
  
  
  
  9.     // 3. 环绕通知 
    10. 
  
  
  
  
  10.     @Around("logPointCut()") 
    11. 
  
  
  
  
  11.     public void logAround(ProceedingJoinPoint joinPoint){ 
    12. 
  
  
  
  
  12.         // 获取方法名称 
    13. 
  
  
  
  
  13.         String methodName = joinPoint.getSignature().getName(); 
    14. 
  
  
  
  
  14.         // 获取入参 
    15. 
  
  
  
  
  15.         Object[] param = joinPoint.getArgs(); 
    16. 
  
  
  
  
  16.         StringBuilder sb = new StringBuilder(); 
    17. 
  
  
  
  
  17.         for(Object o : param){ 
    18. 
  
  
  
  
  18.             sb.append(o + "; "); 
    19. 
  
  
  
  
  19.         } 
    20. 
  
  
  
  
  20.         System.out.println("进入[" + methodName + "]方法,参数为:" + sb.toString()); 
    21. 
  
  
  
  
  21.         // 继续执行方法 
    22. 
  
  
  
  
  22.         try { 
    23. 
  
  
  
  
  23.             joinPoint.proceed(); 
    24. 
  
  
  
  
  24.         } catch (Throwable throwable) { 
    25. 
  
  
  
  
  25.             throwable.printStackTrace(); 
    26. 
  
  
  
  
  26.         } 
    27. 
  
  
  
  
  27.         System.out.println(methodName + "方法执行结束");
    28. 
  
  
  
  
  28.     } 
    29. 
  
  
  
  
  29. }
    30.

在步骤二中的IndexController写一个sourceC进行测试，加上我们的自定义注解：

 
 
 
 
    
  
  
  
  
  1. @MyLog 
    2. 
  
  
  
  
  2. @GetMapping("/sourceC/{source_name}") 
    3. 
  
  
  
  
  3. public String sourceC(@PathVariable("source_name") String sourceName){ 
    4. 
  
  
  
  
  4.     return "你正在访问sourceC资源"; 
    5. 
  
  
  
  
  5. }
    6.

启动springboot web项目，输入访问地址

当前文章：谈谈Java中自定义注解及使用场景
网页路径：http://www.mswzjz.cn/qtweb/news20/521670.html

攀枝花网站建设、攀枝花网站运维推广公司-贝锐智能，是专注品牌与效果的网络营销公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 贝锐智能

贝锐智能技术为您推荐以下文章

用户体验知识

行业网站建设

医药医疗网站建设方案　　 　边坡防护网　　 　成都宣传画册设计　　 　广汉锦华　　 　营销型网站建设　　 　成都西云机房　　 　成都微信开发　　 　金羊影视传媒　　 　网站建设　　 　营销型网站建设　　 　成都画册设计　　 　四川发电机回收　　 　大吉雪茄　　 　重庆水土三线托管　　 　造型师设计　　 　四川晃众门窗　　 　蜜朵婚庆　　 　成都网站建设　　 　玄科环保　　 　川银永信