Spring Boot 常用注解整理(最全收藏版)

spring & spring boot 常用注解整理

现代的 spring 与 spring boot 应用大量使用注解来简化配置、管理组件和实现各种框架功能。本文系统整理了常用的 spring/spring boot 注解，按照功能分类进行介绍。每个注解都会涵盖其含义、提供来源、应用场景以及代码示例，帮助开发者深入理解和快速检索。

一、spring boot 核心注解

@springbootapplication

简介： @springbootapplication 是 spring boot 应用的主入口注解。它标注在启动类上，表示这是一个 spring boot 应用。该注解由 spring boot 提供（位于 org.springframework.boot.autoconfigure 包），本质上是一个组合注解，包含了 spring framework 和 spring boot 的关键配置注解。

作用与场景： 使用 @springbootapplication 标记主类后，spring boot 会自动进行以下配置：

• 配置类声明： 包含了 @springbootconfiguration（其本身是 @configuration 的特化），因此该类被视为配置类，可定义 bean。
• 组件扫描： 内含 @componentscan，会自动扫描该类所在包及其子包下的组件（被诸如 @component、@service、@controller 等注解标记的类），将它们注册为 spring 容器中的 bean。
• 自动配置： 内含 @enableautoconfiguration，根据类路径下依赖自动配置 spring boot 应用。例如，若 classpath 中存在 hsqldb 数据库依赖，则会自动配置内存数据库等。开发者无需手动编写大量配置即可启动应用。

使用示例： 创建一个 spring boot 主启动类，在类上添加 @springbootapplication 注解，并编写 main 方法启动应用：

@springbootapplication
public class myapplication {
    public static void main(string[] args) {
        springapplication.run(myapplication.class, args);
    }
}

上述代码中，myapplication 类由 @springbootapplication 注解标记为应用入口。运行 springapplication.run 后，spring boot 将引导启动内嵌服务器、初始化 spring 容器，自动扫描组件并完成配置。

注： @springbootapplication 提供了属性用于定制，如 exclude 可排除特定的自动配置类。如果需要禁用某些自动配置，可以使用例如 @springbootapplication(exclude = datasourceautoconfiguration.class) 来排除。

二、spring 容器与组件注册注解

这一类注解用于将类注册为 spring 容器管理的组件或定义配置，以取代传统的 xml 配置文件，实现注解驱动的装配。

@component

简介： @component 是一个通用的组件注解，由 spring framework 提供（org.springframework.stereotype.component）。它用于将一个普通的 java 类标识为 spring 容器中的 bean。被标注的类在组件扫描时会被发现并实例化，由容器统一管理生命周期。

作用与场景： 当某个类不好归类到特定层时，可以使用 @component 进行标注。典型场景如工具类、通用逻辑处理类等。使用 @component 后，无需在 xml 中声明 bean，spring 会根据配置的扫描路径自动将其注册。提供模块： spring context 模块提供对组件扫描和 @component 注解的支持。

使用示例： 定义一个组件类并演示注入：

@component
public class messageutil {
    public string getwelcomemessage() {
        return "welcome to spring!";
    }
}
// 使用组件
@service
public class greetingservice {
    @autowired
    private messageutil messageutil;
    public void greet() {
        system.out.println(messageutil.getwelcomemessage());
    }
}

上例中，messageutil 类通过 @component 标记成为容器 bean，greetingservice 中使用 @autowired（详见后文）将其注入，最后调用其方法。

@service

简介： @service 是 @component 的一种特化，用于标注业务逻辑层的组件（service层）。它位于 spring 框架的 org.springframework.stereotype 包。

作用与场景： 在分层架构中，服务层类使用 @service 注解，使代码含义更语义化。尽管行为上和 @component 相同（被扫描注册为 bean），@service 强调该类承担业务服务职责。提供模块： spring context，同属于组件模型的一部分。

使用示例：

@service
public class orderservice {
    public void createorder(order order) {
        // 业务逻辑：创建订单
    }
}

通过 @service，orderservice 会被自动扫描注册。在需要使用它的地方，例如控制层或其他服务层，可以通过依赖注入获取该 bean 实例。

@repository

简介： @repository 是 @component 的特化注解之一，用于标注数据访问层组件（dao层，或仓库类）。定义在 spring framework 的 org.springframework.stereotype.repository 包中。

作用与场景： dao 类（例如访问数据库的类）使用 @repository 注解不仅可以被扫描为容器 bean，还能启用异常转换功能。spring dao 层会捕获底层数据访问异常（如 jdbc 的 sqlexception 或 jpa 的异常），将其翻译为 spring 统一的dataaccessexception体系，从而简化异常处理。换句话说，如果一个类标注为 @repository，spring 在为其创建代理时会自动处理持久化异常，将原始异常转为 spring 的非检查型数据访问异常，以提高健壮性。另外，标注了 @repository 的类可以被 @autowired 等注解自动装配到其他地方。

使用示例：

@repository
public class userdao {
    @autowired
    private jdbctemplate jdbctemplate;
    public user findbyid(long id) {
        try {
            return jdbctemplate.queryforobject("select * from users where id=?", 
                                               new beanpropertyrowmapper<>(user.class), id);
        } catch (dataaccessexception e) {
            // spring 已将底层sqlexception翻译为dataaccessexception
            throw e;
        }
    }
}

上例中，userdao 使用 @repository 注解，使其成为容器管理的dao组件。spring 自动为其提供异常转换功能：如果 jdbc 操作抛出 sqlexception，会被翻译为 dataaccessexception（runtimeexception），调用处可以统一处理。标注后也允许通过 @autowired 注入到服务层使用。

@controller

简介： @controller 是 spring mvc 的控制层组件注解，同样派生自 @component。由 spring web mvc 模块提供（org.springframework.stereotype.controller），用于标识一个类是web mvc 控制器，负责处理 http 请求并返回视图或响应。

作用与场景： 在 web 应用程序中，@controller 注解的类会被 dispatcherservlet 识别为控制器，用于映射请求url、封装模型数据并返回视图名。通常配合视图模板（如 thymeleaf、jsp）返回页面。如果需要直接返回 json 数据，可以配合 @responsebody 或直接使用 @restcontroller（后者见下文）。

使用示例：

@controller
public class homecontroller {
    @requestmapping("/home")
    public string homepage(model model) {
        model.addattribute("msg", "hello spring mvc");
        return "home"; // 返回视图名，由视图解析器解析为页面
    }
}

上述 homecontroller 使用 @controller 标记，提供一个映射 “/home” 请求的处理方法。返回值 "home" 代表视图逻辑名，框架会根据配置解析到具体的页面（如 home.html）。如果我们在类上使用了 @controller，框架在启动时会自动注册相应的映射。

@restcontroller

简介： @restcontroller 是 spring 提供的组合注解，等价于同时在类上使用 @controller 和 @responsebody。它主要由 spring web 模块提供，用于restful web服务的控制器。

作用与场景： 标注 @restcontroller 的类会被识别为控制器，并且其每个处理方法的返回值会直接作为 http 响应体输出，而不是作为视图名称解析。适用于需要返回 json、xml 等数据的场景，比如 web api 接口。模块提供： spring web（spring mvc）。

使用示例：

@restcontroller
@requestmapping("/api")
public class userapicontroller {
    @getmapping("/hello")
    public string hello() {
        return "hello, restful";
    }
    @postmapping("/users")
    public user createuser(@requestbody user user) {
        // 直接接收json反序列化为user对象，处理后返回
        return userservice.save(user);
    }
}

userapicontroller 使用 @restcontroller 注解，其方法返回字符串和对象将直接通过消息转换器写入响应（例如字符串作为纯文本，user 对象会序列化为 json）。不需要再在每个方法上加 @responsebody，使代码更加简洁。通常在开发 rest api 时，都使用 @restcontroller 来定义控制器。

@configuration

简介： @configuration 用于声明一个配置类，由 spring framework 提供（org.springframework.context.annotation.configuration）。配置类可以包含若干个带有 @bean 注解的方法，以定义 bean 并交由 spring 容器管理。@configuration 本身也是 @component，因此配置类也会被组件扫描注册。

作用与场景： 在 java config 风格的应用中，@configuration 相当于传统 xml 配置文件。用于定义 beans、设置依赖注入规则等。spring boot 应用的某些自动配置也是以配置类形式存在。提供模块： spring context。

使用示例：

@configuration
public class appconfig {
    @bean
    public datasource datasource() {
        // 配置数据源 bean，例如使用 hikaricp 数据源
        hikaridatasource ds = new hikaridatasource();
        ds.setjdbcurl("jdbc:mysql://localhost:3306/test");
        ds.setusername("root");
        ds.setpassword("123456");
        return ds;
    }
    @bean
    public userservice userservice() {
        // 将 userservice 注册为 bean，并注入依赖的数据源
        return new userservice(datasource());
    }
}

上述 appconfig 被 @configuration 注解标识为配置类。方法 datasource() 和 userservice() 上的 @bean 注解会使 spring 将其返回值注册为容器中的 bean。其中 userservice() 方法调用了 datasource()，spring 会拦截并确保返回的是容器中单例的 datasource bean，而非每次调用重新实例化（即 cglib 增强 @configuration 类确保 bean 单例行为）。

@bean

简介： @bean 注解用于定义一个 bean。它标注在方法上，表示该方法返回的对象会注册到 spring 容器中。@bean 通常配合 @configuration 使用，由 spring context 模块提供。

作用与场景： 当通过 javaconfig 定义 bean 时，用 @bean 替代传统 xml <bean> 声明。例如整合第三方库的 bean、或需要在创建 bean 时执行一些自定义逻辑等场景。@bean 方法可以指定名称（默认是方法名），还支持设置 initmethod（初始化时回调方法）和 destroymethod（销毁时回调方法）。

使用示例：

@configuration
public class myconfig {
    @bean(name = "custombean", initmethod = "init", destroymethod = "cleanup")
    public mycomponent custombean() {
        return new mycomponent();
    }
}

在上例中，@bean 注解声明了 custombean 这个 bean。容器启动时调用 custombean() 方法创建 mycomponent 实例，并以 "custombean" 名称注册。initmethod="init" 表示在 bean 创建后自动调用其 init() 方法进行初始化；destroymethod="cleanup" 表示容器销毁该 bean 时调用其 cleanup() 方法。通过这种方式可以管理 bean 的生命周期方法（类似于 initializingbean 和 disposablebean 接口或 @postconstruct/@predestroy，见后文）。

@componentscan

简介： @componentscan 用于配置组件扫描路径的注解。由 spring context 提供，通常与 @configuration 一起使用。它的作用是指示 spring 在指定的包路径下搜索带有组件注解的类，并注册为 bean。

作用与场景： 默认情况下，spring boot 的 @springbootapplication 已经隐含指定扫描其所在包及子包。如果需要自定义扫描范围（例如扫描其他包的组件），可以使用 @componentscan 注解并提供 basepackages 等属性。普通 spring 应用（非 boot）则经常需要在主配置类上显式使用 @componentscan 指定根包。提供模块： spring context。

使用示例：

@configuration
@componentscan(basepackages = {"com.example.service", "com.example.dao"})
public class appconfig {
    // ... bean definitions
}

上述配置类通过 @componentscan 指定 spring 将扫描 com.example.service 和 com.example.dao 这两个包及其子包，搜索所有标注了 @component/@service/@controller 等的类并注册。这样可以将应用的组件按照包组织，而由配置集中管理扫描范围。

@import

简介： @import 注解用于导入额外的配置类或组件到 spring 容器。它由 spring context 提供，可用在 @configuration 类上，将一个或多个配置类合并进来。也可以用于引入第三方配置。

作用与场景： 当项目拆分成多个配置类时，可以通过 @import 将它们组合。例如，将公共配置独立出来，再在主配置中引入。spring boot 自动配置内部也大量使用了 @import 来按条件加载配置类。提供模块： spring context。

使用示例：

@configuration
@import({securityconfig.class, dataconfig.class})
public class mainconfig {
    // 主配置，导入了安全配置和数据配置
}

如上，mainconfig 通过 @import 导入了 securityconfig 和 dataconfig 两个配置类。这样这两个配置类中定义的 bean 同样会加载到容器中，相当于把多个配置模块拼装在一起。相比在 xml 里用 <import>，注解方式更加直观。

注： spring boot 提供的许多 @enable... 注解（例如后文的 @enablescheduling 等）内部也是通过 @import 导入相应的配置实现启用功能的。

三、依赖注入注解

依赖注入（di）是 spring 核心机制之一。以下注解用于在容器中进行 bean 注入和装配，解决 bean 间的依赖关系。

@autowired

简介： @autowired 是 spring 提供的自动装配注解（org.springframework.beans.factory.annotation.autowired），用于按类型自动注入依赖对象。它可作用于字段、setter方法或者构造函数上。由 spring context 模块支持。

