Kotlin中如何强制类的所有公开方法返回ApiResponse类型

首先，仅靠普通Kotlin接口无法完全实现“所有公开方法必须返回ApiResponse”的编译期约束——因为接口只能约束自身声明的方法签名，实现类仍可新增未被接口定义的公开方法，且这些方法的返回类型不受接口限制。

但可以通过以下两种方式实现编译期强制约束，满足你的临时需求：

方案1：抽象类+强制方法声明（简单易实现） #

定义一个抽象类ApiController，将所有可能用到的API方法都声明为抽象方法，且返回类型固定为ApiResponse。实现类必须重写这些方法，同时可以通过团队规范配合IDE检查，限制实现类新增未被抽象类定义的公开方法。

示例代码：

data class ApiResponse(val code: Int, val data: Any?)

abstract class ApiController {
    abstract fun getExample(): ApiResponse
    abstract fun postExample(body: String): ApiResponse
    // 按需添加所有API路由对应的抽象方法
}

class ExampleApiController : ApiController() {
    override fun getExample(): ApiResponse {
        return ApiResponse(200, "success")
    }

    override fun postExample(body: String): ApiResponse {
        return ApiResponse(201, "created")
    }

    // 若新增如下公开方法，编译不会报错，但可通过IDE规则或团队约定禁止
    // fun invalidMethod(): String { return "error" }
}

这种方案无需额外依赖，上手快；缺点是不够灵活，需要提前枚举所有API方法，且无法完全阻止实现类新增违规方法（需配合规范）。

方案2：编译期注解处理器（严格强制约束） #

通过自定义注解处理器，在编译阶段扫描所有标记为API控制器的类，检查其所有公开方法的返回类型是否为ApiResponse，若存在不符合的方法则直接抛出编译错误。

步骤大致如下：

1. 定义一个标记注解，比如@ApiController。
2. 编写Kotlin注解处理器，实现AbstractProcessor，在核心逻辑中：
   • 扫描所有带有@ApiController的类。
   • 遍历类的所有公开方法，检查返回类型是否匹配ApiResponse。
   • 若发现违规方法，调用编译工具链抛出错误提示。

示例核心代码片段：

// 定义标记注解
@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.SOURCE)
annotation class ApiController

// 注解处理器核心逻辑
class ApiResponseCheckerProcessor : AbstractProcessor() {
    override fun process(annotations: MutableSet<out TypeElement>, roundEnv: RoundEnvironment): Boolean {
        val apiResponseType = processingEnv.elementUtils.getTypeElement("com.yourpackage.ApiResponse").asType()
        roundEnv.getElementsAnnotatedWith(ApiController::class.java).forEach { element ->
            if (element is TypeElement) {
                element.enclosedElements.filterIsInstance<ExecutableElement>().forEach { method ->
                    if (Modifier.isPublic(method.modifiers) && method.returnType != apiResponseType) {
                        processingEnv.messager.printMessage(
                            Diagnostic.Kind.ERROR,
                            "API控制器方法必须返回ApiResponse类型",
                            method
                        )
                    }
                }
            }
        }
        return true
    }

    override fun getSupportedAnnotationTypes(): MutableSet<String> {
        return mutableSetOf(ApiController::class.java.canonicalName)
    }

    override fun getSupportedSourceVersion(): SourceVersion {
        return SourceVersion.latestSupported()
    }
}

这种方案能严格在编译期强制约束所有公开方法的返回类型，但需要编写注解处理器，有一定学习成本，适合需要强约束的场景。

临时方案推荐 #

如果只是临时使用，优先选择方案1，配合团队约定即可满足需求，实现简单且无需额外开发成本；若需要更严格的强制约束，再考虑方案2。

内容的提问来源于stack exchange，提问作者please_help_im_confused