SpringBoot註解最全詳解

阿新 • • 發佈：2018-11-23

一、註解(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.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";
}
}

@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配置的屬性的值。示例程式碼：

@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幹類似的事。

三、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:路徑變數。如

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

引數與大括號裡的名字一樣要相同。

五、全域性異常處理

@ControllerAdvice：包含@Component。可以被掃描到。統一處理異常。

@ExceptionHandler（Exception.class）：用在方法上面表示遇到這個異常就執行以下方法。

六、專案中具體配置解析和使用環境

@MappedSuperclass：

[email protected] 註解使用在父類上面，是用來標識父類的

[email protected] 標識的類表示其不能對映到資料庫表，因為其不是一個完整的實體類，但是它所擁有的屬效能夠對映在其子類對用的資料庫表中

[email protected] 標識的類不能再有@Entity或@Table註解

@Column：

1.當實體的屬性與其對映的資料庫表的列不同名時需要使用@Column標註說明，該屬性通常置於實體的屬性宣告語句之前，還可與 @Id 標註一起使用。

[email protected] 標註的常用屬性是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型別中有效

[email protected] 標註的columnDefinition屬性: 表示該欄位在資料庫中的實際型別.通常 ORM 框架可以根據屬性型別自動判斷資料庫中欄位的型別,但是對於Date型別仍無法確定資料庫中欄位型別究竟是DATE,TIME還是TIMESTAMP.此外,String的預設對映型別為VARCHAR,如果要將 String 型別對映到特定資料庫的 BLOB 或TEXT欄位型別.

[email protected]標註也可置於屬性的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型別，可檢視原始碼的註釋知道

@PreUpdate和@PrePersist

@PreUpdate
1.用於為相應的生命週期事件指定回撥方法。
2.該註釋可以應用於實體類，對映超類或回撥監聽器類的方法。
3.用於setter 如果要每次更新實體時更新實體的屬性，可以使用@PreUpdate註釋。
4.使用該註釋，您不必在每次更新使用者實體時顯式更新相應的屬性。
5.preUpdate不允許您更改您的實體。 您只能使用傳遞給事件的計算的更改集來修改原始欄位值。

@Prepersist
1.檢視@PrePersist註釋，幫助您在持久化之前自動填充實體屬性。
2.可以用來在使用jpa的時記錄一些業務無關的欄位，比如最後更新時間等等。生命週期方法註解（delete沒有生命週期事件）
[email protected] save之前被呼叫，它可以返回一個DBObject代替一個空的 @PostPersist save到datastore之後被呼叫 
[email protected] 在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 & @bean

[email protected]標註在類上，相當於把該類作為spring的xml配置檔案中的<beans>，作用為：配置spring容器(應用上下文)

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容器已經啟動了：

1 八月 11, 2016 12:04:11 下午 org.springframework.context.annotation.AnnotationConfigApplicationContext prepareRefresh
  2 資訊: Refreshing org.spring[email protected]203e25d3: startup date [Thu Aug 11 12:04:11 CST 2016]; root of context hierarchy
  3 spring容器啟動初始化。。。

[email protected]標註在方法上(返回某個例項的方法)，等價於spring的xml配置檔案中的<bean>，作用為：註冊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;
    }
}

配置類：

//開啟註解配置
@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.在配置中也可享受OO帶來的好處(面向物件)

3.型別安全對重構也能提供良好的支援

4.減少複雜配置檔案的同時依舊能享受到所有springIoC容器提供的功能

@RestController和@RequestMapping註解

4.0重要的一個新的改進是@RestController註解，它繼承自@Controller註解。4.0之前的版本，Spring MVC的元件都使用@Controller來標識當前類是一個控制器servlet。使用這個特性，我們可以開發REST服務的時候不需要使用@Controller而專門的@RestController。

當你實現一個RESTful web services的時候，response將一直通過response body傳送。為了簡化開發，Spring 4.0提供了一個專門版本的controller。下面我們來看看@RestController實現的定義：

@Target(value=TYPE)  
 @Retention(value=RUNTIME)  
 @Documented  
 @Controller  
 @ResponseBody  
public @interface RestController