作用与场景： 标注了 @autowired 的属性或方法，spring 会在容器启动时自动寻找匹配的 bean 注入。其中按类型匹配是默认行为。如果匹配到多个同类型 bean，则需要结合 @qualifier 或 @primary 来消除歧义（见下文）。如果没有找到匹配 bean，默认会抛出异常。可通过设置 @autowired(required=false) 来表示找不到 bean 时跳过注入而不报错。

使用示例：

@component
public class userservice {
    @autowired  // 按类型自动装配
    private userrepository userrepository;
    // 或者构造函数注入
    // @autowired 
    // public userservice(userrepository userrepository) { ... }
    public user finduser(long id) {
        return userrepository.findbyid(id);
    }
}

上例中，userservice 有一个成员 userrepository，使用 @autowired 标注。容器会自动将类型为 userrepository 的 bean 注入进来（假设已有 @repository 或 @component 标记的 userrepository 实现）。开发者可以通过构造器、setter 或字段注入的方式使用 @autowired。注意： spring 4.3+ 如果类中只有一个构造器，且需要注入参数，可省略构造函数上的 @autowired，仍会自动注入。

@qualifier

简介： @qualifier 注解与 @autowired 配合使用，用于按照名称或限定符进行依赖注入匹配。它由 spring 提供（org.springframework.beans.factory.annotation.qualifier），可以解决当容器中存在多个同类型 bean 时的冲突。

作用与场景： 默认按类型注入在有多于一个候选 bean 时会无法确定注入哪个。例如有两个实现类实现了同一接口，都被注册为 bean。这种情况下，可以在注入点使用 @qualifier("beanname") 指定注入哪一个 bean，或在 bean 定义处使用 @component("name") 为 bean 命名，然后在注入处引用同名限定符。提供模块： spring context/beans。

使用示例：

@component("mysqlrepo")
public class mysqluserrepository implements userrepository { ... }
@component("oraclerepo")
public class oracleuserrepository implements userrepository { ... }
@service
public class userservice {
    @autowired
    @qualifier("mysqlrepo")  // 指定注入名称为 mysqlrepo 的实现
    private userrepository userrepository;
    // ...
}

如上，有两个 userrepository 实现 bean，分别命名为 “mysqlrepo” 和 “oraclerepo”。在 userservice 中，通过 @qualifier("mysqlrepo") 指定注入名为 mysqlrepo 的 bean。这样即使存在多个同类型 bean，spring 也能准确地注入所需的依赖。

@primary

简介： @primary 注解用于标记一个 bean 为主要候选者。当按类型注入出现多个 bean 可选时，标有 @primary 的 bean 将优先被注入。它由 spring 提供（org.springframework.context.annotation.primary），可作用于类或方法（例如 @bean 方法）上。

作用与场景： 如果不方便在每个注入点都使用 @qualifier 指定 bean，另一种方式是在 bean 定义处用 @primary 声明一个首选 bean。当存在歧义时，容器会选择标记了 @primary 的 bean 注入。注意，@primary 只能有一个，否则仍然无法明确选择。提供模块： spring context。

使用示例：

@configuration
public class repoconfig {
    @bean
    @primary  // 将这个bean标记为首选
    public userrepository mysqluserrepository() {
        return new mysqluserrepository();
    }
    @bean
    public userrepository oracleuserrepository() {
        return new oracleuserrepository();
    }
}
@service
public class userservice {
    @autowired
    private userrepository userrepository;
    // 将自动注入 mysqluserrepository，因为它被标记为 @primary
}

在上例的配置中，我们定义了两个 userrepository bean，其中 mysql 实现被标记为 @primary。因此在 userservice 中按类型注入 userrepository 时，spring 会注入标记了 @primary 的 mysql 实现。@primary 提供了一个全局默认方案，简化了注入点的选择。

@resource

简介： @resource 是来自 jsr-250 规范的注解（javax/jakarta annotation），spring 对其提供了支持，用于按名称或按类型注入依赖。它通常位于 jakarta.annotation.resource（java ee/jakarta ee）包下。注意： 尽管不在 spring 包中，spring 容器能识别并处理它。

作用与场景： @resource 可以看作功能类似于 @autowired + @qualifier 的组合。默认情况下按名称注入：它首先按照属性名或指定的名称在容器中查找 bean，找不到再按类型匹配。这在某些情况下很有用，例如需要与传统 java ee 代码兼容时。在 spring 应用中，也有开发者偏好使用 @resource 进行依赖注入。提供模块： 需要引入相应的 jakarta annotation api，但 spring framework 自身支持处理。

使用示例：

@component("userrepo")
public class userrepositoryimpl implements userrepository { ... }
@service
public class userservice {
    @resource(name = "userrepo")  // 按名称注入名为"userrepo"的bean
    private userrepository userrepo;
    // ...
}

这里，userrepositoryimpl 组件被命名为 "userrepo"。在 userservice 中，通过 @resource(name = "userrepo") 来注入。如果省略 name 属性，@resource 默认以属性名 userrepo 作为 bean 名称查找。与 @autowired 不同，@resource 不支持 required=false 属性，但其异常信息可能更直观（若找不到 bean 则抛出 nosuchbeandefinitionexception）。值得一提的是，spring 也支持 jsr-330 的 @inject（javax.inject.inject）注解，其语义与 @autowired 相同，也可用于构造函数注入等。在实际开发中，可根据团队规范选择使用 spring 原生的 @autowired 还是标准的 @resource/@inject。

@value

简介： @value 注解用于将外部化配置中的属性值注入到 bean 的字段或参数中。它由 spring 提供（org.springframework.beans.factory.annotation.value），常用于读取 application.properties/yaml 配置文件或系统环境变量、jndi等属性。

作用与场景： 当需要在 bean 中使用配置文件里的值时，可以使用 @value("${property.name}") 注入。例如数据库连接参数、服务端口号等。还支持设置默认值和 spel 表达式。提供模块： spring context 环境抽象。

使用示例：
假设 application.properties 有如下内容：

app.name=myspringapp
app.version=1.0.0

java 类使用 @value 注入：

@component
public class appinfo {
    @value("${app.name}")
    private string appname;
    @value("${app.version:0.0.1}")  // 带默认值，若配置缺失则使用0.0.1
    private string appversion;
    // ...
}

上述 appinfo 类中，@value("${app.name}") 将把配置中的 app.name 值注入到 appname 字段。如果对应属性不存在，会启动失败。而 appversion 字段提供了默认值 0.0.1，当配置文件未设置 app.version 时就会使用默认值。这样，可以灵活地将外部配置与代码解耦，使应用更易于调整参数而无需改动源码。

@scope

简介： @scope 注解用于指定 bean 的作用域，由 spring 提供（org.springframework.context.annotation.scope）。默认情况下，spring 容器中的 bean 都是单例（singleton）作用域。通过 @scope 可以定义其他作用域，例如 prototype、request、session 等。

作用与场景： 常见的作用域：

• singleton（默认）：容器中仅保持一个实例。
• prototype：每次请求 bean 时都会创建新实例。
• web相关的作用域（需要在 web 容器环境下使用）：如 request（每个http请求创建）、session（每个会话创建）等。

在需要每次使用新对象的场景（如有状态 bean），可将 bean 定义成 prototype；在 web 应用中某些 bean 希望随请求或会话存续，可用相应作用域。提供模块： spring context。

使用示例：

@component
@scope("prototype")
public class connection {
    public connection() {
        system.out.println("new connection created.");
    }
}

将 connection bean 声明为 prototype，每次获取都会创建新的实例：

@autowired
private connection conn1;
@autowired
private connection conn2;

上面 conn1 和 conn2 将是不同的实例，因为 connection 定义为 prototype。日志会打印两次 “new connection created.”。若作用域是 singleton，则只创建一次实例并复用。需要注意，prototype bean 的生命周期由使用方管理，spring 只负责创建，不会自动调用其销毁方法。

@lazy

简介： @lazy 注解用于将 bean 的初始化延迟到首次使用时（懒加载）。由 spring 提供（org.springframework.context.annotation.lazy），可用于类级别或 @bean 方法上。

作用与场景： 默认情况下，单例 bean 在容器启动时就会初始化。如果某些 bean 的创建比较耗时或在应用运行期间可能不会被用到，可以标记为 @lazy，这样只有在真正需要时才实例化，减少启动时间和资源消耗。懒加载常用于：例如调试或在单元测试中减少不必要 bean 创建，或避免循环依赖时暂缓 bean 的注入初始化。对于 prototype bean，spring 始终延迟创建（因为本身就按需创建），@lazy主要针对单例 bean。提供模块： spring context。

使用示例：

@service
@lazy
public class heavyservice {
    public heavyservice() {
        // 构造函数可能进行大量初始化
        system.out.println("heavyservice initialized");
    }
    // ...
}
@controller
public class democontroller {
    @autowired
    private heavyservice heavyservice; // 被@lazy标记，不会在容器启动时实例化
    // ...
}

如上，heavyservice 使用 @lazy 注解标记为懒加载单例。启动时不会打印 “heavyservice initialized”。当 democontroller 第一次实际调用 heavyservice 的方法或访问它时，spring 才会创建 heavyservice 实例并注入。这对于优化启动性能和按需加载组件很有帮助。但应谨慎使用懒加载，如果bean在启动后马上就会用到，则不应延迟初始化，以免首次调用时产生延迟。

四、配置属性注解

spring 提供了将配置文件内容绑定到对象的机制，这类注解帮助管理应用的外部化配置和环境区分。

@configurationproperties

简介： @configurationproperties 用于将一组配置属性映射到一个 java 类上。由 spring boot 提供（org.springframework.boot.context.properties.configurationproperties），通常配合 bean 使用。通过前缀（prefix）来批量注入配置项到类的属性中。

作用与场景： 当有多项相关配置需要使用时，比起逐个使用 @value，可以定义一个配置属性类。例如应用配置、数据源配置等。在类上标注 @configurationproperties(prefix="xxx") 后，该类的各属性会根据前缀读取配置文件中的对应项赋值。需要将该类注册为 bean（可以通过在类上加 @component 或在配置类中用 @bean 创建），spring boot 会自动将配置绑定到 bean 实例上。

使用示例：
application.yml:

app:
  name: myapp
  apiurl: https://api.example.com
  pool:
    size: 20
    enablelog: true

定义属性绑定类：

@component  // 确保被扫描注册为bean
@configurationproperties(prefix = "app")
public class appproperties {
    private string name;
    private string apiurl;
    private pool pool;
    // 内部静态类或普通类用于嵌套属性
    public static class pool {
        private int size;
        private boolean enablelog;
        // getters/setters ...
    }
    // getters/setters ...
}

将 appproperties 注入使用：

@restcontroller
public class appinfocontroller {
    @autowired
    private appproperties appproperties;
    @getmapping("/appinfo")
    public appproperties getappinfo() {
        // 返回整个配置对象，框架会序列化为json
        return appproperties;
    }
}

在这个例子中，@configurationproperties(prefix="app") 使得 yaml 中 app 下的配置自动绑定到 appproperties bean。name、apiurl 会对应赋值，嵌套的 pool.size 和 pool.enablelog 也会注入到 pool 类中。这样可以方便地管理和校验成组的配置属性。需要注意，绑定类必须有无参构造器，提供标准的 getter/setter。spring boot 还支持jsr-303校验注解（如 @validated）配合 @configurationproperties 对配置进行格式校验。

@enableconfigurationproperties

简介： @enableconfigurationproperties 是 spring boot 用于启用 @configurationproperties 支持的注解。它通常加在主应用类或配置类上，用来将带有 @configurationproperties 注解的配置pojo注入到容器中。

作用与场景： 在 spring boot 2.x 以后，如果配置属性类已经被声明为 bean（例如加了 @component），则无需显式使用这个注解。@enableconfigurationproperties 常用在需要将未被组件扫描的配置属性类纳入 spring 管理时。例如定义了一个纯 pojo 没有用@component，则可以在主类上通过此注解指定要启用绑定的配置类列表。提供模块： spring boot autoconfigure。

使用示例：

@springbootapplication
@enableconfigurationproperties(appproperties.class)
public class myapplication {
    // ...
}

上述在主启动类上添加了 @enableconfigurationproperties(appproperties.class)，显式指定将 appproperties 这个被 @configurationproperties 注解的类纳入配置属性绑定并注册为 bean。这样即使未加 @component，仍可使用 @autowired 注入 appproperties 实例。spring boot 自动配置模块会扫描此注解并完成相应的绑定工作。

@profile

简介： @profile 注解用于根据**环境（profile）**加载 bean。由 spring 提供（org.springframework.context.annotation.profile）。可以标注在类或方法（bean 方法）上，只有在激活的环境与指定 profile 匹配时，该 bean 才会注册到容器。

作用与场景： 常用于区别开发、测试、生产环境的配置。例如开发环境使用嵌入式数据库，而生产环境使用正式数据库连接，就可以用 @profile("dev") 和 @profile("prod") 注解分别标注不同的配置类或 bean。在运行应用时通过配置 spring.profiles.active 激活某个 profile，则对应的 bean 生效。提供模块： spring context 环境管理。

使用示例：

