使用 Bazel 增强 Datanucleus

Question

我正在尝试将 Maven 项目迁移到 Bazel，但在 Datanucleus 增强方面遇到了问题。

在构建 jar 文件后，Datanucleus 会查看其中的内容并进行一些字节码操作以增强持久性类。在 Bazel 中执行此操作的方法是定义一个规则，该规则采用 java_library 规则的 *.jar 输出并创建库的新增强版本。

我遇到的问题是，对于我的规则，我需要来自外部库的 datanucleus-core 包。当我尝试通过 $(location //third_party:datanucleus_core) 从 genrule 访问它时，它指向一个没有类:

的罐子

(genrule) cmd = "echo $(location //third_party:datanucleus_core)"
bazel-out/local-fastbuild/bin/third_party/liborg_datanucleus_datanucleus_core.jar

(genrule) cmd = "jar tf $(location //third_party:datanucleus_core)"
META-INF/
META-INF/MANIFEST.MF

Bazel 在 genrule 中从 $(location //third_party:datanucleus_core) 中解析的 jar 文件仅包含 META-INF/MANIFEST.MF，内容如下：

Manifest-Version: 1.0
Created-By: blaze

我尝试使用 java_binary 规则将正确的 datanucleus_core.jar 添加到类路径中，但 Datanucleus 就地增强了我的库并且无法将其更改写入磁盘（重写规则的输入文件） .此外 java_binary 规则不应该用于构建。

所以问题是在 Bazel 运行 Datanucleus 实用程序中增强 jar 库的最佳方法是什么，它在 Maven 存储库中作为第三方依赖项提供？

Bazel 构建标签：0.3.2-homebrew、OS：OS X El Capitan (10.11.6)、java：1.8.0_92

更新

Datanucleus 依赖声明：

# WORKSPACE
maven_jar(
    name = "org_datanucleus_datanucleus_core",
    artifact = "org.datanucleus:datanucleus-core:5.0.3",
)

# third_party/BUILD
java_library(
    name = "org_datanucleus_datanucleus_core",
    visibility = ["//visibility:public"],
    exports = ["@org_datanucleus_datanucleus_core//jar"],
)

（在我的问题中我将 org_datanucleus_datanucleus_core 缩短为 datanucleus_core）

Answer 1

正如 Neil Stockton 提到的，您无法在罐子中增强 classes。因此，基本策略将是：

创建 jar。
解压 class 个文件。
运行增强功能。
将其备份。

第 2 步和第 3 步必须合并为第 4 步，因为 Bazel 坚持要求您将所有输入和输出声明为构建规则（并且您不知道 .class 文件是什么。java文件将生成，因此 Bazel 总是将它们打包）。

创建一个 datanucleus.bzl 文件来声明您的增强规则。它应该类似于：

# Run datastore enhancements on the java_library named "jarname".
def enhance(jarname):
  # src is the name of the jar file your java_library rule generates.
  src = "lib" + jarname + ".jar"
  native.genrule(
      name = jarname + "-enhancement",
      srcs = [
          src, 
          "//third_party:datanucleus_core"
      ],
      outs = [jarname + "-enhanced.jar"],
      cmd = """
# Un-jar the .class files.
jar tf $(location {0})
# Run the enhance.
classes=""
for $$class in $$(find . -name *.class); do
  java -cp {0}:$(location //third_party:datanucleus_core) $$class
  classes="$$classes $$class"
done
# jar them back up.
jar cf $@ $$classes""".format(src),
  )

（我对数据存储不太熟悉，所以 cmd 可能需要一些修改，但应该是大意。）

然后，在您的 BUILD 文件中，您需要：

java_library(
    name = "my-lib",
    srcs = glob(["*.java"]),
    deps = ["..."],
)

# import the rule you wrote.
load('//:datanucleus.bzl', 'enhance')
enhance("my-lib")

现在你可以做：

bazel build //:my-lib-enhanced.jar

并在其他 java_ 规则中使用 my-lib-enhanced.jar 作为依赖项。

有关 .bzl 文件的更多信息：https://bazel.build/versions/master/docs/skylark/concepts.html。

编辑以添加更多关于依赖 jar 的信息：

有几个选项可以获取包含 datanucleus 内容的 jar。首先，你不需要间接层：你可以说：

      srcs = [
          src, 
          "@datanucleus_core//jar"
      ],

这会给你实际的罐子。

如果出于某种原因，您需要将 jar 放在 third_party 中，您可以修改 third_party/BUILD 以创建一个 部署 jar，这是一个 java 二进制文件，它捆绑了所有部署依赖项（因为你实际上并不打算将它用作二进制文件，所以你可以使用任何你想要的主 class 名称）：

java_binary(
    name = "datanucleus-core",
    main_class = "whatever",
    runtime_deps = ["@org_datanucleus_datanucleus_core//jar"],
)

genrule(
    name = "your-lib",
    srcs = [":datanucleus-core_deploy.jar", ...],
)

:datanucleus-core_deploy.jar 称为 隐式目标 ：它仅在请求时构建，但可以从您的 java_binary 声明中生成。

使用 Bazel 增强 Datanucleus

Datanucleus enhancement with Bazel

datanucleus

bazel