用Spring组合自定义的注释 - mscharhag

20-03-01 banq

在本文中,我们将介绍一个非常有用的Spring功能,该功能允许我们基于一个或多个Spring注释创建自己的注释。

假设我们有一组经常一起使用的Spring注释。一个常见的示例是@Service和@Transactional的组合:

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

如果希望在所有服务类上用这两个注释,现在不必一遍又一遍地重复注释了,我们可以创建一个新注释包含这两个注释。创建我们自己的注释非常简单,如下所示:

@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 {
    ...
}

 

              

猜你喜欢