SpringBoot以及集成组件注解大全详解（一）——lomback && JPA

一、常用注解

1、@SpringbootApplication

是一个复合注解，包括@ComponentScan，和@SpringBootConfiguration，@EnableAutoConfiguration。

• @SpringBootConfiguration继承自@Configuration，二者功能也一致，标注当前类是配置类，并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到srping容器中，并且实例名就是方法名。
• @EnableAutoConfiguration的作用是启动自动的配置，意思就是Springboot根据你添加的jar包来配置你项目的默认配置，比如根据spring-boot-starter-web ，来判断你的项目是否需要添加了webmvc和tomcat，就会自动的帮你配置web项目中所需要的默认配置。
• @ComponentScan，扫描当前包及其子包下被@Component，@Controller，@Service，@Repository注解标记的类并纳入到spring容器中进行管理。是以前的<context:component-scan>（以前使用在xml中使用的标签，用来扫描包配置的平行支持）。

 

2、@Configuration 

从Spring3.0开始，@Configuration用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。

配置类注意事项：

 

 3、@RestController

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

4、@Autowired 和 @Resource

1）@Autowired与@Resource都可以用来装配bean. 都可以写在字段上,或写在setter方法上。

2）@Autowired默认按类型装配（这个注解是属业spring的），默认情况下必须要求依赖对象必须存在，如果要允许null 值，可以设置它的required属性为false，如：@Autowired(required=false) ，如果我们想使用名称装配可以结合@Qualifier注解进行使用

3）@Resource（这个注解属于J2EE的），默认安照名称进行装配，名称可以通过name属性进行指定， 
如果没有指定name属性，当注解写在字段上时，默认取字段名进行按照名称查找，如果注解写在setter方法上默认取属性名进行装配。 当找不到与名称匹配的bean时才按照类型进行装配。但是需要注意的是，如果name属性一旦指定，就只会按照名称进行装配。

5、@PathVariable

带占位符的 URL 是 Spring3.0 新增的功能，该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义，通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中：URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。

6、@JsonBackReference、@JsonManagedReference和@JsonIgnore

1）@JsonBackReference和@JsonManagedReference这两个标注通常配对使用，通常用在父子关系中。@JsonBackReference标注的属性在序列化（serialization，即将对象转换为json数据）时，会被忽略（即结果中的json数据不包含该属性的内容）。

2）@JsonManagedReference标注的属性则会被序列化。在序列化时，@JsonBackReference的作用相当于@JsonIgnore，此时可以没有@JsonManagedReference。但在反序列化（deserialization，即json数据转换为对象）时，如果没有@JsonManagedReference，则不会自动注入@JsonBackReference标注的属性（被忽略的父或子）；如果有@JsonManagedReference，则会自动注入自动注入@JsonBackReference标注的属性。  

3）@JsonIgnore直接忽略某个属性，以断开无限递归，序列化或反序列化均忽略。当然如果标注在get、set方法中，则可以分开控制，序列化对应的是get方法，反序列化对应的是set方法。在父子关系中，当反序列化时，@JsonIgnore不会自动注入被忽略的属性值（父或子），这是它跟@JsonBackReference和@JsonManagedReference最大的区别。  

7、@RequestMapping

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

8、@Import

在应用中，有时没有把某个类注入到IOC容器中，但在运用的时候需要获取该类对应的bean，此时就需要用到@Import注解。

9、ImportResource

ImportResource用来加载xml配置文件。

10、@Service、@Component、@Repository、@Controller

1. @Configuration配置类不可以是final类型；
2. @Configuration配置类不可以是匿名类；
3. 嵌套的configuration配置类必须是静态类。

@Service用于标注业务层组件，

@Controller用于标注控制层组件,

@Repository用于标注数据访问组件，即DAO组件，

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

11、@Bean

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

12、@Value

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

13、@Inject

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

14、@RequestBody

1）常用来处理content-type不是默认的application/x-www-form-urlcoded编码的内容，比如说：application/json或者是application/xml等。一般情况下来说常用其来处理application/json类型。

2）通过@requestBody可以将请求体中的JSON字符串绑定到相应的bean上，当然，也可以将其分别绑定到对应的字符串上。

3）在一些特殊情况@requestBody也可以用来处理content-type类型为application/x-www-form-urlcoded的内容，只不过这种方式不是很常用，在处理这类请求的时候，@requestBody会将处理结果放到一个MultiValueMap<String,String>中，这种情况一般在特殊情况下才会使用，例如jQuery easyUI的datagrid请求数据的时候需要使用到这种方式、小型项目只创建一个POJO类的话也可以使用这种接受方式

15、@RequestParam

用于将指定的请求参数赋值给方法中的形参。

16、@ModelAttribute

将参数绑定到Model对象

17、@Primary

自动装配时当出现多个Bean候选者时，被注解为@Primary的Bean将作为首选者，否则将抛出异常 。

18、@Qualifier

Qualifier的意思是合格者，通过这个标示，表明了哪个实现类才是我们所需要的，添加@Qualifier注解，需要注意的是@Qualifier的参数名称为我们之前定义@Service注解的名称之一。

19、@PostConstruct、@PreConstruct

1）@PostConstruct

     被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行，并且只会被服务器调用一次，类似于Serclet的inti()方法。被@PostConstruct修饰的方法会在构造函数之后，init()方法之前运行。

2）@PreConstruct

     被@PreConstruct修饰的方法会在服务器卸载Servlet的时候运行，并且只会被服务器调用一次，类似于Servlet的destroy()方法。被@PreConstruct修饰的方法会在destroy()方法之后运行，在Servlet被彻底卸载之前。

二、lomback注解

1、@Getter

实体类生成相应的get()方法

2、@Setter

实体类生成相应的set()方法

