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 Boot实现微信小程序登录

    Spring Boot实现微信小程序登录

    这篇文章主要为大家详细介绍了Spring Boot实现微信小程序登录,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-04-04
  • Java中的枚举enum详细解读

    Java中的枚举enum详细解读

    这篇文章主要介绍了Java中的枚举enum详细解读,当我们使用enum关键字开发一个枚举类时,默认会继承Enum类,而且是一个final类,当有多个枚举对象时,使用逗号 ,隔开,最后一个用分号;结尾,需要的朋友可以参考下
    2024-01-01
  • Java主线程捕获子线程异常的实现

    Java主线程捕获子线程异常的实现

    本文主要介绍了Java主线程捕获子线程异常的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-04-04
  • java动态代理和cglib动态代理示例分享

    java动态代理和cglib动态代理示例分享

    这篇文章主要介绍了java动态代理和cglib动态代理示例,JDK1.3之后,Java提供了动态代理的技术,允许开发者在运行期间创建接口的代理实例,下面我们使用示例学习一下
    2014-03-03
  • java发送http请求并获取状态码的简单实例

    java发送http请求并获取状态码的简单实例

    下面小编就为大家带来一篇java发送http请求并获取状态码的简单实例。小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-05-05
  • SpringBoot使用注解集成Redis缓存的示例代码

    SpringBoot使用注解集成Redis缓存的示例代码

    这篇文章主要介绍了在 Spring Boot 中使用注解集成 Redis 缓存的步骤,包括添加依赖、创建相关配置类、需要缓存数据的类(TestService)以及测试方法(如在 Controller 中的 redisTest 和 redisCache 方法),还对一些关键代码和配置进行了详细说明
    2025-01-01
  • Spring Batch入门教程篇

    Spring Batch入门教程篇

    这篇文章主要给大家介绍了Spring Batch入门的相关资料,文中介绍的非常详细,对大家具有一定的参考学习价值,需要的朋友们下面跟着小编一起来学习学习吧。
    2017-06-06
  • java利用SMB读取远程文件的方法

    java利用SMB读取远程文件的方法

    这篇文章主要为大家详细介绍了java利用SMB读取远程文件的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-05-05
  • 使用Enumeration和Iterator遍历集合类详解

    使用Enumeration和Iterator遍历集合类详解

    Enumeration和Iterator接口功能相似,而且Iterator的功能还比Enumeration多,那么为什么还要使用Enumeration
    2013-09-09
  • java实现四子棋游戏

    java实现四子棋游戏

    这篇文章主要为大家详细介绍了java实现四子棋游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-03-03

最新评论