SpringBoot中必須掌握的45個註解
- 2020 年 2 月 24 日
- 筆記
1.SpringBoot/spring
@SpringBootApplication:
包含@Configuration、@EnableAutoConfiguration、@ComponentScan通常用在主類上；
@Repository:
用於標註數據訪問組件，即DAO組件；
@Service:
用於標註業務層組件；
@RestController:
用於標註控制層組件(如struts中的action)，包含@Controller和@ResponseBody；
@Controller:
用於標註是控制層組件，需要返回頁面時請用@Controller而不是@RestController；
@Component:
泛指組件，當組件不好歸類的時候，我們可以使用這個註解進行標註；
@ResponseBody:
表示該方法的返回結果直接寫入HTTP response body中，一般在異步獲取數據時使用，在使用@RequestMapping後，返回值通常解析為跳轉路徑，
加上@responsebody後返回結果不會被解析為跳轉路徑，而是直接寫入HTTP response body中；比如異步獲取json數據，加上@responsebody後，會直接返回json數據；
@RequestBody:
參數前加上這個註解之後，認為該參數必填。表示接受json字符串轉為對象 List等；
@ComponentScan:
組件掃描。個人理解相當於，如果掃描到有@Component @Controller @Service等這些註解的類，則把這些類註冊為bean*；
@Configuration:
指出該類是 Bean 配置的信息源，相當於XML中的，一般加在主類上；
@Bean:
相當於XML中的,放在方法的上面，而不是類，意思是產生一個bean,並交給spring管理；
@EnableAutoConfiguration:
讓 Spring Boot 根據應用所聲明的依賴來對 Spring 框架進行自動配置，一般加在主類上；
@AutoWired:
byType方式。把配置好的Bean拿來用，完成屬性、方法的組裝，它可以對類成員變量、方法及構造函數進行標註，完成自動裝配的工作；
當加上（required=false）時，就算找不到bean也不報錯；
@Qualifier:
當有多個同一類型的Bean時，可以用@Qualifier(「name」)來指定。與@Autowired配合使用；
@Resource(name=」name」,type=」type」)：
沒有括號內內容的話，默認byName。與@Autowired干類似的事；
@RequestMapping:
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)類型中包含該指定類型才返回。
@GetMapping、@PostMapping等:
相當於@RequestMapping（value=」/」，method=RequestMethod.GetPostPutDelete等） 。是個組合註解；
@RequestParam:
用在方法的參數前面。相當於 request.getParameter()；
@PathVariable:
路徑變量。如 RequestMapping(「user/get/mac/{macAddress}」) ；
public String getByMacAddress( @PathVariable(「macAddress」) String macAddress){ //do something; }
參數與大括號里的名字相同的話，註解後括號里的內容可以不填。
2.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配置文件中的一對一，一對多，多對一。
3.全局異常處理
@ControllerAdvice:
包含@Component。可以被掃描到。統一處理異常；
@ExceptionHandler(Exception.class):
用在方法上面表示遇到這個異常就執行以下方法。
4.springcloud
@EnableEurekaServer:
用在springboot啟動類上，表示這是一個eureka服務註冊中心；
@EnableDiscoveryClient:
用在springboot啟動類上，表示這是一個服務，可以被註冊中心找到；
@LoadBalanced:
開啟負載均衡能力；
@EnableCircuitBreaker:
用在啟動類上，開啟斷路器功能；
@HystrixCommand(fallbackMethod=」backMethod」):
用在方法上，fallbackMethod指定斷路回調方法；
@EnableConfigServer:
用在啟動類上，表示這是一個配置中心，開啟Config Server；
@EnableZuulProxy:
開啟zuul路由，用在啟動類上；
@SpringCloudApplication:
包含
@SpringBootApplication
@EnableDiscovertyClient
@EnableCircuitBreaker
分別是SpringBoot註解、註冊服務中心Eureka註解、斷路器註解。對於SpringCloud來說，這是每一微服務必須應有的三個註解，所以才推出了@SpringCloudApplication這一註解集合。
