【问题标题】:Is it possible to tab-complete values in Spring Shell?是否可以在 Spring Shell 中完成值的制表符?
【发布时间】:2016-02-25 10:28:26
【问题描述】:

我目前正在尝试改进 Spring Shell 应用程序,如果它支持值和选项的制表符补全,那么它会变得更好。

例如,如果我的 CLI 有一个命令 getInfo --name <name>,其中 <name> 是数据库中有限名称集合中的一个名称,那么这样做会很方便

> getInfo --name Lu<tab>
  Lucy Luke Lulu
> getInfo --name Luk<tab>
> getInfo --name Luke

有没有办法使用现有的 Spring Shell 工具来做到这一点?我在文档中四处寻找,找不到任何关于自动完成值的信息..

干杯!

【问题讨论】:

  • 如果您仍然想弄清楚,您使用的是什么版本的 Spring Shell?

标签: java spring shell spring-shell


【解决方案1】:

对于Spring Shell 2,需要实现ValueProvider接口。

import org.springframework.shell.standard.ValueProvider;

@Component
public class MyValueProvider implements ValueProvider {

    @Override
    public boolean supports(MethodParameter methodParameter, CompletionContext completionContext) {
        return true;
    }

    @Override
    public List<CompletionProposal> complete(MethodParameter methodParameter, CompletionContext completionContext, String[] strings) {

        List<CompletionProposal> result = new ArrayList();
        List<String> knownThings = new ArrayList<>();
        knownPaths.add("something");

        String userInput = completionContext.currentWordUpToCursor();
        knownThings.stream()
                .filter(t -> t.startsWith(userInput))
                .forEach(t -> result.add(new CompletionProposal(t)));

        return result;
    }
}

【讨论】:

  • 也可以扩展ValueProviderSupport 并且我们已经实现了supports 方法,因此可以使用@ShellOption(valueProvider = MyValueProvider.class)“激活”MyValueProvider
  • @Ralph,正如你所建议的,我实现了 ValueProviderSupport 的一个子类,它为文件名提供补全并设置 ShellOption valueProvider,但我之前使用的默认 FilleValueProvider 仍然被调用,而不是我的解释。知道为什么会发生这种情况吗?
  • @Chris94:我不知道,也许有一个提示:扩展的 ValueProviderSupport 类需要初始化为 Spring Bean! -- 如果您的问题仍然存在,那么我建议您提出一个新问题并发布您的代码
  • 谢谢——缺少 bean 注释是问题所在。
【解决方案2】:

您可以注册一个 Converter 来将此功能转换为 String 类型。已经有一些已经创建的转换器,org.springframework.shell.converters.EnumConverter 具有您正在寻找的功能。

要注册一个转换器,您需要实现org.springframework.shell.core.Converter 接口:

@Component
public class PropertyConverter implements Converter<String> {

    public boolean supports(Class<?> type, String optionContext) {
        return String.class.isAssignableFrom(type)
                && optionContext != null && optionContext.contains("enable-prop-converter");
    }

    public String convertFromText(String value, Class<?> targetType, String optionContext) {
        return value;
    }

    public boolean getAllPossibleValues(List<Completion> completions, Class<?> targetType, String existingData,
            String optionContext, MethodTarget target) {
        boolean result = false;

        if (String.class.isAssignableFrom(targetType)) {
            String [] values = {"ONE", "BOOKING", "BOOK"};

            for (String candidate : values) {
                if ("".equals(existingData) || candidate.startsWith(existingData) || existingData.startsWith(candidate)
                        || candidate.toUpperCase().startsWith(existingData.toUpperCase())
                        || existingData.toUpperCase().startsWith(candidate.toUpperCase())) {
                    completions.add(new Completion(candidate));
                }
            }

            result = true;
        }
        return result;
    }

}

在前面的示例中,我为字符串对象注册了一个转换器,当 @CliOption 注释的 optionContext 具有 enable-prop-converter 时,它启用它。

您还必须禁用默认的 StringConverter。在下一行中,我使用disable-string-converter 禁用了@CliOption 注释中的默认字符串转换器,并使用enable-prop-converter 启用了新的PropertyConverter。

@CliOption(key = { "idProp" }, mandatory = true, help = "The the id of the property", optionContext="disable-string-converter,enable-prop-converter") final String idProp

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2015-08-07
    • 1970-01-01
    • 2022-12-21
    • 1970-01-01
    • 2015-02-09
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多