【如何让代码变“高级”(一)】-Spring组合注解提升代码维度(这么有趣)

简介: 在定义某个类或接口时,使用了Spring自带的注解(@Controller、@Service,@Conditional),同时又要使用公司特定的注解标注公司的业务,接着就出现了以下处理方式的那一幕。

开发中这样的代码


对于每个开发人员都会遇到这样情况,代码如下:


@Api(tags = "自定义组合注解", description = "组合注解优化代码")
@StandardResult
@RequestMapping("/Ccww")
@Controller
@ResponseBody
public class CombinationController{
}
复制代码


在定义某个类或接口时,使用了Spring自带的注解(@Controller、@Service,@Conditional),同时又要使用公司特定的注解标注公司的业务,接着就出现了以下处理方式的那一幕。


“普通”开发人员


对于一般开发人员来说,只要功能、需求达到即可,代码也差不多就可以了,生活也就那样。只要不出现BUG,测试人员,产品经理不找,万事大吉了,不用加班准备开溜陪女朋友了真的有吗?😭)!!!


生活就像心电图一样,一帆风顺就证明挂了,

因此我们需要一颗折腾的心


高级”开发员(BUG工程师)


对于我们这类 “高级”开发员(BUG工程师) ,看到这样的代码,一个类上声明了五六个注解,长长的一大串注解,代码看起来就很普通,体现不出我们“高级”开发员(BUG工程师)折腾的心💗,BUG创造师的水平。


而且注解本意是为了提供我们便捷,代码优化,作标注用。但和XML一样,过度使用就编程了一种灾难。


于是我们持着一颗折腾的心💗,寻找一种可以让自己看来舒服的整洁的代码修正,现在找到了使用组合注解的方式把需要的注解组合在一个自定义的组合注解上。


"高级”开发人员(BUG工程师)-基于组合注解方案


首先我们持着一个折腾的心💗,想到平时我们常见的SpringBoot的启动注解@SpringBootApplication


为什么它一个注解可以实现那么多功能呢?

怎么实现的呢?

我们怎么才能在将这个实现转化出自己所需的自定义注解呢?


接下来我们看看它的源码:


@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
    @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
    @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
  @AliasFor(annotation = EnableAutoConfiguration.class)
  Class<?>[] exclude() default {};
  @AliasFor(annotation = EnableAutoConfiguration.class)
  String[] excludeName() default {};
  @AliasFor(annotation = ComponentScan.class, attribute = "basePackages")
  String[] scanBasePackages() default {};
  @AliasFor(annotation = ComponentScan.class, attribute = "basePackageClasses")
  Class<?>[] scanBasePackageClasses() default {};
}
复制代码


@SpringBootApplication功能列表:


  • 声明@Inherited注解,声明了它的类的子类是可以继承它的
  • 声明@SpringBootConfiguration注解,可为类标注为配置类
  • 声明@EnableAutoConfiguration注解,声明了它的类会默认开启自动配置
  • 声明@ComponentScan注解,同时是@ComponentScan注解的容器。我们发现scanBasePackagesscanBasePackageClasses两个注解属性上面同样声明了@AliasFor注解,分别指向了@ComponentScan注解的basePackages注解属性和basePackageClasses属性。
  • 声明了exclude()为排除特定的自动配置类以及excludeName()排除特定的自动配置类名称


疑问??


  • 这时我们会想@SpringBootApplication为什么可以这样使用呢?
  • 为什么可以继承?
  • 我们定义的普通类和接口有什么区别?
  • @AliasFor 为什么可以这样使用?
  • ....


其实,基于@Retention的值可以分两时期对注解进行处理,:


  1. 编译时处理
  2. 运行时处理


@Retention的值为RetentionPolicy.SOURCE时注解只存在.java源文件中

@Retention的值为RetentionPolicy.CLASS时注解只存在于.class文件中,


都无法在运行时去获取注解的信息,只能在编译时处理


设定为RetentionPolicy.RUNTIME注解信息会存在.class文件中


通知单JVM加载.class文件时会把注解也加载到JVM中,所以就可在运行时获取注解的信息


运行时处理:运行时处理是通过反射机制获取注解


再看看最原始的注解(完全由元注解组成的):


public @Interface Annotation
{
}
复制代码


创建注解使用@Interface类型声明为注解,并且声明为@Interface类型的类在编译时会自动继承Annotation接口。


那什么类型的类可以继承接口呢?


自然是接口类型了,对编译器而言,注解其实就是一个接口。所以,我们在某个类上声明注解本质上等价于继承注解代表的接口。因为注解本质上是接口,就具有了相互继承的能力了。


还有(心想,这问题少年,那么多问题),在注解里声明的注解方法以及给注解属性赋值怎么处理的呢?


对了,就是JDK动态代理!编译器把我们的类翻译为实现了注解接口的类,然后用JDK动态代理的方式拦截所有该类方法的调用,如果是自定义方法就放行;如果是注解方法就拦截下来执行某些逻辑。至于我们给注解属性赋值,会以JDK动态代理类的常量的方式保存,需要时使用就可以了。我们可以看看代理注解的类是怎样的,具体的可以实现跟踪源码看看


