SpringBoot常用注解

(1)组件相关注解

@Controller:控制层,被组件扫描并生成实例化对象

@Service:业务层,被组件扫描并生成实例化对象

@Repository:数据层,被组件扫描并生成实例化对象

@Component:用于修饰SpringBoot中的组件,会被组件扫描并生成实例化对象。@Controller@Service@Repository都是特殊的组件注解。

(2)依赖注入注解

@Autowired:会根据对象类型自动注入依赖对象,默认要求注入对象实例必须存在,可以配置required=false来注入不一定存在的对象。

@Resource:默认会根据对象的名称自动注入依赖对象,如果想要根据类型进行注入,可以设置属性为type = UmsAdminService.class

@Qualifier:当同一个对象有多个实例可以注入时,使用@Autowired注解无法进行注入,这时可以使用@Qualifier注解指定实例的名称进行精准注入。

@Primary:当同一个对象有多个实例时,优先选择该实例。

(3)实例与生命周期相关注解

@Bean:用于修饰方法,表示该方法会创建一个Bean实例,并交给Spring容器来管理。

@Scope:用于声明一个Spring Bean实例的作用域,作用域的范围有:singleton(单例模式),

prototype(原型模式),request(在同一请求中使用相同的实例,不同请求重新创建。),session(在同一会话中使用相同的实例,不同会话重新创建。)

@PostConstruct:可用于对象实例的初始化操作

@PreDestroy:可用于对象实例持有资源的释放

(4)SpringMVC相关注解

@RequestBody:表示方法的请求参数为JSON格式,从Body中传入,将自动绑定到方法参数对象中。

@RequestParam:

用于接收请求参数,可以是如下三种形式:

  • query param:GET请求拼接在地址里的参数。
  • form data:POST表单提交的参数。
  • multipart:文件上传请求的部分参数。

@PathVariable:用于接收请求路径中的参数,常用于REST风格的API。

@RequestPart:用于接收文件上传中的文件参数,通常是multipart/form-data形式传入的参数。

(5)配置相关注解

@Configuration:用于声明一个Java形式的配置类,SpringBoot推荐使用Java配置,在该类中声明的Bean等配置将被SpringBoot的组件扫描功能扫描到。

@EnableAutoConfiguration:启用SpringBoot的自动化配置,会根据你在pom.xml添加的依赖和application-dev.yml中的配置自动创建你需要的配置。

@ComponentScan:启用SpringBoot的组件扫描功能,将自动装配和注入指定包下的Bean实例。

@SpringBootApplication:用于表示SpringBoot应用中的启动类,相当于@Configuration@EnableAutoConfiguration@ComponentScan三个注解的结合体。

@EnableCaching:当添加Spring Data Redis依赖之后,可用该注解开启Spring基于注解的缓存管理功能。

@Value:用于注入在配置文件中配置好的属性。

@ConfigurationProperties:用于批量注入外部配置

@Conditional:

用于表示当某个条件满足时,该组件或Bean将被Spring容器创建,下面是几个常用的条件注解。

  • @ConditionalOnBean:当某个Bean存在时,配置生效。
  • @ConditionalOnMissingBean:当某个Bean不存在时,配置生效。
  • @ConditionalOnClass:当某个类在Classpath存在时,配置生效。
  • @ConditionalOnMissingClass:当某个类在Classpath不存在时,配置生效。

(6)数据库事务相关注解

@EnableTransactionManagement:启用Spring基于注解的事务管理功能,需要和@Configuration注解一起使用。

@Transactional:表示方法和类需要开启事务,当作用与类上时,类中所有方法均会开启事务,当作用于方法上时,方法开启事务,方法上的注解无法被子类所继承。

(7)SpringSecurity注解

@EnableWebSecurity:启用SpringSecurity的Web功能。

@EnableGlobalMethodSecurity:启用SpringSecurity基于方法的安全功能,当我们使用@preAuthorize修饰接口方法时,需要有对应权限的用户才能访问。

(8)全局异常处理注解

@ControllerAdvice:常与@ExceptionHandler注解一起使用,用于捕获全局异常,能作用于所有controller中。

@ExceptionHandler:修饰方法时,表示该方法为处理全局异常的方法。

(9)AOP相关注解

@Aspect:用于定义切面,切面是通知和切点的结合,定义了何时、何地应用通知功能。

@Before:表示前置通知,通知方法会在目标方法屌用之前执行,通知描述了切面要完成的工作以及何时执行。

@After:表示后置通知,通知方法会子目标方法返回或抛出异常后执行。

@AfterReturning:表示返回通知,通知方法会在目标方法返回后执行。