@configuration
public class datasourceconfig {
    @bean
    @profile("dev")
    public datasource memorydatasource() {
        // 开发环境使用内存数据库
        return new h2datasource(...);
    }
    @bean
    @profile("prod")
    public datasource mysqldatasource() {
        // 生产环境使用mysql数据源
        return new mysqldatasource(...);
    }
}

当设置 spring.profiles.active=dev 时，应用启动只会创建 memorydatasource bean；设置为 prod 时只创建 mysqldatasource bean。如果不激活任何 profile，上述两个 bean 都不会加载（也可以用 @profile("default") 指定默认配置）。使用 @profile 实现了根据环境有条件地注册 bean，方便一套代码多环境运行。

五、bean 生命周期与作用域注解

spring 管理的 bean 具有完整的生命周期，包括初始化和销毁过程。以下注解用于在生命周期特定阶段执行方法，以及控制 bean 的作用域与加载时机。

@postconstruct

简介： @postconstruct 是一个来自 java 标准（jsr-250）的注解（位于 jakarta.annotation.postconstruct）。spring 容器在bean初始化完依赖注入后，会调用被该注解标记的方法。常用于初始化逻辑。需要注意在 spring boot 3+ 中，@postconstruct 等由 jakarta 引入，需要相应依赖。

作用与场景： 当我们希望在 bean 完成依赖注入后自动执行一些初始化代码，可以在 bean 的方法上加 @postconstruct。例如设置默认值、开启定时器、检查配置完整性等。在传统 spring 中，这相当于 <bean init-method="..."> 或实现 initializingbean 接口的 afterpropertiesset。提供模块： jsr-250（javax/jakarta annotation），由 spring 容器支持调用。

使用示例：

@component
public class cachemanager {
    private map<string, object> cache;
    @postconstruct
    public void init() {
        // 初始化缓存
        cache = new concurrenthashmap<>();
        system.out.println("cachemanager initialized");
    }
}

当 spring 创建了 cachemanager bean 并注入完依赖后，会自动调用其 init() 方法，输出 “cachemanager initialized” 并完成缓存容器初始化。这样开发者无需手动调用初始化逻辑，容器托管完成。这对于单例bean非常方便。

@predestroy

简介： @predestroy 同样来自 jsr-250 标准（jakarta.annotation.predestroy），spring 在 bean 销毁前（容器关闭或 bean 移除前）调用标注该注解的方法。常用于资源释放、保存状态等操作。

作用与场景： 当应用结束或容器要销毁 bean 时，希望执行一些清理工作，例如关闭文件流、线程池、数据库连接等，可以在方法上加 @predestroy 注解。相当于 xml 配置中的 <bean destroy-method="..."> 或实现 disposablebean 接口的 destroy 方法。提供模块： jsr-250，由 spring 容器负责调用。

使用示例：

@component
public class connectionmanager {
    private connection connection;
    @postconstruct
    public void connect() {
        // 建立数据库连接
        connection = drivermanager.getconnection(...);
    }
    @predestroy
    public void disconnect() throws sqlexception {
        // 关闭数据库连接
        if(connection != null && !connection.isclosed()) {
            connection.close();
            system.out.println("connection closed.");
        }
    }
}

在上例中，connectionmanager bean 在初始化时建立数据库连接，在容器销毁时通过 @predestroy 标记的 disconnect() 方法关闭连接。spring 在应用关闭时会调用该方法，确保资源释放。这使得资源管理更加可靠，避免连接泄漏等问题。

@scope (作用域) – 见上文第三部分

(此处简要说明：) 使用 @scope 注解可以改变 bean 的作用域，比如 "singleton"、"prototype" 等。已在依赖注入部分详细介绍其使用。

@lazy (懒加载) – 见上文第三部分

(此处简要说明：) 使用 @lazy 可以延迟 bean 的初始化直至第一次使用。在某些场景下提高启动性能或解决循环依赖。前文已介绍其概念和示例。

六、web 开发注解

spring mvc 框架提供了大量注解来简化 web 开发，包括请求映射、参数绑定、响应处理等。这些注解大多位于 org.springframework.web.bind.annotation 包中。

@requestmapping

简介： @requestmapping 是最基本的请求映射注解，用于将 http 请求url路径映射到对应的控制器类或处理方法上。由 spring web mvc 提供。可用于类和方法级别。

作用与场景： 在类上标注 @requestmapping("basepath") 可以为该控制器指定一个基础路径，方法上的 @requestmapping("subpath") 则在类路径基础上进一步细分。它支持设置请求方法（get、post等）、请求参数和请求头等属性，用于更精确地映射请求。例如只处理 get 请求，或某个请求参数存在时才匹配。spring mvc 启动时会根据这些注解建立 url 到方法的映射关系。

使用示例：

@controller
@requestmapping("/users")
public class usercontroller {
    @requestmapping(value = "/{id}", method = requestmethod.get)
    public string getuserprofile(@pathvariable long id, model model) {
        // 根据id查询用户...
        model.addattribute("user", userservice.findbyid(id));
        return "profile";
    }
    @requestmapping(value = "", method = requestmethod.post, params = "action=register")
    public string registeruser(userform form) {
        // 处理用户注册
        userservice.register(form);
        return "redirect:/users";
    }
}

usercontroller 类上的 @requestmapping("/users") 指定了基础路径“/users”。方法级注解：

• getuserprofile: 映射 get 请求到 “/users/{id}”。使用 method = requestmethod.get 限定请求方法为 get，@pathvariable 获取 url 中的 {id} 部分。返回视图名 “profile” 供显示用户信息。
• registeruser: 映射 post 请求到 “/users”，并使用 params="action=register" 进一步限定只有请求参数包含 action=register 时才调用此方法。这是区分同一路径不同操作的方式。处理完后重定向到用户列表。

@requestmapping 非常灵活，其常用属性：

