springboot的常用注解

本文详细介绍了SpringBoot中控制器(@Controller)、服务(@Service)、仓库(@Repository)等组件的作用,以及@Autowired、@Qualifier、@Bean等依赖注入注解的使用。此外,还涵盖了实例生命周期、SpringMVC相关注解、数据库事务管理、全局异常处理和AOP相关注解,以及测试工具如@SpringBootTest的运用。
摘要由CSDN通过智能技术生成

在这里插入图片描述

声明解释这个对象(类或者其他)组件相关

名称作用
@Controller用于修饰MVC中controller层的组件SpringBoot中的组件扫描功能会识别到该注解,并为修饰的类实例化对象,通常与@RequestMapping联用,当SpringMVC获取到请求时会转发到指定路径的方法进行处理。声明 MVC中起到控制操作的,与Requestmap联用,相当于控制 处理请求,或者叫做请求入口
@Service用于修饰service层的组件,service层组件专注于系统业务逻辑的处理,同样会被组件扫描并生成实例化对象。服务层,也不叫做服务层吧,就是controller接收到请求之后,扔给这个修饰的进行处理
Repository用于修饰dao层的组件,dao层组件专注于系统数据的处理,例如数据库中的数据,同样会被组件扫描并生成实例化对象。声明是个DAO层组件
@Component用于修饰SpringBoot中的组件,会被组件扫描并生成实例化对象,修饰的类会修饰成bean。@Controller、@Service、@Repository都是特殊的组件注解。所有声明组件的祖先吧

依赖注入相关

名称作用
@Autowired会根据对象的类型自动注入依赖对象,默认要求注入对象实例必须存在,可以配置required=false来注入不一定存在的对象。修饰后,改对象就会被自动初始化注入了,这就是框架的神奇之处,底层原理发射
@Qualifier当同一个对象有多个实例可以注入时,使用@Autowired注解无法进行注入,这时可以使用@Qualifier注解指定实例的名称进行精确注入。用父类声明,子类实例化的时候,所以存在多个是咧

实例与生命周期相关注解

名称作用
@Bean用于修饰方法,标识该方法会创建一个Bean实例,并交给Spring容器来管理。用来声明其实一个bean,交给spring管理,其他就可以依赖注入了
@Scope用于声明一个SpringBean实例的作用域,作用域的范围有以下几种:singleton:单例模式,在Spring容器中该实例唯一,Spring默认的实例模式。 prototype:原型模式,每次使用实例都将重新创建。request:在同一请求中使用相同的实例,不同请求重新创建。session:在同一会话中使用相同的实例,不同会话重新创建
@Primary当同一个对象有多个实例时,优先选择该实例。
@PostConstruct用于修饰方法,当对象实例被创建并且依赖注入完成后执行,可用于对象实例的初始化操作。
@PreDestroy用于修饰方法,当对象实例将被Spring容器移除时执行,可用于对象实例持有资源的释放。

SpringMVC相关注解

名称作用
@RequestMapping可用于将Web请求路径映射到处理类的方法上,当作用于类上时,可以统一类中所有方法的路由路径,当作用于方法上时,可单独指定方法的路由路径。method属性可以指定请求的方式,如GET、POST、PUT、DELETE等@RequestBody表示方法的请求参数为JSON格式,从Body中传入,将自动绑定到方法参数对象中。
@ResponseBody表示方法将返回JSON格式的数据,会自动将返回的对象转化为JSON数据。
@RequestParam用于接收请求参数,可以是如下三种形式:query param:GET请求拼接在地址里的参数。form data:POST表单提交的参数。multipart:文件上传请求的部分参数。
@PathVariable用于接收请求路径中的参数,常用于REST风格的API。
@RequestPart用于接收文件上传中的文件参数,通常是multipart/form-data形式传入的参数。

配置相关注解

名称作用
@Configuration用于声明一个Java形式的配置类,SpringBoot推荐使用Java配置,在该类中声明的Bean等配置将被SpringBoot的组件扫描功能扫描到。
@EnableAutoConfiguration启用SpringBoot的自动化配置,会根据你在pom.xml添加的依赖和application-dev.yml中的配置自动创建你需要的配置
@ComponentScan启用SpringBoot的组件扫描功能,将自动装配和注入指定包下的Bean实例。
@SpringBootApplication用于表示SpringBoot应用中的启动类,相当于@EnableAutoConfiguration、@EnableAutoConfiguration和@ComponentScan三个注解的结合体。
@EnableCaching当添加Spring Data Redis依赖之后,可用该注解开启Spring基于注解的缓存管理功能。
@value用于注入在配置文件中配置好的属性,例如我们可以在application.yml配置如下属性:jwt:tokenHeader: Authorization #JWT存储的请求头 secret: mall-admin-secret #JWT加解密使用的密钥 expiration: 604800 #JWT的超期限时间(606024*7)tokenHead: 'Bearer ’ #JWT负载中拿到开头
@ConfigurationProperties用于批量注入外部配置,以对象的形式来导入指定前缀的配置,比如这里我们在application.yml中指定了secure.ignored为前缀的属性:
@Conditional用于表示当某个条件满足时,该组件或Bean将被Spring容器创建,下面是几个常用的条件注解。@ConditionalOnBean:当某个Bean存在时,配置生效。@ConditionalOnMissingBean:当某个Bean不存在时,配置生效。@ConditionalOnClass:当某个类在Classpath存在时,配置生效。@ConditionalOnMissingClass:当某个类在Classpath不存在时,配置生效。
@SpringBootApplication
public class HelloworldApplication {
	public static void main(String[] args) {
			SpringApplication.run(HelloworldApplication.class, args
		);
	}
}

数据库事务相关注解

名称作用
@EnableTransactionManagement启用Spring基于注解的事务管理功能,需要和@Configuration注解一起使用。
@Transactional表示方法和类需要开启事务,当作用与类上时,类中所有方法均会开启事务,当作用于方法上时,方法开启事务,方法上的注解无法被子类所继承。

全局异常处理注解

名称作用
@ControllerAdvice常与@ExceptionHandler注解一起使用,用于捕获全局异常,能作用于所有controller中。
@ExceptionHandler修饰方法时,表示该方法为处理全局异常的方法

AOP相关注解

名称作用
@Aspect用于定义切面,切面是通知和切点的结合,定义了何时、何地应用通知功能。
@Before表示前置通知(Before),通知方法会在目标方法调用之前执行,通知描述了切面要完成的工作以及何时执行。
@After表示后置通知(After),通知方法会在目标方法返回或抛出异常后执行。
@AfterReturning表示返回通知(AfterReturning),通知方法会在目标方法返回后执行。
@AfterThrowing表示异常通知(AfterThrowing),通知方法会在目标方法返回后执行。
@Around表示环绕通知(Around),通知方法会将目标方法封装起来,在目标方法调用之前和之后执行自定义的行为。
@Pointcut定义切点表达式,定义了通知功能被应用的范围。
@Order用于定义组件的执行顺序,在AOP中指的是切面的执行顺序,value属性越低优先级越高。

测试

名称作用
@SpringBootTest用于指定测试类启用Spring Boot Test功能,默认会提供Mock环境。
@Test指定方法为测试方法。
@RunWith用来指定测试类的运行器,也就是用什么方式来执行测试类中的测试方法。不同的运行器有不同的功能和特点
package com.weiz.helloworld.service;

import org.junit.Assert;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
class UserServiceTest {

    @Autowired
    private UserService userService;


    @Test
    void findOne() {
        Assert.assertEquals("1002", userService.findOne());
    }
}
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值