3、@Data

1）该注解使用在类上，该注解是最常用的注解，它结合了@ToString，@EqualsAndHashCode， @Getter和@Setter。本质上使用@Data注解，类默认@ToString和@EqualsAndHashCode以及每个字段都有@Setter和@getter。该注解也会生成一个公共构造函数，可以将任何@NonNull和final字段作为参数。

2）虽然@Data注解非常有用，但是它没有与其他注解相同的控制粒度。@Data提供了一个可以生成静态工厂的单一参数，将staticConstructor参数设置为所需要的名称，Lombok自动生成的构造函数设置为私有，并提供公开的给定名称的静态工厂方法。

4、@NonNull

该注解使用在属性上，该注解用于属的非空检查，当放在setter方法的字段上，将生成一个空检查，如果为空，则抛出NullPointerException。 该注解会默认是生成一个无参构造。 

5、@ToString

该注解使用在类上，该注解默认生成任何非讲台字段以名称-值的形式输出。 
1）如果需要可以通过注释参数includeFieldNames来控制输出中是否包含的属性名称。 
2）可以通过exclude参数中包含字段名称，可以从生成的方法中排除特定字段。 
3）可以通过callSuper参数控制父类的输出。
 

6、@EqualsAndHashCode

该注解使用在类上，该注解在类级别注释会同时生成equals()和hashCode()。 存在继承关系需要设置callSuper参数为true。

7、@AllArgsConstructor

该注解使用在类上，该注解提供一个全参数的构造方法，默认不提供无参构造。 

8、@NoArgsConstructor

该注解使用在类上，该注解提供一个无参构造 。

9、@RequiredArgsConstructor

该注解使用在类上，将类中所有带有 @NonNull 注解的或者带有 final 修饰的成员变量生成对应的构造方法。 

10、@Value

这个注解作用在实体类 上，会生成含所有参数的构造方法，get ()方法，此外还提供了equals()、hashCode()、toString ()方法。 
注意：没有setter ()

11、@Cleanup

该注解使用在属性前，该注解是用来保证分配的资源被释放。在本地变量上使用该注解，任何后续代码都将封装在try/finally中，确保当前作用于中的资源被释放。默认@Cleanup清理的方法为close，可以使用value指定不同的方法名称。

三、JPA注解 

1、@Entity

@Entity用于实体类，指出该Java 类为实体类，将映射到指定的数据库表。如声明一个实体类 User，它将映射到数据库中的 user 表上。

2、@Table

1）当实体类与其映射的数据库表名不同名时需要使用 @Table 标注说明，该标注与 @Entity 标注并列使用，置于实体类声明语句之前，可写于单独语句行，也可与声明语句同行。

2）@Table 标注的常用选项是 name，用于指明数据库的表名 @Table标注还有一个两个选项 catalog 和 schema 用于设置表所属的数据库目录或模式，通常为数据库名。

3、@Id

@Id 标注用于声明一个实体类的属性映射为数据库的主键列。该属性通常置于属性声明语句之前，可与声明语句同行，也可写在单独行上。 @Id标注也可置于属性的getter()方法之前。

4、@GeneratedValue

@GeneratedValue 用于标注主键的生成策略，通过 strategy 属性指定。默认情况下，JPA 自动选择一个最适合底层数据库的主键生成策略：SqlServer 对应 identity，MySQL 对应 auto increment。 在 javax.persistence.GenerationType 中定义了以下几种可供选择的策略：

IDENTITY：采用数据库 ID自增长的方式来自增主键字段，Oracle 不支持这种方式；

AUTO： JPA自动选择合适的策略，是默认选项；

SEQUENCE：通过序列产生主键，通过 @SequenceGenerator 注解指定序列名，MySql 不支持这种方式

TABLE：通过表产生主键，框架借由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植。

5、@Basic

@Basic 表示一个简单的属性到数据库表的字段的映射，默认存在。

@Basic fetch: 表示该属性的读取策略,有 EAGER 和 LAZY 两种,分别表示主支抓取和延迟加载,默认为 EAGER.

optional:表示该属性是否允许为null, 默认为true

6、@Column

当实体的属性与其映射的数据库表的列不同名时需要使用@Column 标注说明，该属性通常置于实体的属性声明语句之前，还可与 @Id 标注一起使用。

@Column 标注的常用属性是 name，用于设置映射数据库表的列名。此外，该标注还包含其它多个属性，如：unique 、nullable、length 等。

@Column 标注的 columnDefinition 属性: 表示该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR, 如果要将 String 类型映射到特定数据库的 BLOB 或TEXT 字段类型.

@Column标注也可置于属性的getter方法之前

7、@Transient

表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性，如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic

8、@Temporal

在核心的 Java API 中并没有定义 Date 类型的精度(temporal precision). 而在数据库中,表示 Date 类型的数据有 DATE, TIME, 和 TIMESTAMP 三种精度(即单纯的日期,时间,或者两者 兼备)，在进行属性映射时可使用@Temporal注解来调整精度。

9、@TableGenerator

将当前主键的值单独保存到一个数据库的表中，主键的值每次都是从指定的表中查询来获得 这种方法生成主键的策略可以适用于任何数据库，不必担心不同数据库不兼容造成的问题。

属性：

1）name 属性表示该主键生成策略的名称，它被引用在@GeneratedValue中设置的generator 值中

2）table 属性表示表生成策略所持久化的表名

3）pkColumnName 属性的值表示在持久化表中，该主键生成策略所对应键值的名称

4）valueColumnName 属性的值表示在持久化表中，该主键当前所生成的值，它的值将会随着每次创建累加

5）pkColumnValue 属性的值表示在持久化表中，该生成策略所对应的主键

6）allocationSize 表示每次主键值增加的大小, 默认值为 50