9

我在创建构造函数时遇到问题，Jenkins 可以调用一些源自 Jelly 形式的 JSON 数据。为了测试，我创建了一个最小的 Jenkins 插件，其中包含mvn hpi:create两个自定义文件：

src/main/resources/foo/hyde/jenkins/plugins/OptionalBlockSampleBuilder/config.jelly

<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
<f:block>
    <table>
        <f:optionalBlock name="enableText" title="Enable optional text" checked="${instance.enableText}">
            <f:entry title="Optional text" field="text">
                <f:textbox />
            </f:entry>
        </f:optionalBlock>
    </table>
</f:block>

src/main/java/foo/hyde/jenkins/plugins/OptionalBlockSampleBuilder.java

package foo.hyde.jenkins.plugins;

public class OptionalBlockSampleBuilder extends hudson.tasks.Builder {

    public final String text;
    public final boolean enableText;

    @org.kohsuke.stapler.DataBoundConstructor
    public OptionalBlockSampleBuilder(String text, Boolean enableText) {
        this.text = text;
        this.enableText = (enableText != null) && enableText;
    }

    @Override
    public boolean perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) {
        listener.getLogger().println("OptionalBlockSampleBuilder " + enableText + "/" + text);
        return true;
    }

    @hudson.Extension
    public static final class DescriptorImpl extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder> {
        public boolean isApplicable(Class<? extends hudson.model.AbstractProject> aClass) {
            return true;
        }
        public String getDisplayName() {
            return "Optional Block Sample";
        }
    }
}

我正在针对 pom.xml parent<groupId>org.jenkins-ci.plugins</groupId><artifactId>plugin</artifactId><version>1.454</version>进行构建，一切都在构建，Netbeans 6.9.1 启动 Debug Jenkins，我可以通过这个构建步骤创建一个作业。如果我不选中该复选框，一切都会正常工作，并且我期望OptionalBlockSampleBuilder false/null工作的控制台输出。

但是，如果我确实选中了复选框并添加了文本，那么当它尝试调用我的构造函数时，保存/应用作业配置会从 Jenkins 代码的深处给出这个异常：

java.lang.RuntimeException:
  Failed to instantiate class
    foo.hyde.jenkins.plugins.OptionalBlockSampleBuilder 
  from {
    "enableText":{"text":"xx"},
    "kind":"foo.hyde.jenkins.plugins.OptionalBlockSampleBuilder",
    "stapler-class":"foo.hyde.jenkins.plugins.OptionalBlockSampleBuilder"
    }

必须有一个简单的修复。我尝试了许多不同的更改，也尝试查看其他插件如何使用它，最后创建了这个最小的测试插件。如何修复它以使 optionalBlock 工作？

4

2 回答 2

16

提示来自 JSON 数据：

{
"enableText":{"text":"xx"},
"kind":"foo.hyde.jenkins.plugins.OptionalBlockSampleBuilder",
"stapler-class":"foo.hyde.jenkins.plugins.OptionalBlockSampleBuilder"
}

您可以在此处看到enableText包含子属性的text. 这意味着f:optionalBlock实际上期望封装块中包含的所有字段——检查块时，您将收到封装字段类的实例；未选中时，该字段将为null. 要optionalBlock正确使用，您需要@DataBoundConstructor接收一个封装整个optionalBlock. 例如：

private String text;

@DataBoundConstructor
public MyClass(EnableTextBlock enableText)
{
    if (enableText != null)
    {
        this.text = enableText.text;
    }
}

public static class EnableTextBlock
{
    private String text;

    @DataBoundConstructor
    public EnableTextBlock(String text)
    {
        this.text = text;
    }
}

请注意，enableText本例中的字段实际上是EnableTextBlock类的一个实例，其中包含一个子属性text. 这将满足在表单中发送的 JSON 对象。

相反，如果您只需要一个带有复选框以启用该字段输入的单个字段，您可能需要考虑使用f:optionalProperty标签，它会为您处理该单字段封装。但是，在许多情况下，optionalBlock实际上需要配置多个字段，在这种情况下，封装类（如上例）通常是正确的方法。

封装类不必是静态内部类；它可以是你的包中的一个单独的类，但重要的部分是它DataBoundConstructor应该接受一个与从表单传递的 JSON 结构相匹配的参数。

于 2012-10-26T17:17:39.057 回答
11

或者您可以inline像这样向 optionalBlock 添加标签：

<f:optionalBlock inline="true">

如果inline存在，可折叠部分在提交时不会被分组到单独的 JSON 对象中。

于 2014-07-31T22:04:03.947 回答