文章目录
- [Spring Boot常用注解](#Spring Boot常用注解)
-
- [1.Spring Boot 启动类注解](#1.Spring Boot 启动类注解)
- [2. 导入常用注解](#2. 导入常用注解)
- [3. 业务层常用注解](#3. 业务层常用注解)
- [4. 异常处理常用注解](#4. 异常处理常用注解)
- [5. 其他常用注解](#5. 其他常用注解)
Spring Boot常用注解
1.Spring Boot 启动类注解
java
@SpringBootApplication
public class Springboot02Application {
public static void main(String[] args) {
SpringApplication.run(Springboot02Application.class, args);
}
}
@SpringBootApplication:
申明让Spring Boot自动给程序进行必要的配置,等同于 @SpringBootConfiguration
,@EnableAutoConfiguration
,@ComponentScan
三个配置
@SpringBootConfiguration
继承至@Configuration
,其实两种功能一致,都是标注该类为配置类,读取启动类
@EnableAutoConfiguration
这个注解是SpirngBoot自动配置的核心所在,通过此注解,能所有符合自动配置条件的bean的定义加载到spring容器中。
@ComponentScan
该注解会扫描当前包及子包下面被纳入sping容器管理的类。
2. 导入常用注解
@Configuration
等同于spring的XML配置文件,使用Java代码可以检查类型安全。指出该类是 Bean 配置的信息源,相当于XML中的
<beans></beans>
,一般加在主类上。
@Bean
相当于XML中的
<bean></bean>
,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理;
@Import
用来导入其他配置类;
@ImportResource
用来加载xml配置文件;
@Autowired
自动导入依赖的bean,自动导入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错;
@Resource(name="name",type="type")
没有括号内内容的话,默认byName,与@Autowired干类似的事;
@Inject
等价于默认的@Autowired,只是没有required属性;
3. 业务层常用注解
@Component
泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注;
@Controller
用于定义控制器类,在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层),一般这个注解在类中,通常方法需要配合注解
@RequestMapping
@RestController
用于标注控制层组件(如struts中的action),是
@ResponseBody
和@Controller
的合集;
@Service
一般用于修饰service层的组件;
@Repository
用于标注数据访问组件,即DAO组件;
@ResponseBody
表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用,用于构建RESTful的api。在使用
@RequestMapping
后,返回值通常解析为跳转路径,加上@responsebody
后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。比如异步获取json数据,加上@Responsebody
后,会直接返回json数据。该注解一般会配合@RequestMapping
一起使用;
@RequestMapping
提供路由信息,负责URL到Controller中的具体函数的映射;
- params:指定request中必须包含某些参数值是,才让该方法处理;
- headers:指定request中必须包含某些指定的header值,才能让该方法处理请求;
- value:指定请求的实际地址,指定的地址可以是URI Template 模式;
- method:指定请求的method类型, GET、POST、PUT、DELETE等;
- consumes:指定处理请求的提交内容类型(Content-Type),如application/json,text/html;
- produces:指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回。
@PropertySource("classpath: ")
读取文件
@ConfigurationProperties(prefix = "")
前缀
@Value
注入 application.properties 或 application.yml 配置的属性的值;
@PathVariable
路径变量,参数与大括号里的名字一样要相同;
@Profiles
Spring Profiles 提供了一种隔离应用程序配置的方式,并让这些配置只能在特定的环境下生效。任何
@Component
或@Configuration
都能被@Profile
标记,从而限制加载它的时机;
@ConfigurationProperties
Spring Boot将尝试校验外部的配置,默认使用JSR-303(如果在classpath路径中)。你可以轻松的为你的
@ConfigurationProperties
类添加JSR-303 javax.validation约束注解;
@Mapper
一般使用在Dao层接口上,相当于一个mapper.xml文件,它的作用就是将接口生成一个动态代理类。加入了
@Mapper
注解,目的就是为了不再写mapper映射文件。这个注解就是用来映射mapper.xml文件的。使用
@mapper
后,不需要在spring配置中设置扫描地址,通过mapper.xml里面的namespace属性对应相关的mapper类,spring将动态的生成Bean后注入到ServiceImpl中
@MapperScan
当我们的一个项目中存在多个
Dao
层接口的时候,此时我们需要对每个接口类都写上@Mapper
注解,非常的麻烦,此时可以使用@MapperScan
注解来解决这个问题。让这个接口进行一次性的注入,不需要在写@Mapper
注解,@MapperScan
注解多个包,@Mapper
只能把当前接口类进行动态代理。
4. 异常处理常用注解
@ControllerAdvice
包含
@Component
,可以被扫描到,统一处理异常;
@ExceptionHandler
用在方法上面,表示遇到这个异常就执行以下方法;
5. 其他常用注解
@Transactional
事务声明
@Cacheable
声明数据缓存
@Async
多线程异步方法,在方法上表示是一个异步方法,在类上表示该类所有方法都是异步方法
@EnableAsync
开启异步任务支持,在配置类上
@EnableScheduling
在配置类上,开启对计划任务的支持
@Scheduled
在方法上,声明该方法时计划任务。支持多类型的计划任务:cron,fixDelay,fixRate