SpringBoot常用注解

最新推荐文章于 2024-06-27 10:55:31 发布

原创最新推荐文章于 2024-06-27 10:55:31 发布 · 339 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#SpringBoot

Spring Boot 专栏收录该内容

4 篇文章

订阅专栏

本文详细介绍了SpringBoot中常用的核心注解，如@SpringBootApplication、@ComponentScan、@Configuration、@RestController等的功能及使用方法，帮助读者更好地理解和使用这些注解。

@SpringBootApplication

@SpringBootApplication 注解等价于以默认属性使用 @Configuration ， @EnableAutoConfiguration 和 @ComponentScan 。
在这里插入图片描述

@ComponentScan

注解在类上，扫描标注了@Controller等注解的类，注册为bean ,为@Configuration注解的类配置组件扫描指令。

@ComponentScan 注解会自动扫描指定包下的全部标有 @Component注解的类，并注册成bean，包括 @Component下的子注解@Service、@Repository、@Controller。

@Configuration

Spring Boot提倡基于Java的配置。尽管可以用一个XML源来调用SpringApplication.run() ，不过通常建议使用 @Configuration 类作为主要源。

一般定义 main 方法的类也是主要 @Configuration 的一个很好候选。并且通过使用 @ComponentScan 注解自动收集所有的Spring组件，包括 @Configuration 类。

如果需要使用基于XML的配置，建议仍旧从一个 @Configuration 类开始。可以使用附加的 @ImportResource 注解加载XML配置文件。

@EnableAutoConfiguration

启用 Spring 应用程序上下文的自动配置，试图猜测和配置您可能需要的bean。自动配置类通常采用基于你的classpath 和已经定义的 beans 对象进行应用。

被 @EnableAutoConfiguration 注解的类所在的包有特定的意义，并且作为默认配置使用。通常推荐将 @EnableAutoConfiguration 配置在 root 包下，这样所有的子包、类都可以被查找到。

@RestController

这是一个结合了 @ResponseBody 和 @Controller 的注解

如果使用@RestController注解Controller，则Controller中的方法无法返回jsp页面，或者html，配置的视图解析器 InternalResourceViewResolver不起作用，返回的内容就是Return 里的内容。
如果需要返回到指定页面，则需要用@Controller配合视图解析InternalResourceViewResolver才行。
如果需要返回JSON，XML或自定义mediaType内容到页面，则需要在对应的方法上加上@ResponseBody注解。

@ResponseBody

注解表示该方法的返回的结果直接写入 HTTP 响应正文（ResponseBody）中，一般在异步获取数据时使用。

通常是在使用 @RequestMapping 后，返回值通常解析为跳转路径，加上@Responsebody 后返回结果不会被解析为跳转路径，而是直接写入HTTP 响应正文中。

@Controller

用于标记在一个类上，使用它标记的类就是一个SpringMVC Controller 对象。分发处理器将会扫描使用了该注解的类的方法，并检测该方法是否使用了@RequestMapping 注解。

@RequestMapping

可以使用@RequestMapping 来映射URL 到控制器类，或者是到Controller 控制器的处理方法上。

当@RequestMapping 标记在Controller 类上的时候，里面使用@RequestMapping 标记的方法的请求地址都是相对于类上的@RequestMapping 而言的。

当Controller 类上没有标记@RequestMapping 注解时，方法上的@RequestMapping 都是绝对路径。这种绝对路径和相对路径所组合成的最终路径都是相对于根路径“/ ”而言的。

@RequestBody

常用来处理content-type不是默认的application/x-www-form-urlcoded编码的内容，比如说：application/json或者是application/xml等。一般情况下来说常用其来处理application/json类。

@RequestBody接收的是一个Json对象的字符串，不是一个Json对象。jax请求往往传的都是Json对象，需要用 JSON.stringify(data)的方式就能将对象变成字符串。

@Autowired

按类型注入（这个注解是属于spring的）。

默认属性required= true;当不能确定 Spring 容器中一定拥有某个类的Bean 时，可以在需要自动注入该类 Bean 的地方可以使用 @Autowired(required = false)，这等于告诉Spring：在找不到匹配Bean时也不抛出BeanCreationException 异常。

@Autowired 和 @Qualifier 结合使用时，自动注入的策略就从 byType 转变byName 了。
@Autowired可以对成员变量、方法以及构造函数进行注释，而 @Qualifier 的标注对象是成员变量、方法入参、构造函数入参。正是由于注释对象的不同，所以 Spring 不将 @Autowired 和 @Qualifier 统一成一个注释类。

@Resource

按名称装配（这个注解属于J2EE的）。

默认安照名称进行装配，名称可以通过name属性进行指定，如果没有指定name属性，当注解写在字段上时，默认取字段名进行按照名称查找，如果注解写在setter方法上默认取属性名进行装配。

当找不到与名称匹配的bean时才按照类型进行装配。但是需要注意的是，如果name属性一旦指定，就只会按照名称进行装配。

@Mapper

在Dao接口类上添加@Mapper，在编译之后会生成相应的接口实现类,但这种方式要求每一个mapper类都需要添加此注解，比较麻烦。
在这里插入图片描述

@MapperScan

通过使用@MapperScan可以指定要扫描的Mapper类的包的路径，

相当于在每一个Dao接口上写@Mapper，通常使用这个注解。
在这里插入图片描述

@Service

下图的(“UserService”)注解是告诉Spring，当Spring要创建UserServiceImpl的的实例时，bean的名字必须叫做"userService"，这样当Action需要使用UserServiceImpl的的实例时,就可以由Spring创建好的"userService"，然后注入给Action。
在这里插入图片描述