TOC

CLI с Spring Shell

CLI с Spring Shell

1. обзор

Проще говоря, Spring Shellproject предоставляет интерактивную оболочку для обработки команд и создания полнофункционального интерфейса командной строки с использованием модели программирования Spring.

В этой статье мы рассмотрим его функции, ключевые классы и аннотации, а также реализуем несколько пользовательских команд и настроек.

2. Maven Dependency

Во-первых, нам нужно добавить зависимостьspring-shell к нашемуpom.xml: 


    org.springframework.shell
    spring-shell
    1.2.0.RELEASE

Последнюю версию этого артефакта можно найтиhere.

3. Доступ к оболочке

В наших приложениях есть два основных способа доступа к оболочке.

Первый - это загрузить оболочку в точке входа нашего приложения и позволить пользователю вводить команды: 

public static void main(String[] args) throws IOException {
    Bootstrap.main(args);
}

Второй - получитьJLineShellComponent и программно выполнить команды: 

Bootstrap bootstrap = new Bootstrap();
JLineShellComponent shell = bootstrap.getJLineShellComponent();
shell.executeCommand("help");

Мы собираемся использовать первый подход, поскольку он лучше всего подходит для примеров в этой статье, однако в исходном коде вы можете найти тестовые примеры, использующие вторую форму.

4. команды

В оболочке уже есть несколько встроенных команд, таких какclear,help,exit и т. Д., Которые обеспечивают стандартные функции каждого CLI.

Пользовательские команды могут быть представлены путем добавления методов, отмеченных аннотацией@CliCommand, внутри компонента Spring, реализующего интерфейсCommandMarker.

Каждый аргумент этого метода должен быть помечен аннотацией@CliOption, если мы этого не сделаем, мы столкнемся с несколькими ошибками при попытке выполнить команду.

4.1. Добавление команд в оболочку

Во-первых, нам нужно сообщить оболочке, где находятся наши команды. Для этого в нашем проекте должен присутствовать файлMETA-INF/spring/spring-shell-plugin.xml, там мы можем использовать функцию сканирования компонентов Spring:

Как только компоненты зарегистрированы и созданы в Spring, они регистрируются с помощью синтаксического анализатора оболочки, и их аннотации обрабатываются.

Давайте создадим две простые команды: одна для захвата содержимого URL-адреса и его отображения, а другая для сохранения этого содержимого в файл: 

@Component
public class SimpleCLI implements CommandMarker {

    @CliCommand(value = { "web-get", "wg" })
    public String webGet(
      @CliOption(key = "url") String url) {
        return getContentsOfUrlAsString(url);
    }

    @CliCommand(value = { "web-save", "ws" })
    public String webSave(
      @CliOption(key = "url") String url,
      @CliOption(key = { "out", "file" }) String file) {
        String contents = getContentsOfUrlAsString(url);
        try (PrintWriter out = new PrintWriter(file)) {
            out.write(contents);
        }
        return "Done.";
    }
}

Обратите внимание, что мы можем передать более одной строки в атрибутыvalue иkey@CliCommand и@CliOption соответственно, это позволяет нам отображать несколько команд и аргументов, которые ведут себя одинаково. .

Теперь проверим, все ли работает должным образом: 

spring-shell>web-get --url https://www.google.com
web-save --url https://www.google.com --out contents.txt
Done.

4.2. Доступность команд

Мы можем использовать аннотацию@CliAvailabilityIndicator в методе, возвращающемboolean для изменения во время выполнения, если команда должна быть доступна оболочке.

Во-первых, давайте создадим метод для изменения доступности командыweb-save: 

private boolean adminEnableExecuted = false;

@CliAvailabilityIndicator(value = "web-save")
public boolean isAdminEnabled() {
    return adminEnableExecuted;
}

Теперь давайте создадим команду для изменения переменнойadminEnableExecuted: 

@CliCommand(value = "admin-enable")
public String adminEnable() {
    adminEnableExecuted = true;
    return "Admin commands enabled.";
}

Наконец, давайте проверим это: 

spring-shell>web-save --url https://www.google.com --out contents.txt
Command 'web-save --url https://www.google.com --out contents.txt'
  was found but is not currently available
  (type 'help' then ENTER to learn about this command)
spring-shell>admin-enable
Admin commands enabled.
spring-shell>web-save --url https://www.google.com --out contents.txt
Done.

4.3. Обязательные аргументы

По умолчанию все аргументы команды являются необязательными. Однако мы можем сделать их обязательными с помощью атрибутаmandatory аннотации@CliOption: 

@CliOption(key = { "out", "file" }, mandatory = true)

Теперь мы можем проверить, что, если мы не введем его, приведет к ошибке: 

spring-shell>web-save --url https://www.google.com
You should specify option (--out) for this command

