SpringBoot注解大全

  1 package com.example.myproject;
  2 import org.springframework.boot.SpringApplication;
  3 import org.springframework.boot.autoconfigure.SpringBootApplication;
  4 
  5 @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan 
  6 public class Application {
  7    public static void main(String[] args) {
  8      SpringApplication.run(Application.class, args);
  9    }
 10 }

  1 @RequestMapping(“/test”)
  2 @ResponseBody
  3 public String test(){
  4    return”ok”;
  5 }

  1 @Controller
  2 @RequestMapping(“/demoInfo”)
  3 public class DemoController {
  4 @Autowired
  5 private DemoInfoService demoInfoService;
  6 
  7 @RequestMapping("/hello")
  8 public String hello(Map<String,Object> map){
  9    System.out.println("DemoController.hello()");
 10    map.put("hello","from TemplateController.helloHtml");
 11    //会使用hello.html或者hello.ftl模板进行渲染显示.
 12    return"/hello";
 13 }
 14 }

  1 package com.kfit.demo.web;
  2 
  3 import org.springframework.web.bind.annotation.RequestMapping;
  4 import org.springframework.web.bind.annotation.RestController;
  5 
  6 
  7 @RestController
  8 @RequestMapping(“/demoInfo2”)
  9 publicclass DemoController2 {
 10 
 11 @RequestMapping("/test")
 12 public String test(){
 13    return "ok";
 14 }
 15 }

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

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

  1 RequestMapping(“user/get/mac/{macAddress}”)
  2 public String getByMacAddress(@PathVariable String macAddress){
  3    //do something; 
  4 }

  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类型中有效

  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类型，可查看源码的注释知道

方法的标注： @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 package com.test.spring.support.configuration;
  2 
  3 @Configuration
  4 public class TestConfiguration {
  5     public TestConfiguration(){
  6         System.out.println("spring容器启动初始化。。。");
  7     }
  8 }

  1 <?xml version="1.0" encoding="UTF-8"?>
  2 <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3     xmlns:context="http://www.springframework.org/schema/context" xmlns:jdbc="http://www.springframework.org/schema/jdbc"
  4     xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"
  5     xmlns:util="http://www.springframework.org/schema/util" xmlns:task="http://www.springframework.org/schema/task" xsi:schemaLocation="
  6         http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
  7         http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
  8         http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc-4.0.xsd
  9         http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd
 10         http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
 11         http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.0.xsd
 12         http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.0.xsd" default-lazy-init="false">
 13 
 14 
 15 </beans>

  1 package com.test.spring.support.configuration;
  2 
  3 public class TestMain {
  4     public static void main(String[] args) {
  5 
  6         //@Configuration注解的spring容器加载方式，用AnnotationConfigApplicationContext替换ClassPathXmlApplicationContext
  7         ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);
  8 
  9         //如果加载spring-context.xml文件：
 10         //ApplicationContext context = new ClassPathXmlApplicationContext("spring-context.xml");
 11     }
 12 }

  1 八月 11, 2016 12:04:11 下午 org.springframework.context.annotation.AnnotationConfigApplicationContext prepareRefresh
  2 信息: Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@203e25d3: startup date [Thu Aug 11 12:04:11 CST 2016]; root of context hierarchy
  3 spring容器启动初始化。。。

  1 package com.test.spring.support.configuration;
  2 
  3 public class TestBean {
  4 
  5     public void sayHello(){
  6         System.out.println("TestBean sayHello...");
  7     }
  8 
  9     public String toString(){
 10         return "username:"+this.username+",url:"+this.url+",password:"+this.password;
 11     }
 12 
 13     public void start(){
 14         System.out.println("TestBean 初始化。。。");
 15     }
 16 
 17     public void cleanUp(){
 18         System.out.println("TestBean 销毁。。。");
 19     }
 20 }

  1 package com.test.spring.support.configuration;
  2 
  3 @Configuration
  4 public class TestConfiguration {
  5         public TestConfiguration(){
  6             System.out.println("spring容器启动初始化。。。");
  7         }
  8 
  9     //@Bean注解注册bean,同时可以指定初始化和销毁方法
 10     //@Bean(name="testNean",initMethod="start",destroyMethod="cleanUp")
 11     @Bean
 12     @Scope("prototype")
 13     public TestBean testBean() {
 14         return new TestBean();
 15     }
 16 }

  1 package com.test.spring.support.configuration;
  2 
  3 public class TestMain {
  4     public static void main(String[] args) {
  5         ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);
  6         //获取bean
  7         TestBean tb = context.getBean("testBean");
  8         tb.sayHello();
  9     }
 10 }

  1 package com.test.spring.support.configuration;
  2 
  3 //添加注册bean的注解
  4 @Component
  5 public class TestBean {
  6 
  7     public void sayHello(){
  8         System.out.println("TestBean sayHello...");
  9     }
 10 
 11     public String toString(){
 12         return "username:"+this.username+",url:"+this.url+",password:"+this.password;
 13     }
 14 }

  1 //开启注解配置
  2 @Configuration
  3 //添加自动扫描注解，basePackages为TestBean包路径
  4 @ComponentScan(basePackages = "com.test.spring.support.configuration")
  5 public class TestConfiguration {
  6     public TestConfiguration(){
  7         System.out.println("spring容器启动初始化。。。");
  8     }
  9 
 10     //取消@Bean注解注册bean的方式
 11     //@Bean
 12     //@Scope("prototype")
 13     //public TestBean testBean() {
 14     //  return new TestBean();
 15     //}
 16 }

  1 public class TestMain {
  2     public static void main(String[] args) {
  3         ApplicationContext context = new AnnotationConfigApplicationContext(TestConfiguration.class);
  4         //获取bean
  5         TestBean tb = context.getBean("testBean");
  6         tb.sayHello();
  7     }
  8 }

  1 <beans>
  2         <bean id="orderService" class="com.acme.OrderService"/>
  3                 <constructor-arg ref="orderRepository"/>
  4         </bean>
  5         <bean id="orderRepository" class="com.acme.OrderRepository"/>
  6                 <constructor-arg ref="dataSource"/>
  7         </bean>
  8 </beans>

  1 ApplicationContext ctx = new ClassPathXmlApplicationContext("application-config.xml");
  2 OrderService orderService = (OrderService) ctx.getBean("orderService");

  1 @Configuration
  2 public class ApplicationConfig {
  3 
  4         public @Bean OrderService orderService() {
  5                 return new OrderService(orderRepository());
  6         }
  7 
  8         public @Bean OrderRepository orderRepository() {
  9                 return new OrderRepository(dataSource());
 10         }
 11 
 12         public @Bean DataSource dataSource() {
 13                 // instantiate and return an new DataSource … 
 14         }
 15 }

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