SpringBoot注解最全详解

最新推荐文章于 2024-05-03 01:25:32 发布

渣渣苏

最新推荐文章于 2024-05-03 01:25:32 发布

阅读量547

点赞数

文章标签： springboot 注解 mybatis-plus lombok

本文链接：https://blog.csdn.net/su2231595742/article/details/116373891

版权

文章目录

SpringBoot注解最全详解(整合超详细版本)

SpringBoot注解最全详解(整合超详细版本)

使用注解的优势：

采用纯java代码，不在需要配置繁杂的xml文件
在配置中也可享受面向对象带来的好处
类型安全对重构可以提供良好的支持
减少复杂配置文件的同时亦能享受到springIoC容器提供的功能

一、注解详解（配备了完善的释义）

@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）：尝试根据你添加的jar依赖自动配置你的Spring应用。例如，如果你的classpath下存在HSQLDB，并且你没有手动配置任何数据库连接beans，那么我们将自动配置一个内存型（in-memory）数据库”。你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类，你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。

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

@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配置的属性的值。示例代码：

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

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

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

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

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

@Resource(name=”name”,type=”type”)： 没有括号内内容的话，默认byName。与@Autowired干类似的事。

二、注解列表如下

@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使用。推荐：Java面试练题宝典

三、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配置文件中的一对一，一对多，多对一。

四、Mybatis-plus注解

@TableName：表名，写在实体类上

@Tabled：主键

@TableField：字段注解(非主键)

@Version：乐观锁注解、标记 @Verison 在字段上

@EnumValue：通枚举类注解(注解在枚举字段上)

@TableLogic：表字段逻辑处理注解（逻辑删除）

@SqlParser：租户注解目前只支持注解在 mapper 的方法上(3.1.1开始支持注解在mapper上)

@KeySequence：序列主键策略 oracle

五、lombok注解

@Data： 在JavaBean中使用，注解包含包含getter、setter、NoArgsConstructor注解

@Value注解和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法

@getter： 在JavaBean中使用，注解会生成对应的getter方法

@setter： 在JavaBean中使用，注解会生成对应的setter方法

@NoArgsConstructor： 在JavaBean中使用，注解会生成对应的无参构造方法

@AllArgsConstructor： 在JavaBean中使用，注解会生成对应的有参构造方法

@RequiredArgsConstructor ： 生成private构造方法，使用staticName选项生成指定名称的static方法。

@ToString： 在JavaBean中使用，注解会自动重写对应的toStirng方法

@ToString(exclude={“column1”,“column2”})： 排除多个column列所对应的元素
@ToString(of={“column1”,“column2”})： 只生成包含多个column列所对应的元素

@NonNull： 注解在属性上，如果注解了，就必须不能为Null

@val： 注解在属性上，如果注解了，就是设置为final类型，

@EqualsAndHashCode： 在JavaBean中使用，注解会自动重写对应的equals方法和hashCode方法

@Slf4j： 在需要打印日志的类中使用，项目中使用slf4j日志框架

@Log4j： 在需要打印日志的类中使用，项目中使用log4j日志框架

@NonNull： 注解快速判断是否为空,为空抛出java.lang.NullPointerException

@Synchronized： 注解自动添加到同步机制，生成的代码并不是直接锁方法,而是锁代码块，作用范围是方法上

@Cleanup： 注解用于确保已分配的资源被释放（IO的连接关闭）

@Accessors(chain = true)： 链式风格，在调用set方法时，返回这个类的实例对象

@RequiredArgsContructor(staticName = “of”)： 生成一个静态方法，用于构建本类对象，与@NonNull联用，指定那些属性是本方法参数

@Builder： 构建者模式

@Delegate： 代理模式

六、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 =request.getParameter(“a”)。

@PathVariable: 路径变量。

参数与大括号里的名字一样要相同。

七、Swagger常用注解

Swagger注解	简单说明
@Api(tags = “xxx模块说明”)	作用在模块类上
@ApiOperation(“xxx接口说明”)	作用在接口方法上
@ApiModel(“xxxPOJO说明”)	作用在模型类上：如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true)	作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”)	作用在参数、方法和字段上，类似@ApiModelProperty
@ApiIgnore()	用于类，方法，方法参数，表示这个方法或者类被忽略

六、全局异常处理

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

@ExceptionHandler（Exception.class）：用在方法上面表示遇到这个异常就执行以下方法。推荐：Java面试练题宝典

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

@MappedSuperclass：

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

@Column：

当实体的属性与其映射的数据库表的列不同名时需要使用@Column标注说明，该属性通常置于实体的属性声明语句之前，还可与 @Id 标注一起使用。
@Column 标注的常用属性是name，用于设置映射数据库表的列名。此外，该标注还包含其它多个属性，如：unique、nullable、length、precision等。

具体如下：
- name属性：name属性定义了被标注字段在数据库表中所对应字段的名称
- unique属性：unique属性表示该字段是否为唯一标识，默认为false，如果表中有一个字段需要唯一标识，则既可以使用该标记，也可以使用@Table注解中的@UniqueConstraint
- nullable属性：nullable属性表示该字段是否可以为null值，默认为true
- insertable属性：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还是TIMESTAMP.此外,String的默认映射类型为VARCHAR,如果要将 String 类型映射到特定数据库的 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：删除后。
1）数据库查询

@PostLoad事件在下列情况下触发：

执行EntityManager.find()或getreference()方法载入一个实体后。

执行JPQL查询后。

EntityManager.refresh()方法被调用后。

2）数据库插入
@PrePersist和@PostPersist事件在实体对象插入到数据库的过程中发生：

@PrePersist事件在调用persist()方法后立刻发生，此时的数据还没有真正插入进数据库。

@PostPersist事件在数据已经插入进数据库后发生。

3）数据库更新
@PreUpdate和@PostUpdate事件的触发由更新实体引起：

@PreUpdate事件在实体的状态同步到数据库之前触发，此时的数据还没有真正更新到数据库。

@PostUpdate事件在实体的状态同步到数据库之后触发，同步在事务提交时发生。

4）数据库删除
@PreRemove和@PostRemove事件的触发由删除实体引起：

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

@PostRemove事件在实体从数据库中删除后触发。