【Spingboot】Springboot注解大全

使用注解的优势：

 1.采用纯java代码，不在需要配置繁杂的xml文件

 2.在配置中也可享受面向对象带来的好处

 3.类型安全对重构可以提供良好的支持

 4.减少复杂配置文件的同时亦能享受到springIoC容器提供的功能

---

一、注解（注解）列表

@SpringBootApplication：包含了@ComponentScan，@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan让spring Boot扫描到Configuration类并把它加入到程序清单中。

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

@EnableAutoConfiguration自动配置。

@ComponentScan组件扫描，可自动发现和装配一些Bean。

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

@RestController注解是@Controller和@ResponseBody的合集，表示这是一个控制器bean，并且是将函数的返回值直接填充到HTTP响应体中，是REST风格的控制器。

@Autowired自动导入。

@PathVariable获取参数。

@JsonBackReference解决嵌套外链问题。

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

二、注解（注解）详解

@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);
  }
}

@ ResponseBody：表示该方法的返回结果直接写入HTTP响应正文，一般在异步获取数据时使用，用于生成RESTful的api。在使用@RequestMapping后，返回值通常解析为替换路径，加上@ responsebody后返回结果不会被解析为转换路径，而是直接写入HTTP响应正文。。垂直初始化获取json数据，加上@responsebody后，会直接返回json数据。该注解一般会配合@RequestMapping一起使用。示例代码：

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

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

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

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

@RestController：用于标注控制层组件（如struts中的动作），@ResponseBody和@Controller的合集。

package com.kfit.demo.web;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
@RequestMapping("/demoInfo2")
publicclass DemoController2 {

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

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

@EnableAutoConfiguration：Spring Boot自动配置（自动配置）：尝试根据您添加的jar依赖自动配置自己的Spring应用程序。例如，如果您的类路径下存在HSQLDB，并且您没有手动配置任何数据库连接bean，那么我们将你可以将
@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类，你可以使用@ EnableAutoConfiguration注解的排除属性来代替它们。

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

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

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

@ImportResource：用于加载xml配置文件。

@Autowired：自动导入依赖的bean

@Service：一般用于修饰服务层的组件

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

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

@Value：注入Spring Boot application.properties配置的属性的值。示例代码：

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

@Inject：等价于默认的@Autowired，只是没有必填属性

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

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

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

@Qualifier：当有多个相同类型的Bean时，可以用@Qualifier（“名称”）来指定。与@Autowired配合使用。@Qualifier限定除了另外可以根据名字进行注入，但能进行更细粒度的控制如何选择预设者，具体使用方式如下：

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

@Resource(name = "name", type = "type")：没有括号内内容的话，被按名称。与@Autowired干类似的事。

三、JPA注解

@Entity和@Table(name = "")：表明这是一个实体类。一般使用jpa这两个注解一般一块使用，但是如果表名和实体类名相同的话，@Table可以省略

@MappedSuperClass：用在确定是父类的实体上。父类的属性子类可以继承。

@NoRepositoryBean：一般利用父类的存储库，有这个注解，spring不会去实例化该存储库。

@Column：如果基线名与列名相同，则可以省略。

@Id：表示该属性主要键。

@GeneratedValue(strategy = GenerationType.SEQUENCE，generator ="repair_seq")：表示主键生成策略是序列（可以为Auto，IDENTITY，native等，自动表示可在多个数据库间切换），指定序列的名字就是repair_seq。

@SequenceGeneretor(name = "repair_seq", sequenceName ="seq_repair", allocationSize = 1)：名称为序列的名称，名称使用，sequenceName为数据库的序列名称，两个名称可以一致。

@Transient：表示该属性并非一个到数据库表的串行映射，ORM框架将忽略该属性。如果一个属性非数据库表的偏移映射，则将其指示为@Transient，否则，ORM框架为其注解为@Basic。@Basic（fetch = FetchType.LAZY）：标记可以指定实体属性的加载方式

@JsonIgnore：作用是json序列化时将Java JavaBean中的一些属性忽略掉，序列化和反序列化都受到干扰。

@JoinColumn（name = "loginId"）：一对一：本表中指向另一个表的外键。一对多：另一个表指向本表的外键。

@ OneToOne，@ OneToMany，@ ManyToOne：对应的休眠配置文件中的一对一，一对多，多对一。

四、springMVC相关注解

@RequestMapping("path")：表示该控制器处理所有“/路径”的url请求。RequestMapping是一个用来处理请求地址映射的，用于柯林斯类或方法上用于类上，表示类中的所有响应请求的。该注解有六个属性： PARAMS：指定请求中必须包含某些参数值是，才让该方法处理。标题：指定请求中必须包含某些指定的报头值，才能让该方法处理请求。值：指定请求的实际地址，指定的地址可以是URI模板模式方法：指定请求的方法类型，GET，POST，PUT，DELETE等消耗：指定处理请求的提交内容类型（Content-Type），如application/json，text/html; 产生：指定返回的内容类型，仅当request请求头中的（接受）类型中包含该指定类型才返回