springboot注解大全

1.注解（annotations）列表

@SpringBootApplication:
包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。
其中@ComponentScan讓spring Boot掃描到Configuration類并把它加入到程序上下文。

@Configuration
等同于spring的XML配置文件；使用Java代碼可以檢查類型安全。

@EnableAutoConfiguration
自動配置。

@ComponentScan
組件掃描，可自動發(fā)現(xiàn)和裝配一些Bean。

@Component
可配合CommandLineRunner使用，在程序啟動后執(zhí)行一些基礎(chǔ)任務(wù)。

@RestController
是@Controller和@ResponseBody的合集,表示這是個控制器bean,并且是將函數(shù)的返回值直 接填入HTTP響應(yīng)體中,是REST風格的控制器。

@Autowired
自動導(dǎo)入。

@PathVariable
獲取參數(shù)。

@JsonBackReference
解決嵌套外鏈問題。

@RepositoryRestResourcepublic
配合spring-boot-starter-data-rest使用。

=======================================================

2.注解(annotations)詳解

@SpringBootApplication：
申明讓springboot自動給程序進行必要的配置，這個配置等同于：@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：
表示該方法的返回結(jié)果直接寫入HTTP response body中，一般在異步獲取數(shù)據(jù)時使用，用于構(gòu)建RESTful的api。
在使用@RequestMapping后，返回值通常解析為跳轉(zhuǎn)路徑，加上@responsebody后返回結(jié)果不會被解析為跳轉(zhuǎn)路徑，而是直接寫入HTTP response body中。
比如異步獲取json數(shù)據(jù)，加上@responsebody后，會直接返回json數(shù)據(jù)。
該注解一般會配合@RequestMapping一起使用。示例代碼：

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

@Controller：
用于定義控制器類，在spring 項目中由控制器負責將用戶發(fā)來的URL請求轉(zhuǎn)發(fā)到對應(yīng)的服務(wù)接口（service層）
一般這個注解在類中，通常方法需要配合注解@RequestMapping。
示例代碼：