value 或 path：映射的 url 路径，可以是 ant 风格模式（如 /users/*）。method：限定 http 方法，如 requestmethod.get 等。params：指定必须存在的参数或参数值，如 "action=register" 或 "!admin"（必须不包含admin参数）。headers：指定必须的请求头，如 "content-type=application/json"。 @getmapping / @postmapping 等

简介： @getmapping 和 @postmapping 是 @requestmapping 的派生注解，专门用于简化映射 get 和 post 请求。类似的还有 @putmapping、@deletemapping、@patchmapping，分别对应 http put/delete/patch 方法。它们由 spring mvc 提供，从 spring 4.3 开始引入。

作用与场景： 这些注解相当于 @requestmapping(method = requestmethod.x) 的快捷方式，使代码更简洁。尤其在定义 restful api 时，常用不同 http 方法表示不同操作，用这些注解能直观体现方法用途。例如 @getmapping 表示获取资源，@postmapping 表示创建资源等。

使用示例：

@restcontroller
@requestmapping("/items")
public class itemcontroller {
    @getmapping("/{id}")
    public item getitem(@pathvariable long id) {
        return itemservice.findbyid(id);
    }
    @postmapping("")
    public item createitem(@requestbody item item) {
        return itemservice.save(item);
    }
    @deletemapping("/{id}")
    public void deleteitem(@pathvariable long id) {
        itemservice.delete(id);
    }
}

上例中：

• @getmapping("/{id}) 等价于 @requestmapping(value="/{id}", method = requestmethod.get)，用于获取指定id的 item。
• @postmapping("") 等价于类路径/items下的 post 请求（创建新的 item），请求体通过 @requestbody 解析为 item 对象。
• @deletemapping("/{id}") 处理删除操作。

这些组合注解让控制器方法定义更直观，更符合 restful 风格。可以根据需要使用对应的 http方法注解。未提供参数时，@getmapping 等注解的路径可以直接写在注解括号内（如上 @postmapping("") 指当前路径）。

@pathvariable

简介： @pathvariable 用于将 url 路径中的动态部分绑定到方法参数上。由 spring mvc 提供。常与 @requestmapping 或 @getmapping 等一起使用，用于处理restful风格的url。

作用与场景： 当url中含有变量占位符（如 /users/{id}）时，可通过在方法参数上加 @pathvariable 来获取该占位符的值。可以指定名称匹配占位符，或者不指定名称则根据参数名自动推断。适用于从路径获取资源标识（id、name等）的场景。

使用示例：

@getmapping("/orders/{orderid}/items/{itemid}")
public orderitem getorderitem(
        @pathvariable("orderid") long orderid, 
        @pathvariable("itemid") long itemid) {
    return orderservice.finditem(orderid, itemid);
}

当收到请求 /orders/123/items/456 时：

• orderid 参数会被赋值为 123（long 类型转换），
• itemid 参数赋值为 456。

@pathvariable("orderid") 中指定名称，与 {orderid} 占位符对应。如果方法参数名与占位符名称相同，可以简写为 @pathvariable long orderid。

通过 @pathvariable，我们无需从 httpservletrequest 手动解析路径，spring mvc 自动完成转换和注入，简化了代码。

@requestparam

简介： @requestparam 用于绑定 http 请求的查询参数或表单数据到方法参数上。由 spring mvc 提供。支持为参数设置默认值、是否必需等属性。

作用与场景： 处理 get 请求的查询字符串参数（url ? 后的参数）或 post 表单提交的字段时，可以使用 @requestparam 获取。例如搜索接口的关键词，分页的页码和大小等。它可以将 string 类型的请求参数转换为所需的目标类型（如 int、boolean），自动完成类型转换和必要的校验。

使用示例：

@getmapping("/search")
public list<product> searchproducts(
        @requestparam(name="keyword", required=false, defaultvalue="") string keyword,
        @requestparam(defaultvalue="0") int pageindex,
        @requestparam(defaultvalue="10") int pagesize) {
    return productservice.search(keyword, pageindex, pagesize);
}

当请求 /search?keyword=phone&pageindex=1 到达时：

• keyword 参数绑定到方法的 keyword 参数。如果未提供则使用默认值空字符串。
• pageindex 绑定到整型参数，未提供则为默认0。
• pagesize 在此请求未提供，因此取默认值10。

@requestparam 常用属性：

• value 或 name：参数名，对应url中的参数名。
• required：是否必须提供，默认 true（不提供会报错）。上例中我们将 keyword 标记为 false 可选。
• defaultvalue：如果请求未包含该参数则使用默认值（注意即使标记 required=true，有 defaultvalue 也不会报错）。

通过 @requestparam，方法可以直接获得解析后的参数值，无需自己从 request 获取和转换，大大简化控制器代码。

@requestbody

简介： @requestbody 用于将 http 请求报文体中的内容转换为 java 对象并绑定到方法参数上。常用于处理 json 或 xml 等请求体。由 spring mvc 提供。

作用与场景： 在 restful api 中，post/put 等请求通常会携带 json 格式的数据作为请求体。使用 @requestbody 注解在方法参数（通常是自定义的 dto 类）上，spring mvc 会利用 httpmessageconverter 将 json/xml 等按需转换为对应的对象实例。适用于需要从请求正文获取复杂对象的场景。与之对应，返回值或方法上使用 @responsebody（或 @restcontroller）可将对象序列化为响应。

使用示例：

@postmapping("/users")
public responseentity<string> adduser(@requestbody userdto userdto) {
    // userdto 已自动绑定了请求json的数据
    userservice.save(userdto);
    return responseentity.ok("user added successfully");
}

假设客户端发送 post 请求至 /users，请求体为：

{ "name": "tom", "email": "tom@example.com" }

spring mvc 会根据 @requestbody userdto userdto：

• 读取请求体 json，
• 将其转换为 userdto 对象（要求有适当的属性和setter）。
• 然后传递给控制器方法使用。

方法处理后返回成功响应。使用 @requestbody，开发者无需手动解析 json，提高了开发效率并减少出错。

注意： @requestbody 默认要求请求体存在，否则报错。如果希望在请求体为空时处理为 null，可以设置 required=false。对于 get 请求一般不使用 @requestbody（get没有主体或主体被忽略）。

@responsebody

简介： @responsebody 注解用于将控制器方法的返回值直接作为 http 响应内容输出，而不是解析为视图名称。由 spring mvc 提供。可以标注在方法上或（较少见）标注在类上（类上标注相当于对该类所有方法应用此行为）。

作用与场景： @responsebody 常用于 ajax 接口或 restful 方法，需要返回 json、xml或纯文本等给客户端，而非页面。当方法标注该注解后，spring 会将返回对象通过合适的 httpmessageconverter 转换为 json/xml 或其他格式写入响应流。例如返回一个对象会自动序列化为 json 字符串。@restcontroller 注解实际上已经包含了 @responsebody 效果，所以在使用 @restcontroller 时无需再标注此注解在每个方法上。

使用示例：

@controller
public class statuscontroller {
    @getmapping("/ping")
    @responsebody
    public string ping() {
        return "ok";
    }
    @getmapping("/status")
    @responsebody
    public map<string, object> status() {
        map<string, object> info = new hashmap<>();
        info.put("status", "up");
        info.put("timestamp", system.currenttimemillis());
        return info;
    }
}

对于上例：

• /ping 请求返回纯文本 “ok” 给客户端。
• /status 请求返回一个 map，spring 会将其转换为 json，如：{"status":"up","timestamp":1638346953000}。

因为使用的是普通的 @controller 类，所以需要在每个方法上添加 @responsebody 来指示直接返回内容。如果改用 @restcontroller 则可以省略这些注解。@responsebody 常用于快速测试接口或者在需要精确控制输出内容时使用。

@crossorigin

简介： @crossorigin 注解用于配置跨域资源共享 (cors)。由 spring web 提供，可标注在类或方法上。它允许来自不同域名的客户端访问被标注的资源。

作用与场景： 当前端和后端分属不同域（例如前端react开发服务器 http://localhost:3000，后端 http://localhost:8080）时，浏览器会拦截跨域请求。使用 @crossorigin 可以在服务端指定允许跨域的来源、方法、头信息等，从而使浏览器允许调用。可以针对整个控制器类统一配置（类上标注）或针对特定方法（方法上标注）配置不同跨域策略。

使用示例：

@restcontroller
@requestmapping("/api")
@crossorigin(origins = "http://localhost:3000")
public class apicontroller {
    @getmapping("/data")
    public data getdata() { ... }
    @postmapping("/submit")
    @crossorigin(origins = "http://example.com", methods = requestmethod.post)
    public void submitdata(@requestbody data data) { ... }
}

类上标注的 @crossorigin(origins = "http://localhost:3000") 表示允许来自 http://localhost:3000 的跨域请求访问该控制器的所有接口。submitdata 方法上单独标注了一个不同的 @crossorigin，表示对于 /api/submit 接口，允许来自 http://example.com 的 post 请求跨域访问（不受类上通用配置限制）。@crossorigin 还可设置允许的请求头、是否发送凭证等，通过参数如 allowedheaders, allowcredentials 等配置。使用这个注解，开发者不必在全局web配置中配置 corsregistry，可以就近管理跨域策略。

@exceptionhandler

简介： @exceptionhandler 用于在控制器中定义异常处理方法的注解。由 spring mvc 提供。通过指定要处理的异常类型，当控制器方法抛出该异常时，转而由标注了 @exceptionhandler 的方法来处理。

作用与场景： 为了避免将异常堆栈暴露给客户端或者在每个控制器方法中编写重复的 try-catch，可以使用 @exceptionhandler集中处理。例如处理表单校验异常返回友好错误信息、处理全局异常返回统一格式响应等。@exceptionhandler 通常与 @controlleradvice（后述）配合，用于全局异常处理；也可以直接在本控制器内部定义专门的异常处理方法。

使用示例：

@controller
@requestmapping("/orders")
public class ordercontroller {
    @getmapping("/{id}")
    public string getorder(@pathvariable long id, model model) {
        order order = orderservice.findbyid(id);
        if(order == null) {
            throw new ordernotfoundexception(id);
        }
        model.addattribute("order", order);
        return "orderdetail";
    }
    // 本控制器专门处理 ordernotfoundexception
    @exceptionhandler(ordernotfoundexception.class)
    public string handlenotfound(ordernotfoundexception ex, model model) {
        model.addattribute("error", "订单不存在，id=" + ex.getorderid());
        return "ordererror";
    }
}

在 ordercontroller 中，getorder 方法如果找不到订单，会抛出自定义的 ordernotfoundexception。下方用 @exceptionhandler(ordernotfoundexception.class) 标注了 handlenotfound 方法来处理这种异常：当异常抛出后，控制器不会继续执行原流程，而是进入该方法。方法可以接收异常对象，以及 model 等参数，处理后返回一个视图名 "ordererror" 显示错误信息。

通过 @exceptionhandler，控制器内部的异常处理逻辑与正常业务逻辑解耦，代码清晰且易于维护。

@controlleradvice

简介： @controlleradvice 是全局控制器增强注解。由 spring mvc 提供，用于定义一个全局异常处理或全局数据绑定的切面类。标注该注解的类可以包含多个 @exceptionhandler 方法，用于处理应用所有控制器抛出的异常；也可以包含 @modelattribute 或 @initbinder 方法对所有控制器生效。

作用与场景： 当需要对所有控制器统一处理某些逻辑时，使用 @controlleradvice 非常方便。典型用法是结合 @exceptionhandler 作为全局异常处理器，比如拦截所有 exception 返回通用错误响应，或分类处理不同异常类型返回不同状态码。提供模块： spring mvc。

使用示例：

@controlleradvice
public class globalexceptionhandler {
    // 处理所有异常的fallback
    @exceptionhandler(exception.class)
    @responsebody
    public responseentity<string> handleexception(exception ex) {
        // 记录日志
        ex.printstacktrace();
        // 返回通用错误响应
        return responseentity.status(httpstatus.internal_server_error)
                             .body("internal server error: " + ex.getmessage());
    }
    // 处理特定异常
    @exceptionhandler(methodargumentnotvalidexception.class)
    @responsebody
    public responseentity<list<string>> handlevalidationexception(methodargumentnotvalidexception ex) {
        list<string> errors = ex.getbindingresult().getallerrors()
                                .stream()
                                .map(objecterror::getdefaultmessage)
                                .collect(collectors.tolist());
        return responseentity.badrequest().body(errors);
    }
}

globalexceptionhandler 类使用 @controlleradvice 声明后，spring 会将其中标注了 @exceptionhandler 的方法应用到整个应用的控制器：

• 第一个方法捕获所有未被其它更专门处理的异常，打印栈trace并返回500错误提示。
• 第二个方法专门处理参数校验失败异常，提取错误信息列表并返回400状态和错误列表。

此外，可以在 @controlleradvice 类中定义 @modelattribute 方法，为所有控制器请求添加模型数据（如公共下拉选项），或定义 @initbinder 方法，注册全局属性编辑器等。@controlleradvice 可以通过属性限制只应用于某些包或注解的控制器，但全局异常处理通常都是应用全局的。

通过 @controlleradvice，我们实现了 aop 式的全局控制器逻辑抽取，使各控制器关注自身业务，将通用逻辑集中处理，保持代码整洁。

七、数据访问与事务注解

在使用 spring 管理数据持久化层时，会涉及到 jpa/hibernate 等注解定义实体，以及 spring 提供的事务管理注解等。

@entity

简介： @entity 是 java persistence api (jpa) 的注解（jakarta.persistence.entity），用于将一个类声明为 jpa 实体。spring boot 通常通过 jpa/hibernate 来操作数据库，因此定义模型时会用到它。@entity 注解的类对应数据库中的一张表。

作用与场景： 标记为 @entity 的类将由 jpa 实现（例如 hibernate）管理，其实例可映射到数据库记录。必须提供主键（用 @id 标注），可选地用 @table 指定表名，不指定则默认表名为类名。提供模块： jpa 规范，由 hibernate 等实现。在 spring boot 中，引入 spring-boot-starter-data-jpa 会自动扫描 @entity 类并创建表结构（结合ddl生成策略）。

使用示例：

@entity
@table(name = "users")
public class user {
    @id
    @generatedvalue(strategy = generationtype.identity)
    private long id;              // 主键
    @column(name = "username", length = 50, nullable = false, unique = true)
    private string username;      // 用户名列
    @column(nullable = false)
    private string password;      // 密码列
    // getters & setters ...
}

user 类被 @entity 注解标记为持久化实体，对应数据库表users（由@table指定，若不指定默认表名user）。字段上：

• id 用 @id 标识为主键，@generatedvalue 指定主键生成策略（自增）。
• username 用 @column 细化映射：列名指定为username，长度50，非空且唯一。
• password 仅用了 @column(nullable=false)，列名默认为属性名。

定义好实体后，可以使用 spring data jpa 的仓库接口来自动生成常用查询（见下文 @repository 和 @query）。spring boot 启动时若开启ddl-auto，会根据实体定义自动在数据库创建或更新表结构。

@table

简介： @table 是 jpa 注解（jakarta.persistence.table），配合 @entity 使用，用于指定实体映射的数据库表信息，如表名、schema、catalog等。

作用与场景： 默认情况下，实体类名即表名。若数据库表名与类名不同，或者需要定义 schema，使用 @table 注解非常必要。也能定义唯一约束等。提供模块： jpa。

使用示例：

@entity
@table(name = "t_user", schema = "public", uniqueconstraints = {
    @uniqueconstraint(columnnames = "email")
})
public class user {
    // ...
}

该实体指定映射到 public 模式下的 t_user 表，并声明 email 列上有唯一约束。@table 的属性：

• name：表名。
• schema/catalog：所属 schema 或 catalog 名称。
• uniqueconstraints：唯一约束定义。

@id

简介： @id 是 jpa 注解（jakarta.persistence.id），指定实体类的主键字段。每个 @entity 必须有且只有一个属性使用 @id 注解。可配合 @generatedvalue 一起使用定义主键生成策略。

作用与场景： 标记主键后，jpa 会将该字段作为数据库表的主键列。支持基本类型或包装类型，或 java.util.uuid 等。提供模块： jpa。

使用示例：

@entity
public class product {
    @id
    @generatedvalue(strategy = generationtype.auto)
    private long id;
    // ... 其他字段
}

如上，id 字段为主键，使用自动生成策略。常见的 generationtype：

• identity：数据库自增字段（mysql的auto_increment等）。
• sequence：使用数据库序列（需要定义序列，oracle等db适用）。
• auto：让 jpa 自动选择合适策略。
• table：使用一个数据库表模拟序列。

@generatedvalue

简介： @generatedvalue 是 jpa 注解（jakarta.persistence.generatedvalue），与 @id 联用，表示主键的生成方式。可指定策略 strategy 和生成器 generator。

作用与场景： 根据数据库和需求选择主键生成策略。比如 mysql 用 identity 让数据库自增，oracle 用 sequence 指定序列名称等。提供模块： jpa。

使用示例：

@id
@generatedvalue(strategy = generationtype.sequence, generator = "user_seq")
@sequencegenerator(name = "user_seq", sequencename = "user_sequence", allocationsize = 1)
private long id;

上例中，使用序列生成器：

• @sequencegenerator 定义名为 “user_seq” 的序列生成器，映射数据库序列 “user_sequence”。
• @generatedvalue 引用该生成器并使用 sequence 策略。每次插入user时会从序列获取下一个值作为id。

对于常用的 auto 或 identity 策略，在大多数情况下只需简单标注 @generatedvalue(strategy = generationtype.identity) 等，无需额外生成器配置。

@column

简介： @column 是 jpa 注解（jakarta.persistence.column），用于定义实体字段与数据库表列的映射细节。可以不使用，如果不标注，jpa 默认按属性名映射列名（可能做小写下划线转换，视实现而定）。

作用与场景： @column 可指定列名、数据类型长度、是否允许null、是否唯一等约束。对于日期时间类型，还可指定 columndefinition 或 temporal 等，控制sql类型。提供模块： jpa。

使用示例：

@column(name = "email", length = 100, nullable = false, unique = true)
private string email;

如上，将字段 email 映射为名为 email 的列（其实和默认同名，但明确指出），长度100，非空且唯一。使用 @column 可以清晰地将实体和数据库字段对应起来。

@repository – 见上文第二部分

(此处补充：) 在数据访问层，@repository 标注的接口或类通常与 spring data jpa 搭配使用。如一个接口 userrepository extends jparepository<user, long> 上加 @repository（实际上 spring data jpa 的接口已经隐式有这个语义），spring 会为其生成实现并交由容器管理。@repository 除了提供组件扫描和异常转换外，本身没有其他方法属性。

@transactional

简介： @transactional 是 spring 提供的声明式事务管理注解（org.springframework.transaction.annotation.transactional）。可标注在类或方法上，表示其中的数据库操作应当在一个事务中执行。spring 将在运行时提供事务支持，如开始、提交或回滚事务。

作用与场景： 数据库操作需要事务保障数据一致性，例如同时更新多张表，要么全部成功要么全部失败。使用 @transactional 可以在不手动编程式管理事务的情况下，由框架自动处理。典型应用：

• service 层的方法需要原子性，则加上 @transactional，spring会在进入方法时开启事务，方法成功返回则提交，如有异常则回滚。
• 也可加在类上，表示类中所有公有方法都事务管理。

提供模块： spring orm/transaction 模块，需要相应的事务管理器（datasourcetransactionmanager 或 jpatransactionmanager 等）配置。spring boot 自动根据数据源配置合适的事务管理器。

使用示例：

@service
public class accountservice {
    @autowired
    private accountrepository accountrepo;
    @autowired
    private auditservice auditservice;
    @transactional
    public void transfer(long fromid, long toid, bigdecimal amount) {
        // 扣减转出账户余额
        accountrepo.decreasebalance(fromid, amount);
        // 增加转入账户余额
        accountrepo.increasebalance(toid, amount);
        // 记录转账流水
        auditservice.logtransfer(fromid, toid, amount);
        // 方法结束时，spring自动提交事务。如发生运行时异常则自动回滚。
    }
}

transfer 方法标注了 @transactional，因此上述三个数据库操作将处于同一个事务中：如果任何一步抛出未经捕获的异常（默认仅runtimeexception和error会导致回滚，可通过 rollbackfor 属性更改回滚规则），所有已执行的数据库更新都会回滚，保持数据一致性。如果全部成功，则提交事务，将更新真正持久化。事务传播行为和隔离级别等也可以通过注解属性配置，例如 @transactional(propagation=propagation.requires_new) 开启新事务，@transactional(isolation=isolation.serializable) 设置高隔离级别等，视业务需求而定。

注意： 使用 @transactional 时，需要确保启用了 spring 的事务支持（见下文 @enabletransactionmanagement），spring boot 会自动在有数据源时启用事务管理。所以在 boot 场景下通常不需要额外配置即可使用。

@jsonformat

简介： @jsonformat 是 jackson 提供的序列化/反序列化格式化注解（com.fasterxml.jackson.annotation.jsonformat）。可作用在字段、方法（getter / setter）或类型上，用于自定义日期-时间、数字、布尔等属性在 json ←→ java 转换时的形态、时区与本地化设置。

作用与场景：

• 日期时间格式化：将 date / localdatetime 等类型格式化为固定字符串（例如 yyyy-mm-dd hh:mm:ss）并指定时区，避免前后端默认时区不一致导致时间偏移。
• 数字 / 布尔形态控制：可把布尔值序列化成 0/1，或把 instant、localdatetime 转成数值时间戳（shape = number）等。
• 与 bean validation 协同：在 dto 中同时配合 @datetimeformat / 校验注解，可保持前后端格式完全一致。
• 优先级：字段级 @jsonformat 会覆盖 objectmapper 的全局日期格式配置，适用于单独字段需要特殊格式的场景。

使用示例：

@data
public class orderdto {
    private long id;
    // 1. 指定日期-时间格式 + 时区
    @jsonformat(shape = jsonformat.shape.string,
                pattern = "yyyy-mm-dd hh:mm:ss",
                timezone = "gmt+8")
    private localdatetime createdat;
    // 2. 以秒级时间戳输出
    @jsonformat(shape = jsonformat.shape.number)
    private instant eventtime;
    // 3. 布尔值改为 0 / 1
    @jsonformat(shape = jsonformat.shape.number)
    private boolean paid;
}

@getter

简介： @getter 是 lombok 提供的生成器注解（lombok.getter）。编译期自动为被注解的类或字段生成 public getter 方法，省去手写样板代码。

作用与场景：

• 简化 pojo / dto 编写：一个注解即可为所有字段（或单独字段）生成读取方法，保持类体简洁。
• 与框架集成：spring / jackson / hibernate 等框架依赖 getter 读取属性时可直接使用 lombok 生成的方法。

使用示例：

@getter          // 为所有字段生成 getter
public class uservo {
    private long id;
    @getter(accesslevel.none) // 不生成该字段的 getter
    private string password;
    // 也可在字段级别加 @getter 仅生成单个方法
}

依赖：开发环境需引入 lombok 依赖，并在 ide 中安装 lombok 插件或开启 annotation processing。

@setter

简介： @setter 同样由 lombok 提供（lombok.setter），自动为类或字段生成 public setter 方法。

作用与场景：

• 可变对象赋值：在需要修改字段值、或框架反射注入时使用。
• 粒度控制：可通过 accesslevel 设置方法可见性（如 @setter(accesslevel.protected)），或仅在特定字段上使用，避免暴露全部可写接口。

使用示例：

@getter
@setter               // 为所有字段生成 setter
public class productvo {
    private long id;
    @setter(accesslevel.private) // 仅类内部可修改
    private bigdecimal price;
    // price 的 setter 为 private，其余字段的 setter 为 public
}

@tostring

简介： @tostring 亦由 lombok 提供（lombok.tostring）。在编译期生成 tostring() 方法，自动拼接字段名和值，支持包含/排除特定字段、隐藏敏感信息等。

作用与场景：

• 调试与日志：快速输出对象内容而不必手写 tostring()。
• 避免敏感字段泄漏：可用 @tostring.exclude 排除字段，或在注解上设置 callsuper = true 包含父类字段。
• 链式注解：常与 @getter/@setter/@equalsandhashcode 等一起使用，快速生成完整数据类。

使用示例：

@getter
@setter
@tostring(exclude = "password")          // 排除 password
public class accountvo {
    private string username;
    @tostring.exclude
    private string password;             // 或者字段级排除
    private localdatetime lastlogin;
}
/*
输出示例：
accountvo(username=admin, lastlogin=2025-05-10t20:30:00)
*/

