Spring Boot 相关注解大全(需要时候查询)

Spring Boot 相关注解大全(需要时候查询)

一.springboot注解

1.@SpringBootApplication

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

示例代码:

package com.example.myproject;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

2.@ResponseBody

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

比如异步获取 json 数据，加上 @responsebody 后，会直接返回 json 数据。

该注解一般会配合 @RequestMapping 一起使用

示例代码:

@RequestMapping(“/test”)
@ResponseBody
public String test(){
    return”ok”;
}

3.@Controller

用于定义控制器类，在 spring 项目中由控制器负责将用户发来的 URL 请求转发到对应的服务接口（service 层）

一般这个注解在类中，通常方法需要配合注解 @RequestMapping。

示例代码:

@Controller
@RequestMapping(“/demoInfo”)
publicclass DemoController {
    @Autowired
    private DemoInfoService demoInfoService;

    @RequestMapping("/hello")
    public String hello(Map map){
        System.out.println("DemoController.hello()");
        map.put("hello","from TemplateController.helloHtml");
        //会使用hello.html或者hello.ftl模板进行渲染显示.
        return"/hello";
    }
}

4.@RestController

@ResponseBody 和 @Controller 的合集。

示例代码:

@RestController
@RequestMapping(“/demoInfo2”)
publicclass DemoController2 {

    @RequestMapping("/test")
    public String test(){
        return"ok";
    }
}

5.@RequestMapping

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

6.@EnableAutoConfiguration

Spring Boot 自动配置（auto-configuration）：尝试根据你添加的 jar 依赖自动配置你的 Spring 应用。

例如，如果你的 classpath 下存在 HSQLDB，并且你没有手动配置任何数据库连接 beans，那么我们将自动配置一个内存型（in-memory）数据库”。

你可以将 @EnableAutoConfiguration 或者 @SpringBootApplication 注解添加到一个 @Configuration 类上来选择自动配置。

如果发现应用了你不想要的特定自动配置类，你可以使用 @EnableAutoConfiguration 注解的排除属性来禁用它们。

7.@ComponentScan

表示将该类自动发现扫描组件

8.@Configuration

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

9.@Import

用来导入其他配置类。

10.@ImportResource

用来加载 xml 配置文件。

11.@Autowired

自动导入依赖的 bean

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

12.@Service

一般用于修饰 service 层的组件

13.@Repository

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

14.@Bean

用 @Bean 标注方法等价于 XML 中配置的 bean。

相当于 XML 中的, 放在方法的上面，而不是类，意思是产生一个 bean, 并交给 spring 管理。

15.@Value

注入 Spring boot application.properties 配置的属性的值。

示例代码:

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

16.@Inject

等价于默认的 @Autowired，只是没有 required 属性；

17.@Component

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

18.@Qualifier

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

示例代码:

@Autowired
@Qualifier(value = “demoInfoService”)
private DemoInfoService demoInfoService;

19.@Resource

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

示例:

@Resource(name=”name”,type=”type”)

二.springmvc注解

1.@RequestMapping

@RequestMapping(“/path”)表示该控制器处理所有 “/path” 的 UR L 请求。

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) 类型中包含该指定类型才返回

2.@RequestParam

用在方法的参数前面。
@RequestParam
String a =request.getParameter(“a”)。

3.@PathVariable

路径变量

@RequestMapping(“user/get/mac/{macAddress}”)
public String getByMacAddress(@PathVariable String macAddress){
    //do something;
}

三.全局异常处理

1.@ControllerAdvice

包含 @Component。可以被扫描到。统一处理异常。

2.@ExceptionHandler

用在方法上面表示遇到这个异常就执行以下方法。