springboot註釋詳解
阿新 • • 發佈:2019-02-14
屬於 cte 數據庫 beans 實現 body man 等價 toon 1.@SpringBootApplication
為復合註解,包含:
* @Configuration:表示將該類作用springboot配置文件類。
*@EnableAutoConfiguration:表示程序啟動時,自動加載springboot默認的配置。例如,如果你的classpath下存在HSQLDB,並且你沒有手動配置任何數據庫連接beans,那麽我們將自動配置一個內存型(in-memory)數據庫”。你可以將@EnableAutoConfiguration或者@SpringBootApplication註解添加到一個@Configuration類上來選擇自動配置。如果發現應用了你不想要的特定自動配置類,你可以使用@EnableAutoConfiguration註解的排除屬性來禁用它們。
* @ComponentScan:表示程序啟動時,自動掃描當前包及子包下所有類,可自動發現和裝配一些Bean。
其中@ComponentScan讓springBoot掃描到Configuration類並把它加入到程序上下文,如果掃描到有@Component、@Controller、@Service等這些註解的類,並註冊為Bean,可以自動收集所有的Spring組件,包括@Configuration類。我們經常使用@ComponentScan註解搜索beans,並結合@Autowired註解導入。可以自動收集所有的Spring組件,包括@Configuration類。我們經常使用@ComponentScan註解搜索beans,並結合@Autowired註解導入。如果沒有配置的話,Spring Boot會掃描啟動類所在包下以及子包下的使用了@Service,@Repository等註解的類。
2.@MapperScan
指定要掃描的Mapper類的包的路徑,可註解多個包,如:{"com.kfit.demo","com.kfit.user"},
如果mapper類沒有在SpringBoot主程序可以掃描的包或者子包下面,可以使用如:{"com.kfit.*.mapper","org.kfit.*.mapper"}
3. @Mapper
為了能夠被別的類進行引用,可添加@Mapper
4.@RequestMapping
提供路由信息,負責URL到Controller中的具體函數的映射。是一個用來處理請求地址映射的註解,可用於類或方法上。用於類上,表示類中的所有響應請求的方法都是以該地址作為父路徑。@RequestMapping(“/path”)表示該控制器處理所有“/path”的UR L請求。
屬性說明及應用:
* .value:指定請求的實際地址,指定的地址可以是URI Template模式
* .method:指定請求的method類型,GET、POST、PUT、DELETE等;
如:
1./*@RequestMapping("/appointments")
**@RequestMapping(method = RequestMethod.GET)
**@RequestMapping(value="/{day}", method = RequestMethod.GET)
**@RequestMapping(value="/new", method = RequestMethod.GET)
**@RequestMapping(method = RequestMethod.POST)
*/
2./*@RequestMapping(value="/owners/{ownerId}", method=RequestMethod.GET)
*/
3./*@RequestMapping("/spring-web/{symbolicName:[a-z-]+}-{version:\d\.\d\.\d}.{extension:\.[a- *z]}")
*/
註解:
value的uri值為以下三類:
A) 可以指定為普通的具體值(1./**/);
B) 可以指定為含有某變量的一類值(URI Template Patterns with Path Variables)(2./**/);
C) 可以指定為含正則表達式的一類值( URI Template Patterns with Regular Expressions)(3./**/);
* .consumes:指定處理請求的提交內容類型(Content-Type),如;application/json,text/html;
如:
/*@RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")
*方法僅處理request Content-Type為"application/json"類型的請求
*/
* .produss:指定返回的內容類型,僅當request請求頭中的(Accept)類型中包含該指定類型才返回;
如:
/*@RequestMapping(value = "/pets/{petId}", method =RequestMethod.GET,produces="application/json")
*方法僅處理request請求中Accept頭中包含了"application/json"的請求,同時暗示了返回的內容類型為application/json;
*/
* .params:指定request中必須包含某些參數值是,才讓該方法處理
如:
/*@RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET,*params="myParam=myValue")
*僅處理請求中包含了名為“myParam”,值為“myValue”的請求;
*/
* .headers:指定request中必須包含某些指定的header值,才能讓該方法處理請求。
如:
/*@RequestMapping(value = "/pets", method = RequestMethod.GET,*headers="Referer=http://www.ifeng.com/")
*僅處理request的header中包含了指定“Refer”請求頭和對應值為“http://www.ifeng.com/”的請求;
*/
5.@Autowired(自動導入)
自動把bean裏面引用的對象的setter/getter方法省略,自動幫你set/get,使用了,只需要在UserService的實現類中聲明即可。自動導入依賴的bean。byType方式。把配置好的Bean拿來用,完成屬性、方法的組裝,它可以對類成員變量、方法及構造函數進行標註,完成自動裝配的工作。當加上(required=false)時,就算找不到bean也不報錯。
如:
@Autowired
protected EntryMapper entryMapper;
6.@Bean
註解分為兩類:
1)使用Bean,即是把已經在xml文件中配置好的Bean拿來用(等價於XML中配置的bean。)完成屬性、方法的組裝;比如 @Autowired,@Resource,可以通過byTYPE(@Autowired),byNAME(@Resource)的方法獲取Bean;
2)註冊Bean,@Component,@Repository,@Controller,@Service,@Resource配合到一起,把對象、屬性、方法完美組裝。
@Bean明確地指示了一種方法,什麽方法呢——產生一個bean的方法,並且交給Spring容器管理;從這我們就明白了為啥@Bean是放在方法的註釋上了,因為它很明確地告訴被註釋的方法,你給我產生一個Bean,然後交給Spring容器,剩下的你就別管了
解釋:1.凡是子類及帶屬性、方法的類都註冊Bean到Spring中,交給它管理;
2.@Bean用在方法上,告訴Spring容器,你可以從下面這個方法中拿到一個Bean
7.@Configuration
用於定義配置類,可替換xml配置文件(兩者等同),被註解的類內部包含有一個或多個被@Bean註解的方法,這些方法將會被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext類進行掃描,並用於構建bean定義,初始化Spring容器,使用java代碼可以檢查類型安全,如果有些第三方庫需要用到xml文件,建議仍然通過@Configuration類作為項目的配置主類——可以使用@ImportResource註解加載xml配置文件。
1.1、@Configuration配置spring並啟動spring容器
1)@Configuration標註在類上,相當於把該類作為spring的xml配置文件中的<beans>,作用為:配置spring容器(應用上下文)
1.2、@Configuration啟動容器+@Bean註冊Bean,@Bean下管理bean的生命周期
2)@Bean標註在方法上(返回某個實例的方法),等價於spring的xml配置文件中的<bean>,作用為:註冊bean對象
8.@ConfigurationProperties
作用:綁定application.properties中的屬性
9.@Test
是JUnit測試的基礎,它提供了其他作用
1)指定會拋出的異常類型,如果沒有拋出異常或者拋出的異常不屬於我們指定的類型,就會算是測試失敗(@Test(expected =RuntimeException.class))
2)測試一段代碼運行時間。如:@Test(timeout=100)
10.@Select
11.@Delete
12.@Param
給參數命名,參數命名後就能根據名字得到參數值,正確的將參數傳入sql語句中
13.@Insert
14.@NonNull :
註解在參數上, 如果該類參數為 null , 就會報出異常, throw new 15.NullPointException(參數名)
16.@Cleanup :
註釋在引用變量前, 自動回收資源 默認調用 close() 方法
17.@Getter/@Setter :
註解在類上, 為類提供讀寫屬性
18.@Getter(lazy=true) :
19.@ToString :
註解在類上, 為類提供 toString() 方法
20.@EqualsAndHashCode :
註解在類上, 為類提供 equals() 和 hashCode() 方法
21.@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor :
註解在類上, 為類提供無參,有指定必須參數, 全參構造函數
22.@Data :
註解在類上, 為類提供讀寫屬性, 此外還提供了 equals()、hashCode()、toString() 方法
23.@Value :
註入Spring boot application.properties配置的屬性的值
如:
@Value(value = “#{message}”)
private String message;
24.@Builder :
註解在類上, 為類提供一個內部的 Builder
25.@SneakThrows :
26.@Synchronized :
註解在方法上, 為方法提供同步鎖
27.@Log :
28.@Log4j :
註解在類上, 為類提供一個屬性名為 log 的 log4j 的日誌對象
29.@Slf4j :
註解在類上, 為類提供一個屬性名為 log 的 log4j 的日誌對象
30.@Cleanup("dispose") org.eclipse.swt.widgets.CoolBar bar = new CoolBar(parent, 0);
31.@Cleanup InputStream in = new FileInputStream(args[0]);
32.@Cleanup OutputStream out = new FileOutputStream(args[1]);
33.@EnableAutoConfiguration 自動配置。
34.@Component可配合CommandLineRunner使用,在程序啟動後執行一些基礎任務。泛指組件,當組件不好歸類的時候,我們可以使用這個註解進行標註。
35.@RestController註解是@Controller和@ResponseBody的合集,表示這是個控制器bean,並且是將函數的返回值直 接填入HTTP響應體中,是REST風格的控制器,用於標註控制層組件(如struts中的action)
36.@PathVariable獲取參數。
37.@JsonBackReference解決嵌套外鏈問題。
38.@RepositoryRestResourcepublic配合spring-boot-starter-data-rest使用。
39.@ResponseBody
表示該方法的返回結果直接寫入HTTP responsebody中,一般在異步獲取數據時使用,用於構建RESTful的api。在使用@RequestMapping後,返回值通常解析為跳轉路徑,加上@responsebody後返回結果不會被解析為跳轉路徑,而是直接寫入HTTP response body中。比如異步獲取json數據,加上@responsebody後,會直接返回json數據。該註解一般會配合@RequestMapping一起使用。
40.@Controller:
用於定義控制器類,在spring 項目中由控制器負責將用戶發來的URL請求轉發到對應的服務接口(service層),一般這個註解在類中,通常方法需要配合註解@RequestMapping。
41.@Import:用來導入其他配置類。
42.@ImportResource:用來加載xml配置文件。
43.@Service:一般用於修飾service層的組件
44.@Repository:
使用@Repository註解可以確保DAO或者repositories提供異常轉譯,這個註解修飾的DAO或者repositories類會被ComponetScan發現並配置,同時也不需要為它們提供XML配置項。
45.@Inject:等價於默認的@Autowired,只是沒有required屬性;
46.@Qualifier:當有多個同一類型的Bean時,可以用@Qualifier(“name”)來指定。與@Autowired配合使用。@Qualifier限定描述符除了能根據名字進行註入,但能進行更細粒度的控制如何選擇候選者
如:
@Autowired
@Qualifier(value = “demoInfoService”)
private DemoInfoService demoInfoService;
47.@Resource(name=”name”,type=”type”):
沒有括號內內容的話,默認byName。與@Autowired幹類似的事。
48.@Entity:@Table(name=”“):
表明這是一個實體類。一般用於jpa這兩個註解一般一塊使用,但是如果表名和實體類名相同的話,@Table可以省略
49.@MappedSuperClass:
用在確定是父類的entity上。父類的屬性子類可以繼承。
50.@NoRepositoryBean:
一般用作父類的repository,有這個註解,spring不會去實例化該repository。
51.@Column:如果字段名與列名相同,則可以省略。
52.@Id:表示該屬性為主鍵。
53.@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”):表示主鍵生成策略是sequence(可以為Auto、IDENTITY、native等,Auto表示可在多個數據庫間切換),指定sequence的名字是repair_seq。
54.@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1):name為sequence的名稱,以便使用,sequenceName為數據庫的sequence名稱,兩個名稱可以一致。
55.@Transient:表示該屬性並非一個到數據庫表的字段的映射,ORM框架將忽略該屬性。如果一個屬性並非數據庫表的字段映射,就務必將其標示為@Transient,否則,ORM框架默認其註解為@Basic。@Basic(fetch=FetchType.LAZY):標記可以指定實體屬性的加載方式
56.@JsonIgnore:作用是json序列化時將Java bean中的一些屬性忽略掉,序列化和反序列化都受影響。
57.@JoinColumn(name=”loginId”):一對一:本表中指向另一個表的外鍵。一對多:另一個表指向本表的外鍵。
58.@OneToOne、@OneToMany、@ManyToOne:對應hibernate配置文件中的一對一,一對多,多對一。
59.@RequestParam:用在方法的參數前面。
如:
@RequestParam
String a =request.getParameter(“a”)。
60.@PathVariable:路徑變量
如:
RequestMapping(“user/get/mac/{macAddress}”)
public String getByMacAddress(@PathVariable String macAddress){
//do something;
}
61.@ControllerAdvice:包含@Component。可以被掃描到。統一處理異常。
62.@ExceptionHandler(Exception.class):用在方法上面表示遇到這個異常就執行以下方法。
springboot註釋詳解