转自:

SpringBoot注解大全

下文笔者讲述SpringBoot注解大全简介说明，如下所示

SpringBoot注解的优点

 
1.由于使用注解,减少xml编写,可使纯java编写2.采用配置的方式,可应用面向对象的优势3.类型安全4.减少复杂配置文件

SpringBoot注解大全

@SpringBootApplication:申明让spring boot自动给程序进行必要的配置  配置等同于: @Configuration,@EnableAutoConfiguration 和 @ComponentScan 三个配置@ResponseBody:表示该方法的返回结果直接写入HTTP response body中一般在异步获取数据时使用，用于构建RESTful的api在使用@RequestMapping后，返回值通常解析为跳转路径,加上@esponsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中如:异步获取json数据,加上@Responsebody后,会直接返回json数据此注解一般会配合@RequestMapping一起使用@Controller:用于定义控制器类在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层)一般这个注解在类中,通常方法需要配合注解@RequestMapping@RestController:用于标注控制层组件(如struts中的action)@ResponseBody和@Controller的合集@RequestMapping:提供路由信息,负责URL到Controller中的具体函数的映射@EnableAutoConfiguration:SpringBoot自动配置(auto-configuration):@EnableAutoConfiguration注解的排除属性来禁用它们。@ComponentScan:该类自动发现扫描组件@Configuration:相当于传统的xml配置文件如果有些第三方库需要用到xml文件建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件@Import:用于导入其他配置类@ImportResource:用于加载xml配置文件@Autowired：自动导入依赖的bean@Service：常用于修饰service层的组件@Repository：修饰的DAO@Bean:用@Bean标注方法等价于XML中配置的bean@Value:注入Spring boot application.properties配置的属性的值 @Inject:等同于默认的@Autowired,但没有required属性@Component:泛指组件@Bean:相当于XML中放在方法的上面而不是类 @AutoWired:自动导入依赖的beanbyType方式 @Qualifier:当有多个同一类型的Bean时可使用@Qualifier(“name”)来指定与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入 @Resource(name=”name”,type=”type”)：没有括号内内容的话，默认byName。与@Autowired功能相同@PathVariable:获取参数@JsonBackReference:解决嵌套外链问题@RepositoryRestResourcepublic:配合spring-boot-starter-data-rest使用

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序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。@JoinColumn（name=”loginId”):一对一：本表中指向另一个表的外键一对多：另一个表指向本表的外键@OneToOne、@OneToMany、@ManyToOne：对应hibernate配置文件中的一对一，一对多，多对一。

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("test") 其效果等同于String test =request.getParameter("test")@PathVariable:路径变量。如
参数与大括号里的名字一样要相同

全局异常处理

@ControllerAdvice:包含@Component可以被扫描到。统一处理异常。@ExceptionHandler(Exception.class)用在方法上面表示遇到这个异常就执行以下方法

项目中具体配置解析和使用环境

@MappedSuperclass：@MappedSuperclass:注解使用在父类上面，是用来标识父类的@MappedSuperclass:标识的类表示其不能映射到数据库表因为其不是一个完整的实体类但是它所拥有的属性能够映射在其子类对用的数据库表中@MappedSuperclass:标识的类不能再有@Entity或@Table注解

@Column