@Controller
@RequestMapping(“/demoInfo”)
publicclass DemoController {
    @Autowired
    private DemoInfoService demoInfoService;

    @RequestMapping("/hello")
    public String hello(Map 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中的具體函數(shù)的映射。

@EnableAutoConfiguration：
Spring Boot自動配置（auto-configuration）：嘗試根據(jù)你添加的jar依賴自動配置你的Spring應(yīng)用。
例如，如果你的classpath下存在HSQLDB，并且你沒有手動配置任何數(shù)據(jù)庫連接beans，那么我們將自動配置一個內(nèi)存型（in-memory）數(shù)據(jù)庫”。
你可以將@EnableAutoConfiguration或者@SpringBootApplication注解添加到一個@Configuration類上來選擇自動配置。
如果發(fā)現(xiàn)應(yīng)用了你不想要的特定自動配置類，你可以使用@EnableAutoConfiguration注解的排除屬性來禁用它們。

@ComponentScan：
表示將該類自動發(fā)現(xiàn)掃描組件。
個人理解相當于，如果掃描到有@Component、@Controller、@Service等這些注解的類，并注冊為Bean，可以自動收集所有的Spring組件，包括@Configuration類。
我們經(jīng)常使用@ComponentScan注解搜索beans，并結(jié)合@Autowired注解導(dǎo)入?？梢宰詣邮占械腟pring組件，包括@Configuration類。
如果沒有配置的話，Spring Boot會掃描啟動類所在包下以及子包下的使用了@Service,@Repository等注解的類。

@Configuration：
相當于傳統(tǒng)的xml配置文件，如果有些第三方庫需要用到xml文件，建議仍然通過@Configuration類作為項目的配置主類——可以使用@ImportResource注解加載xml配置文件。

@Import：
用來導(dǎo)入其他配置類。

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

@Autowired：
自動導(dǎo)入依賴的bean

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

@Repository：
使用@Repository注解可以確保DAO或者repositories提供異常轉(zhuǎn)譯，這個注解修飾的DAO或者repositories類會被ComponetScan發(fā)現(xiàn)并配置，同時也不需要為它們提供XML配置項。

@Bean：
用@Bean標注方法等價于XML中配置的bean。

@Value：
注入Spring boot application.properties配置的屬性的值。
示例代碼：

@Bean
    @ConditionalOnProperty(prefix = "springboot_template", name = "cluster", havingValue = "false")
    public DefaultWebSessionManager sessionManager(@Value("${springboot_template.globalSessionTimeout:3600}") long globalSessionTimeout) {
        DefaultWebSessionManager sessionManager = new DefaultWebSessionManager ();
        /* 開啟session會話任務(wù)調(diào)度效驗 */
        sessionManager.setSessionValidationSchedulerEnabled ( true );
        /* 去掉shiro登錄時url里的JSESSIONID */
        sessionManager.setSessionIdUrlRewritingEnabled ( false );
        /* 會話驗證間隔 */
        sessionManager.setSessionValidationInterval ( globalSessionTimeout * 1000 );
        /* 會話超時 */
        sessionManager.setGlobalSessionTimeout ( globalSessionTimeout * 1000 );

        return sessionManager;
    }

yml文件示列：

springboot_template:
  cluster: false  #集群配置  true集群環(huán)境   false單機環(huán)境，還需打開pom.xml里的spring-session-data-redis注釋
  globalSessionTimeout: 3600   #單機環(huán)境，session過期時間為60分鐘
  redis:
    open: false  #是否開啟redis緩存  true開啟   false關(guān)閉

@Inject：
等價于默認的@Autowired，只是沒有required屬性；

@Component：
泛指組件，當組件不好歸類的時候，我們可以使用這個注解進行標注。

@Bean：
相當于XML中的,放在方法的上面，而不是類，意思是產(chǎn)生一個bean,并交給spring管理。

@AutoWired：
自動導(dǎo)入依賴的bean。byType方式。把配置好的Bean拿來用，完成屬性、方法的組裝，它可以對類成員變量、方法及構(gòu)造函數(shù)進行標注，完成自動裝配的工作。當加上（required=false）時，就算找不到bean也不報錯。

@Qualifier：
當有多個同一類型的Bean時，可以用@Qualifier(“name”)來指定。與@Autowired配合使用。@Qualifier限定描述符除了能根據(jù)名字進行注入，但能進行更細粒度的控制如何選擇候選者，具體使用方式如下：

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

@Resource(name=”name”,type=”type”)：
沒有括號內(nèi)內(nèi)容的話，默認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表示可在多個數(shù)據(jù)庫間切換），指定sequence的名字是repair_seq。

@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1)：
name為sequence的名稱，以便使用，sequenceName為數(shù)據(jù)庫的sequence名稱，兩個名稱可以一致。

@Transient：
表示該屬性并非一個到數(shù)據(jù)庫表的字段的映射,ORM框架將忽略該屬性。
如果一個屬性并非數(shù)據(jù)庫表的字段映射,就務(wù)必將其標示為@Transient,否則,ORM框架默認其注解為@Basic。@Basic(fetch=FetchType.LAZY)：標記可以指定實體屬性的加載方式

@JsonIgnore：
作用是json序列化時將Java bean中的一些屬性忽略掉,序列化和反序列化都受影響。

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

@OneToOne、@OneToMany、@ManyToOne：
對應(yīng)hibernate配置文件中的一對一，一對多，多對一。

=======================================================

4.springMVC相關(guān)注解

@RequestMapping：
@RequestMapping(“/path”)表示該控制器處理所有“/path”的UR L請求。
RequestMapping是一個用來處理請求地址映射的注解，可用于類或方法上。
用于類上，表示類中的所有響應(yīng)請求的方法都是以該地址作為父路徑。該注解有六個屬性：
params:指定request中必須包含某些參數(shù)值是，才讓該方法處理。
headers:指定request中必須包含某些指定的header值，才能讓該方法處理請求。
value:指定請求的實際地址，指定的地址可以是URI Template 模式
method:指定請求的method類型， GET、POST、PUT、DELETE等
consumes:指定處理請求的提交內(nèi)容類型（Content-Type），如application/json,text/html;
produces:指定返回的內(nèi)容類型，僅當request請求頭中的(Accept)類型中包含該指定類型才返回

@RequestParam：
用在方法的參數(shù)前面。
@RequestParam
String a =request.getParameter(“a”)。

@PathVariable:
路徑變量。如

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

參數(shù)與大括號里的名字一樣要相同。

=======================================================

5.全局異常處理

@ControllerAdvice：
包含@Component?？梢员粧呙璧?。統(tǒng)一處理異常。
其中@RestControllerAdvice與其功能相似

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

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容