在生产日志中输出对象时务必排除敏感信息；@tostring 支持 exclude 数组或字段级 @tostring.exclude 精细控制。

@enabletransactionmanagement

简介： @enabletransactionmanagement 注解用于开启 spring 对 事务注解（如 @transactional）的支持。由 spring 提供（org.springframework.transaction.annotation.enabletransactionmanagement）。一般加在配置类上。

作用与场景： 在非 spring boot 场景下，使用 @transactional 前通常需要在 java 配置类上加此注解或在 xml 中配置 <tx:annotation-driven/> 来启用事务 aop。它会注册事务管理相关的后置处理器，检测 @transactional 并在运行时生成代理。提供模块： spring tx。

使用示例：

@configuration
@enabletransactionmanagement
public class txconfig {
    @bean
    public platformtransactionmanager txmanager(datasource datasource) {
        return new datasourcetransactionmanager(datasource); // 配置事务管理器
    }
}

上例通过 @enabletransactionmanagement 启用了注解驱动的事务管理，并显式声明了数据源事务管理器 bean。在 spring boot 中，如果引入了 spring-boot-starter-jdbc 或 jpa，会自动配置 datasourcetransactionmanager 或 jpatransactionmanager，且默认启用事务支持，无需手动添加该注解（boot 会自动应用）。但在需要更细粒度控制事务行为时，了解此注解的作用仍然重要。

@query

简介： @query 注解由 spring data jpa 提供（org.springframework.data.jpa.repository.query），用于在 repository 方法上定义自定义的 jpql或原生sql 查询。

作用与场景： 虽然 spring data jpa 可以通过解析方法名自动生成查询，但是复杂或特殊的查询可以用 @query 手工编写jpql语句。还可以通过设置 nativequery=true 使用原生sql。当自动生成无法满足需求，或为了性能使用数据库特定查询时，用此注解非常有用。提供模块： spring data jpa。

使用示例：

public interface userrepository extends jparepository<user, long> {
    // 使用jpql查询
    @query("select u from user u where u.email = ?1")
    user findbyemail(string email);
    // 使用原生sql查询
    @query(value = "select * from users u where u.status = :status limit :limit", nativequery = true)
    list<user> findtopbystatus(@param("status") int status, @param("limit") int limit);
}

在上面的仓库接口中：

• findbyemail 方法使用 jpql 查询根据邮箱获取用户。?1 表示第一个参数。
• findtopbystatus 方法使用原生sql查询指定状态的用户若干条，使用命名参数 :status 和 :limit。需要搭配 @param 注解绑定参数值。

spring data jpa 在运行时会解析这些注解并生成相应实现代码执行查询。@query 能大大提升查询的灵活性，但要注意jpql语句的正确性以及原生sql的可移植性。

八、面向切面编程（aop）注解

spring aop 提供了强大的面向切面编程功能，可以通过注解定义横切关注点，如日志记录、性能监控、权限检查等。主要的 aop 注解包括：

@aspect

简介： @aspect 注解用于将一个类声明为切面类。由 aspectj 提供（spring aop 使用 aspectj 注解风格）。标记为 @aspect 的类内部可以定义切点和通知，实现 aop 功能。需要配合 spring aop 使用。

作用与场景： 切面类汇总了横切逻辑，例如日志切面、安全切面等。一个切面类里通常包含若干通知方法（@before、@after等）和切点定义（@pointcut）。spring 在运行时会根据切面定义生成代理对象，将横切逻辑织入目标对象的方法调用。提供模块： org.aspectj.lang.annotation.aspect（需要 spring-boot-starter-aop 或 spring aop 模块依赖）。

使用示例：

@aspect
@component  // 切面本身也需注册为bean
public class loggingaspect {
    // 切点定义：匹配 service 包下所有类的公共方法
    @pointcut("execution(public * com.example.service..*(..))")
    public void servicemethods() {}
    // 前置通知：在满足切点的方法执行之前执行
    @before("servicemethods()")
    public void logbefore(joinpoint joinpoint) {
        system.out.println("entering: " + joinpoint.getsignature());
    }
    // 后置通知：无论方法正常或异常结束都会执行
    @after("servicemethods()")
    public void logafter(joinpoint joinpoint) {
        system.out.println("exiting: " + joinpoint.getsignature());
    }
}

上面定义了一个日志切面类 loggingaspect：

• 使用 @aspect 标记为切面类，结合 @component 使其成为 spring bean。
• servicemethods() 方法使用 @pointcut 定义了一个切点，表达式 "execution(public * com.example.service..*(..))" 表示匹配 com.example.service 包及子包下所有类的任意公共方法执行。切点方法本身没有实现，仅作标识。
• logbefore 方法使用 @before("servicemethods()") 注解，表示在执行匹配 servicemethods() 切点的任意方法之前，先执行该通知。
• 通过 joinpoint 参数可以获取被调用方法的信息。logafter 方法使用 @after("servicemethods()")，表示目标方法执行完成后（无论成功与否）执行。输出方法签名的退出日志。

为使上述 aop 生效，需要启用 spring 对 aspectj 切面的支持。spring boot 自动配置已经启用了 aop（如果引入了 starter-aop，默认会开启 @aspectj 支持），在非 boot 环境可能需要在配置类上添加 @enableaspectjautoproxy 注解来开启代理机制。如果未启用，@aspect 注解不会生效。总之，@aspect 注解的类定义了 aop 的横切逻辑，是实现日志、事务、权限等横切关注点的关键。

@pointcut

简介： @pointcut 用于定义一个切点表达式，以命名方式重用切点。由 aspectj 注解提供。通常是一个签名为 void 且无实现的方法注解，用于给切点命名。

作用与场景： 切点定义了哪些连接点(join point)需要织入切面逻辑。通过@pointcut可以将复杂的切点表达式进行抽象，方便在多个通知上引用，避免重复书写表达式。提供模块： aspectj。

使用示例：

@aspect
@component
public class securityaspect {
    // 切点：controller 包下的所有含 @getmapping 注解的方法
    @pointcut("within(@org.springframework.web.bind.annotation.restcontroller *) && @annotation(org.springframework.web.bind.annotation.getmapping)")
    public void allgetendpoints() {}
    @before("allgetendpoints()")
    public void checkauthentication() {
        // 执行权限验证逻辑
        if (!securitycontext.isauthenticated()) {
            throw new securityexception("user not authenticated");
        }
    }
}

此处，securityaspect 定义了一个切点 allgetendpoints()，通过 @pointcut 注解的表达式指定：凡是标注了@restcontroller的类中，标注了@getmapping的方法，都是切点。然后在 @before("allgetendpoints()") 通知中引用这个切点，执行权限检查。如果当前用户未认证则抛出异常阻止方法执行。

切点表达式语言十分丰富，可以基于执行方法签名（execution）、注解（@annotation, within 等）、this/target对象等进行匹配组合。通过适当的切点定义，可以灵活地选择哪些点应用横切逻辑。

@before

简介： @before 定义一个前置通知（advice），即在目标方法执行之前执行的切面方法。它由 aspectj 提供（org.aspectj.lang.annotation.before）。需要在 @aspect 切面类中使用，注解的值是一个切点表达式或命名切点。

作用与场景： 前置通知通常用于在方法调用前执行一些检查、日志或准备工作。例如权限验证（见上例）、记录方法开始日志、在方法执行前设置环境（如初始化 threadlocal）等。在目标方法之前执行，不影响目标方法参数和执行结果，只作附加操作。

使用示例： 参考前述 loggingaspect 和 securityaspect 中的 @before 用法。在 loggingaspect 中：

@before("servicemethods()")
public void logbefore(joinpoint joinpoint) { ... }

这表示在匹配 servicemethods() 切点的每个目标方法执行前调用 logbefore 方法。joinpoint 参数可以获取方法签名、参数等信息，用于日志输出。

@before 通知不能阻止目标方法执行（除非抛出异常）。如果在通知中抛异常，目标方法将不会执行且异常向上抛出。因此一般前置通知不故意抛异常（权限验证除外，验证失败则通过异常中断执行）。

@after

简介： @after 定义一个后置通知，即在目标方法执行结束后执行的切面方法，无论目标方法正常返回还是抛出异常都会执行（类似 finally block）。由 aspectj 提供。

作用与场景： 常用于清理资源、记录方法结束日志等操作。例如在方法完成后记录执行时间（需要结合开始时间），或确保某些线程上下文数据被清除。不关心方法的结果，只要离开方法就执行通知。

使用示例： 参考 loggingaspect 中：

@after("servicemethods()")
public void logafter(joinpoint joinpoint) { ... }

不管 servicemethods() 匹配的方法成功或异常返回，都会执行 logafter。可以用它来打印离开方法的日志。

