Java批注在2004年隨Java 5一起引入，是一種將元數據添加到Java源代碼中的方法。 如今，許多主要框架（如Spring或Hibernate）都嚴重依賴注釋。

在本文中，我們將介紹一個非常有用的Spring功能，該功能允許我們基于一個或多個Spring注釋創建自己的注釋。

編寫自定義注釋

假設我們有一組經常一起使用的Spring注釋。 一個常見的示例是@Service和@Transactional的組合：

@Service @Transactional (rollbackFor = Exception. class , timeout = 5 ) public class UserService { ... }

不必一遍又一遍地重復兩個注釋，我們可以創建包含這兩個Spring注釋的自己的注釋。 創建我們自己的注釋非常簡單，如下所示：

@Service @Transactional (rollbackFor = Exception. class , timeout = 5 ) @Retention (RetentionPolicy.RUNTIME) public @interface MyService {}

注釋是使用@interface關鍵字定義的（而不是類或接口）。 標準Java注釋@Retention用于指示注釋應在運行時可處理。 我們還將兩個Spring注釋都添加到了注釋中。

現在，我們可以使用自己的@MyService批注來批注我們的服務：

@MyService public class UserService { ... }

Spring現在檢測到@MyService被@Service和@Transactional注釋，并提供與前面的示例相同的行為，并且在UserService類中存在兩個注釋。

請注意，這是Spring注釋處理方式的功能，而不是一般的Java功能。 如果將其他框架和庫的注釋添加到自己的注釋中，則它們可能無法正常工作。

用例范例

自定義注釋可以在各種情況下使用，以提高代碼的可讀性。 這是另外兩個可能派上用場的例子。

也許我們在代碼的各個位置都需要一個屬性值。 通常使用Spring的@Value注釋注入屬性：

// injects configuration properties my.api.key @Value ( "${my.api.key}" ) private String apiKey;

在這種情況下，我們可以將屬性表達式從代碼中移到單獨的注釋中：

@Value ( "${my.api.key}" ) @Retention (RetentionPolicy.RUNTIME) public @interface ApiKey {}

現在，在我們的代碼中，我們可以使用@ApiKey而不是在各處重復屬性表達式：

@ApiKey private String apiKey;

另一個例子是集成測試。 在測試中，通常使用各種Spring批注來定義測試設置。 可以使用自定義注釋將這些注釋分組在一起。 例如，我們可以創建一個@MockMvcTest注釋，該注釋定義模擬mvc測試的Spring設置：

@SpringBootTest @AutoConfigureMockMvc (secure = false ) @TestPropertySource (locations = "classpath:test.properties" ) @ExtendWith (SpringExtension. class ) @Retention (RetentionPolicy.RUNTIME) public @interface MockMvcTest {}

現在，我們的測試定義看起來更加清晰。 我們只需要添加@MockMvcTest即可獲得完整的測試設置：

@MockMvcTest public class MyTest { ... }

請注意，我們的@MockMvcTest批注還包含JUnit 5的@ExtendWith批注。與Spring一樣，如果將其添加到您自己的自定義批注中，JUnit 5也能夠檢測到此批注。 請注意，如果仍在使用JUnit 4，這將無法正常工作。對于JUnit 4，您必須使用@RunWith而不是@ExtendWith。 不幸的是，@RunWith僅在直接放在測試類中時才起作用。

春天的例子

Spring在各種情況下都使用此功能來定義常用注釋的快捷方式。

這里有一些例子：

• @GetMapping是@RequestMapping的簡短版本（方法= {RequestMethod.GET}）。
• @RestController是@Controller和@ResponseBody的組合。
• @SpringBootApplication是@ SpringBootConfiguration，@ EnableAutoConfiguration和@ComponentScan的快捷方式

您可以通過查看Spring源代碼中這些注釋的定義來自己驗證。

翻譯自: https://www.javacodegeeks.com/2020/02/composing-custom-annotations-with-spring.html

總結

以上是生活随笔為你收集整理的用Spring组成自定义注释的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。