@AfterThrowing:表示异常通知(AfterThrowing),通知方法会在目标方法返回后执行。

@Around:表示环绕通知(Around),通知方法会将目标方法封装起来,在目标方法调用之前和之后执行自定义的行为。

@Pointcut:定义切点表达式,定义了通知功能被应用的范围。

@Order:用于定义组件的执行顺序,在AOP中指的是切面的执行顺序,value属性越低优先级越高。

(10)测试相关注解

@SpringBootTest:用于指定测试类启用Spring Boot Test功能,默认会提供Mock环境。

@Test:指定方法为测试方法。

### Spring Boot 常用注解及功能说明 Spring Boot 是一个快速开发框架,通过整合常用的第三方依赖、简化 XML 配置并采用注解形式,内置 HTTP 服务器(如 Jetty 和 Tomcat),使得开发者可以以 Java 应用程序的形式执行项目[^3]。以下是 Spring Boot常用注解及其功能说明: #### 1. `@SpringBootApplication` 这是一个复合注解,整合了以下三个注解的功能: - **`@SpringBootConfiguration`**:标识当前类为 Spring Boot 的配置类[^1]。 - **`@EnableAutoConfiguration`**:启用 Spring Boot 的自动配置机制,根据项目中的依赖和应用上下文自动配置 Spring 应用程序[^2]。 - **`@ComponentScan`**:自动扫描指定包及其子包中的 Spring 组件,并将它们注册为 Spring 容器中的 Bean[^2]。 示例代码如下: ```java package com.demo; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class MyStartApplication { public static void main(String[] args) { SpringApplication.run(MyStartApplication.class, args); } } ``` #### 2. `@Configuration` 用于标识一个类作为配置类,类似于 Spring XML 配置文件的作用。该注解通常与 `@Bean` 结合使用,定义方法返回的实例作为 Spring 容器中的 Bean[^3]。 示例代码如下: ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class AppConfig { @Bean public MyService myService() { return new MyServiceImpl(); } } ``` #### 3. `@Component`, `@Service`, `@Repository`, `@Controller` 这些注解都属于组件扫描的一部分,用于将类标记为 Spring 容器中的 Bean: - **`@Component`**:通用注解,表示该类是一个组件。 - **`@Service`**:用于业务逻辑层的类[^3]。 - **`@Repository`**:用于数据访问层的类[^3]。 - **`@Controller`**:用于控制器层的类,通常与 Web 层结合使用。 示例代码如下: ```java import org.springframework.stereotype.Service; @Service public class MyService { public String getMessage() { return "Hello, Spring Boot!"; } } ``` #### 4. `@RestController` 这是一个组合注解,相当于 `@Controller` 和 `@ResponseBody` 的结合。它主要用于构建 RESTful Web 服务,直接返回 JSON 或 XML 格式的数据。 示例代码如下: ```java import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class MyController { @GetMapping("/message") public String getMessage() { return "Hello, RESTful API!"; } } ``` #### 5. `@Autowired` 用于自动装配依赖。它可以作用于构造函数、字段、Setter 方法等,Spring 容器会根据类型或名称自动注入相应的 Bean。 示例代码如下: ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; @Service public class MyService { private final MyRepository myRepository; @Autowired public MyService(MyRepository myRepository) { this.myRepository = myRepository; } public String getData() { return myRepository.findData(); } } ``` #### 6. `@Value` 用于从配置文件中读取属性值,或者直接赋值给字段。可以通过 `${}` 占位符获取配置文件中的值。 示例代码如下: ```properties app.name=MyApp app.version=1.0.0 ``` ```java import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Component; @Component public class AppInfo { @Value("${app.name}") private String name; @Value("${app.version}") private String version; public String getAppInfo() { return name + " - " + version; } } ``` #### 7. `@Bean` 用于在 `@Configuration` 类中定义方法,将方法返回的对象注册为 Spring 容器中的 Bean[^3]。 示例代码如下: ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class AppConfig { @Bean public MyService myService() { return new MyServiceImpl(); } } ``` #### 8. `@PostConstruct` 和 `@PreDestroy` 这两个注解分别用于定义 Bean 初始化后和销毁前的回调方法。`@PostConstruct` 标记的方法会在 Bean 创建完成后执行,而 `@PreDestroy` 标记的方法会在 Bean 销毁前执行[^4]。 示例代码如下: ```java import javax.annotation.PostConstruct; import javax.annotation.PreDestroy; import org.springframework.stereotype.Component; @Component public class MyComponent { @PostConstruct public void init() { System.out.println("Bean initialized."); } @PreDestroy public void destroy() { System.out.println("Bean destroyed."); } } ``` --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值