springboot注解代码Annotation整合

常见注解代码集合，方便以后查阅，后续持续更新。

Annotation简介

• 从Java1.5开始，Java增加了元数据（MetaData）的支持，也就是Annotation（注释）；

• Annotation能被用来为程序元素（类、方法、成员变量等）设置元数据；

• Annotation不能影响程序代码的执行，无论添加、删除Annotation，代码始终如一的执行；

• 如果希望让程序中的Annotataion能在 运行时其一定作用，只有通过某种配套的工具对Annotation中的信息进行访问和处理，这些工具统称APT（Annotion Processing Tool）；

Annotation基本注解

• @Override：限定重写父类方法,验证@Override下面的方法名是否是你父类中所有的，如果没有则报错，避免方法名错误。

• @Deprecated：标记已过时,用于标识某个程序元素（类、方法等）已过时，当其他程序使用已过时的类、方法时，编译器将会给出警告。该方法不可再调用。

• @SuppressWarnings：抑制编译器警告,指示被Annotation标识的程序元素（以及在该程序元素中的所有字元素）取消显示指定的编译器警告；一直作用于该程序元素的所有子元素；

lombok基本注解

• @Data:使用这个注解，就不用再去手写Getter,Setter,equals,canEqual,hasCode,toString等方法了，注解后在编译时会自动加进去。

• @AllArgsConstructor:使用后添加一个构造函数，该构造函数含有所有已声明字段属性参数。

• @NoArgsConstructor:使用后创建一个无参构造函数。

• @Builder:解决某个类有很多构造函数的情况，省去写很多构造函数的麻烦。用一个内部类去实例化一个对象，避免一个类出现过多构造函数。

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

• @toString:生成toString方法，默认情况下，会输出类名、所有属性，属性会按照顺序输出，以逗号分割。

