Java SpringBoot自定义注解的使用及说明

 更新时间:2025年11月21日 10:40:19   作者:Java皇帝  
本文介绍了在Spring Boot中创建和使用自定义注解的方法,通过自定义注解,可以减少重复代码、增强代码可读性和可维护性,具体步骤包括定义注解、创建注解处理器以及在业务方法上使用注解

一、自定义注解的场景与优势

1.1 场景

在开发过程中,我们常常需要在多个地方实现相同的功能,例如日志记录、性能监控、权限验证等。

如果直接在每个业务方法中编写这些功能的代码,会导致代码重复和难以维护。

1.2 优势

使用自定义注解的优势在于:

  • 减少重复代码 :通过注解的方式,将公共逻辑集中到一个地方,避免在多个地方重复编写相同的代码。
  • 增强代码可读性 :注解能够清晰地表达方法的用途和行为,使代码更具可读性。
  • 便于维护和扩展 :当需要修改或扩展功能时,只需修改注解的实现逻辑,而无需在多个地方进行修改。

二、创建自定义注解

2.1 定义注解

使用 @interface 关键字定义注解,并通过 @Retention@Target 等元注解来指定注解的保留策略和适用目标。

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD) // 指定注解适用的目标类型为方法
@Retention(RetentionPolicy.RUNTIME) // 指定注解的保留策略为运行时
@Documented
public @interface LogAnnotation {
    String module() default ""; // 模块名称
    String operation() default ""; // 操作描述
}

2.2 创建注解处理器

通过创建注解处理器(Aspect),利用 AOP(面向切面编程)来拦截带有自定义注解的方法,并在方法执行前后添加自定义逻辑。

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

@Aspect
@Component
@Order(1) // 指定切面的顺序
public class LogAspect {
    private static final Logger logger = LoggerFactory.getLogger(LogAspect.class);

    @Pointcut("@annotation(LogAnnotation)") // 定义切点,匹配使用了 LogAnnotation 的方法
    public void logPointcut() {}

    @Before("logPointcut()")
    public void doBefore() {
        logger.info("方法执行前,添加日志记录逻辑");
    }
}

三、使用自定义注解

3.1 在业务方法上使用注解

在需要记录日志的业务方法上添加自定义注解,指定模块名称和操作描述。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class DemoController {
    @GetMapping("/test")
    @LogAnnotation(module = "测试模块", operation = "测试方法执行")
    public String test() {
        return "Hello, World!";
    }
}

3.2 配置类加载注解

确保 Spring 能够扫描到自定义注解和注解处理器,可以在主应用类或配置类上添加 @ComponentScan 注解,指定扫描的包路径。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication
@ComponentScan(basePackages = "your.package.name") // 指定扫描的包路径
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

四、总结

在 Spring Boot 中创建和使用自定义注解,可以帮助我们实现代码的复用、增强代码的可读性和可维护性。

通过定义注解、创建注解处理器,并在业务方法上使用注解,可以轻松实现诸如日志记录、性能监控、权限验证等功能。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Spring中一个少见的引介增强IntroductionAdvisor

    Spring中一个少见的引介增强IntroductionAdvisor

    这篇文章主要为大家介绍了Spring中一个少见的引介增强IntroductionAdvisor实战详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • Spring控制反转和依赖注入超详细讲解

    Spring控制反转和依赖注入超详细讲解

    控制反转(IoC)与依赖注入(DI)是密切相关的概念,它们通常一起出现在讨论Spring框架时,这篇文章主要介绍了Spring控制反转和依赖注入的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-10-10
  • 浅谈SpringBoot Bean加载优先级的问题

    浅谈SpringBoot Bean加载优先级的问题

    这篇文章主要介绍了浅谈SpringBoot Bean加载优先级的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • Java数据结构及算法实例:考拉兹猜想 Collatz Conjecture

    Java数据结构及算法实例:考拉兹猜想 Collatz Conjecture

    这篇文章主要介绍了Java数据结构及算法实例:考拉兹猜想 Collatz Conjecture,本文直接给出实现代码,代码中包含详细注释,需要的朋友可以参考下
    2015-06-06
  • 如何在MyBatis中实现DataSource

    如何在MyBatis中实现DataSource

    今天给大家整理了如何在MyBatis中实现DataSource,文中有非常详细的代码示例,对正在学习java的小伙伴们很有帮助,需要的朋友可以参考下
    2021-06-06
  • 解决创建springboot后启动报错:Failed to bind properties under‘spring.datasource‘

    解决创建springboot后启动报错:Failed to bind properties under‘spri

    在Spring Boot项目中,application.properties和application.yml是用于配置参数的两种文件格式,properties格式简洁但不支持层次结构,而yml格式支持层次性,可读性更好,在yml文件中,要注意细节,比如冒号后面需要空格
    2024-10-10
  • java后端操作树结构的案例代码

    java后端操作树结构的案例代码

    这篇文章主要介绍了java后端操作树结构,树结构的三种组装方式(递归.双层for循环,map),通过实例代码介绍了使用递归查询某个节点所在的树结构,需要的朋友可以参考下
    2023-10-10
  • java项目中的绝对路径和相对路径用法说明

    java项目中的绝对路径和相对路径用法说明

    这篇文章主要介绍了java项目中的绝对路径和相对路径用法说明,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • java整数与byte数组的转换实现代码

    java整数与byte数组的转换实现代码

    这篇文章主要介绍了java整数与byte数组的转换实现代码的相关资料,需要的朋友可以参考下
    2017-07-07
  • SpringBoot集成ElasticSearch实现搜索功能

    SpringBoot集成ElasticSearch实现搜索功能

    本文主要介绍了Spring Boot 集成ElasticSearch实现搜索功能,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-03-03

最新评论