关于注解:SpringBoot注解最全详解整合超详细版本

46次阅读

共计 7266 个字符,预计需要花费 19 分钟才能阅读完成。

应用注解的劣势:

1. 采纳纯 java 代码,不在须要配置繁冗的 xml 文件

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

3. 类型平安对重构能够提供良好的反对

4. 缩小简单配置文件的同时亦能享受到 springIoC 容器提供的性能

一、注解详解(装备了欠缺的释义)——(可采纳 ctrl+F 来进行搜寻哦~~~~)

@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 应用。

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

@PathVariable: 门路变量。如

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

五、全局异样解决

@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 办法

1 @Data:注解在类上;提供类所有属性的 getting 和 setting 办法,此外还提供了 equals、canEqual、hashCode、toString 办法
  2 
  3 @Setter:注解在属性上;为属性提供 setting 办法
  4 
  5 @Getter:注解在属性上;为属性提供 getting 办法
  6 
  7 @Log4j2:注解在类上;为类提供一个 属性名为 log 的 log4j 日志对象,和 @Log4j 注解相似
  8 
  9 @NoArgsConstructor:注解在类上;为类提供一个无参的构造方法
 10 
 11 @AllArgsConstructor:注解在类上;为类提供一个全参的构造方法
 12 
 13 @EqualsAndHashCode: 默认状况下,会应用所有非瞬态(non-transient) 和非动态 (non-static) 字段来生成 equals 和 hascode 办法,也能够指定具体应用哪些属性。
 14 
 15 @toString: 生成 toString 办法,默认状况下,会输入类名、所有属性,属性会依照程序输入,以逗号宰割。
 16 
 17 @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor
 18 无参结构器、局部参数结构器、全参结构器,当咱们须要重载多个结构器的时候,只能本人手写了
 19 
 20 @NonNull:注解在属性上,如果注解了,就必须不能为 Null
 21 
 22 @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 事件在实体从数据库中删除后触发。

正文完
 0