如果需要根据方法是否抛异常做区分，可以使用 @afterreturning 或 @afterthrowing（详见下文）。@after 通常用来放置最终执行的操作，比如解锁资源，不管成功失败都要执行的。

@afterreturning

简介： @afterreturning 定义一个返回通知，在目标方法成功返回后执行（未抛异常）。可以捕获返回值。由 aspectj 提供。

作用与场景： 当需要获取目标方法的返回结果进行处理时，可使用 @afterreturning。例如日志中记录返回值，或者根据返回值做后续动作。若目标方法抛异常则不会执行此通知。注解可指定 returning 属性绑定返回值。

使用示例：

@afterreturning(pointcut = "execution(* com.example.service.orderservice.placeorder(..))", returning = "result")
public void logorderresult(object result) {
    system.out.println("order placed result: " + result);
}

此通知针对 orderservice.placeorder 方法执行，如果其正常完成，则将返回值绑定到 result 形参并打印日志。比如 result 可能是订单id或确认对象。若 placeorder 抛异常，则该通知不执行。

@afterthrowing

简介： @afterthrowing 定义一个异常通知，在目标方法抛出指定异常后执行。由 aspectj 提供。可捕获异常对象。

作用与场景： 用于统一处理或记录目标方法抛出的异常，例如记录错误日志、发送告警等。可以指定 throwing 属性将异常绑定到参数。只在有未捕获异常时执行，正常返回不执行。

使用示例：

@afterthrowing(pointcut = "execution(* com.example..*.*(..))", throwing = "ex")
public void logexception(exception ex) {
    system.err.println("exception in method: " + ex.getmessage());
}

该切面方法会在应用中任何未捕获的异常抛出时执行，打印异常信息。ex 参数即目标方法抛出的异常对象（可以指定具体异常类型过滤，如 throwing="ex" throwing=runtimeexception.class）。

通过 @afterthrowing 可以集中处理异常情况，例如对特定异常进行额外处理（如事务补偿或资源回收），或统一记录。

@around

简介： @around 定义一个环绕通知，它包裹了目标方法的执行。由 aspectj 提供。环绕通知最为强大，可以在方法执行前后都进行处理，并可决定是否、如何执行目标方法（通过 proceedingjoinpoint 调用)。

作用与场景： 可以用来计算执行时间、控制方法执行（比如实现自定义注解的权限校验并决定是否调用原方法）、修改方法的返回值甚至拦截异常。@around 通知需要显式调用 proceed() 才会执行目标方法，如果不调用则目标方法不执行。这让我们有机会在调用前后插入逻辑，甚至改变执行流程。

使用示例：

@around("execution(* com.example.service.*.*(..))")
public object measureexecutiontime(proceedingjoinpoint pjp) throws throwable {
    long start = system.currenttimemillis();
    object result;
    try {
        result = pjp.proceed(); // 执行目标方法
    } finally {
        long end = system.currenttimemillis();
        system.out.println(pjp.getsignature() + " executed in " + (end - start) + "ms");
    }
    return result;
}

这个环绕通知为 service 包下所有方法计算执行时间：

• 在调用目标方法前记录开始时间。
• 通过 pjp.proceed() 执行目标方法，将返回结果保存。
• 方法执行后计算时间差并打印。
• 将目标方法的返回值返回，保证调用流程正常进行。

如果目标方法抛异常，proceed() 会抛出异常到外层（如上例没有 catch，finally执行后异常继续抛出）。也可以在环绕通知中捕获异常并处理，甚至返回替代结果，从而吞掉异常（视业务需要谨慎处理）。

@around 通知还可以实现诸如自定义注解拦截功能，例如检查方法上是否有某注解，有则执行特殊逻辑等，灵活性最高。

@enableaspectjautoproxy

简介： @enableaspectjautoproxy 是 spring 提供的注解（org.springframework.context.annotation.enableaspectjautoproxy），用于开启基于注解的 aop 支撑。它会启用 aspectj 注解的自动代理机制。

作用与场景： 在纯 spring 配置中，需要在配置类上添加此注解才能使前述 @aspect 切面生效（等同于 xml 配置中的 <aop:aspectj-autoproxy/>）。spring boot 在引入 aop 起步依赖时，默认已经启用了该功能 ，因此多数情况下无需显式添加。但了解这个注解有助于在需要调整 aop 代理选项时使用（比如 proxytargetclass=true 强制使用cglib代理）。

使用示例：

@configuration
@enableaspectjautoproxy(proxytargetclass = true)
public class aopconfig {
    // 切面类bean或通过@component扫描切面类
}

这将在容器中搜索 @aspect 注解的类，自动创建代理。proxytargetclass=true 强制使用类代理而不是接口代理。默认为 false，即如果有实现接口则用jdk动态代理。这一点在需要代理没有接口的类或者希望统一使用cglib代理时可以设置。

总结而言，spring aop 的注解允许我们以声明方式实现横切逻辑，将日志、性能监控、安全检查等与业务代码分离，提升模块化和可维护性。

九、异步与定时任务注解

spring 提供了对多线程异步任务和定时调度的支持，只需通过注解即可开启这些功能。

@async

简介： @async 注解用于将某个方法声明为异步执行。由 spring 提供（org.springframework.scheduling.annotation.async）。标注该注解的方法会在调用时由 spring 异步执行，而不是同步阻塞当前线程。通常需要配合 @enableasync 一起使用。

作用与场景： 当某些操作不需要同步完成、可以在后台线程执行时，用 @async 能简化并发编程。例如发送邮件、短信通知，执行耗时的计算而不阻塞主流程，或并行调用多个外部服务等。spring 会基于 taskexecutor （默认simpleasynctaskexecutor）调度异步方法。方法可以返回 void 或 future/completablefuture 以便获取结果。

使用示例：

@service
public class notificationservice {
    @async
    public void sendemail(string to, string content) {
        // 模拟发送邮件的耗时操作
        try {
            thread.sleep(5000);
            system.out.println("email sent to " + to);
        } catch (interruptedexception e) {
            thread.currentthread().interrupt();
        }
    }
}

@springbootapplication
@enableasync  // 开启异步支持
public class myapp { ... }

在 notificationservice 中，sendemail 标注了 @async，因此当它被调用时，spring 会从线程池中拿出一个线程来异步执行该方法，原调用方线程不必等待5秒。需要在应用主类或配置类上添加 @enableasync 以激活异步处理能力。使用默认配置时，spring 会使用一个简单线程池执行，也可以通过定义 executor bean 并加上 @async("beanname") 来指定特定线程池。

调用异步方法示例：

@restcontroller
public class ordercontroller {
    @autowired
    private notificationservice notificationservice;
    @postmapping("/order")
    public responseentity<string> placeorder(@requestbody order order) {
        orderservice.process(order);
        // 异步发送通知
        notificationservice.sendemail(order.getemail(), "your order is placed.");
        return responseentity.ok("order received");
    }
}

placeorder 方法调用了 sendemail，因为后者是异步的，所以 placeorder 在触发邮件发送后会立即返回响应，邮件发送在另一个线程进行，不影响接口响应时间。异步调用的异常需特别处理，可以使用 asyncuncaughtexceptionhandler 或返回 future 在调用方监听。总之，@async 大大方便了将任务异步化。

@enableasync

简介： @enableasync 是 spring 提供的注解（org.springframework.scheduling.annotation.enableasync），用于开启对 @async 注解的处理。加在配置类或主启动类上，激活 spring 异步方法执行的能力。

作用与场景： 类似于 @enableaspectjautoproxy 之于 aop，对于异步也需要显式开启。spring boot 自动配置通常不会主动开启异步，所以需要开发者添加此注解。提供模块： spring context 调度任务支持。

使用示例： 见上方，将 @enableasync 放在 @springbootapplication 类上或独立的配置类上均可。

启用后，spring 容器会搜索应用中标注了 @async 的 bean 方法，并通过代理的方式调用线程池执行它们。默认的执行器可以通过定义 taskexecutor bean 来覆盖。如：

@bean(name = "taskexecutor")
public executor taskexecutor() {
    threadpooltaskexecutor executor = new threadpooltaskexecutor();
    executor.setcorepoolsize(5);
    executor.setmaxpoolsize(10);
    executor.initialize();
    return executor;
}

定义名为 “taskexecutor” 的执行器后，spring @async 会自动使用它（因为默认执行器名称就是 taskexecutor）。也可在 @async 注解的参数中指定一个自定义执行器 bean 名称。

@scheduled

简介： @scheduled 注解用于将方法标记为定时任务。由 spring 提供（org.springframework.scheduling.annotation.scheduled）。可以通过 cron 表达式或固定间隔等配置何时运行该方法。需要配合 @enablescheduling 开启调度支持。

作用与场景： 当需要周期性地执行某段代码时，例如每隔一段时间检查库存，每天夜间生成报表等，可以使用 @scheduled 注解而不需要借助外部的调度框架。spring 容器会在后台线程按指定计划调用这些方法。支持多种调度配置：

• cron 表达式：通过 cron 定义复杂时间计划。
• 固定速率 fixedrate：以上一次开始时间为基准，间隔固定毫秒执行。
• 固定延迟 fixeddelay：以上一次完成时间为基准，延迟固定毫秒执行。
• 可选属性如 initialdelay 等设置启动延迟。

使用示例：

@component
public class reporttask {
    @scheduled(cron = "0 0 2 * * ?")
    public void generatedailyreport() {
        // 每天凌晨2点生成报告
        system.out.println("generating daily report at " + localdate.now());
        // ... 报表生成逻辑
    }
    @scheduled(fixedrate = 60000)
    public void checksystemhealth() {
        // 每隔60秒检查系统健康
        system.out.println("health check at " + instant.now());
        // ... 健康检查逻辑
    }
}

这里，reporttask 类中：

• generatedailyreport() 使用 cron="0 0 2 * * ?"，表示每天2:00执行（cron表达式：“秒 分 时 日 月 周”，“?”表示不指定周几）。这个方法将在主线程之外的调度线程按计划调用。
• checksystemhealth() 使用 fixedrate=60000 表示每60秒执行一次，不论上次执行多长时间，都按固定频率触发。若上次尚未执行完，新周期到了默认不会并发执行（调度器会等待），但可以通过配置 scheduler 实现并发。

为了使 @scheduled 生效，需要在配置类上添加 @enablescheduling（见下文）。spring boot 应用通常也需要手动加这一注解。定时任务执行由 spring 的 taskscheduler（默认singlethreadscheduler）驱动，可能需要注意任务不应长时间阻塞，否则会影响后续任务调度。可自定义线程池 taskscheduler 以提高并发度。

@enablescheduling

简介： @enablescheduling 注解用于开启 spring 对定时任务调度的支持（org.springframework.scheduling.annotation.enablescheduling）。添加在配置类或主类上。

作用与场景： 没有这个注解，@scheduled 等注解不会被识别处理。启用后，spring 容器会启动一个调度线程池，定时调用标记的方法。提供模块： spring context 定时任务支持。

使用示例：

@springbootapplication
@enablescheduling
public class application { ... }

将 @enablescheduling 放在启动类上即可激活调度机制。然后所有 @scheduled 注解的方法都会按照配置的计划执行。spring boot 不会自动开启定时任务支持，因为有的应用可能不需要调度功能，所以必须显式声明。

如果需要自定义调度器，可以定义 scheduler bean 或 taskscheduler bean。默认使用单线程执行所有定时任务，若多个任务需要并行，建议提供 threadpooltaskscheduler bean。

通过 @async 和 @scheduled 这组注解，spring 让并发编程和任务调度变得非常容易，不再需要显式创建线程或使用外部调度平台，在应用内部即可完成这些逻辑。

十、缓存注解

spring 提供了便捷的缓存机制，通过注解即可实现方法级缓存，把方法调用结果存储起来，避免重复计算或数据库查询。

@enablecaching

简介： @enablecaching 注解用于开启 spring 对缓存注解的支持（org.springframework.cache.annotation.enablecaching）。通常加在配置类或主类上，激活缓存管理能力。

作用与场景： 开启后，spring 会自动配置一个缓存管理器（可基于内存、ehcache、redis等，取决于依赖配置），并扫描应用中的缓存注解（如 @cacheable 等），在运行时用aop代理实现缓存逻辑。提供模块： spring cache。

使用示例：

@springbootapplication
@enablecaching
public class application { ... }

这样，spring boot 就会自动根据 classpath 中的缓存库选择缓存实现（如有 spring-boot-starter-cache 默认用 concurrentmapcache 简单实现；如果引入 spring-boot-starter-redis 则使用 rediscachemanager 等）。确保在使用缓存注解前调用了 @enablecaching，否则缓存注解不会生效。

@cacheable

简介： @cacheable 用于标记方法，将其返回结果缓存起来。由 spring 提供（org.springframework.cache.annotation.cacheable）。再次调用该方法时，如果传入参数相同且缓存中有结果，则直接返回缓存而不执行方法。