@RequestMapping 註解提供路由資訊。它告訴Spring任何來自"/"路徑的HTTP請求都應該被對映到 home 方法。 @RestController 註解告訴Spring以字串的形式渲染結果，並直接返回給呼叫者。

注： @RestController 和 @RequestMapping 註解是Spring MVC註解（它們不是Spring Boot的特定部分）

@EnableAutoConfiguration註解

第二個類級別的註解是 @EnableAutoConfiguration 。這個註解告訴Spring Boot根據新增的jar依賴猜測你想如何配置Spring。由於 spring-boot-starter-web 添加了Tomcat和Spring MVC，所以auto-configuration將假定你正在開發一個web應用並相應地對Spring進行設定。Starter POMs和Auto-Configuration：設計auto-configuration的目的是更好的使用"Starter POMs"，但這兩個概念沒有直接的聯絡。你可以自由地挑選starter POMs以外的jar依賴，並且Spring Boot將仍舊盡最大努力去自動配置你的應用。

你可以通過將 @EnableAutoConfiguration 或 @SpringBootApplication 註解新增到一個 @Configuration 類上來選擇自動配置。
注：你只需要新增一個 @EnableAutoConfiguration 註解。我們建議你將它新增到主 @Configuration 類上。

如果發現應用了你不想要的特定自動配置類，你可以使用 @EnableAutoConfiguration 註解的排除屬性來禁用它們。

<pre name="code" class="java">import org.springframework.boot.autoconfigure.*;
import org.springframework.boot.autoconfigure.jdbc.*;
import org.springframework.context.annotation.*;
@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class MyConfiguration {
}

@Configuration

Spring Boot提倡基於Java的配置。儘管你可以使用一個XML源來呼叫 SpringApplication.run() ，我們通常建議你使用 @Configuration 類作為主要源。一般定義 main 方法的類也是主要 @Configuration 的一個很好候選。你不需要將所有的 @Configuration 放進一個單獨的類。 @Import 註解可以用來匯入其他配置類。另外，你也可以使用 @ComponentScan 註解自動收集所有的Spring元件，包括 @Configuration 類。

如果你絕對需要使用基於XML的配置，我們建議你仍舊從一個 @Configuration 類開始。你可以使用附加的 @ImportResource 註解載入XML配置檔案。

@Configuration註解該類，等價與XML中配置beans；用@Bean標註方法等價於XML中配置bean

@ComponentScan(basePackages = "com.hyxt",includeFilters = {@ComponentScan.Filter(Aspect.class)})

@SpringBootApplication

很多Spring Boot開發者總是使用 @Configuration ， @EnableAutoConfiguration 和 @ComponentScan 註解他們的main類。由於這些註解被如此頻繁地一塊使用（特別是你遵循以上最佳實踐時），Spring Boot提供一個方便的 @SpringBootApplication 選擇。
該 @SpringBootApplication 註解等價於以預設屬性使用 @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);
    }
}

Spring Boot將嘗試校驗外部的配置，預設使用JSR-303（如果在classpath路徑中）。你可以輕鬆的為你的@ConfigurationProperties類新增JSR-303 javax.validation約束註解：

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}

@Profiles

Spring Profiles提供了一種隔離應用程式配置的方式，並讓這些配置只能在特定的環境下生效。任何@Component或@Configuration都能被@Profile標記，從而限制載入它的時機。

@Configuration
@Profile("production")
public class ProductionConfiguration {
// ...
}

@ResponseBody
表示該方法的返回結果直接寫入HTTP response body中

一般在非同步獲取資料時使用，在使用@RequestMapping後，返回值通常解析為跳轉路徑，加上
@responsebody後返回結果不會被解析為跳轉路徑，而是直接寫入HTTP response body中。比如
非同步獲取json資料，加上@responsebody後，會直接返回json資料。

@Component：
泛指元件，當元件不好歸類的時候，我們可以使用這個註解進行標註。一般公共的方法我會用上這個註解

@AutoWired
byType方式。把配置好的Bean拿來用，完成屬性、方法的組裝，它可以對類成員變數、方法及構
造函式進行標註，完成自動裝配的工作。
當加上（required=false）時，就算找不到bean也不報錯。

