本文介绍如何在 spring boot（kotlin）中通过自定义组合注解（如 @getjson）将 @getmapping 和 @responsebody 等多个重复注解合并为一个，提升控制器代码的简洁性与可维护性。
本文介绍如何在 spring boot（kotlin）中通过自定义组合注解（如 @getjson）将 @getmapping 和 @responsebody 等多个重复注解合并为一个，提升控制器代码的简洁性与可维护性。
在 Spring Boot 开发中，REST 控制器方法常需同时声明 @GetMapping（指定路径与 HTTP 方法）和 @ResponseBody（启用 JSON 自动序列化），尤其在返回 JSON 数据时几乎成对出现。这种重复不仅冗余，还降低了代码可读性。借助 Spring 的元注解（meta-annotation）机制，我们可以将其封装为一个语义清晰、功能完整的组合注解——例如 @GetJson。
✅ 正确实现 @GetJson 组合注解（Java 定义，Kotlin 可直接使用）
虽然项目使用 Kotlin 编写控制器，但自定义注解建议用 Java 实现（兼容性更稳定，且避免 Kotlin 注解处理器潜在限制）。创建如下 Java 类：
// src/main/java/com/example/annotation/GetJson.java
import org.springframework.core.annotation.AliasFor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RequestMapping;
import java.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ResponseBody
@GetMapping(produces = "application/json")
public @interface GetJson {
@AliasFor(annotation = GetMapping.class, attribute = "value")
String[] value() default {};
}
? 关键说明：
- @ResponseBody 和 @GetMapping(...) 直接作为元注解标注在 @GetJson 上，Spring 会在运行时自动“展开”它们；
- 使用 @AliasFor 将 @GetJson.value() 映射到 @GetMapping.value()，确保路径参数可透传（支持数组形式，如 @GetJson({"/api/v1/users", "/users"})）；
- produces = "application/json" 明确指定响应媒体类型，替代手动配置 @ResponseBody + @GetMapping 的组合效果。
✅ Kotlin 控制器中使用示例
定义好注解后，在 Kotlin Controller 中即可简洁调用：
@RestController
class TestController {
@GetJson("/test-get")
fun testGet(): Map<string string> {
return mapOf("message" to "test get", "status" to "success")
}
@GetJson("/hello/{name}")
fun hello(@PathVariable name: String): String {
return "Hello, $name!"
}
}</string>
✅ 效果等同于：
@GetMapping(value = ["/test-get"], produces = ["application/json"])
@ResponseBody
fun testGet(): Map<string string> { ... }</string>
⚠️ 注意事项与最佳实践
- 包扫描要求：无需额外配置——只要 @GetJson 注解类位于 Spring Boot 主启动类 @SpringBootApplication 默认扫描路径下（或显式通过 @ComponentScan 包含），Spring 即可识别并解析该组合注解。
- 不支持继承注解属性：若需扩展（如支持 params, headers 等），须在 @GetJson 中显式声明并用 @AliasFor 映射至 @GetMapping 对应属性。
- 避免循环元注解：切勿在组合注解中重复嵌套自身或其他可能引发解析冲突的注解。
- 生产建议：可进一步封装 @PostJson、@PutJson 等，统一团队 REST 风格；也可结合 @Validated 或自定义异常处理器增强健壮性。
通过组合注解，你不仅减少了样板代码，更赋予接口语义更强的表达力——@GetJson 不仅是语法糖，更是领域意图的精准传达。