作用与场景： 典型用于读取操作缓存，例如从数据库查询数据后缓存，下次查询相同参数可以直接返回缓存值，提高性能。@cacheable 需要指定缓存的名称（cachename）以及缓存键（key），可以是 spel 表达式。默认键根据所有参数自动生成（需参数可哈希）。

提供模块： spring cache。

使用示例：

@service
public class productservice {
    @cacheable(value = "products", key = "#id")
    public product getproductbyid(long id) {
        // 假设这里有复杂计算或慢速数据库查询
        system.out.println("loading product " + id + " from db...");
        return productrepository.findbyid(id).orelse(null);
    }
}

配置 @cacheable(value="products", key="#id")：

• value 指定缓存的名字叫 “products”（类似分类，可对应不同缓存存储）。
• key="#id" 表示使用方法参数 id 作为缓存键。

第一次调用 getproductbyid(1l) 时，会打印“loading product 1 from db…”并查询数据库，然后结果缓存到名为 “products” 的缓存中，键为 1。第二次调用 getproductbyid(1l)，spring 检测到相同键在缓存中有值，直接返回缓存，不执行方法主体，因此不会再打印那条日志。

@cacheable 还有一些属性：

• condition：满足条件时才缓存或才查缓存，如 condition="#id > 10".
• unless：方法执行完后判断，如果满足条件则不缓存结果，如 unless="#result == null".
• sync：是否在并发场景下同步，只让一个线程计算缓存，其它等待。

@cacheput

简介： @cacheput 注解用于将方法返回值直接放入缓存，但与 @cacheable 不同的是，它始终执行方法，不会跳过。它通常用于更新缓存数据。由 spring 提供。

作用与场景： 当执行了修改操作后，希望缓存与数据库同步更新，可使用 @cacheput 标记修改方法，使其结果及时写入缓存。这样后续再读缓存可以得到最新值。提供模块： spring cache。

使用示例：

@cacheput(value = "products", key = "#product.id")
public product updateproduct(product product) {
    system.out.println("updating product " + product.getid());
    return productrepository.save(product);
}

每次调用 updateproduct，都会执行保存操作并返回更新后的 product。@cacheput 注解确保无论如何，这个返回的 product 对象会以其 id 作为键，存入 “products” 缓存（覆盖旧值）。因此，即便之前通过 @cacheable 缓存过旧的 product 数据，这里也会更新缓存，使之与数据库一致。值得注意的是，@cacheput 不会影响方法执行（总会执行方法），它只是在返回后把结果写缓存。

@cacheevict

简介： @cacheevict 注解用于移除缓存。标记在方法上，可以在方法执行前或后将指定 key 或整个缓存清除。由 spring 提供。

作用与场景： 当数据被删除或改变且缓存不再有效时，需要清除缓存。例如删除一个记录后，需要把对应缓存删掉；批量更新后，可以选择清空整个缓存。@cacheevict 支持指定 key 或设置 allentries=true 清空整个命名缓存。提供模块： spring cache。

使用示例：

@cacheevict(value = "products", key = "#id")
public void deleteproduct(long id) {
    system.out.println("deleting product " + id);
    productrepository.deletebyid(id);
}

调用 deleteproduct(5) 时，@cacheevict 会使缓存 “products” 中键为5的条目无效（删除）。默认地，它在方法成功执行后清除缓存。如果希望无论方法是否成功都清除，可设定 beforeinvocation=true，那将在方法进入时就清除（防止方法抛异常缓存未清）。allentries=true 则可以不顾键，直接清空整个缓存空间。例如：

@cacheevict(value = "products", allentries = true)
public void refreshallproducts() { ... }

会清除 “products” 缓存的所有条目。

通过 @cacheevict 与 @cacheput，我们可以维护缓存与底层数据的一致性。

注意： 使用缓存注解要求配置正确的 cachemanager 和缓存存储。spring boot 默认使用简单的内存缓存（concurrentmapcachemanager）用于开发测试。生产中常结合 redis、ehcache等实现，更换实现通常无需改动注解，只需配置 cachemanager bean。

十一、事件监听注解

spring 提供了应用内事件发布-订阅机制，支持松耦合的消息通信。通过注解可以方便地订阅事件。

@eventlistener

简介： @eventlistener 是 spring 4.2+ 引入的注解（org.springframework.context.event.eventlistener），用于将任意 spring bean 的方法标识为事件监听器。当有匹配的事件发布时（实现 applicationevent 或自定义事件对象），该方法会被调用。相比实现 applicationlistener 接口，注解方式更简洁。

作用与场景： 在应用内，不同组件之间可以通过发布事件进行解耦通讯。例如用户注册后发布一个 userregisteredevent，由其他监听器监听来发送欢迎邮件或统计指标。使用 @eventlistener，方法签名定义了它感兴趣的事件类型，也可以通过 condition 属性设置过滤条件（比如只处理某字段满足条件的事件）。提供模块： spring context 事件机制。

使用示例：

// 定义事件类（可以继承 applicationevent 也可以是普通类）
public class userregisteredevent /* extends applicationevent */ {
    private final user user;
    public userregisteredevent(user user) { this.user = user; }
    public user getuser() { return user; }
}
// 发布事件的组件
@service
public class userservice {
    @autowired 
    private applicationeventpublisher eventpublisher;
    public void register(user user) {
        // ... 保存用户逻辑
        // 发布事件
        eventpublisher.publishevent(new userregisteredevent(user));
    }
}
// 监听事件的组件
@component
public class welcomeemaillistener {
    @eventlistener
    public void handleuserregistered(userregisteredevent event) {
        user newuser = event.getuser();
        // 发送欢迎邮件
        system.out.println("sending welcome email to " + newuser.getemail());
        // ... 实际发送邮件逻辑
    }
}

流程说明：

• userservice.register 方法在新用户注册成功后，通过 applicationeventpublisher 发布了一个 userregisteredevent 事件。spring boot 默认通过 applicationeventpublisher 将事件发布到应用上下文。
• welcomeemaillistener 是一个普通组件（被 @component 扫描）。其中方法 handleuserregistered 标注了 @eventlistener，且参数是 userregisteredevent。这表明它订阅此类型事件。当事件被发布时，spring 检测到存在匹配的监听方法，便调用该方法并将事件对象传入。
• 监听方法运行，完成发送欢迎邮件的功能。

这样，发送邮件的逻辑和用户服务逻辑完全解耦，只通过事件联系。如果以后不需要发送邮件，只需移除监听器，而不影响用户注册流程。另外，可以很容易地新增其它监听，如统计注册用户数的监听器，而不需要修改 userservice。

@eventlistener 还支持 condition 属性使用 spel 表达式进行事件内容过滤。例如：

@eventlistener(condition = "#event.user.vip")
public void handlevipuserregistered(userregisteredevent event) { ... }

仅当用户是vip时才处理。这种细粒度控制进一步增强了事件机制的灵活性。

需要注意，默认事件监听器在发布线程内同步执行。如果想异步处理事件，可以结合 @async 注解，将监听方法异步执行（前提是已启用 @enableasync）。或者使用 spring 5 提供的 applicationeventmulticaster 配置为异步模式。

applicationlistener 接口 （替代方案）

说明： 在 @eventlistener 出现之前，spring 使用实现 applicationlistener<e> 接口的方式来监听事件。虽然这不是注解，但与事件注解结合使用时值得一提。任何 spring bean 实现了 applicationlistener<myevent>，当 myevent 发布时其 onapplicationevent 方法会被调用。自 spring 4.2 起推荐使用 @eventlistener 代替，更加简洁。

使用示例：

@component
public class statslistener implements applicationlistener<userregisteredevent> {
    @override
    public void onapplicationevent(userregisteredevent event) {
        // 统计用户注册
        metrics.increment("user.register.count");
    }
}

这个监听器无须注解，spring根据泛型自动注册。但相比注解方式，它需要一个独立的类实现接口，不如 @eventlistener 可以直接用任意方法方便。而且一个类只能实现对一种事件的监听，要监听多种事件需要写多个类或使用一些if判断，不如注解灵活。因此现在开发中更多使用 @eventlistener。

综上，spring 的事件模型通过发布订阅实现了应用内部的解耦协作。@eventlistener 极大降低了使用门槛，使得监听事件就像写普通方法一样便捷。配合异步能力，还能实现类似消息队列的效果，用于不太关键的异步通知等场景。

十二、测试相关注解

spring 为了方便编写测试，特别是针对 spring mvc 或 jpa等组件的测试，提供了一系列注解来简化配置测试上下文。

@springboottest

简介： @springboottest 是 spring boot 测试框架提供的注解（org.springframework.boot.test.context.springboottest），用于在测试类上，表示启动一个完整的 spring boot 应用上下文进行集成测试。

作用与场景： 标注此注解的测试类在运行时会通过 spring boot 引导启动应用（除非配置特定属性使其部分引导），这意味着：

• 会扫描并创建所有 bean，加载完整应用上下文。
• 提供对 bean 的依赖注入支持，使测试类可以直接 @autowired 需要的 bean 进行集成测试。

它常用于需要测试多个层级协同工作的场景，例如验证服务层和仓库层交互，或者整个请求流程。

使用示例：

@springboottest
class applicationtests {
    @autowired
    private userservice userservice;
    @test
    void testuserregistration() {
        user user = new user("alice");
        userservice.register(user);
        // 验证注册结果，比如检查数据库或事件发布效果
        assertnotnull(user.getid());
    }
}

这个测试类使用 @springboottest，则测试运行时 spring boot 会启动应用上下文并注入 userservice bean，测试方法里可以直接调用业务代码进行验证。@springboottest 还可以指定启动端口、环境等参数，或通过 properties 覆盖配置，比如：

@springboottest(webenvironment = springboottest.webenvironment.random_port)

用于启动嵌入式服务器在随机端口，以进行 web 集成测试。

@webmvctest

简介： @webmvctest 是用于测试 spring mvc 控制器的注解（org.springframework.boot.test.autoconfigure.web.servlet.webmvctest）。它会启动一个精简的 spring mvc 环境，只包含web相关的bean，如@controller、@restcontroller等，以及mvc配置，而不加载整个应用上下文。

作用与场景： 主要用于单元测试控制器。默认只扫描 @controller 和 @restcontroller 等 web 层组件，以及必要的配置（如 jackson 转换、validator）。不会加载服务层、仓库层bean，除非通过配置指定。这样测试运行速度快且聚焦于mvc层逻辑。常配合 mockmvc （spring提供的模拟mvc请求的工具）使用进行控制器的请求/响应测试。

使用示例：

@webmvctest(controllers = usercontroller.class)
class usercontrollertests {
    @autowired
    private mockmvc mockmvc;
    @mockbean
    private userservice userservice;  // 将userservice模拟
    @test
    void testgetuser() throws exception {
        user user = new user(1l, "bob");
        // 定义当userservice.findbyid(1)被调用时返回user对象
        given(userservice.findbyid(1l)).willreturn(user);
        mockmvc.perform(get("/users/1"))
               .andexpect(status().isok())
               .andexpect(jsonpath("$.name").value("bob"));
    }
}

此测试类标注 @webmvctest(usercontroller.class)：

1. spring boot 会仅启动与 usercontroller 相关的 mvc 组件，如 usercontroller 本身，mvc配置，序列化组件等。
2. userservice 因为不是@controller组件，不会自动加载。因此使用了 @mockbean 注解（见后）创建一个模拟的 userservice bean，将其注入到 usercontroller 中，避免涉及真实的服务层逻辑。
3. 测试使用 mockmvc 发起get请求到 /users/1，并断言返回状态200和返回json中的name字段为"bob"。由于我们预先通过 given(userservice.findbyid(1l)) 指定了模拟行为，所以控制器调用userservice时会得到我们构造的user对象。

通过这种方式，不需要启动整个应用，也不需要真实数据库等，就能测试控制器映射、参数解析、返回结果等。@webmvctest 提供了对spring mvc各方面的支持（如可以自动配置mockmvc）。

@datajpatest

简介： @datajpatest 是用于测试 jpa 持久层的注解（org.springframework.boot.test.autoconfigure.orm.jpa.datajpatest）。它会启动一个只包含 jpa 相关组件的 spring 应用上下文，例如实体管理器、spring data jpa 仓库、嵌入式数据库等。

作用与场景： 主要用于单元测试 repository 层。它会：

• 配置嵌入式内存数据库（如h2）用于测试，除非明确指定其他datasource。
• 扫描 @entity 实体和 spring data repository 接口并注册。
• 不加载 web、安全等其他非持久层bean，以加快测试速度。
• 默认使用事务包装每个测试，并在结束时回滚，保证测试隔离。

使用示例：

@datajpatest
class userrepositorytests {
    @autowired
    private userrepository userrepository;
    @test
    void testfindbyemail() {
        // 准备测试数据
        user user = new user();
        user.setemail("test@example.com");
        user.setname("test");
        userrepository.save(user);
        // 执行查询方法
        user found = userrepository.findbyemail("test@example.com");
        assertequals("test", found.getname());
    }
}

