天天看點

@column注解_Spring Boot 注解大全,一鍵收藏!一、注解 (annotations) 清單二、注解 (annotations) 詳解三、JPA 注解四、springMVC 相關注解五、全局異常處理

@column注解_Spring Boot 注解大全,一鍵收藏!一、注解 (annotations) 清單二、注解 (annotations) 詳解三、JPA 注解四、springMVC 相關注解五、全局異常處理

來源 | www.cnblogs.com/tanwei81/p/6814022.html

一、注解 (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 三個配置。 @ResponseBody:表示該方法的傳回結果直接寫入 HTTP response body 中,一般在異步擷取資料時使用,用于建構 RESTful 的 api。在使用 @RequestMapping 後,傳回值通常解析為跳轉路徑,加上 @responsebody 後傳回結果不會被解析為跳轉路徑,而是直接寫入 HTTP response body 中。比如異步擷取 json 資料,加上 @responsebody 後,會直接傳回 json 資料。該注解一般會配合 @RequestMapping 一起使用。示例代碼: @Controller:用于定義控制器類,在 spring 項目中由控制器負責将使用者發來的 URL 請求轉發到對應的服務接口(service 層)一般這個注解在類中,通常方法需要配合注解 @RequestMapping。示例代碼: @RestController:用于标注控制層元件 (如 struts 中的 action),@ResponseBody 和 @Controller 的合集。示例代碼: @RequestMapping:提供路由資訊,負責 URL 到 Controller 中的具體函數的映射。 @EnableAutoConfiguration:Spring Boot 自動配置(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 類。如果沒有配置的話,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 配置的屬性的值。示例代碼: @Inject:等價于預設的 @Autowired,隻是沒有 required 屬性; @Component:泛指元件,當元件不好歸類的時候,我們可以使用這個注解進行标注。 @Bean:相當于 XML 中的, 放在方法的上面,而不是類,意思是産生一個 bean, 并交給 spring 管理。 @AutoWired:自動導入依賴的 bean。byType 方式。把配置好的 Bean 拿來用,完成屬性、方法的組裝,它可以對類成員變量、方法及構造函數進行标注,完成自動裝配的工作。當加上(required=false)時,就算找不到 bean 也不報錯。 @Qualifier:當有多個同一類型的 Bean 時,可以用 @Qualifier(“name”) 來指定。與 @Autowired 配合使用。@Qualifier 限定描述符除了能根據名字進行注入,但能進行更細粒度的控制如何選擇候選者,具體使用方式如下: @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: 路徑變量。如 參數與大括号裡的名字一樣要相同。

五、全局異常處理

@ControllerAdvice:包含 @Component。可以被掃描到。統一處理異常。 @ExceptionHandler(Exception.class):用在方法上面表示遇到這個異常就執行以下方法。