SpringBoot常⽤注解说明
⼀、注解(annotations)列表
@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使⽤。
⼆、注解(annotations)详解
@SpringBootApplication：申明让spring boot⾃动给程序进⾏必要的配置，这个配置等同于：
@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三个配置。
1 project;
2 import org.springframework.boot.SpringApplication;
3 import org.springframework.boot.autoconfigure.SpringBootApplication;
4
5 @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
6 public class Application {
7    public static void main(String[] args) {
8      SpringApplication.run(Application.class, args);
9    }
10 }
@ResponseBody：表⽰该⽅法的返回结果直接写⼊HTTP response body中，⼀般在异步获取数据时使⽤，⽤于构建RESTful的api。在使⽤@RequestMapping后，返回值通常解析为跳转路径，加上@Responsebody后返回结果不会被解析为跳转路径，⽽是直接写⼊HTTP response body中。⽐如异步获取json数据，加上@Responsebody后，会直接返回json数据。该注解⼀般会配合@RequestMapping⼀起使⽤。⽰例代码：
1 @RequestMapping(“/test”)
2 @ResponseBody
3 public String test(){
4    return”ok”;
5 }
@Controller：⽤于定义控制器类，在spring项⽬中由控制器负责将⽤户发来的URL请求转发到对应的服务接⼝（service层），⼀般这个注解在类中，通常⽅法需要配合注解@RequestMapping。⽰例代码：
1 @Controller
springboot框架的作用2 @RequestMapping(“/demoInfo”)
3 public class DemoController {
4 @Autowired
5 private DemoInfoService demoInfoService;
6
7 @RequestMapping("/hello")
8 public String hello(Map<String,Object> map){
9    System.out.println("DemoController.hello()");
10    map.put("hello","from TemplateController.helloHtml");
11    //会使⽤hello.html或者hello.ftl模板进⾏渲染显⽰.
12    return"/hello";
13 }
14 }
@RestController：⽤于标注控制层组件(如struts中的action)，@ResponseBody和@Controller的合集。⽰例代码：
1 package com.kfit.demo.web;
2
3 import org.springframework.web.bind.annotation.RequestMapping;
4 import org.springframework.web.bind.annotation.RestController;
5
6
7 @RestController
8 @RequestMapping(“/demoInfo2”)
9 publicclass DemoController2 {
10
11 @RequestMapping("/test")
12 public String test(){
13    return "ok";
14 }
15 }
@RequestMapping：提供路由信息，负责URL到Controller中的具体函数的映射。
@EnableAutoConfiguration：SpringBoot⾃动配置（auto-configuration）：尝试根据你添加的jar依赖⾃动配置你的Spring应⽤。例如，如果你的classpath下存在HSQLDB，并且你没有⼿动配置任何数据库连接beans，那么我们将⾃动配置⼀个内存型（in-memory）数据库”。你可以将@EnableAutoConfi
guration或者@SpringBootApplication注解添加到⼀个@Configuration类上来选择⾃动配置。如果发现应⽤了你不想要的特定⾃动配置类，你可以使⽤@EnableAutoConfiguration注解的排除属性来禁⽤它们。
@ComponentScan：其实很简单，@ComponentScan主要就是定义扫描的路径从中出标识了需要装配的类⾃动装配到spring的bean 容器中，你⼀定都有⽤过@Controller，@Service，@Repository注解，查看其源码你会发现，他们中有⼀个共同的注解@Component，没错@ComponentScan注解默认就会装配标识了@Controller，@Service，@Repository，@Component注解的类到spring容器中。当然，这个的前提就是你需要在所扫描包下的类上引⼊注解。
@Configuration：相当于传统的xml配置⽂件，如果有些第三⽅库需要⽤到xml⽂件，建议仍然通过@Configuration类作为项⽬的配置主类——可以使⽤@ImportResource注解加载xml配置⽂件。
@Import：⽤来导⼊其他配置类。
@ImportResource：⽤来加载xml配置⽂件。
@Autowired：⾃动导⼊依赖的bean
@Service：⼀般⽤于修饰service层的组件
@Repository：使⽤@Repository注解可以确保DAO或者repositories提供异常转译，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项。
@Bean：⽤@Bean标注⽅法等价于XML中配置的bean。
@Value：注⼊Spring boot application.properties配置的属性的值。⽰例代码：
1 @Value(value = “#{message}”)
2 private String message;
@Inject：等价于默认的@Autowired，只是没有required属性；
@Component：泛指组件，当组件不好归类的时候，我们可以使⽤这个注解进⾏标注。
@Bean：相当于XML中的，放在⽅法的上⾯，⽽不是类，意思是产⽣⼀个bean，并交给spring管理。
@AutoWired：⾃动导⼊依赖的bean。byType⽅式。把配置好的Bean拿来⽤，完成属性、⽅法的组装，它可以对类成员变量、⽅法及构造函数进⾏标注，完成⾃动装配的⼯作。当加上（required=false）时，就算不到bean也不报错。
@Qualifier：当有多个同⼀类型的Bean时，可以⽤@Qualifier(“name”)来指定。与@Autowired配合使⽤。@Qualifier限定描述符除了能根据名字进⾏注⼊，但能进⾏更细粒度的控制如何选择候选者，具体使⽤⽅式如下：
1 @Autowired
2 @Qualifier(value = “demoInfoService”)
3 private DemoInfoService demoInfoService;
@Resource(name=”name”,type=”type”)：没有括号内内容的话，默认byName。与@Autowired⼲类似的事。
三、JPA注解
@Entity：@Table(name=”“)：表明这是⼀个实体类。⼀般⽤于jpa这两个注解⼀般⼀块使⽤，但是如果表名和实体类名相同的
话，@Table可以省略
@MappedSuperClass:⽤在确定是⽗类的entity上。⽗类的属性⼦类可以继承。
@NoRepositoryBean:⼀般⽤作⽗类的repository，有这个注解，spring不会去实例化该repository。
@Column：如果字段名与列名相同，则可以省略。
@Id：表⽰该属性为主键。
@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”)：表⽰主键⽣成策略是sequence（可以为Auto、IDENTITY、native等，Auto表⽰可在多个数据库间切换），指定sequence的名字是repair_seq。
@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1)：name为sequence的名称，以便使⽤，sequenceName为数据库的sequence名称，两个名称可以⼀致。
@Transient：表⽰该属性并⾮⼀个到数据库表的字段的映射,ORM框架将忽略该属性。如果⼀个属性并⾮数据库表的字段映射，就务必将其标⽰为@Transient，否则,ORM框架默认其注解为@Basic。@Basic(fetch=FetchType.LAZY)：标记可以指定实体属性的加载⽅式
@JsonIgnore：作⽤是json序列化时将bean中的⼀些属性忽略掉，序列化和反序列化都受影响。
@JoinColumn（name=”loginId”）:⼀对⼀：本表中指向另⼀个表的外键。⼀对多：另⼀个表指向本表的外键。
@OneToOne、@OneToMany、@ManyToOne：对应配置⽂件中的⼀对⼀，⼀对多，多对⼀。
四、springMVC相关注解
@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)类型中包含该指定类型才返回
@RequestParam：⽤在⽅法的参数前⾯。
@RequestParam
String a =Parameter(“a”)。
@PathVariable：路径变量。如
1 RequestMapping(“user/get/mac/{macAddress}”)
2 public String getByMacAddress(@PathVariable String macAddress){
3    //do something;
4 }
参数与⼤括号⾥的名字⼀样要相同。
五、全局异常处理
@ControllerAdvice：包含@Component。可以被扫描到。统⼀处理异常。
@ExceptionHandler（Exception.class）：⽤在⽅法上⾯表⽰遇到这个异常就执⾏以下⽅法。
六、项⽬中具体配置解析和使⽤环境
@MappedSuperclass：
1.@MappedSuperclass 注解使⽤在⽗类上⾯，是⽤来标识⽗类的
2.@MappedSuperclass 标识的类表⽰其不能映射到数据库表，因为其不是⼀个完整的实体类，但是它所拥有的属性能够映射在其⼦类对⽤的数据库表中
3.@MappedSuperclass 标识的类不能再有@Entity或@Table注解
@Column：
1.当实体的属性与其映射的数据库表的列不同名时需要使⽤@Column标注说明，该属性通常置于实体的属性声明语句之前，还可与 @Id 标注⼀起使⽤。
2.@Column 标注的常⽤属性是name，⽤于设置映射数据库表的列名。此外，该标注还包含其它多个
属性，如：unique、nullable、length、precision等。具体如下：
1 name属性：name属性定义了被标注字段在数据库表中所对应字段的名称
2 unique属性：unique属性表⽰该字段是否为唯⼀标识，默认为false，如果表中有⼀个字段需要唯⼀标识，则既可以使⽤该标记，也可以使⽤@Table注解中的@UniqueConstraint
3 nullable属性：nullable属性表⽰该字段是否可以为null值，默认为true
4 insertable属性：insertable属性表⽰在使⽤”INSERT”语句插⼊数据时，是否需要插⼊该字段的值
5 updateable属性：updateable属性表⽰在使⽤”UPDATE”语句插⼊数据时，是否需要更新该字段的值
6 insertable和updateable属性：⼀般多⽤于只读的属性，例如主键和外键等，这些字段通常是⾃动⽣成的
7 columnDefinition属性：columnDefinition属性表⽰创建表时，该字段创建的SQL语句，⼀般⽤于通过Entity⽣成表定义时使⽤，如果数据库中表已经建
好，该属性没有必要使⽤
8 table属性：table属性定义了包含当前字段的表名
9 length属性：length属性表⽰字段的长度，当字段的类型为varchar时，该属性才有效，默认为255个字符
10 precision属性和scale属性：precision属性和scale属性⼀起表⽰精度，当字段类型为double时，precision表⽰数值的总长度，scale表⽰⼩数点所占的位数
具体如下：
1.double类型将在数据库中映射为double类型，precision和scale属性⽆效
2.double类型若在columnDefinition属性中指定数字类型为decimal并指定精度，则最终以columnDefinition为准
3.BigDecimal类型在数据库中映射为decimal类型，precision和scale属性有效
4.precision和scale属性只在BigDecimal类型中有效
3.@Column 标注的columnDefinition属性: 表⽰该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型⾃动判断数据库中字段的类型，但是对于Date类型仍⽆法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR，如果要将 String 类型映射到特定数据库的 BLOB 或TEXT字段类型.
4.@Column标注也可置于属性的getter⽅法之前
@Getter和@Setter（Lombok）
@Setter：注解在属性上；为属性提供 setting ⽅法 @Getter：注解在属性上；为属性提供 getting ⽅法
扩展：

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。