这里 @datajpatest 将自动配置一个内存数据库并初始化 jpa 环境。userrepository 接口（假设继承自 jparepository）会被加载为bean。测试中先保存一个用户，然后调用仓库自定义方法 findbyemail 验证结果。由于测试结束时事务会回滚，插入的测试数据不会污染下一个测试或实际数据库。

@datajpatest 同样可以与 @mockbean 配合如果需要模拟一些非jpa的bean，但是通常持久层测试不需要。也可以通过 properties 指定连接真实数据库进行集成测试，不过大多数情况下，使用内存数据库足以测试repository逻辑。

@mockbean

简介： @mockbean 是 spring boot test 提供的注解（org.springframework.boot.test.mock.mockito.mockbean），用于在 spring 测试上下文中添加一个由 mockito 模拟的bean，并替换掉容器中原本该类型的bean（如果有）。常用于在 web层或服务层测试中，模拟依赖的bean行为。

作用与场景： 当测试的目标bean有依赖，而我们不想测试依赖的真实逻辑（可能复杂或不确定），就可以用 @mockbean 来提供一个mockito创建的模拟对象给容器。这比手工使用 mockito.mock 然后手动注入更方便，因为 spring 会自动把这个模拟bean注入到需要它的地方。典型应用是在 @webmvctest 中模拟服务层bean，在 @springboottest 中模拟外部系统客户端bean等。

使用示例：

@mockbean
private weatherservice weatherservice;

将 weatherservice 接口模拟为一个 bean 注入容器。如果应用上下文本来有一个该类型的bean（比如真实的实现），会被模拟对象替换。这使得我们可以用 given(weatherservice.gettodayweather())... 等来预设行为。这个注解可以用在测试类的字段上（如上）、也可以用在测试方法内参数上。

具体的用法在前面的 @webmvctest 示例已经体现。再比如，在一个服务层测试中：

@springboottest
class orderservicetests {
    @autowired
    private orderservice orderservice;
    @mockbean
    private paymentclient paymentclient;  // 模拟外部支付服务客户端
    @test
    void testorderpayment() {
        order order = new order(...);
        // 假定调用外部支付返回成功结果
        given(paymentclient.pay(order)).willreturn(new paymentresult(true));
        boolean result = orderservice.processpayment(order);
        asserttrue(result);
        // 验证内部行为，如订单状态更新
        // ...
    }
}

这里 orderservice 依赖 paymentclient，但我们不想真的调用外部服务，于是用 @mockbean 模拟它并规定返回 paymentresult 成功。这样 orderservice.processpayment 执行时实际上用的是假的 paymentclient，但可以测试 orderservice 自身的逻辑是否正确处理了成功结果。注意： @mockbean 底层使用 mockito，所以需要确保引入了 mockito 相关依赖。

其他测试注解：

• @springboottest 和 @webmvctest, @datajpatest 是 spring boot test 提供的测试切面注解，此外还有类似 @webfluxtest（测试webflux控制器）、@jdbctest（测试jdbc）、@jsontest（测试json序列化）等，根据需要使用。
• junit本身的注解如 @test, @beforeeach, @aftereach 等也在测试中大量使用（如上示例已经用到 @test）。虽然不属于spring范畴，但也算开发中常用的注解之一。

通过这些测试注解，开发者可以方便地编写隔离的测试用例。例如只启动web层或持久层进行单元测试，大大提高测试执行速度和定位问题的精准度。spring boot 自动配置为测试裁剪了上下文，避免加载无关bean，使测试既保持类似生产环境的行为，又能高效运行。

十三、安全相关注解

spring security 框架提供了方法级安全控制的注解和配置注解，方便对控制器或服务方法实施权限检查。此外还有开启安全的配置注解等。

@enablewebsecurity

简介： @enablewebsecurity 是用于开启 spring security web 安全支持的注解（org.springframework.security.config.annotation.web.configuration.enablewebsecurity）。通常加在一个继承 websecurityconfigureradapter（spring security 5.7 之前）的配置类上，或者加在包含 securityfilterchain bean 的配置类上。它启用了 spring security 的过滤器链。

作用与场景： 使用 spring security 时，需要此注解来加载 web 安全配置，使应用受 spring security 管理。提供模块： spring security config。

使用示例：

@configuration
@enablewebsecurity
public class securityconfig extends websecurityconfigureradapter {
    @override
    protected void configure(httpsecurity http) throws exception {
        http.authorizerequests()
            .antmatchers("/admin/**").hasrole("admin")
            .anyrequest().authenticated()
            .and().formlogin();
    }
}

上述经典用法在 spring security 5.7 之前通过继承 websecurityconfigureradapter 来配置。@enablewebsecurity 注解开启安全功能。spring boot 自动配置也会在引入 starter-security 时添加该注解，因此有时无需手动添加；但当我们提供自定义安全配置类时，一般会注明此注解。注意： spring security 5.7 开始，官方更推荐不继承类而是声明 securityfilterchain bean 配合 @enablewebsecurity 使用，但注解作用相同。

@enableglobalmethodsecurity （已过时） / @enablemethodsecurity

简介： @enableglobalmethodsecurity 用于开启方法级安全注解的支持（如 @preauthorize, @secured）。这是 spring security 旧版本使用的注解，位于 org.springframework.security.config.annotation.method.configuration.enableglobalmethodsecurity。它已经在 spring security 6 被替换为新的 @enablemethodsecurity（@enableglobalmethodsecurity 标记为已弃用）。

作用与场景： 加在 security 配置类上，启用对 @preauthorize, @postauthorize, @secured, @rolesallowed 注解的识别。可以通过其属性启用各类注解，如 prepostenabled=true 支持 pre/postauthorize，securedenabled=true 支持@secured，jsr250enabled=true 支持@rolesallowed 等。提供模块： spring security config。

使用示例（旧）：

@configuration
@enablewebsecurity
@enableglobalmethodsecurity(prepostenabled = true, securedenabled = true)
public class securityconfig extends websecurityconfigureradapter {
    // ...
}

这将开启 @preauthorize/@postauthorize（因为 prepostenabled=true） 和 @secured 注解（因为 securedenabled=true）。在 security 6 中，等价的做法是：

@configuration
@enablewebsecurity
@enablemethodsecurity(prepostenabled = true, securedenabled = true, jsr250enabled = true)
public class securityconfig { ... }

@enablemethodsecurity 默认就启用了 pre/post，所以可以不用显式 prepostenabled，secured和jsr250需要明确true。

总而言之，在当前的 spring boot 3 / security 6 环境中，使用 @enablemethodsecurity 取代 @enableglobalmethodsecurity 来开启方法安全注解支持。

@preauthorize

简介： @preauthorize 是 spring security 的方法级权限注解（org.springframework.security.access.prepost.preauthorize）。它可以用在方法或类上，在方法调用之前基于给定的表达式进行权限验证。需要启用了全局方法安全后（如上），此注解才会生效。

作用与场景： @preauthorize 可以检查当前认证用户是否具备某权限或角色，或者满足spel表达式定义的任意条件，然后才允许方法执行。常用于服务层或控制层方法，保护敏感操作。例如只有admin角色能调用删除用户方法，或者只有资源拥有者才能访问资源等。它比 @secured 更强大，因为可以使用spring el编写复杂的逻辑。

使用示例：

@service
public class accountservice {
    @preauthorize("hasrole('admin')")
    public void deleteaccount(long accountid) {
        // 只有admin角色用户才能执行
        accountrepository.deletebyid(accountid);
    }
    @preauthorize("#user.name == authentication.name or hasauthority('scope_profile')")
    public profile getuserprofile(user user) {
        // 用户本人或具有profile权限的可以查看
        return profilerepository.findbyuser(user);
    }
}

• deleteaccount 方法上，@preauthorize("hasrole('admin')") 限制只有具有role_admin的用户可以调用，否则会被拒绝（抛出 accessdeniedexception）。getuserprofile 方法上，使用了表达式：#user.name == authentication.name or hasauthority('scope_profile')。authentication.name 代表当前登录用户名。如果传入的 user.name 等于当前用户名（即查询自己的资料），或当前主体具有 scope_profile 权限（例如 oauth2 scope），则允许访问。否则拒绝。可以看到preauthorize能够引用方法参数（通过#参数名）和安全上下文信息（authentication对象）进行复杂判断。

@preauthorize 非常灵活，也支持调用自定义权限评估方法等。但要注意权限表达式越复杂可能越难维护，需要在安全和可读性之间平衡。spring security官方推荐使用preauthorize胜过secured，因为其表达能力更强。

@secured

简介： @secured 是较早的 spring security 提供的简单方法安全注解（org.springframework.security.access.annotation.secured）。它指定一组允许的角色，调用该方法的用户必须具备其中一个角色才行。需要在全局方法安全配置中启用 securedenabled=true 才生效。

作用与场景： 适用于简单的基于角色的访问控制。如果系统的授权模型主要基于角色，可以使用 @secured("role_x") 来保护方法。相对于 preauthorize，它不支持复杂表达式，只能指定角色列表。提供模块： spring security（需要 @enablemethodsecurity(securedenabled=true) 或旧的相应配置）。

使用示例：

@secured("role_admin")
public void createuser(user user) { ... }
@secured({"role_user", "role_admin"})
public data getdata() { ... }

• createuser 方法要求调用者必须拥有 role_admin 角色。
• getdata 方法允许 role_user 或 role_admin 拥有者访问（逻辑是or的关系）。

如果不满足要求，spring security同样会抛出访问拒绝异常。@secured 内部实际上也是通过 aop 拦截，与 @preauthorize 实现机制类似，但因为其功能有限，spring官方更推荐使用pre/postauthorize。

需要留意的是，@secured 注解中的字符串需要包含完整的角色前缀（如默认前缀是 “role_”)。如上必须写 “role_admin” 而不是 “admin”，除非通过配置修改了前缀策略。

@rolesallowed

简介： @rolesallowed 来自 jsr-250（jakarta.annotation.security.rolesallowed），功能与 @secured 类似，也是指定允许访问方法的角色列表。spring security 支持它，需要 jsr250enabled=true。它和 secured的区别主要在注解来源不同。

作用与场景： 可以作为 @secured 的替代，用标准注解来声明角色限制。在spring环境下两者效果一样。提供模块： jsr-250，spring security需启用支持。

使用示例：

@rolesallowed("admin")
public void updatesettings(settings settings) { ... }

这里假设已将角色前缀配置成无"role_"前缀或 securityconfigurer里做了处理，否则 spring security会把 “admin” 当作角色名直接匹配 grantedauthority “admin”。一般secured和rolesallowed不能混用不同前缀，否则容易出错。

综上，spring security提供的这些注解允许我们无需在方法内部手动检查权限，而由框架自动在调用前进行验证，符合条件才执行。需要注意：

• 要在配置类上开启相应支持（使用 @enablemethodsecurity 或旧版 @enableglobalmethodsecurity）。
• @preauthorize/@postauthorize 功能最强，但稍复杂，@secured/@rolesallowed简单直接，但只能基于角色判断。
• 这类注解只检查spring security的上下文，对于未经过滤器链保护的方法调用（比如同类中自调用方法不会触发注解检查，或者在无security环境下）就不起作用。这是常见陷阱——所以带有安全注解的方法最好不要在内部直接调用，否则绕过了切面检查。

十四、其他常用注解

除了上述类别，spring & spring boot 中还有一些常用但未分类到的注解，例如：

• 参数校验相关： spring 对 jsr 303 bean validation 的支持，让我们可以在模型上使用如 @notnull, @size, @valid 等注解。其中在 controller 方法参数上使用 @valid 可触发校验，并结合 @exceptionhandler 或 @controlleradvice 统一处理校验结果。
• json 序列化控制： 像 @jsoninclude（来自 jackson）可以注解类或属性，控制json序列化包含规则，例如 @jsoninclude(jsoninclude.include.non_null) 表示忽略null值字段。这在返回rest数据时很有用。
• 条件装配注解： spring boot 提供了一系列 @conditionalon... 注解用于自动配置（如 @conditionalonproperty, @conditionalonclass, @conditionalonmissingbean 等）来有条件地装配bean。这些主要在开发spring boot自动配置模块时使用，在应用层较少直接用到，但理解它们有助于明白boot的装配机制。

以上罗列的注解涵盖了spring核心开发中最常用的部分。从应用启动配置、bean装配，到web层开发、数据持久化、aop、异步、缓存、事件、测试、安全，各个方面都有简洁的注解支持。掌握它们的用法能显著提高开发效率，减少样板代码，让我们更多关注业务逻辑实现。

总结： spring & spring boot 常用注解极大地便利了开发，它们遵循“约定优于配置”的理念，通过简单的注解声明即可完成以前繁琐的xml配置或手动编码工作。在使用时要注意启用相应功能的开关（如异步、事务、缓存等），理解注解背后机制（如aop代理、运行时处理）以避免踩坑。熟练运用上述注解，能覆盖大部分日常开发场景，实现优雅、高效和可维护的spring应用。

到此这篇关于spring boot 常用注解整理的文章就介绍到这了,更多相关spring boot 常用注解内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！