玩转Spring Boot自定义注解：从入门到精通的5个实战案例

最新推荐文章于 2025-12-27 11:00:00 发布
原创 最新推荐文章于 2025-12-27 11:00:00 发布 · 556 阅读 · 17 ·
本内容遵循CC 4.0 BY-SA版权协议
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
GEO检测
标签
#spring boot #java #android

玩转Spring Boot自定义注解：从入门到精通的5个实战案例

Spring Boot自定义注解是扩展框架功能的强大工具，它能简化代码、提升可维护性，并实现AOP（面向切面编程）等高级特性。本文将通过5个实战案例，从简单入门到精通进阶，逐步教你如何创建和应用自定义注解。每个案例包括：

  • 描述：注解的作用和场景。
  • 实现步骤：使用Spring Boot和Java代码展示。
  • 解释：核心原理和注意事项。

所有代码基于Spring Boot 3.x和Java 17，确保真实可用。案例难度递增，覆盖日志记录、参数验证、事务管理、安全控制和启动配置。

案例1：入门级 - 日志记录注解（@LogExecutionTime）

描述：创建一个简单注解，用于记录方法执行时间，适合初学者理解注解定义和AOP集成。
实现步骤：

  1. 定义注解：
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME) // 注解在运行时保留
@Target(ElementType.METHOD) // 只能应用于方法
public @interface LogExecutionTime {
}

  1. 创建AOP切面处理：
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class LogExecutionAspect {

    @Around("@annotation(LogExecutionTime)") // 拦截@LogExecutionTime注解的方法
    public Object logTime(ProceedingJoinPoint joinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = joinPoint.proceed(); // 执行原方法
        long endTime = System.currentTimeMillis();
        System.out.println("方法 " + joinPoint.getSignature().getName() + " 执行耗时: " + (endTime - startTime) + "ms");
        return result;
    }
}

  1. 应用注解：
@Service
public class UserService {