注解(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：

• @SpringBootApplication：申明让spring boot自动给程序进行必要的配置，这个配置等同于：@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三个配置。

• @ResponseBody：表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，用于构建RESTful的api。在使用@RequestMapping后，返回值通常解析为跳转路径，加上@esponsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@Responsebody后，会直接返回json数据。该注解一般会配合@RequestMapping一起使用。

• @Controller：用于定义控制器类对Controller实现类进行标注，在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping。

• @RestController：用于标注控制层组件(如struts中的action)，@ResponseBody和@Controller的合集。

• @RequestMapping：提供路由信息，负责URL到Controller中的具体函数的映射
  @GetMapping：是@RequestMapping(method = RequestMethod.GET)的缩写。该注解将HTTP Get 映射到 特定的处理方法上。大白话即：根据HTTP地址映射调用Controller对应方法
  @PostMapping:向服务器提交信息,即客户端信息返回给服务器端。
  @PutMapping：作用与@PostMapping类似，用@PutMapping倾向于更新信息。
  @DeleteMapping： 删除URL映射

• @EnableAutoConfiguration：SpringBoot自动配置（auto-configuration）：尝试根据你添加的jar依赖自动配置你的Spring应用。例如，如果你的classpath下存在HSQLDB，并且你没有手动配置任何数据库连接beans，那么我们将自动配置一个内存型（in-memory）数据库”。你可以将@EnableAutoConfiguration或者@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,byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。当加上（required=false）时，就算找不到bean也不报错。

• @Service：一般用于修饰service层的组件用于对Service实现类进行标注,（注入dao）用于标注服务层，主要用来进行业务的逻辑处理.

• @Repository：使用@Repository注解可以确保DAO或者repositories提供异常转译实现dao访问，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项,用于对DAO实现类进行标注。

• @Bean：用@Bean标注方法等价于XML中配置的bean,相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

• @Value：注入Spring boot application.properties配置的属性的值。示例代码：

  1 2	@Value(value = “#{message}”) private String message;

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

• @Component：泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。带此注解的类看为组件，就是说当我们的类不属于各种归类的时候（不属于@Controller、@Services等的时候），我们就可以使用@Component来标注这个类。

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

  1 2 3

  @Autowired @Qualifier(value = “demoInfoService”) private DemoInfoService demoInfoService;

• @Resource(name=”name”,type=”type”)：没有括号内内容的话，默认byName。与@Autowired干类似的事。
  -
  @Resource有两个常用属性name、type，所以分4种情况：
  1、指定name和type：通过name找到唯一的bean，找不到抛出异常；如果type和字段类型不一致，也会抛出异常
  2、指定name：通过name找到唯一的bean，找不到抛出异常
  3、指定type：通过tpye找到唯一的bean，如果不唯一，则抛出异常：NoUniqueBeanDefinitionException
  4、都不指定：通过字段名作为key去查找，找到则赋值；找不到则再通过字段类型去查找，如果不唯一，则抛出异常：NoUniqueBeanDefinitionException

@Autowired
1、@Autowired只有一个属性required，默认值为true，为true时，找不到就抛异常，为false时，找不到就赋值为null。
2、@Autowired按类型查找，如果该类型的bean不唯一，则抛出异常；可通过组合注解解决@Autowired()@Qualifier(“baseDao”)

不同点：
Resource是JDK提供的，而Autowired是Spring提供的
Resource不允许找不到bean的情况，而Autowired允许（@Autowired(required = false)）
指定name的方式不一样，@Resource(name = “baseDao”),@Autowired()@Qualifier(“baseDao”)
Resource默认通过name查找，而Autowired默认通过type查找

JPA注解

• @Entity：@Table(name=”“)：表明这是一个实体类。一般用于jpa这两个注解一般一块使用，但是如果表名和实体类名相同的话，@Table可以省略

• @Table 当实体类与其映射的数据库表名不同名时需要使用，声明此对象映射到数据库的数据表，通过它可以为实体指定表(talbe)。

• @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：用在方法的参数前面。将请求参数绑定到你控制器的方法参数上（是springmvc中接收普通参数的注解）
  接收请求地址末尾为？(value的参数名)的请求

  1 2 3 4 5 6 7 8 9 10 11

  语法：@RequestParam(value=”参数名”,required=”true/false”,defaultValue=””) value：参数名 required：是否包含该参数，默认为true，表示该请求路径中必须包含该参数，如果不包含就报错。 defaultValue：默认参数值，如果设置了该值，required=true将失效，自动为false,如果没有传该参数，就使用默认值 @RequestMapping("/list") public String test(@RequestParam(value = "userId", defaultValue = "0", required = false) int userId) { 　　return "list"; }

• @PathVariable:路径变量。参数与大括号里的名字一样要相同.

  1 2 3 4

  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
2
3
4
5
6
7
8
9
10
11
12
13
14
15

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表示小数点所占的位数
    具体如下：
   1.double类型将在数据库中映射为double类型，precision和scale属性无效
   2.double类型若在columnDefinition属性中指定数字类型为decimal并指定精度，则最终以columnDefinition为准
   3.BigDecimal类型在数据库中映射为decimal类型，precision和scale属性有效
   4.precision和scale属性只在BigDecimal类型中有效

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

• @PreUpdate和@PrePersist:
  @PreUpdate
  1.用于为相应的生命周期事件指定回调方法。
  2.该注释可以应用于实体类，映射超类或回调监听器类的方法。
  3.用于setter 如果要每次更新实体时更新实体的属性，可以使用@PreUpdate注释。
  4.使用该注释，您不必在每次更新用户实体时显式更新相应的属性。
  5.preUpdate不允许您更改您的实体。 您只能使用传递给事件的计算的更改集来修改原始字段值。
  @Prepersist
  1.查看@PrePersist注释，帮助您在持久化之前自动填充实体属性。
  2.可以用来在使用jpa的时记录一些业务无关的字段，比如最后更新时间等等。生命周期方法注解（delete没有生命周期事件）
  3.@PrePersist save之前被调用，它可以返回一个DBObject代替一个空的 @PostPersist save到datastore之后被调用
  4.@PostLoad 在Entity被映射之后被调用 @EntityListeners 指定外部生命周期事件实现类
  实体Bean生命周期的回调事件:

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

  方法的标注： @PrePersist @PostPersist @PreRemove @PostRemove @PreUpdate @PostUpdate @PostLoad 。 它们标注在某个方法之前，没有任何参数。这些标注下的方法在实体的状态改变前后时进行调用，相当于拦截器; pre 表示在状态切换前触发，post 则表示在切换后触发。 @PostLoad 事件在下列情况触发： 1. 执行 EntityManager.find()或 getreference()方法载入一个实体后； 2. 执行 JPA QL 查询过后； 3. EntityManager.refresh( )方法被调用后。 @PrePersist 和 @PostPersist事件在实体对象插入到数据库的过程中发生; @PrePersist 事件在调用 EntityManager.persist()方法后立刻发生，级联保存也会发生此事件，此时的数据还没有真实插入进数据库。 @PostPersist 事件在数据已经插入进数据库后发生。 @PreUpdate 和 @PostUpdate 事件的触发由更新实体引起, @PreUpdate 事件在实体的状态同步到数据库之前触发，此时的数据还没有真实更新到数据库。 @PostUpdate 事件在实体的状态同步到数据库后触发，同步在事务提交时发生。 @PreRemove 和 @PostRemove 事件的触发由删除实体引起，@ PreRemove 事件在实体从数据库删除之前触发，即调用了 EntityManager.remove()方法或者级联删除 当你在执行各种持久化方法的时候，实体的状态会随之改变，状态的改变会引发不同的生命周期事件。这些事件可以使用不同的注释符来指示发生时的回调函数。 @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事件在实体从数据库中删除后触发。

使用@Configuration注解来代替Spring的bean配置

• Spring配置文件（application-config.xml）：

  1 2 3 4 5 6 7 8

  <beans> <bean id="orderService" class="com.acme.OrderService"/> <constructor-arg ref="orderRepository"/> </bean> <bean id="orderRepository" class="com.acme.OrderRepository"/> <constructor-arg ref="dataSource"/> </bean> </beans>

• Spring Java @Configuratio通过java代码来装配bean的方案：

  1 2 3 4 5 6 7 8 9 10 11 12

  @Configuration public class ApplicationConfig { public @Bean OrderService orderService() { return new OrderService(orderRepository()); } public @Bean OrderRepository orderRepository() { return new OrderRepository(dataSource()); } }

  使用bean

  1 2	JavaConfigApplicationContext ctx = new JavaConfigApplicationContext(ApplicationConfig.class); OrderService orderService = ctx.getBean(OrderService.class);

• ← Previous Post
• Next Post →

...

...

00:00

00:00