Java自定义注释通常用于使用自定义注释阻止程序或AOP自行设计框架以使代码看起来优雅的场景中。 本文首先从自定义评论的基础概念入手，开始实战，写短代码实现自定义评论断路器，实现自定义评论AOP。
一、评论是什么(注释) ) )。
什么是Java评论？ 以下是从维基百科引用的
Java注释(也称为Java标注)是一种特殊的语法元数据，JDK 5.0版现在支持添加到源代码中。
可以标记Java语言中的类、方法、变量、参数和包等。 与Javadoc不同，Java标注可以通过反射获取标注的内容。 编译器生成类文件时，可以将标记嵌入字节码中。 Java虚拟机可以保留标记内容，并在运行时检索标记内容。 当然，它还支持自定义Java注释。
二.注释体系图
元注释： java.lang.annotation包含可用于定义自己的注释的元注释。 主要使用目标和保留注释
评论处理类：既然已经定义了评论，就有办法得到我们定义的评论吧。 可以在Java.lang.reflect.annotation element界面中使用此功能。 注释的处理由java反射处理。
如下所示，反射相关的类Class、Method、Field都实现了AnnotationElement接口。
因此，如果反射地取得Class、Method、Field类，则能够在getAnnotation(Class )中取得希望的注释并取得值。
三.常用元评论
Target :描述了注释限定的范围，采用在Java.lang.annotation.element type中定义的值，通常如下所示：
方法：用于说明方法
包：用于说明包
PARAMETER :描述方法的变量
类型：描述类、接口或枚举类型
Retention:显示注释保留时间的长度。 值为Java.lang.annotation.retention policy，采用以下值：
SOURCE :在源文件中有效，在编译过程中被忽略
CLASS—与源文件一起编译为class文件，在运行时被忽略
运行时：运行时有效
只有在定义为RetentionPolicy.RUNTIME时，才能从注释的反射中获取注释。
因此，假设您要自定义字段中使用并可通过反射获取的注释。 功能用于描述字段的长度和作用。
@target(elementtype.field ) /注释用于字段
@ retention (retention policy.runtime ) /如果要保留到运行时，可以通过注释获取
公共@接口my field {
字符串描述(；
int length (；
}
4 .示例-通过反射获取评论
首先定义注释。
@target(elementtype.field ) )
@ retention (retention policy.runtime ) )。
公共@接口my field {
字符串描述(；
int length (；
}
通过反射获取注释
公共类my field test {
//使用我们的自定义评论
@ my field (描述='用户名'，length=12 ) )。
私有字符串用户名称；
@Test
公共语音测试我的字段
//获取类模板
Class c=MyFieldTest.class；
//获取所有字段
for (field f : c.getdeclaredfields () ) ) )。
//确定此字段中是否存在MyField注释
if (f.isannotationpresent (my field.class ) ) }
我的字段注释=f.get annotation (my field.class；
System.out.println (字段：(f.getname ) )、说明：(annotation.description )、长度： () annotation ) )
}
}
}
}
执行结果
应用场景一：自定义注解+拦截器 实现登录校验
接下来，我们使用springboot拦截器实现这样一个功能，如果方法上加了@LoginRequired，则提示用户该接口需要登录才能访问，否则不需要登录。
首先定义一个LoginRequired注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LoginRequired {
}
然后写两个简单的接口，访问sourceA，sourceB资源
@RestController
public class IndexController {
@GetMapping("/sourceA")
public String sourceA() {
return "你正在访问sourceA资源";
}
@GetMapping("/sourceB")
public String sourceB() {
return "你正在访问sourceB资源";
}
}
没添加拦截器之前成功访问
实现spring的HandlerInterceptor 类先实现拦截器，但不拦截，只是简单打印日志，如下：
public class SourceAccessInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("进入拦截器了");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
}
}
实现spring类WebMvcConfigurer，创建配置类把拦截器添加到拦截器链中
@Configuration
public class InterceptorTrainConfigurer implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new SourceAccessInterceptor()).addPathPatterns("/**");
}
}
拦截成功如下
在sourceB方法上添加我们的登录注解@LoginRequired
@RestController
public class IndexController {
@GetMapping("/sourceA")
public String sourceA() {
return "你正在访问sourceA资源";
}
@LoginRequired
@GetMapping("/sourceB")
public String sourceB() {
return "你正在访问sourceB资源";
}
}
简单实现登录拦截逻辑
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("进入拦截器了");
// 反射获取方法上的LoginRequred注解
HandlerMethod handlerMethod = (HandlerMethod) handler;
LoginRequired loginRequired = handlerMethod.getMethod().getAnnotation(LoginRequired.class);
if (loginRequired == null) {
return true;
}
// 有LoginRequired注解说明需要登录，提示用户登录
response.setContentType("application/json; charset=utf-8");
response.getWriter().print("你访问的资源需要登录");
return false;
}
运行成功，访问sourceB时需要登录了，访问sourceA则不用登录
应用场景二：自定义注解+AOP 实现日志打印
先导入切面需要的依赖包
org.springframework.boot
spring-boot-starter-aop
定义一个注解@MyLog
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
}
定义一个切面类，见如下代码注释理解：
@Aspect // 1.表明这是一个切面类
@Component
public class MyLogAspect {
// 2. PointCut表示这是一个切点，@annotation表示这个切点切到一个注解上，后面带该注解的全类名
// 切面最主要的就是切点，所有的故事都围绕切点发生
// logPointCut()代表切点名称
@Pointcut("@annotation(me.zebin.demo.annotationdemo.aoplog.MyLog)")
public void logPointCut() {};
// 3. 环绕通知
@Around("logPointCut()")
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 + "方法执行结束");
}
}
在步骤二中的IndexController写一个sourceC进行测试，加上我们的自定义注解：
@MyLog
@GetMapping("/sourceC/{source_name}")
public String sourceC(@PathVariable("source_name") String sourceName){
return "你正在访问sourceC资源";
}
启动springboot web项目，输入访问地址
到此这篇关于谈谈Java中自定义注解及使用场景的文章就介绍到这了,更多相关Java 自定义注解内容请搜索聚米学院以前的文章或继续浏览下面的相关文章希望大家以后多多支持聚米学院！