如何在创建Groovy DSL时让对象方法仅在特定闭包/作用域可用

假设我有如下Java类：

class Foo {
    void always() {}
    void onlyScopeB() {}
}

同时我有两个接收闭包的方法：scopeA、scopeB，使用场景如下：

foo = new Foo()

scopeA{
  foo.always()     // 此代码应可编译
  foo.onlyScopeB() // 此代码应不可编译
}

scopeB{
  foo.always()     // 此代码应可编译
  foo.onlyScopeB() // 此代码应可编译
}

能否在编译阶段实现上述效果？我正在编写一个DSL，其作用域对应流程中的不同阶段，部分字段在某一作用域中为null，在另一作用域中不为null，希望通过最优的语义体验来快速排查错误。

完全可以在编译阶段实现这个效果，核心思路是利用类型系统的约束来区分不同作用域的可用API，具体可参考以下几种方式：

1. 拆分接口（推荐） #

把Foo的方法拆分为两个接口，让不同的作用域方法返回对应的接口类型：

// 基础接口：包含所有作用域通用的方法
interface AlwaysAvailable {
    void always();
}

// 扩展接口：继承基础接口，添加仅ScopeB可用的方法
interface ScopeBAvailable extends AlwaysAvailable {
    void onlyScopeB();
}

// 原Foo类实现完整接口
class Foo implements ScopeBAvailable {
    @Override
    public void always() {}
    
    @Override
    public void onlyScopeB() {}
}

修改scopeA和scopeB的方法签名，让它们接收的闭包参数类型不同：

// ScopeA的闭包仅能接收AlwaysAvailable类型实例
void scopeA(Closure<Void> closure) {
    AlwaysAvailable restrictedFoo = new Foo();
    closure.call(restrictedFoo);
}

// ScopeB的闭包可接收完整的ScopeBAvailable类型实例
void scopeB(Closure<Void> closure) {
    ScopeBAvailable fullFoo = new Foo();
    closure.call(fullFoo);
}

这种方式下，scopeA闭包里的对象只能调用always()，调用onlyScopeB()会直接触发编译错误，完全符合需求。

2. 包装类适配（兼容现有类结构） #

如果不想修改原Foo类的结构，可以在作用域方法内部用包装类做类型限制：

// 仅包装通用方法的类
class ScopeAWrapper implements AlwaysAvailable {
    private final Foo foo;
    
    public ScopeAWrapper(Foo foo) {
        this.foo = foo;
    }
    
    @Override
    public void always() {
        foo.always();
    }
}

然后在scopeA中传入包装后的实例：

void scopeA(Closure<Void> closure) {
    closure.call(new ScopeAWrapper(new Foo()));
}

void scopeB(Closure<Void> closure) {
    closure.call(new Foo());
}

这种方式无需改动原Foo类，但需要额外编写包装类，适合对现有代码做兼容的场景。

3. Groovy编译时元编程（进阶） #

如果是基于Groovy编写DSL，可利用Groovy的编译时注解或AST转换，在编译阶段检查闭包内的方法调用：

• 给scopeA方法添加自定义注解，编译时扫描闭包内代码，若发现调用onlyScopeB()则抛出编译错误。
• 这种方式灵活性更高，但需要熟悉Groovy的AST操作，实现成本也相对较高。

不管采用哪种方式，核心都是通过类型约束或编译时检查限制不同作用域的可用方法，从根源上避免运行时才发现的错误，提升DSL的语义安全性。

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