4.4. Аргументы по умолчанию

Пустое значениеkey для@CliOption делает этот аргумент значением по умолчанию. Там мы получим введенные в оболочку значения, которые не являются частью ни одного именованного аргумента: 

@CliOption(key = { "", "url" })

А теперь давайте проверим, как это работает: 

spring-shell>web-get https://www.google.com

4.5. Помощь пользователям

Аннотации@CliCommand и@CliOption предоставляют атрибутhelp, который позволяет нам направлять наших пользователей при использовании встроенной командыhelp или при переходе через табуляцию для автоматического завершения.

Давайте изменим нашweb-get, чтобы добавить собственные справочные сообщения: 

@CliCommand(
  // ...
  help = "Displays the contents of an URL")
public String webGet(
  @CliOption(
    // ...
    help = "URL whose contents will be displayed."
  ) String url) {
    // ...
}

Теперь пользователь может точно знать, что делает наша команда: 

spring-shell>help web-get
Keyword:                    web-get
Keyword:                    wg
Description:                Displays the contents of a URL.
  Keyword:                  ** default **
  Keyword:                  url
    Help:                   URL whose contents will be displayed.
    Mandatory:              false
    Default if specified:   '__NULL__'
    Default if unspecified: '__NULL__'

* web-get - Displays the contents of a URL.
* wg - Displays the contents of a URL.

5. настройка

Есть три способа настроить оболочку, реализовав интерфейсыBannerProvider,PromptProvider иHistoryFileNameProvider, все они с уже предоставленными реализациями по умолчанию.

Кроме того, нам нужно использовать аннотацию@Order, чтобы позволить нашим поставщикам иметь приоритет над этими реализациями.

Давайте создадим новый баннер, чтобы приступить к настройке: 

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class SimpleBannerProvider extends DefaultBannerProvider {

    public String getBanner() {
        StringBuffer buf = new StringBuffer();
        buf.append("=======================================")
            .append(OsUtils.LINE_SEPARATOR);
        buf.append("*          example Shell             *")
            .append(OsUtils.LINE_SEPARATOR);
        buf.append("=======================================")
            .append(OsUtils.LINE_SEPARATOR);
        buf.append("Version:")
            .append(this.getVersion());
        return buf.toString();
    }

    public String getVersion() {
        return "1.0.1";
    }

    public String getWelcomeMessage() {
        return "Welcome to example CLI";
    }

    public String getProviderName() {
        return "example Banner";
    }
}

Обратите внимание, что мы также можем изменить номер версии и приветственное сообщение.

Теперь давайте изменим подсказку: 

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class SimplePromptProvider extends DefaultPromptProvider {

    public String getPrompt() {
        return "example-shell";
    }

    public String getProviderName() {
        return "example Prompt";
    }
}

Наконец, давайте изменим имя файла истории: 

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class SimpleHistoryFileNameProvider
  extends DefaultHistoryFileNameProvider {

    public String getHistoryFileName() {
        return "example-shell.log";
    }

    public String getProviderName() {
        return "example History";
    }

}

Файл истории запишет все команды, выполненные в оболочке, и будет помещен вместе с нашим приложением.

Имея все на месте, мы можем вызвать нашу оболочку и увидеть ее в действии: 

=======================================
*          example Shell             *
=======================================
Version:1.0.1
Welcome to example CLI
example-shell>

6. Преобразователи

До сих пор мы использовали только простые типы в качестве аргументов наших команд. Обычные типы, такие какInteger,Date,Enum,File и т. Д., Имеют уже зарегистрированный преобразователь по умолчанию.

Реализуя интерфейсConverter, мы также можем добавить наши конвертеры для получения пользовательских объектов.

Давайте создадим конвертер, который может преобразовыватьString вURL: 

@Component
public class SimpleURLConverter implements Converter {

    public URL convertFromText(
      String value, Class requiredType, String optionContext) {
        return new URL(value);
    }

    public boolean getAllPossibleValues(
      List completions,
      Class requiredType,
      String existingData,
      String optionContext,
      MethodTarget target) {
        return false;
    }

    public boolean supports(Class requiredType, String optionContext) {
        return URL.class.isAssignableFrom(requiredType);
    }
}

Наконец, давайте изменим наши командыweb-get иweb-save: 

public String webSave(... URL url) {
    // ...
}

public String webSave(... URL url) {
    // ...
}

Как вы уже догадались, команды ведут себя одинаково.

7. Заключение

В этой статье мы кратко рассмотрели основные функции проекта Spring Shell. Мы смогли предоставить наши команды и настроить оболочку с нашими провайдерами, мы изменили доступность команд в соответствии с различными условиями выполнения и создали простой конвертер типов.

Полный исходный код этой статьи можно найти вover on GitHub.

Related