编写自定义Lombok注释处理程序

Question

我想编写自定义Lombok注释处理程序。我知道http://notatube.blogspot.de/2010/12/project-lombok-creating-custom.html.但是当前的lombok jar文件并不包含很多内容。类文件，但文件名为。症状自评量表。取而代之的是龙目山。

我发现，的。SCL. lombok文件是. class文件，Lombok的构建脚本在生成jar文件时重命名了它们，ShadowClassLoader能够加载这些类——缩写SCL似乎就是由此而来的。这样做的原因似乎只是为了“避免污染使用基于SCL的jar的任何项目的命名空间”。IDE中的自动完成程序不会建议实际公共API以外的任何东西。"

我只能编译我的自定义处理程序

• 打开龙目山的包装。罐子
• 重命名。症状自评量表。lombok文件到。班级
• 将结果目录添加到编译类路径

此外，为了能够使用我的自定义处理程序，我需要创建一个新的fat jar，其中包含lombok类和我的自定义处理程序。自定义lombok类加载器本质上防止在其他多个JAR中添加自定义处理程序。

这是扩展龙目岛的唯一方法吗？还是我错过了什么？

我正在使用以下构建脚本

apply plugin: 'java'

repositories {
    jcenter()
}

configurations {
    lombok
    compileOnly
}

def unpackedAndRenamedLombokDir = file("$buildDir/lombok")

task unpackAndRenameLombok {
    inputs.files configurations.lombok
    outputs.dir unpackedAndRenamedLombokDir
    doFirst {
        mkdir unpackedAndRenamedLombokDir
        delete unpackedAndRenamedLombokDir.listFiles()
    }
    doLast {
        copy {
            from zipTree(configurations.lombok.singleFile)
            into unpackedAndRenamedLombokDir
            rename "(.*)[.]SCL[.]lombok", '$1.class'
        }
    }
}

sourceSets {
    main {
        compileClasspath += configurations.compileOnly
        output.dir(unpackedAndRenamedLombokDir, builtBy: unpackAndRenameLombok)
    }
}

tasks.compileJava {
    dependsOn unpackAndRenameLombok
}

dependencies {
    compile files("${System.properties['java.home']}/../lib/tools.jar")
    compile "org.eclipse.jdt:org.eclipse.jdt.core:3.10.0"
    compile 'javax.inject:javax.inject:1'
    lombok 'org.projectlombok:lombok:1.16.6'

    compileOnly files(unpackedAndRenamedLombokDir)
}

Answer 1

使用这个问题和另一个答案（由Balder提供）的输入，我们成功地构建了一个定制的Lombok注释处理程序：Symbok。请随意使用它作为编写自己的示例。

顺便说一句，与编写自定义Lombok处理程序不同，您还可以实现一个javac插件——这可能更简单。

Answer 2

与此同时，Reinier Zwitserroot创建了一个新的git分支sclExpansionUpdate，其中包含ShadowClassLoader的更新版本：

ShadowClassLoader现在对尝试扩展lombok更加友好。

您的（单独的）jar/dir应该有一个名为META-INF/ShadowClassLoader的文件。这个文件应该包含字符串'lombok'。如果您有，该jar/dir中的任何类都将加载在与Lombok类相同的空间中。您还可以将类文件重命名为。SCL. lombok以避免其他加载程序找到它们。

我想这还没有进入主分支，因为它肯定没有经过太多测试-我只是自己尝试过，它包含一个小错误，阻止从扩展加载所需的META-INF/服务。要修复它，您应该将对partOfShadow的两个方法调用替换为inOwnBase：

[... line 443]
Enumeration<URL> sec = super.getResources(name);
while (sec.hasMoreElements()) {
    URL item = sec.nextElement();
    if (!inOwnBase(item, name)) vector.add(item); // <<-- HERE
}

if (altName != null) {
    Enumeration<URL> tern = super.getResources(altName);
    while (tern.hasMoreElements()) {
        URL item = tern.nextElement();
        if (!inOwnBase(item, altName)) vector.add(item); // <<-- AND HERE
    }
}

我用上面的补丁对它进行了测试，它似乎工作得很好（虽然测试不多）。

另一方面：有了这个新的扩展机制，现在终于可以将扩展注释处理程序和注释放在不同于“lombok”的名称空间中了——很好！