    @LogExecutionTime
    public void processUserData() {
        // 模拟耗时操作
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

解释：

  • 原理：通过AOP的@Around通知，在方法执行前后计算时间差。
  • 优点：代码非侵入式，易于复用。
  • 注意：确保Spring Boot项目已添加spring-boot-starter-aop依赖。
案例2：基础级 - 参数验证注解（@ValidParam）

描述：扩展Spring Validation，自定义注解用于方法参数校验，适合掌握注解属性和验证器集成。
实现步骤：

  1. 定义注解：
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Documented
@Constraint(validatedBy = NotEmptyValidator.class) // 指定验证器
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidParam {
    String message() default "参数不能为空"; // 默认错误消息
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

  1. 创建验证器：
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class NotEmptyValidator implements ConstraintValidator<ValidParam, String> {

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return value != null && !value.trim().isEmpty(); // 简单非空校验
    }
}

  1. 应用注解：
@RestController
public class UserController {

    @PostMapping("/user")
    public ResponseEntity<String> createUser(@RequestBody @ValidParam String username) {
        // 如果username为空，Spring会自动抛出MethodArgumentNotValidException
        return ResponseEntity.ok("用户创建成功: " + username);
    }
}

解释：

  • 原理：集成Spring Validation框架，通过ConstraintValidator实现校验逻辑。
  • 优点：统一处理参数错误，减少重复代码。
  • 注意：需添加spring-boot-starter-validation依赖，并配置全局异常处理器。
案例3：中级 - 事务管理注解（@CustomTransactional）

描述：自定义简化版事务注解，结合Spring事务管理，适合学习注解属性和事务传播。
实现步骤：

  1. 定义注解：
import org.springframework.transaction.annotation.Transactional;

@Transactional(rollbackFor = Exception.class) // 继承Spring的@Transactional
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomTransactional {
    int timeout() default 30; // 自定义超时属性，单位为秒
}

  1. 创建事务切面：
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;
import org.springframework.transaction.support.TransactionTemplate;

@Aspect
@Component
public class CustomTransactionAspect {

    private final TransactionTemplate transactionTemplate;

    public CustomTransactionAspect(TransactionTemplate transactionTemplate) {
        this.transactionTemplate = transactionTemplate;
    }

    @Around("@annotation(customTx)") // 拦截@CustomTransactional注解
    public Object manageTransaction(ProceedingJoinPoint joinPoint, CustomTransactional customTx) throws Throwable {
        return transactionTemplate.execute(status -> {
            try {
                status.setTimeout(customTx.timeout()); // 设置超时
                return joinPoint.proceed();
            } catch (Throwable e) {
                throw new RuntimeException("事务异常", e);
            }
        });
    }
}

  1. 应用注解：
@Service
public class OrderService {

    @CustomTransactional(timeout = 10) // 设置10秒超时
    public void placeOrder() {
        // 数据库操作，如超时或异常会自动回滚
    }
}

解释：

  • 原理：基于Spring的TransactionTemplate，通过AOP包装事务逻辑。
  • 优点：灵活控制事务属性，如超时时间。
  • 注意：需要配置DataSource和PlatformTransactionManager。
案例4：高级 - 安全控制注解（@Secure）

描述：实现基于角色的访问控制注解，集成Spring Security，适合高级用户掌握注解解析和权限验证。
实现步骤：

  1. 定义注解：
import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Secure {
    String[] roles() default {}; // 允许的角色列表
}

  1. 创建安全切面：
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class SecurityAspect {

    @Before("@annotation(secure)") // 在方法执行前检查权限
    public void checkAccess(Secure secure) {
        Authentication auth = SecurityContextHolder.getContext().getAuthentication();
        if (auth == null || !auth.isAuthenticated()) {
            throw new SecurityException("用户未认证");
        }
        String[] requiredRoles = secure.roles();
        boolean hasRole = false;
        for (String role : requiredRoles) {
            if (auth.getAuthorities().stream().anyMatch(g -> g.getAuthority().equals(role))) {
                hasRole = true;
                break;
            }
        }
        if (!hasRole) {
            throw new SecurityException("无权限访问");
        }
    }
}

  1. 应用注解：
@RestController
public class AdminController {

    @Secure(roles = {"ADMIN"}) // 仅允许ADMIN角色
    @GetMapping("/admin")
    public String adminDashboard() {
        return "管理员面板";
    }
}

解释：

  • 原理：使用AOP的@Before通知，结合Spring Security的认证上下文进行角色校验。
  • 优点：细粒度控制方法级权限。
  • 注意：需集成Spring Security，并配置角色管理。
案例5：精通级 - 启动配置注解（@EnableCustomFeature）

描述：创建注解用于自动配置Spring Boot启动项，类似@EnableCaching，适合精通Spring自动配置机制。
实现步骤：

  1. 定义注解：
import org.springframework.context.annotation.Import;
import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(CustomFeatureConfig.class) // 导入配置类
public @interface EnableCustomFeature {
    String prefix() default "custom"; // 自定义属性前缀
}

  1. 创建自动配置类：
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties(CustomProperties.class) // 启用属性绑定
public class CustomFeatureConfig {

    @Bean
    public CustomService customService(CustomProperties properties) {
        return new CustomService(properties.getPrefix());
    }
}

  1. 定义属性和服务：
import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "custom") // 绑定application.yml中的属性
public class CustomProperties {
    private String prefix = "default";

    // Getter和Setter
    public String getPrefix() { return prefix; }
    public void setPrefix(String prefix) { this.prefix = prefix; }
}

public class CustomService {
    private final String prefix;

    public CustomService(String prefix) {
        this.prefix = prefix;
    }

    public String process(String input) {
        return prefix + "-" + input;
    }
}

  1. 应用注解：
@SpringBootApplication
@EnableCustomFeature(prefix = "myapp") // 启动时自动配置
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

解释：

  • 原理：通过@Import导入配置类，利用Spring Boot的自动装配机制初始化Bean。
  • 优点：实现模块化启动，简化配置。
  • 注意：需在src/main/resources/META-INF/spring.factories中注册自动配置类。

总结

通过这些实战案例，你已从入门到精通掌握了Spring Boot自定义注解的核心技能：

  1. 入门：日志记录（@LogExecutionTime） – 基础AOP应用。
  2. 基础：参数验证（@ValidParam） – 集成验证框架。
  3. 中级：事务管理（@CustomTransactional） – 自定义事务属性。
  4. 高级：安全控制（@Secure） – 结合Spring Security。
  5. 精通：启动配置（@EnableCustomFeature） – 实现自动装配。

最佳实践：