@RequestParam：
用在方法的引數前面。

@RequestParam String a =request.getParameter("a")。

@PathVariable:
路徑變數。

RequestMapping("user/get/mac/{macAddress}")
public String getByMacAddress(@PathVariable String macAddress){
//do something;
}

引數與大括號裡的名字一樣要相同。
以上註解的示範

/**
 * 使用者進行評論及對評論進行管理的 Controller 類；
 */
@Controller
@RequestMapping("/msgCenter")
public class MyCommentController extends BaseController {
    @Autowired
    CommentService commentService;
 
    @Autowired
    OperatorService operatorService;
 
    /**
     * 新增活動評論；
     *
     * @param applyId 活動 ID；
     * @param content 評論內容；
     * @return
     */
    @ResponseBody
    @RequestMapping("/addComment")
    public Map<String, Object> addComment(@RequestParam("applyId") Integer applyId, @RequestParam("content") String content) {
        ....
        return result;
    }
}

@RequestMapping("/list/{applyId}")
    public String list(@PathVariable Long applyId, HttpServletRequest request, ModelMap modelMap) {
}

全域性處理異常的：
@ControllerAdvice：
包含@Component。可以被掃描到。
統一處理異常。

@ExceptionHandler（Exception.class）：
用在方法上面表示遇到這個異常就執行以下方法。

/**
 * 全域性異常處理
 */
@ControllerAdvice
class GlobalDefaultExceptionHandler {
    public static final String DEFAULT_ERROR_VIEW = "error";
 
    @ExceptionHandler({TypeMismatchException.class,NumberFormatException.class})
    public ModelAndView formatErrorHandler(HttpServletRequest req, Exception e) throws Exception {
        ModelAndView mav = new ModelAndView();
        mav.addObject("error","引數型別錯誤");
        mav.addObject("exception", e);
        mav.addObject("url", RequestUtils.getCompleteRequestUrl(req));
        mav.addObject("timestamp", new Date());
        mav.setViewName(DEFAULT_ERROR_VIEW);
        return mav;
    }}

通過@value註解來讀取application.properties裡面的配置

# face++ key
face_api_key = R9Z3Vxc7ZcxfewgVrjOyrvu1d-qR****
face_api_secret =D9WUQGCYLvOCIdsbX35uTH********

 @Value("${face_api_key}")
    private String API_KEY;
 
    @Value("${face_api_secret}")
    private String API_SECRET;

注意使用這個註解的時候使用@Value的類如果被其他類作為物件引用，必須要使用注入的方式，而不能new。這個很重要，我就是被這個坑了

所以一般常用的配置都是配置在application.properties檔案的

---------------------
作者：走過程式設計師的路
原文：https://blog.csdn.net/lafengwnagzi/article/details/53034369

SpringBoot註解最全詳解

@MappedSuperclass：

@NoArgsConstructor & @AllArgsConstructor（lombok）

使用@Configuration註解來代替Spring的bean配置

SpringBoot註解最全詳解

Runtime最全詳解

WEB前端之網頁設計⑤----最新最全詳解/CSS層疊樣式表

Maven 工程 POM.XML檔案最全詳解

Maven XML配置檔案最全詳解

Gilde 3.7最全詳解介紹和使用

AndroidManifest.xml 最全詳解

Android Studio配置優化最全詳解

SpringBoot 註解@ConfigurationProperties使用詳解

IDEA開發環境安裝最全詳解

常用開發庫 - 告別BeanUtils拷貝，MapStruct工具庫最全詳解

springBoot @Scheduled註解 cron表示式詳解

springmvc常用註解標簽詳解

springboot集成redis詳解

springboot(八)：RabbitMQ詳解

(轉)java之Spring（IOC）註解裝配Bean詳解

spring @Transactional註解參數詳解

spring @Transactional註解參數詳解（13）

Hibernate註解的使用詳解

Spring Boot中使用MyBatis註解配置開發詳解

SpringBoot註解最全詳解

@MappedSuperclass：

@NoArgsConstructor & @AllArgsConstructor（lombok）

使用@Configuration註解來代替Spring的bean配置

相關推薦