JAVA註解的總結及其作用

XiangdxDu發表於2024-03-10

# 一、@component
標註一個類為Spring容器的Bean,(把普通pojo例項化到spring容器中,相當於配置檔案中的<bean id="" class=""/>)。將其掃描注入到Spring容器,注入成Bean

# 二、@ServerEndpoint(value = "/server/{username}")
@ServerEndpoint 註解用於將一個Java類標記為WebSocket端點,指定客戶端可以透過指定的端點URL連線到該WebSocket端點。在註解中,value 屬性用於指定WebSocket端點的URL路徑。
@ServerEndpoint 註解的作用是定義一個WebSocket端點,用於處理WebSocket連線和通訊,實現實時的雙向資料傳輸。

# 三、@OnOpen
@OnOpen 註解的作用是定義一個方法,在WebSocket連線建立時執行特定的邏輯,允許開發人員在連線建立時進行一些自定義操作。

# 四、 @OnMessage
@OnMessage 註解的作用是定義一個方法,在伺服器端接收到客戶端傳送的訊息時執行特定的邏輯,允許開發人員處理接收到的訊息並做出相應的響應。
@OnMessage 註解標記的方法會在伺服器端接收到客戶端傳送的訊息時被呼叫,允許開發人員在方法內部處理接收到的訊息並做出相應的響應。
透過@OnMessage 註解,開發人員可以定義多個方法來處理不同型別或格式的訊息。

# 五、@OnClose
@OnClose 註解標記的方法會在客戶端與伺服器端的WebSocket連線關閉時被呼叫,允許開發人員在連線關閉時執行一些清理操作或其他邏輯

# 六、@OnError
@OnError 註解的作用是定義一個方法,在WebSocket通訊過程中發生錯誤時執行特定的邏輯,允許開發人員處理錯誤並採取適當的措施,以確保應用程式在出現問題時能夠做出正確的響應。

# 七、@Configuration
@Configuration 註解在Spring框架中起著重要的作用,用於定義配置類並配置Spring應用程式上下文中的Bean和其他元件

# 八、@Bean
@Bean 註解,用於定義Bean的方法並將物件例項註冊到Spring應用程式上下文中,為應用程式提供依賴注入和管理功能。
Spring的@Bean註解用於告訴方法,產生一個Bean物件,然後這個Bean物件交給Spring管理。 產生這個Bean物件的方法Spring只會呼叫一次,隨後這個Spring將會將這個Bean物件放在自己的IOC容器中。

# 九、@CrossOrigin
@CrossOrigin 註解在Spring框架中用於處理跨域資源共享,透過配置允許跨域訪問的源,幫助開發人員實現安全、靈活的跨域訪問控制。

# 十、@RestController
結合了@Controller 和@ResponseBody 註解的功能,表示該類中的方法返回的資料將直接寫入 HTTP 響應體中,而不是透過檢視解析器渲染檢視。

# 十一、@RequestMapping("")
@RequestMapping 註解在Spring框架中用於將 HTTP 請求對映到處理方法或控制器,實現請求的路由和處理,提供了靈活的配置選項,方便開發人員定義請求路徑的對映規則和處理邏輯。

# 十二、@RequestBody
@RequestBody 註解在Spring框架中用於從 HTTP 請求中獲取請求體資料並將其轉換為 Java 物件,方便處理客戶端傳送的資料,特別適用於處理 POST 請求中的請求體資料。

# 十三、@PathVariable
獲取 URL 中的路徑變數:透過在方法引數上新增@PathVariable 註解,並指定對應的路徑變數名,可以從請求 URL 中提取該路徑變數的值。
靈活的路徑引數處理:@PathVariable 註解使得控制器方法能夠處理包含動態路徑引數的 URL,從而實現對不同資源的訪問和操作。
支援 RESTful 風格的 API:在 RESTful 服務的設計中,@PathVariable 註解常用於從 URL 中提取資源識別符號或其他引數,實現對資源的操作。
支援多個路徑變數:@PathVariable 註解支援在一個 URL 中包含多個路徑變數,透過指定不同的@PathVariable 註解,可以獲取多個路徑變數的值。
可選路徑變數:@PathVariable 註解還支援將路徑變數設定為可選的,即在 URL 中該路徑變數可以有或者沒有,從而實現更靈活的路徑匹配。

# 十四、@RequestParam
@RequestParam 註解在Spring框架中用於從 HTTP 請求中獲取請求引數的值,支援獲取查詢引數、表單引數等型別的引數,並支援引數的預設值、必選引數等特性,使得處理請求引數變得更加方便和靈活。

# 十五、@Getter
@Getter 註解在Lombok中用於自動生成類中的 getter 方法,簡化了程式碼編寫過程,提高了程式碼的可讀性和可維護性。

# 十六、@Override
標識重寫方法:透過在子類中的方法上新增@Override 註解,明確表示該方法是重寫父類中的方法,提高程式碼的可讀性。
編譯時檢查:編譯器會在編譯時檢查帶有@Override 註解的方法是否真的重寫了父類中的方法,避免由於拼寫錯誤或方法簽名不匹配等導致的錯誤。
防止意外重寫:在父類中修改了一個方法,但是子類沒有正確地重寫該方法時,使用@Override 註解可以幫助開發者及時發現問題。
提高程式碼可維護性:透過明確標識方法的重寫關係,可以使程式碼更易於理解和維護。

# 十七、@Service
@Service 註解用於標識服務層元件,處理業務邏輯。

# 十八、@Mapper
@Mapper 註解用於標識 MyBatis 的對映器介面,定義資料庫操作的 SQL 對映。

相關文章