注解+AOP+自动配置实现自定义starter

最新推荐文章于 2025-08-04 16:42:13 发布

匀升ovo

最新推荐文章于 2025-08-04 16:42:13 发布

阅读量333

点赞数 5

CC 4.0 BY-SA版权

文章标签： spring boot

本文链接：https://blog.youkuaiyun.com/Laollaoaolao/article/details/148896924

自定义starter

新建一个framwork模块，作为项目的公共组件

模块含有三部分

项目层级如下

自定义注解 CurrentTime

/**
 * 在方法执行完之后打印当前时间
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CurrentTime {
    String message() default "currentTime: ";
}

定义aop方法(切面方法)

目的是在使用了CurrentTime注解的方法中执行切面任务

这个方法的作用是在需要加强的方法执行完毕后打印当前时间

@Aspect
public class CurrentTimeAspect {
    @AfterReturning("@annotation(com.zzm.Retention.CurrentTime)")
    public void currentTime(JoinPoint joinPoint) throws Throwable {
        CurrentTime currentTime = getCurrentTimeAnnotation(joinPoint);
        System.out.println(currentTime.message() + LocalDateTime.now());
    }

    /**
     * 返回自定义获取当前时间注解
     */
    public CurrentTime getCurrentTimeAnnotation(JoinPoint joinPoint) throws NoSuchMethodException {
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        Method targetMethod = joinPoint.getTarget().getClass().getDeclaredMethod(methodSignature.getName(), methodSignature.getMethod().getParameterTypes());
        return targetMethod.getAnnotation(CurrentTime.class);
    }
}

定义自动装配类，用于springboot自动配置

/**
 * 日志组件相关配置类
 */
public class LogConfiguration {

    @Bean
    public CurrentTimeAspect currentTimeAspect() {
        return new CurrentTimeAspect();
    }
}

几个问题：

✅ 自动装配类为什么不需要 @Component 或 @Configuration 注解？
1. 自动装配类通常使用的是 SPI机制 加载，而不是通过注解扫描。
2. 它是通过 META-INF/spring.factories（Spring Boot 2.x）或 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports（Spring Boot 3.x）文件中显式声明的。
3. 一旦声明了，Spring Boot 在启动时会主动去加载这些配置类，并把它们注册到容器中。
为什么currentTimeAspect方法需要定义@Bean？

@Bean 是 告诉 Spring：我要把这个方法的返回值注册为一个 Bean。

即使你当前的配置类是通过自动装配机制（不是通过注解扫描），Spring 仍然需要知道你要注册哪些 Bean，而这个指令就是通过 @Bean 提供的。

在META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports中设置自动配置类路径

com.zzm.configuration.LogConfiguration

接下来使用maven对自定义starter进行打包

执行 clean 和 install

这下starter就完全打包好了

在maven仓库也能看到这个包

主模块中引入starter

主模块层级如下

使用自定义stater分为以下几步

pom中导入包

<dependency>
    <groupId>com.zzm</groupId>
    <artifactId>framework</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

定义service

@Service
public class TimeService {

    @CurrentTime(message = "测试时间：")
    public void doSomething() {
        System.out.println("doing something...");
    }
}

定义测试类

@SpringBootTest
public class currentTimeLogTest {

    @Autowired
    private TimeService timeService;

    @Test
    @CurrentTime
    public void testCurrentTimeLog() {
        timeService.doSomething();
    }
}

执行测试方法可以看到打印