最后,@AliasFor的作用是什么呢?


  • 用到注解 属性上,表示两个属性互相为别名,互相为别名的属性值必须相同,若设置成不同,则会报错
  • 注解是可以继承的,但是注解是不能继承父注解的属性的,也就是说,我在类扫描的时候,拿到的注解的属性值,依然是父注解的属性值,而不是你定义的注解的属性值,所以此时可以在子注解对应的属性上加上@AliasFor


手动起来,动手优化


现在该发挥我们程序员的核心本领之一“仿写”,有什么是我们不能仿写出来的呢?哈哈( 程序员的傲娇😏 ),话不多说,撸起袖子,开码,仿写@SpringBootApplication注解:


/**
*自定义组合注解
*@author Ccww
*
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
@RequestMapping
@Api
public @interface StandardResultRestControllerApi
{
  /**
    * 定义映射路径URL
  * @return
    */
   @AliasFor(annotation = RequestMapping.class, value = "path")
   String[] value() default {};
    /**
    *定义spring类名称
    *@return
    */
    @AliasFor(annotation = Controller.class, value = "value")
    String name() default "";
    /**
    *定义Api类tags属性
    *@return
    */
    @AliasFor(annotation = Api.class, attribute = "tags")
    String[] tags() default "";
    /**
    *定义Api类description属性
    *@return
    */
    @AliasFor(annotation = Api.class, attribute = "description")
    String description() default "";
}
复制代码


优化后的代码如下


@StandardResultRestControllerApi(path="/Combination",tags = "自定义组合注解", description = "组合注解优化代码")
public class CombinationController
{
}
复制代码


总结


经过优化后,整个类看起来轻简了很多。以后碰到类似情况,可以考虑使用组合注解来进行优化, 将多个注解作用于一个注解,用一个注解就可以来实现那多个注解的功能,使作用的元素(即方法或类等)看上去更简洁美观,当然主要还是更强大的属性覆盖功能。


但是也要视情况而定,不要盲目的使用组合注解,不然别人看起这代码就比较费劲了哈!!( “高级”程序员的微笑🙂 )


温馨提示:不要盲目的使用组合注解


优点:


  • 代码整齐


缺点:


  • 代码可读性比较差,想使用必须理解其原意


各位看官还可以吗?喜欢的话,动动手指点个💗,点个关注呗!!谢谢支持!



目录
相关文章
|
3月前
|
安全 Java 应用服务中间件
Spring Boot + Java 21:内存减少 60%,启动速度提高 30% — 零代码
通过调整三个JVM和Spring Boot配置开关,无需重写代码即可显著优化Java应用性能:内存减少60%,启动速度提升30%。适用于所有在JVM上运行API的生产团队,低成本实现高效能。
319 3
|
3月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
562 128
|
2月前
|
人工智能 监控 Java
零代码改造 + 全链路追踪!Spring AI 最新可观测性详细解读
Spring AI Alibaba 通过集成 OpenTelemetry 实现可观测性,支持框架原生和无侵入探针两种方式。原生方案依赖 Micrometer 自动埋点,适用于快速接入;无侵入探针基于 LoongSuite 商业版,无需修改代码即可采集标准 OTLP 数据,解决了原生方案扩展性差、调用链易断链等问题。未来将开源无侵入探针方案,整合至 AgentScope Studio,并进一步增强多 Agent 场景下的观测能力。
1482 34
|
2月前
|
安全 Java 测试技术
《深入理解Spring》单元测试——高质量代码的守护神
Spring测试框架提供全面的单元与集成测试支持,通过`@SpringBootTest`、`@WebMvcTest`等注解实现分层测试,结合Mockito、Testcontainers和Jacoco,保障代码质量,提升开发效率与系统稳定性。
|
2月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
398 2
|
3月前
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
382 1
使用Spring的@Retryable注解进行自动重试
|
3月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
299 12
|
3月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
187 0
探索Spring Boot的@Conditional注解的上下文配置
|
3月前
|
智能设计 Java 测试技术
Spring中最大化@Lazy注解,实现资源高效利用
本文深入探讨了 Spring 框架中的 `@Lazy` 注解,介绍了其在资源管理和性能优化中的作用。通过延迟初始化 Bean,`@Lazy` 可显著提升应用启动速度,合理利用系统资源,并增强对 Bean 生命周期的控制。文章还分析了 `@Lazy` 的工作机制、使用场景、最佳实践以及常见陷阱与解决方案,帮助开发者更高效地构建可扩展、高性能的 Spring 应用程序。
141 0
Spring中最大化@Lazy注解,实现资源高效利用
|
3月前
|
Java 测试技术 编译器
@GrpcService使用注解在 Spring Boot 中开始使用 gRPC
本文介绍了如何在Spring Boot应用中集成gRPC框架,使用`@GrpcService`注解实现高效、可扩展的服务间通信。内容涵盖gRPC与Protocol Buffers的原理、环境配置、服务定义与实现、测试方法等,帮助开发者快速构建高性能的微服务系统。
606 0