SpringBoot的常用注解

SpringBoot的常用注解

 

(1)@SpringBootApplication: SpringBoot的重要注解，作用在入口启动类上，它是组合注解，由@Configuration、@EnableAutoConfiguration、@ComponentScan组成，通常用在主类上；

其中@ComponentScan让Spring Boot扫描到Configuration类并把它加入到程序上下文。     

(2)@Configuration：等同于Spring的XML配置文件，一般加在主类上；使用java代码可以检查类型安全。

(3)@EnableAutoConfiguration：完成自动配置,让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置，一般加在主类上；

 

(4)@ComponentScan: 组件扫描，可自动发现和装配一些Bean。扫描到有@Component、@Controller、@Service等这些注解的类，并注册为Bean，可以自动收集所有的Spring组件，包括@Configuration类。

 

(5)@Value : 注入Spring boot application.properties配置的属性的值。，比如：    

@Vale("${xibei.name}")    

private String name;     

 

@Value(value = “#{message}”)    

private String message;    

(6)@Repository: 用于标注数据访问组件，即DAO组件；使用@Repository注解可以确保DAO或者repositories提供异常转译，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项。  

 

(7)@Service: 用于标注业务层组件(服务层)；

 

(8)@RestController: 用于标注控制层组件，包含@Controller和@ResponseBody；表示这是个控制器bean,并且是将函数的返回值直 接填入HTTP响应体中,是REST风格的控制器。 

(9)@Controller: 用于标注是控制层组件，需要返回页面时请用@Controller而不是@RestController；用于定义控制器类，在spring 项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping。

 

(10)@Component: 泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注；

 

(11)@ResponseBody:表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，

加上@responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中；比如异步获取json数据，加上@responsebody后，会直接返回json数据；

 

(12)@RequestBody:参数前加上这个注解之后，认为该参数必填。表示接受json字符串转为对象 List等；

 

(13)@Autowired：自动导入。byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作；

当加上（required=false）时，就算找不到bean也不报错；

 

(14)@Bean:相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理；

 

(15)@Qualifier:当有多个同一类型的Bean时，可以用@Qualifier("name")来指定。与@Autowired配合使用；

 

(16)@Resource(name=”name”,type=”type”)：没有括号内内容的话，默认byName。与@Autowired作用类似；

 

(17)@RequestMapping:  提供路由信息，负责URL到Controller中的具体函数的映射。      

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径；       

该注解有六个属性:      

params:指定request中必须包含某些参数值是，才让该方法处理。    

headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。      

value:指定请求的实际地址，指定的地址可以是URI Template 模式。            

method:指定请求的method类型， GET、POST、PUT、DELETE等。           

consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html;      

produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回。      

 

(18)@GetMapping、@PostMapping、@PutMapping等: 相当于@RequestMapping（value=”/”，method=RequestMethod.Get\Post\Put\Delete等） 。是个组合注解；

 

(19)@RequestParam: 获取请求参数的值,用在方法的参数前面。相当于 request.getParameter()；

)@RequestParam("id") Integer id : 获取请求参数的值, 对应的传值方式: http://localhost:8081/luckmoney/hello?id=1000    

 

(20)@PathVariable:获取url中的数据。如 @GetMapping("/hello/{id}")；

@PathVariable("id") Integer id : 获取url中的数据, 对应的传值方式: http://localhost:8081/xibei/hello/100

  

(21)@Import：用来导入其他配置类。

(22)@ImportResource：用来加载xml配置文件。

(23)@ControllerAdvice：包含@Component。可以被扫描到。统一处理异常。

 

(24)@ExceptionHandler（Exception.class）：用在方法上面表示遇到这个异常就执行以下方法。

(25)@RunWith(SpringRunner.class):引入Spring对JUnit4的支持

 

(26)@WebAppConfiguration: 开启Web应用的配置，用于模拟ServletContext。

 

(27)@SpringApplicationConfiguration(classes = xxx.class) : 指定Spring Boot的启动类。