下面要给大家带来的是Spring Boot注解的整理，你知道它的注解都有哪些吗?这些注解的作用都是什么呢?一起来了解一下吧。
1、注解(annotations)列表
2、注解(annotations)详解
@SpringBootApplication-申明让spring boot自动给程序进行必要的配置，这个配置等同于：@Configuration @EnableAutoConfiguration和@ComponentScan三个配置。
package com.example.myproject;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}@ResponseBody-表示这个方法的返回结果直接写入HTTP response body当中，通常在异步获取数据的时候使用，用于构建RESTful的api。
在使用@RequestMapping之后，返回值一般解析成跳转路径，加上@esponsebody之后，返回结果不会被解析成跳转路径，而是直接写入HTTP response body当中。
例如：异步获取json数据，加上@Responsebody之后，会直接返回json数据。
这个注解一般会配合@RequestMapping一起使用。
示例代码：
@RequestMapping(“/test”)
@ResponseBody public String test() {
return” ok”;
}@Controller-用于定义控制器类，在spring项目当中，由控制器负责将用户发来的URL请求转发到对应的服务接口(service层)，通常这个注解在类中，一般方法需要配合注解@RequestMapping。
示例代码：
@Controller
@RequestMapping(“/demoInfo”)
public class DemoController {
@Autowired
private DemoInfoService demoInfoService;
@RequestMapping("/hello")
public String hello(Map < String, Object > map) {
System.out.println("DemoController.hello()");
map.put("hello", "from TemplateController.helloHtml");
//会使用hello.html或者hello.ftl模板进行渲染显示.
return "/hello";
}
}@RestController-用于标注控制层组件(例如struts当中的action)，@ResponseBody和@Controller的合集。
示例代码：
package com.kfit.demo.web;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping(“/demoInfo2”)
publicclass DemoController2 {
@RequestMapping("/test")
public String test() {
return "ok";
}
15
}@RequestMapping-提供路由信息，负责URL到Controller中的具体函数的映射。
@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
@Service-一般用来修饰service层的组件
@Repository-使用@Repository注解可以确保DAO或者repositories提供异常转译，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项。
@Bean-用@Bean标注方法等价于XML中配置的bean。
@Value-注入Spring boot application.properties配置的属性的值。
示例代码：
@Value(value = “# { message }”)
private String message;@Inject-等价于默认的@Autowired，只是没有required属性。
@Component-泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。
@Bean-相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。
@AutoWired-自动导入依赖的bean。byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。当加上(required=false)时，就算找不到bean也不报错。
@Qualifier-当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入，但能进行更细粒度的控制如何选择候选者。
具体使用方式：
@Autowired @Qualifier(value = “demoInfoService”) private DemoInfoService demoInfoService;
@Resource(name=”name”,type=”type”)：没有括号内内容的话，默认byName。与@Autowired干类似的事。
3、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配置文件中的一对一，一对多，多对一。
4、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-路径变量。
例如：
RequestMapping(“user / get / mac / { macAddress }”)
public String getByMacAddress(@PathVariable String macAddress) {
//do something;
}参数与大括号里的名字一样要相同。
5、全局异常处理
@ControllerAdvice-包含@Component。
可以被扫描到。
统一处理异常。
@ExceptionHandler(Exception.class)-用在方法上面表示遇到这个异常就执行以下方法。
6、项目中具体配置解析和使用环境
@MappedSuperclass：
(1)@MappedSuperclass注解使用在父类上面，是用来标识父类的;
(2)@MappedSuperclass标识的类表示其不能映射到数据库表，因为其不是一个完整的实体类，但是它所拥有的属性能够映射在其子类对用的数据库表中;
(3)@MappedSuperclass标识的类不能再有@Entity或@Table注解;
@Column：
(1)当实体的属性与其映射的数据库表的列不同名时需要使用@Column标注说明，该属性通常置于实体的属性声明语句之前，还可与 @Id 标注一起使用;
(2)@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类型中有效
(3)@Column标注的columnDefinition属性-表示该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR,如果要将 String 类型映射到特定数据库的 BLOB 或TEXT字段类型.
(4)@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类型， 可查看源码的注释知道
@PreUpdate和@PrePersist
@PreUpdate 用于为相应的生命周期事件指定回调方法。 该注释可以应用于实体类， 映射超类或回调监听器类的方法。 用于setter 如果要每次更新实体时更新实体的属性， 可以使用 @PreUpdate注释。 使用该注释， 您不必在每次更新用户实体时显式更新相应的属性。 preUpdate不允许您更改您的实体。 您只能使用传递给事件的计算的更改集来修改原始字段值。 @Prepersist 查看 @PrePersist注释， 帮助您在持久化之前自动填充实体属性。 可以用来在使用jpa的时记录一些业务无关的字段， 比如最后更新时间等等。 生命周期方法注解（ delete没有生命周期事件） @PrePersist save之前被调用， 它可以返回一个DBObject代替一个空的 @PostPersist save到datastore之后被调用 @PostLoad 在Entity被映射之后被调用 @EntityListeners 指定外部生命周期事件实现类
实体Bean生命周期的回调事件
方法的标注： @PrePersist @PostPersist @PreRemove @PostRemove @PreUpdate @PostUpdate @PostLoad。 它们标注在某个方法之前， 没有任何参数。 这些标注下的方法在实体的状态改变前后时进行调用， 相当于拦截器; pre 表示在状态切换前触发， post 则表示在切换后触发。 @PostLoad 事件在下列情况触发： 执行 EntityManager.find() 或 getreference() 方法载入一个实体后； 执行 JPA QL 查询过后； 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事件在实体从数据库中删除后触发。
@NoArgsConstructor & @AllArgsConstructor(lombok)
@NoArgsConstructor，提供一个无参的构造方法。
@AllArgsConstructor，提供一个全参的构造方法。
@Configuration &
@bean1.@Configuration标注在类上，相当于把该类作为spring的xml配置文件中的
package com.test.spring.support.configuration;
@Configuration
public class TestConfiguration {
public TestConfiguration() {
System.out.println("spring容器启动初始化。。。");
}
}相当于：
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:jdbc="http://www.springframework.org/schema/jdbc" xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:util="http://www.springframework.org/schema/util" xmlns:task="http://www.springframework.org/schema/task" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc-4.0.xsd http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.0.xsd http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.0.xsd" default-lazy-init="false"> </beans>
主方法进行测试：
package com.test.spring.support.configuration;
public class TestMain {
public static void main(String[] args) {
//@Configuration注解的spring容器加载方式，用AnnotationConfigApplicationContext替换ClassPathXmlApplicationContext
ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);
//如果加载spring-context.xml文件：
//ApplicationContext context = new ClassPathXmlApplicationContext("spring-context.xml");
}
}从运行主方法结果可以看出，spring容器已经启动：
八月 11, 2016 12: 04: 11 下午 org.springframework.context.annotation.AnnotationConfigApplicationContext prepareRefresh 信息: Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext @203e25d3: startup date[Thu Aug 11 12: 04: 11 CST 2016]; root of context hierarchy spring容器启动初始化。。。
2.@Bean标注在方法上(返回某个实例的方法)，等价于spring的xml配置文件中的，作用为：注册bean对象
bean类：
package com.test.spring.support.configuration;
public class TestBean {
public void sayHello() {
System.out.println("TestBean sayHello...");
}
public String toString() {
return "username:" + this.username + ",url:" + this.url + ",password:" + this.password;
}
public void start() {
System.out.println("TestBean 初始化。。。");
}
public void cleanUp() {
System.out.println("TestBean 销毁。。。");
}
}配置类：
package com.test.spring.support.configuration;
@Configuration
public class TestConfiguration {
public TestConfiguration() {
System.out.println("spring容器启动初始化。。。");
}
//@Bean注解注册bean,同时可以指定初始化和销毁方法
//@Bean(name="testNean",initMethod="start",destroyMethod="cleanUp")
@Bean
@Scope("prototype")
public TestBean testBean() {
return new TestBean();
}
}主方法测试类：
package com.test.spring.support.configuration;
public class TestMain {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);
//获取bean
TestBean tb = context.getBean("testBean");
tb.sayHello();
}
}注：
(1)、@Bean注解在返回实例的方法上，如果未通过@Bean指定bean的名称，则默认与标注的方法名相同;
(2)、@Bean注解默认作用域为单例singleton作用域，可通过@Scope(“prototype”)设置为原型作用域;
(3)、既然@Bean的作用是注册bean对象，那么完全可以使用@Component、@Controller、@Service、@Ripository等注解注册bean，当然需要配置@ComponentScan注解进行自动扫描。
bean类：
package com.test.spring.support.configuration;
//添加注册bean的注解
@Component
public class TestBean {
public void sayHello() {
System.out.println("TestBean sayHello...");
}
public String toString() {
return "username:" + this.username + ",url:" + this.url + ",password:" + this.password;
}
}配置类：
/开启注解配置 2 @Configuration
//添加自动扫描注解，basePackages为TestBean包路径
@ComponentScan(basePackages = "com.test.spring.support.configuration")
public class TestConfiguration {
public TestConfiguration() {
System.out.println("spring容器启动初始化。。。");
}
//取消@Bean注解注册bean的方式
//@Bean
//@Scope("prototype")
//public TestBean testBean() {
// return new TestBean();
//}
}主方法测试获取bean对象：
public class TestMain {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);
//获取bean
TestBean tb = context.getBean("testBean");
tb.sayHello();
}
}sayHello()方法都被正常调用。
使用@Configuration注解来代替Spring的bean配置
下面是一个典型的Spring配置文件(application-config.xml)：
<beans> <bean id="orderService" class="com.acme.OrderService"/> <constructor-arg ref="orderRepository"/> </bean> <bean id="orderRepository" class="com.acme.OrderRepository"/> <constructor-arg ref="dataSource"/>undefined</bean>undefined</beans>
之后就能够像这样来使用是bean：
ApplicationContext ctx = new ClassPathXmlApplicationContext("application-config.xml");
OrderService orderService = (OrderService) ctx.getBean("orderService");现在Spring Java Configuration这个项目提供了一种通过java代码来装配bean的方案：
@Configuration
public class ApplicationConfig
{
public @Bean OrderService orderService()
{
return new OrderService(orderRepository());
}
public @Bean OrderRepository orderRepository()
{
return new OrderRepository(dataSource());
}
public @Bean DataSource dataSource()
{
// instantiate and return an new DataSource …
}
}然后你就可以像这样来使用是bean了：
JavaConfigApplicationContext ctx = new JavaConfigApplicationContext(ApplicationConfig.class); OrderService orderService = ctx.getBean(OrderService.class);
这么做的好处?
1.使用纯java代码，不在需要xml
2.在配置中也可享受OO带来的好处(面向对象)
3.类型安全对重构也能提供良好的支持
4.减少复杂配置文件的同时依旧能享受到所有springIoC容器提供的功能
更多相关内容，请继续通过本站的常见问题栏目来了解。
推荐阅读：