总结篇:SpringBoot常用注解总结

发布时间 2023-12-18 20:05:27作者: "贼*.猫"贼*.帅`

使用springboot开发的优点,就是不用部署war文件因为内部嵌入了tomcat的,允许通过maven来根据需要的starter,非常的方便,可以自动配置spring,为程序员减少大量时间用于写业务逻辑,更不用担心使用某个依赖的版本问题,springboot全部为你自己选择。

springboot的常用注解:

1、@SpringBootApplication:

该注解是springboot最核心注解,也是组合注解,声明它就可以让springboot自动给程序进行必要的配置(简单的说,开启组件扫描和自己配置的功能)。

2、@EnableAutoCfiguration:

使用该注解作用就是告诉springboot根据添加jar依赖猜测你想如何配置spring

3、@ComponentScan:

组件扫描,自动扫描包。并把这些类注册为Bean。

4、@SpringBootConfiguration:

是标志当前的类的配置类

5、@Configuration:

定义配置类,可以替换xml文件,如果被注解的类内部包含有一个或者多个被@Bean注解的方法。

6、@Autowired:

使用该注解作用就是进行自动注入

7、@RestController:

此注解就是@Controller和@ResponseBoby的组合,使用在controller层的,意思就是告诉控制层里面的方法都是以json的格式进行输出。

8、@Controller:

该注解用于定义控制器,在spring项目中是由控制器负责用户发来的请求,然后控制器将用户请求的URL转发到对应的接口service层,进行调用相应的业务,在使用该注解时,还用结合@RequestMapping一起使用,处理http请求。

9、@ResponseBody:

使用该注解表示方法的返回结果直接写入HTTP response body中的,当我们异步请求的时候常使用,用于构建restful的API。

10、@Repository:

该注解用于标注数据访问组件,DAO组件的。

11、@Component:

该注解指当我们组件不好归类时,就可以使用该注解进行标注。

12、@service:

该注解使用于标注业务层,当在业务层的类上使用时,bean就是自动找到该类就是service的。

13、@PathVariable:

该注解是用来绑定函数中的参数用于获取参数的,当默认的情况下,spring会对@该注解的变量进行自动赋值的,我们也可以自己指定。

14、@RequestParam注解:

是指获取请求参数的值,@GetMapping是组合注解。

一、注解(annotations)列表

1、@SpringBootApplication:

包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解
其中:@ComponentScan让SpringBoot扫描到Configuration类并把它加入到程序上下文。

2、@Configuration:

等同于spring的XML配置文件;使用Java代码可以检查类型安全。

3、@EnableAutoConfiguration:

自动配置。

4、@ComponentScan:

组件扫描,可自动发现和装配一些Bean
@ComponentScan让SpringBoot扫描到Configuration类并把它加入到程序上下文。

5、@Component:

可配合CommandLineRunner使用,在程序启动后执行一些基础任务

6、@RestController:

注解是@Controller和@ResponseBody的合集,表示这是个控制器bean,并且是将函数的返回值直接填入HTTP响应体中。

7、@Autowired:

自动注入。

8、@PathVariable:

获取参数。

9、@JsonBackReference:

解决嵌套外链问题。

10、@RepositoryRestResourcepublic:

配合spring-boot-starter-data-rest使用。

二、注解(annotations)详解

1、@SpringBootApplication:

申明让spring boot自动给程序进行必要的配置,这个配置等同于:@Configuration ,@EnableAutoConfiguration 和 @ComponentScan 三个配置。
image

2、@RequestMapping:

提供路由信息,负责URL到Controller中的具体函数的映射。

3、@Controller:

用于定义控制器类,在spring 项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层),一般这个注解在类中,通常方法需要配合注解@RequestMapping
示例代码:
image

4、@ResponseBody:

表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用。在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。比如异步获取json数据,加上@responsebody后,会直接返回json数据。该注解一般会配合@RequestMapping一起使用。
示例代码:
image
或者返回自定义的类型,如使用JsonResult类对数据结果进行封装:
image

5、@RestController:

用于标注控制层组件(如struts中的action),@ResponseBody和@Controller的合集
示例代码:
image

6、@EnableAutoConfiguration:

Spring Boot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用
例如,如果你的classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库”。你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。

7、@ComponentScan:

表示将该类自动发现扫描组件。个人理解相当于,如果扫描到有@Component、@Controller、@Service等这些注解的类,并注册为Bean,可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。如果没有配置的话,Spring Boot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。

8、@Configuration:

相当于传统的xml配置文件,如果有些第三方库需要用到xml文件,建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。

9、@Import:

用来导入其他配置类。

10、@ImportResource:

用来加载xml配置文件。

11、@Service:

一般用于修饰service层的组件

12、@Repository:

使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponentScan发现并配置,同时也不需要为它们提供XML配置项。

13、@Value:

注入Spring boot application.properties配置的属性的值。示例代码:
@Value(value = "#{message}") private String message;

14、@Inject:

等价于默认的@Autowired,只是没有required属性;

15、@Component:

泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。表示这个bean对象会由spring创建,其名字默认为类名,首字母小写

16、@Bean:

用@Bean标注方法等价于XML中配置的bean,放在方法的上面,而不是类,告诉Spring容器,你可以从下面这个方法中拿到一个Bean。
示例代码:
image

17、@AutoWired:

自动注入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。

18、@Qualifier:

当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者,具体使用方式如下:
image

19、@Resource(name="name",type="type"):

没有括号内内容的话,默认byName。与@Autowired干类似的事。

20、@Lazy:

描述Spring管理的bean对象时,可以让bean延迟构建和初始化.
延迟加载(懒加载,按需加载)应用场景:
image

21、@Scope:描述类时用于指定类实例的作用域,常用取值:

(1)singleton :

默认为单例作用域-类的实例在一个JVM内存中其实例只有一份,此作用域通常还会配置@Lazy一起使用,一般可重用对象可设计为单例,对于这样的对象spring框架不仅仅负责其创建,还会存储到bean池.

(2)prototype :

(多例作用域-此作用域对象何时需要何时创建,spring框架不负责销毁)一般不可重用对象,或者说只使用一次就不再用此对象了,这样的对象就可设计为多例作用域.

22、@PostConstruct:

此注解描述的方法为生命周期初始化方法.

23、@PreDestroy:

此注解描述的方法为生命周期销毁方法,此方法会在对象销毁之前执行(如果是多例作用域,则不会触发此方法).
示例代码:
image