关于java:使用Groovy构建DSL

DSL（Domain Specific Language）是针对某一畛域，具备 受限表白性 的一种计算机程序设计语言。

罕用于聚焦指定的畛域或问题，这就要求 DSL 具备弱小的表现力，同时在应用起来要简略。因为其应用简略的个性，DSL 通常不会像 Java，C++ 等语言将其利用于一般性的编程工作。

对于 Groovy 来说，一个平凡的 DSL 产物就是新一代构建工具——Gradle，接下来让咱们看下有哪些个性来撑持 Groovy 不便的编写 DSL：

官网定义是“Groovy 中的闭包是一个凋谢，匿名的代码块，能够承受参数，返回值并调配给变量”

简而言之，他说一个匿名的代码块，能够承受参数，有返回值。在 DSL 中，一个 DSL 脚本就是一个闭包。

比方：

// 执行一句话  
{printf 'Hello World'}                                   
    
// 闭包有默认参数 it，且不必申明      
{println it}                   

// 闭包有默认参数 it，申明了也无所谓                
{it -> println it}      
    
// name 是自定义的参数名  
{name -> println name}                 

 // 多个参数的闭包
{ String x, int y ->                                
    println "hey ${x} the value is ${y}"    
}

每定义的闭包是一个 Closure 对象，咱们能够把一个闭包赋值给一个变量，而后调用变量执行

// 闭包赋值
def closure = {printf("hello")
}
// 调用
closure()

当调用的办法须要参数时，Groovy 不要求应用括号，若有多个参数，那么参数之间仍然应用逗号分隔；如果不须要参数，那么办法的调用必须显示的应用括号。

def add(number) {1 + number}

//DSL 调用
def res = add 1
println res

也反对级联调用形式，举例来说，a b c d 实际上就等同于 a(b).c(d)

// 定义
total = 0
def a(number) {
    total += number
    return this
}
def b(number) {
    total *= number
    return this
}

//dsl
a 2 b 3
println total

咱们联合 Groovy 中对属性的拜访就是对 getXXX 的拜访，将无参数的办法名改成 getXXX 的模式，即可实现“调用无参数的办法不须要括号”的语法！比方：

def getTotal() { println "Total"}

//DSL 调用
total

MOP：元对象协定。由 Groovy 语言中的一种协定。该协定的呈现为元编程提供了优雅的解决方案。而 MOP 机制的外围就是 MetaClass。

有点相似于 Java 中的反射，然而在应用上却比 Java 中的反射简略的多。

罕用的办法有:

invokeMethod()
setProperty()
hasProperty()
methodMissing()

以下是一个 methodMissing 的例子：

detailInfo = [:]

def methodMissing(String name, args) {detailInfo[name] = args
}

def introduce(closure) {
    closure.delegate = this
    closure()
    detailInfo.each {
        key, value ->
            println "My $key is $value"
    }
}

introduce {
    name "zx"
    age 18
}

@BaseScript 须要在正文在自定义的脚本类型变量上，来指定以后脚本属于哪个 Delegate，从而执行相应的脚本命令，也使 IDE 有主动提醒的性能：

脚本定义
abstract class DslDelegate extends Script {def setName(String name){println name}
}

脚本：

import dsl.groovy.SetNameDelegate
import groovy.transform.BaseScript

@BaseScript DslDelegate _

setName("name")

应用以上介绍的办法，只能在脚本里执行单个命令，如果想在脚本里执行简单的嵌套关系，比方 Gradle 中的 dependencies，就须要 @DelegatesTo 反对了，@DelegatesTo 执行了脚本里定义的闭包用那个类来解析。

下面提到一个 DSL 脚本就是一个闭包，这里的 DelegatesTo 其实定义的是闭包外面的二级闭包的格局，当然如果你乐意，能够有限嵌套定义。

// 定义二级闭包格局
class Conf{
    String name
    int age

    Conf name(String name) {
        this.name = name
        return this
    }

    Conf age(int age) {
        this.age = age
        return this
    }
}

// 定义一级闭包格局，即脚本的格局
String user(@DelegatesTo(Conf.class) Closure<Conf> closure) {Conf conf = new Conf()
    DefaultGroovyMethods.with(conf, closure)
    println "my name is ${conf.name} my age is ${conf.age}"
}

//dsl 脚本
user{
    name "tom"
    age 12
}

脚本能够在 IDE 里间接执行，大多数状况下 DSL 脚本都是以文本的模式存在数据库或配置中，这时候就须要先加载脚本再执行，加载脚本能够通过以下形式：

 CompilerConfiguration compilerConfiguration = new CompilerConfiguration();
 compilerConfiguration.setScriptBaseClass(DslDelegate.class.getName());
 GroovyShell shell = new GroovyShell(GroovyScriptRunner.class.getClassLoader());
 Script script = shell.parse(file);

给脚本传参数，并失去返回后果：

Binding binding = new Binding();
binding.setProperty("key", anyValue);
Object res = InvokerHelper.createScript(script.getClass(), binding).run()

通过以上的原理，你应该能设计出本人的 DSL 了，通过 DSL 能够设计出十分简洁的 API 给用户，在执行的时候调用 DSL 外部的简单性能，这些性能的背地逻辑暗藏在了本人编写的 Delegate 中。

为了加深了解，我写了个开源我的项目，把下面知识点串起来，构建了一个较完整的 DSL 流程，如果还有什么不懂的中央，欢送留言交换。

我的项目地址：https://github.com/sofn/dsl-g…

官网 MOP：https://groovy-lang.org/metap…

畛域专属语言：https://wiki.jikexueyuan.com/…

实战 Groovy 系列：https://wizardforcel.gitbooks…

本文作者：木小丰，美团 Java 高级工程师，关注架构、软件工程、全栈等，不定期分享软件研发过程中的实际、思考。

公共号：Java 研发

本文博客链接：https://lesofn.com/archives/s…

关于java:使用Groovy构建DSL

一、原理

1、闭包

2、括号语法

3、无参办法调用

4、MOP

5、定义和脚本拆散

6、闭包委托

7、加载并执行脚本

二、总结

三、参考