  • 测试每个注解：使用JUnit和Spring Boot Test确保功能可靠。
  • 逐步迭代：从简单案例开始，逐步添加复杂逻辑。
  • 资源推荐：参考Spring官方文档和GitHub示例库加深理解。

通过这5个案例，你将能灵活运用自定义注解提升项目效率。如果有具体问题，欢迎进一步讨论！

Spring Boot核心注解大全：从入门到精通（四）
凛鼕将至的博客
04-10 1084
Spring Boot是一个开源的Java框架，它被设计用来简化Spring应用的创建和开发过程。它基于Spring框架，通过自动配置和约定大于配置的方式，提供了一种快速创建独立的、可部署的Spring应用的方法。本文将跟随《Spring Boot核心注解大全：从入门到精通（三）》的进度，继续介绍Spring Boot核心注解。
【Java】SpringBoot应用简单示例
要继续努力的孤独的博客
11-15 5647
springboot应用的一些小示例
55个常见Springboot应用示例，手把手教你深度学习Springboot
写点有用的
01-15 2199
今天给大家推荐一个深度学习实战的Springboot项目，包含了服务端开发常见的55个功能示例，比如logback日志模块的配置、通过AOP切面记录日志、集成mybatisPlus、集成redis、集成RabbitMQ消息队列等等所有常见的功能。项目作者将每一个功能都做成了一个模块，大家使用时只需要按照模块中的readme文档，一步一步的配置就可以完成一个功能的开发。这些项目的代码都是经过大家反复认证过的，只要引入的版本号没问题，就可以在我们的项目中正常的跑起来。1，引入mybatis-plus的包。
Spring Boot应用开发案例展示
qqrrjj2011的博客
10-14 2670
Spring Boot应用开发案例展示
Springboot小例子
qq_27630263的博客
12-06 1817
SpringBoot小案例
【SpringBoot】SpringBoot案例 | Web后端开发
小扣的学习Blog
06-17 1824
自用，SpringBoot入门记录。
Spring Boot 自定义注解实战：用常见的5个高频案例带你飞！
Micro麦可乐的博客
09-28 5518
自定义注解是一种强大的元编程工具，允许在不修改原有代码逻辑的情况下，为程序添加额外的功能。通过AOP（面向切面编程）与自定义注解的结合，我们可以实现关注点分离，让业务代码更加清晰简洁
Spring Boot自定义注解深度解析：从入门到实战进阶
最新发布
用文字记录技术，用分享回馈社区，用坚持见证成长
12-27 1591
在现代化Spring Boot应用开发中，注解已经成为不可或缺的编程元素。自定义注解不仅仅是语法糖，更是实现代码解耦增强可读性统一业务规范和实现AOP编程的利器。通过本文，您将全面掌握Spring Boot自定义注解的设计、实现与应用技巧。元注解（Meta-Annotation）是用于定义其他注解的注解。Java提供了5个标准元注解，它们是构建自定义注解的基石。@Target(ElementType.METHOD) // 仅可用于方法。
【Spring Boot进阶】掌握Spring Boot框架核心注解：从入门到精通（实战指南）
欢迎来到我的技术空间！我是一名经验丰富的Java开发工程师，热衷于分享我在软件开发领域的知识和心得。在这个博客里，您会发现一系列关于Java编程的文章，包括最佳实践、技术趋势、代码优化技巧以及一些有趣的项目案例。无论是初学者还是有经验的开发者，都能在这里找
08-23 2390
本指南全面介绍了Spring Boot中的核心注解及其应用，从基础知识到高级特性，逐一剖析并提供实战示例。适合初学者快速上手，也适用于进阶用户深入探索Spring Boot的强大功能。通过本文，你将学会如何高效地使用Spring Boot构建现代化的Java应用程序。
SpringBoot(一）：简单的SpringBoot项目的实例
weixin_43328816的博客
03-21 5725
简单的一个SpringBoot的项目： 1.SpringBoot的系统版本要求： 2.Maven的设置： <mirrors> <mirror> <id>nexus-aliyun</id> <mirrorOf>central</mirrorOf> <name>Nexus aliyun</name> <url>http
Spring事务管理（详解+实例）
热门推荐
Trigl的博客
03-25 9万+
写这篇博客之前我首先读了《Spring in action》，之后在网上看了很多关于Spring事务管理的文章，具体参考文章如下： 1、将相应的接口依赖图理清出 2、将每个类的具体配置弄明白 3、将具体的配置给出来 4、给出具体的例子（一个声明式的一个编程式的）
springboot-综合案例
29岁的裴野永远爱你
09-15 3669
springboot-综合案例 Springboot + mybatis + redis
Spring Boot 应用示例
weixin_43227193的博客
09-22 653
Service（业务逻辑）、Repository（数据库）、Entity（数据模型）。如果不想用 XML 映射文件，可以全部用注解方式（后面示例会展示）。（如你的例子），不需要 Service 或 Entity。可以直接运行，不需要 Service 或 Entity。Spring Boot 需要一个启动类，通常放在。无需写 SQL（基本 CRUD 已内置）。提前创建 MySQL 数据库（如。确保数据库已创建，账号密码正确。下面我们可以在这个基础上增加。支持 Lambda 查询（如。
20个基于SpringBoot搭建的开源项目，总有一个你会感兴趣
Java圈全能架构师的博客
07-18 2万+
前言 SpringBoot一直是开发者比较青睐的一款轻量级框架，他不仅继承了Spring框架原有的优秀特性，而且还通过简化配置来进一步简化了Spring应用的整个搭建和开发过程。 现在很多Java系的软件开发都是基于SpringBoot的，这就要求开发人员都要掌握基于SpringBoot的开发。 由于SpringBoot体系非常庞大，导致很多人并不能完全掌握如何使用，尤其是涉及分布式相关的开发时，如何和其他框架整合更是让很多程序员无从下手。 最近，小编蹲点各大开源网站、社区等，终于被我找到了20款基
⭐SpringBoot⭐【全面+细致+实例】！！！
记录学习，共同进步
11-05 2274
1.默认包扫描规则:主程序所在的包及其下的子包都会被扫描2.SpringBoot帮我们配置好了所有的web开发的常用场景3.@SpringBootApplication等同于：4.默认配置最终都是映射到MultipartPropertiesSpringBoot先加载所有的自动配置类每个自动配置类按照条件进行生效，默认都会绑定配置文件默认的值生效的配置类就会给容器中装配很多组件只要容器中有了这些组件，就相当于这些功能就有了。只要自己配置了，就以自己的优先。
[spring]spring boot项目实例
henku449141932的博客
02-07 4070
目录 1.概述 2.创建项目 3.配置pom.xml 4.配置application.properties 5.创建package 6.创建相关类 6.1在model包下创建UserBean 6.2在service包下创建UserService 6.3在serviceImpl包下创建UserServiceImpl 6.4在dao包下创建UserMapper 6.5在controller包下创建loginController 6.6 在创建主程序 7.创建mapper文件 7.1创
Springboot精选的八个项目案例
black_skyfall的博客
04-28 1万+
案例包括： 一、支付服务：https://gitee.com/52itstyle/spring-boot-pay 开发环境：JDK1.7、Maven、Eclipse、SpringBoot1.5.2、spring-boot-starter-thymeleaf、Dubbox2.8.4、zookeeper3.4.6。 二、秒杀案例：https://gitee.com/52itstyle/sprin...
springboot 简单案例
logohjiji的博客
04-22 649
本案例主要实现了利用springboot来读取txt文件，并将文件中的数据进行解析，最后返回给页面。
SpringBoot实例加每行代码详解，完整版。从0到1！
心比天高，仗剑走天涯，保持热爱，奔赴向梦想！
09-21 7750
**你想要的SpringBoot， 都在这里！**一，简化开发过程二，特性快速创建，三，四大核心四，开发环境五，第一个spring boot程序七，第一个springboot程序解析八，springboot的核心配置文件九，多配置文件十，自定义配置在springboot的核心配置文件中自定义配置，然后采用注解读取属性值第二种方法十二 springboot下的springmvc十三： springboot下使用jsp十四：springboot继承mybatis 一，简化开发过程 二，特性快速创建， 直接使用j
springboot 事务使用示例
weixin_43931625的博客
09-26 1395
springboot事务使用示例
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值