Spring常用注解

Spring中的常用注解

常用注解

@Component

表示一个带注释的类是一个“组件”,成为Spring管理的Bean。当使用基于注解的配置和类路径扫描时,这些类被视为自动检测的候选对象。同时@Component还是一个元注解。

@Service

组合注解(组合了@Component注解),应用在service层(业务逻辑层)。

@Repository

组合注解(组合了@Component注解),应用在dao层(数据访问层)。

@Controller

组合注解(组合了@Component注解),应用在MVC层(控制层),DispatcherServlet会自动扫描注解了此注解的类,然后将web请求映射到注解了@RequestMapping的方法上。

@RequestMapping

用于映射Web请求,包括访问路径和参数。(类或方法上)

@ResponseBody

支持将返回值放在response内,而不是一个页面,通常用户返回json数据。(返回值旁或方法上)

@RequestBody

允许request的参数在request体中,而不是在直接连接在地址后面。(放在参数前)

@PathVariable

用于接收路径参数,比如@RequestMapping(“/hello/{name}”)申明的路径,将注解放在参数中前,即可获取该值,通常作为Restful的接口实现方法。

@RestController

该注解为一个组合注解,相当于@Controller和@ResponseBody的组合,注解在类上,意味着,该Controller的所有方法都默认加上了@ResponseBody。

@ExceptionHandler

用于全局处理控制器里的异常。

@ModelAttribute

本来的作用是绑定键值对到 Model 里,在 @ControllerAdvice 中是让全局的@RequestMapping都能获得在此处设置的键值对。

@Autowired

Spring提供的工具(由Spring的依赖注入工具(BeanPostProcessor、BeanFactoryPostProcessor)自动注入)。

@Configuration

声明当前类是一个配置类(相当于一个Spring配置的xml文件)(类上)。

@Bean

注解在方法上,声明当前方法的返回值为一个Bean。返回的Bean对应的类中可以定义init()方法和destroy()方法,然后在@Bean(initMethod=”init”,destroyMethod=”destroy”)定义,在构造之后执行init,在销毁之前执行destroy。(方法上)

@ComponentScan

自动扫描指定包下所有使用@Service、@Component、@Controller、@Repository的类并注册(类上)。

@Aspect

声明一个切面(类上) 使用@After、@Before、@Around定义建言(advice),可直接将拦截规则(切点)作为参数。

@After :在方法执行之后执行(方法上)。

@Before: 在方法执行之前执行(方法上)。

@Around: 在方法执行之前与之后执行(方法上)。

@PointCut: 声明切点 在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持(类上)。

@Scope

定义我们采用什么模式去创建Bean(方法上,得有@Bean) 其设置类型包括:

Singleton (单例,一个Spring容器中只有一个bean实例,默认模式), Prototype(每次调用新建一个bean), Request (web项目中,给每个http request新建一个bean), Session(web项目中,给每个http session新建一个bean), GlobalSession(给每一个 global http session新建一个Bean实例)。

@PostConstruct

标注在方法上,该方法在构造函数执行完成之后执行。

@PreDestory

标注在方法上,该方法在对象销毁之前执行。

@Value

经常与Sping EL表达式语言一起使用,注入普通字符,系统属性,表达式运算结果,其他Bean的属性,文件内容,网址请求内容,配置文件属性值等。

@EnableAsync

配置类中,通过此注解开启对异步任务的支持,叙事性AsyncConfigurer接口。(类上)

@Async

在实际执行的bean方法使用该注解来申明其是一个异步任务(方法上或类上所有的方法都将异步,需要@EnableAsync开启异步任务)

@EnableScheduling

在配置类上使用,开启计划任务的支持。(类上)

@Scheduled

来申明这是一个任务,包括cron,fixDelay,fixRate等类型。(方法上,需先开启计划任务的支持)

参考文档

https://juejin.cn/post/7001843959731339271

https://pdai.tech/md/spring/springboot/springboot-x-hello-anno.html


Spring常用注解
https://shikai.info/archives/spring-common-annotations
作者
石 凯
发布于
2023年08月26日
许可协议