SpringBoot報錯，SpringBoot註解大全

SpringBoot註解

一、註解（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：申明讓Spring Boot自動給程序進行必要的配置，這個配置等同於：@Configuration，@EnableAutoConfiguration和@ComponentScan三個配置。

package com.taofuli.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication //相當於 @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

@ResponseBody：表示該方法的返回結果直接寫入HTTP response body中，一般在異步獲取數據時使用，用於構建RESTful的api。在使用@RequestMapping後，返回值通常解析爲跳轉路徑，加上@Responsebody後返回結果不會被解析爲跳轉路徑，而是直接寫入HTTP response body中。比如異步獲取json數據，加上@Responsebody後，會直接返回json數據。該註解一般會配合@RequestMapping一起使用。

示例：

@RequestMapping("/test")
@ResponseBody
public String test() {
    return "ok";
}

@Controller：用於定義控制器類，在Spring項目中有控制器負責將用戶發來的URL請求轉發到對應的服務接口（service層），一般這個註解在類中，通常方法需要配合註解@RequestMapping。

示例：

@RequestMapping：提供路由信息，負責URL到Controller中的具體函數的映射。

@EnableAutoConfiguration：

​ SpringBoot自動配置（auto-configuration）：嘗試根據你添加的jar依賴自動配置你的Spring應用。例如，如果你是classpath下存在HSQLDB,並且你沒有手動配置任何數據庫連接beans，那麼我們將自動配置一個內存型（in-memory）數據庫。你可以將@EnableAutoConfiguration或者SpringBootApplication註解添加到一個@Configuration類上來選擇自動配置。如果發現應用了你不想要的特定自動配置類，你可以使用@EnableAutoConfiguration註解的排除屬性來禁用它們。

@ComponentScan：主要是定義掃描的路徑從中找出標識了需要裝配的類自動裝配到Spring的Bean容器中，你一定都有用過@Controller，@Service，@Repository註解，查看其源代碼會發現，他們中有一個共同的註解@Component，沒錯@ComponentScan註解默認會裝配標識了@Controller，@Service，@Repository，@Component註解的類到Spring容器中。當然，這個的前提就是你需要在所掃描的包下的類上引入註解。

@Configuration：相當於傳統的XML配置文件，如果有些第三方庫需要用到XML文件，建議仍然通過@Configuration類作爲項目的配置主類----可以使用@ImportResources註解加載xml配置文件。

**@Import：**用來導入其它配置類。

@ImportResource：用來加載xml配置文件。

@Autowired：自動導入依賴的bean。

@Service：一般用於修飾service層的組件。

@Repository：使用@Repository註解可以確保Dao或者repositories提供異常轉換，這個註解修飾的DAO或者repositories類會被ComponentScan發現並配置，同時也不需要爲它們提供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限定描述符除了能根據名字進行注入，還能進行更細粒度的控制如何選擇候選者，具體使用方式如下：

@Aurowired
@Qualifier(value="demoService")
private DemoService demoService;

@Resource(name=“name”,type=“type”)：沒有括號中的內容話，默認byName。與@Autowired幹類似的事。

三、JPA註解

@Entity：@Table(name="")：表明這是一個實體類。一般用於JPA這兩個註解一般一塊使用，但是如果表名和實體類名相同的話，@Table可以省略。

@MappedSuperClasss:用在確定是父類的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)：標記可以指定實體屬性的加載方式。

@JoinColumn（name=“loginId”）:一對一：本表中指向另一個表的外鍵。一對多：另一個表指向本表的外鍵。

@OneToOne、***@OneToMany***、***@ManyToOne***：對應Hibernate配置文件中的一對一，一對多，多對一。

四、SpringMVC相關注解

@RequestMapping：@RequestMapping（“/path”）表示該控制器處理所有“/path”的URL請求。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、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 方法
擴展：

@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

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生命週期的回調事件

方法的標註： @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事件在實體從數據庫中刪除後觸發。

@NoArgsConstructor & @AllArgsConstructor（lombok）

@NoArgsConstructor，提供一個無參的構造方法。

@AllArgsConstructor，提供一個全參的構造方法。

@Configuration & @bean1.@Configuration標註在類上，相當於把該類作爲spring的xml配置文件中的<beans>，作用爲：配置spring容器(應用上下文)

---

例：@Bean標註在方法上（返回某個實例的方法），等價於spring的xml配置文件中的,作用爲：註冊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類：

配置類：

//開啓註解配置
@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"/>
        </bean>
</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. 在配置中也可享受面向對象帶來的好處(bean)
3. 對重構也能提供良好的支持
4. 減少複雜配置文件的同時，依舊能享受到所有springIOC容器提供的功能