当实体的属性与其映射的数据库表的列不同名时需要使用@Column标注说明，该属性通常置于实体的属性声明语句之前，还可与 @Id 标注一起使用。@Column 标注的常用属性是name，用于设置映射数据库表的列名。此外，该标注还包含其它多个属性，如：unique、nullable、length、precision等。具体如下：name属性：name属性定义了被标注字段在数据库表中所对应字段的名称unique属性：unique属性表示该字段是否为唯一标识，默认为false，如果表中有一个字段需要唯一标识，则既可以使用该标记，也可以使用@Table注解中的@UniqueConstraintnullable属性：nullable属性表示该字段是否可以为null值，默认为trueinsertable属性：insertable属性表示在使用”INSERT”语句插入数据时，是否需要插入该字段的值updateable属性：updateable属性表示在使用”UPDATE”语句插入数据时，是否需要更新该字段的值insertable和updateable属性：一般多用于只读的属性，例如主键和外键等，这些字段通常是自动生成的columnDefinition属性：columnDefinition属性表示创建表时，该字段创建的SQL语句，一般用于通过Entity生成表定义时使用，如果数据库中表已经建好，该属性没有必要使用table属性：table属性定义了包含当前字段的表名length属性：length属性表示字段的长度，当字段的类型为varchar时，该属性才有效，默认为255个字符precision属性和scale属性：precision属性和scale属性一起表示精度，当字段类型为double时，precision表示数值的总长度，scale表示小数点所占的位数具体如下：double类型将在数据库中映射为double类型，precision和scale属性无效double类型若在columnDefinition属性中指定数字类型为decimal并指定精度，则最终以columnDefinition为准BigDecimal类型在数据库中映射为decimal类型，precision和scale属性有效precision和scale属性只在BigDecimal类型中有效@Column注解:columnDefinition属性: 表示该字段在数据库中的实际类型通常ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMPString的默认映射类型为VARCHARString 类型映射到特定数据库的 BLOB 或TEXT字段类型.@Column标注：也可置于属性的getter方法之前

@Getter和@Setter(Lombok)

@Setter：注解在属性上:为属性提供 setting 方法 @Getter：注解在属性上；为属性提供 getting 方法@Data：注解在类上；提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canEqual、hashCode、toString 方法@Setter：注解在属性上；为属性提供 setting 方法@Getter：注解在属性上；为属性提供 getting 方法@Log4j2 ：注解在类上；为类提供一个 属性名为log 的 log4j 日志对象，和@Log4j注解类似@NoArgsConstructor：注解在类上；为类提供一个无参的构造方法@AllArgsConstructor：注解在类上；为类提供一个全参的构造方法@EqualsAndHashCode:默认情况下,会使用所有非瞬态(non-transient)和非静态(non-static)字段来生成equals和hascode方法，也可以指定具体使用哪些属性。@toString:生成toString方法,默认情况下,会输出类名、所有属性，属性会按照顺序输出，以逗号分割。@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor无参构造器、部分参数构造器、全参构造器，当我们需要重载多个构造器的时候，只能自己手写了@NonNull：注解在属性上当使用此注解后,则不能为Null@val:注解在属性上当注解之,就是设置为final类型可查看源码的注释知道

当运行各种持久化方法的时候实体的状态会随之改变状态的改变会引发不同的生命周期事件这些事件可以使用不同的注释符来指示发生时的回调函数
@javax.persistence.PostLoad：加载后@javax.persistence.PrePersist：持久化前@javax.persistence.PostPersist：持久化后@javax.persistence.PreUpdate：更新前@javax.persistence.PostUpdate：更新后@javax.persistence.PreRemove：删除前@javax.persistence.PostRemove：删除后

数据库查询

@PostLoad事件在下列情况下触发：运行EntityManager.find()或getreference()方法载入一个实体后运行JPQL查询后EntityManager.refresh()方法被调用后

数据库插入

@PrePersist和@PostPersist事件:在实体对象插入到数据库的过程中发生@PrePersist事件:在调用persist()方法后立刻发生此时的数据还没有真正插入进数据库。@PostPersist事件:在数据已经插入进数据库后发生。

数据库更新

@PreUpdate和@PostUpdate事件:触发由更新实体引起@PreUpdate事件:在实体的状态同步到数据库之前触发此时的数据还没有真正更新到数据库。@PostUpdate事件:在实体的状态同步到数据库之后触发同步在事务提交时发生。

数据库删除

@PreRemove和@PostRemove事件的触发由删除实体引起：@PreRemove事件在实体从数据库删除之前触发，即在调用remove()方法删除时发生，此时的数据还没有真正从数据库中删除。@PostRemove事件在实体从数据库中删除后触发