news 2026/2/16 8:12:47

Java 注解与反射实战:手把手实现自定义日志与参数校验注解

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
Java 注解与反射实战:手把手实现自定义日志与参数校验注解

好的,我们来一步步手写两个非常实用的自定义注解 + 反射实现:

  1. @LogExecution:方法执行前后自动打印日志(入参 + 返回值 + 耗时)
  2. @NotBlankParam:方法参数非空/非空白校验(类似 @NotBlank 但作用于方法参数,且用纯反射实现,不依赖 Spring/Hibernate Validator)

我们先用最原始的反射方式实现(不依赖 AOP / Spring),适合理解原理、工具类、测试框架、轻量 SDK 等场景。然后简单提一下如何升级到 Spring AOP 方式。

第一部分:@LogExecution 日志注解(反射实现)

1. 定义注解
importjava.lang.annotation.*;@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic@interfaceLogExecution{Stringvalue()default"";// 可自定义日志前缀booleanlogArgs()defaulttrue;// 是否打印入参booleanlogResult()defaulttrue;// 是否打印返回值booleanlogTime()defaulttrue;// 是否打印耗时}
2. 反射工具类(核心调用逻辑)
importorg.slf4j.Logger;importorg.slf4j.LoggerFactory;importjava.lang.reflect.Method;importjava.util.Arrays;publicclassLogExecutionUtil{privatestaticfinalLoggerlog=LoggerFactory.getLogger(LogExecutionUtil.class);/** * 包装执行目标方法,自动加日志 */publicstaticObjectinvokeWithLogging(Objecttarget,Methodmethod,Object[]args)throwsThrowable{LogExecutionanno=method.getAnnotation(LogExecution.class);if(anno==null){// 没有注解 → 直接执行returnmethod.invoke(target,args);}Stringprefix=anno.value().isEmpty()?method.getName():anno.value();StringBuilderlogPrefix=newStringBuilder("[").append(prefix).append("] ");// 打印入参if(anno.logArgs()){StringargsStr=args==null?"null":Arrays.toString(args);log.info("{}开始执行 → 参数: {}",logPrefix,argsStr);}longstart=System.nanoTime();try{Objectresult=method.invoke(target,args);// 打印返回值if(anno.logResult()){log.info("{}执行完成 → 返回: {}",logPrefix,result);}// 打印耗时if(anno.logTime()){doublems=(System.nanoTime()-start)/1_000_000.0;log.info("{}耗时: {} ms",logPrefix,String.format("%.3f",ms));}returnresult;}catch(Throwablee){log.error("{}执行异常",logPrefix,e);throwe;}}}
3. 使用示例
publicclassUserService{@LogExecution(value="创建用户",logArgs=true,logResult=true,logTime=true)publicUsercreateUser(Stringusername,intage){if(age<0)thrownewIllegalArgumentException("年龄不能为负");returnnewUser(username,age);}@LogExecution("批量删除")// 使用默认值publicvoidbatchDelete(List<Long>ids){System.out.println("删除 "+ids.size()+" 条记录");}}
4. 如何调用(代理 / 手动包装)

最简单的方式:写一个代理类或在调用处手动用invokeWithLogging

// 手动调用方式UserServiceservice=newUserService();Methodmethod=UserService.class.getMethod("createUser",String.class,int.class);LogExecutionUtil.invokeWithLogging(service,method,newObject[]{"alice",25});

更常见的是结合动态代理(JDK Proxy / ByteBuddy / CGLIB)使用。

第二部分:@NotBlankParam 参数非空校验(反射实现)

1. 定义注解(可重复)
importjava.lang.annotation.*;@Repeatable(NotBlankParams.class)@Target(ElementType.PARAMETER)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic@interfaceNotBlankParam{intindex()default-1;// 参数下标(从0开始),-1表示自动推断(推荐)Stringmessage()default"参数不能为空且不能为纯空白";}
@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)public@interfaceNotBlankParams{NotBlankParam[]value();}
2. 校验工具类
importjava.lang.reflect.Method;importjava.lang.reflect.Parameter;importjava.util.Objects;publicclassParamValidator{publicstaticvoidvalidateParams(Objecttarget,Methodmethod,Object[]args){Parameter[]parameters=method.getParameters();Annotation[][]paramAnnos=method.getParameterAnnotations();for(inti=0;i<parameters.length;i++){for(Annotationanno:paramAnnos[i]){if(annoinstanceofNotBlankParam){NotBlankParamnotBlank=(NotBlankParam)anno;intidx=notBlank.index()>=0?notBlank.index():i;if(idx>=args.length){thrownewIllegalArgumentException("注解 index 越界");}Objectvalue=args[idx];if(value==null||(valueinstanceofString&&((String)value).trim().isEmpty())){thrownewIllegalArgumentException(notBlank.message()+" (参数位置: "+idx+")");}}}}}}
3. 使用示例
publicclassOrderService{publicvoidcreateOrder(@NotBlankParamStringorderNo,@NotBlankParam(message="收货人姓名必填")StringreceiverName,Stringremark){// remark 不校验System.out.println("创建订单:"+orderNo);}}
4. 调用方式(同样结合代理)
// 在方法执行前先校验ParamValidator.validateParams(target,method,args);// 再执行方法method.invoke(target,args);

第三部分:升级方案(生产级常用方式)

场景推荐方式优点实现复杂度
学习/理解原理纯反射 + 手动代理最清晰,理解最透彻★★★☆☆
轻量工具类/SDKJDK动态代理 / ByteBuddy无 Spring 依赖,体积小★★★★☆
Spring Boot 项目Spring AOP + @Aspect零侵入、最优雅★★☆☆☆
高性能场景Annotation Processor + APT / 字节码生成编译期生成代码,无反射开销★★★★★
Spring AOP 快速示例(@LogExecution)
@Aspect@ComponentpublicclassLogExecutionAspect{@Around("@annotation(logAnno)")publicObjectaround(ProceedingJoinPointjoinPoint,LogExecutionlogAnno)throwsThrowable{// 前置日志、入参// proceed()// 后置日志、耗时、返回值}}

小结 & 进阶方向

  • 学会了@Retention(RUNTIME)+反射读取注解的基本套路
  • 掌握了方法参数注解的获取方式(method.getParameterAnnotations()
  • 明白了自定义注解 + 反射的两种主要用途:日志追踪参数/返回值校验
  • 能自己写出简易的方法切面工具(不依赖框架)

接下来想深入哪个方向?

A. 写一个完整的JDK动态代理包装器(自动扫描 @LogExecution / @NotBlankParam)
B. 实现Spring AOP版本(AspectJ风格)
C. 做参数校验的支持分组 / 支持自定义消息国际化
D. 用Annotation Processor在编译期校验注解使用是否合法
E. 结合@Around做更复杂的场景(事务 + 日志 + 校验 一条龙)

告诉我字母,我继续带你写代码!

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/2/15 13:20:08

网页设计常用的交互反馈音效有哪些?(2026最新推荐)

根据中国互联网络信息中心&#xff08;CNNIC&#xff09;发布的《第49次中国互联网络发展状况统计报告》&#xff0c;网页用户体验已成为影响用户留存的关键因素&#xff0c;其中超过60%的用户对交互音效的及时反馈表示认可。这份报告强调了音效在提升界面友好度方面的作用&…

作者头像 李华
网站建设 2026/2/9 7:03:40

汽车行业如何突围?天淳AI+GEO精准获客新策略

汽车行业如何突围&#xff1f;天淳AIGEO精准获客新策略 引言 汽车行业正面临前所未有的挑战。新能源与传统燃油车用户需求分化&#xff0c;客群涵盖年轻上班族、家庭用户、高端商务人士等&#xff0c;偏好差异显著&#xff0c;精准触达难度大。线上线索转化为到店试驾率低&am…

作者头像 李华
网站建设 2026/2/8 12:58:04

SGMICRO圣邦微 SGM58031XMS10G/TR MSOP10 模数转换芯片ADC

特性 单电源电压范围:3V至5.5V.PC总线电压范围:3V至5.5V 低静态电流: 连续模式:255pA(典型值) 掉电模式:0.8pA(典型值) 可选数据速率:6.25SPS至960SPS 输入多路复用器 4个单端输入或2个差分输入 内部可编程增益放大器(PGA) 内部电压参考与振荡器 可选数字比较器 2C兼容串行接口…

作者头像 李华
网站建设 2026/2/7 2:13:19

多路温度采集(有完整资料)

资料查找方式&#xff1a; 特纳斯电子&#xff08;电子校园网&#xff09;&#xff1a;搜索下面编号即可 编号&#xff1a; CP-51-2021-018 设计简介&#xff1a; 本设计是基于单片机的多路温度采集系统&#xff0c;主要实现以下功能&#xff1a; 可通过LCD1602显示温度和状…

作者头像 李华
网站建设 2026/2/15 10:06:47

AI短剧制作小程序源码系统,全智能创作系统源码全览

温馨提示&#xff1a;文末有资源获取方式当AI技术能将短剧制作成本压缩至传统方式的10%以下&#xff0c;当几个人几天内就能无拍摄完成一部剧集&#xff0c;“AI短剧”已从概念走进现实&#xff0c;成为普通人内容创业的黄金赛道。面对广阔前景与激烈竞争&#xff0c;一套功能强…

作者头像 李华