Библиотека Java для анализа параметров командной строки?

Question

Я пишу небольшое приложение командной строки на Java. Это приложение должно работать с набором параметров и команд, аналогично svn.

Примеры

app url command1 
app url command2 --parameter2 -x 
app url command1 --param-with-argument argument 
app --parameter url command1 
app --no-url command2 
app --help 

Требуются

• Exists библиотеку простой в использовании для Ja ва
• Поддерживает разбор таких командных строк
• (Bonus) Автоматически создает соответствующую помощь

Answer 1

Я фанат Commons CLI.

Вы можете настроить его для понимания команд, флагов (с короткими и длинными именами), независимо от того, нужны или нет определенные команды/переключатели или имеют значения по умолчанию. Он даже имеет функциональность для печати полезного сообщения типа --help.

На странице Usage Scenarios есть несколько хороших примеров того, как ее можно использовать.

Answer 2

Существует также Java Getopt http://www.urbanophile.com/arenn/hacking/download.html

Answer 3

Попробуйте args4j:http://args4j.kohsuke.org

Я предпочитаю args4j с Commons CLI. (И я использовал оба варианта.)

С args4j вам не нужно вызывать никаких функций. Все сделано для вас! (Параметры устанавливаются в поле объекта через отражение.)

Answer 4

JewelCLI - Java library for command-line parsing that yields clean code. Он использует Проксированные интерфейсы, сконфигурированные с помощью аннотаций, для динамического создания API-интерфейса с поддержкой типа для параметров командной строки.

Интерфейс Пример параметра Person.java:

import uk.co.flamingpenguin.jewel.cli.Option; 

public interface Person { 
    @Option String getName(); 
    @Option int getTimes(); 
} 

Пример использования интерфейса параметра Hello.java:

import static uk.co.flamingpenguin.jewel.cli.CliFactory.parseArguments; 
import uk.co.flamingpenguin.jewel.cli.ArgumentValidationException; 

public class Hello { 
    public static void main(String [] args) { 
     try { 
      Person person = parseArguments(Person.class, args); 
      for (int i = 0; i < person.getTimes(); i++) 
       System.out.println("Hello " + person.getName()); 
     } catch(ArgumentValidationException e) { 
      System.err.println(e.getMessage()); 
     } 
    } 
} 

Сохранение копии файлов выше в один каталог и скачать JewelCLI 0.7.6 JAR в этот каталог также.

Скомпилируйте и запустите пример в Bash на Linux/Mac OS X/etc.:

javac -cp jewelcli-0.7.6.jar:. Person.java Hello.java 
java -cp jewelcli-0.7.6.jar:. Hello --name="John Doe" --times=3 

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

javac -cp jewelcli-0.7.6.jar;. Person.java Hello.java 
java -cp jewelcli-0.7.6.jar;. Hello --name="John Doe" --times=3 

Запуск примера должно привести следующий вывод:

Hello John Doe 
Hello John Doe 
Hello John Doe 

Answer 5

JSAP выглядит довольно хорошо для меня.

http://sourceforge.net/projects/jsap/

Answer 6

Это также стоит смотреть на --jopt-simple.

Он пытается оценить синтаксисы опций командной строки POSIX getopt() и GNU getopt_long(). ' Кажется, что у вас есть какая-то общность в сообществе, в частности, в командной строке parsing lib выбора для OpenJDK (и Minecraft!).

Answer 7

Для полноты давайте добавим JCommander https://github.com/cbeust/jcommander

public class JCommanderTest { 
    @Parameter 
    public List<String> parameters = Lists.newArrayList(); 

    @Parameter(names = { "-log", "-verbose" }, description = "Level of verbosity") 
    public Integer verbose = 1; 

    @Parameter(names = "-groups", description = "Comma-separated list of group names to be run") 
    public String groups; 

    @Parameter(names = "-debug", description = "Debug mode") 
    public boolean debug = false; 
} 

и пример использования

CommanderTest jct = new JCommanderTest(); 
String[] argv = { "-log", "2", "-groups", "unit", "a", "b", "c" }; 
new JCommander(jct, argv); 

Assert.assertEquals(jct.verbose.intValue(), 2); 

Answer 8

Я использую аеролифт для проекта, я работаю, кажется, работает довольно хорошо:

https://github.com/airlift/airline

Простой Maven depen зидент, что вам нужно добавить:

<dependency> 
    <groupId>io.airlift</groupId> 
    <artifactId>airline</artifactId> 
    <version>0.6</version> 
</dependency> 

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

Можно увидеть пример здесь, если это полезно:

https://github.com/mneedham/neo4j-web-importer/blob/master/src/main/java/org/neo4j/dataimport/Neo4jImporter.java

Answer 9

Вот список относительно до настоящего времени (по состоянию на август 2017) библиотек, которые отвечают на ваш вопрос.

• picocli (2017) имеет помощь по использованию с ANSI цвета и автозаполнения
• JArgs
• Jakarta Commons CLI
• TE-Code (он имеет командную строку разборе библиотеки.)
• argparser
• Java port of GNU getopt
• Args4J
• JSAP
• JOpt Simple
• CLAJR
• CmdLn
• JewelCli
• JCommando
• parse-cmd
• JCommander

Если вы ищете рекомендации, я рекомендую JOpt Простой или JewelCli.

Answer 10

Commandline основан на аннотациях, позволяет создавать сложные правила для объединения аргументов (последовательностей, вложенности, аргументов, типов, ...) и достаточно хорошо документирован.

Чтобы использовать его, добавьте

<dependency> 
    <groupId>com.github.jankroken</groupId> 
    <artifactId>commandline</artifactId> 
    <version>1.7.0</version> 
</dependency> 

к вашему ПОМ, и объявить доступные параметры следующим образом:

public class CommandOptions { 
    private List<String> commands = null; 
    private boolean parameter = false; 
    private boolean url = true; 
    private boolean help = false; 

    @LooseArguments 
    public void setCommands(List<String> commands) { 
    this.commands = commands; 
    } 

    @LongSwitch("parameter") 
    @Toggle(true) 
    public void setParameter(boolean parameter) { 
    this.parameter=parameter; 
    } 

    @LongSwitch("noURL") 
    @Toggle(false) 
    public void setUrl(boolean url) { 
    this.url = url; 
    } 

    @longSwitch("help") 
    @Toggle(true) 
    public void setHelp(boolean help) { 
    this.help = help; 
    } 

    // getters 
} 

, а затем на самом деле разобрать командную строку, сделайте

public final static void main(String[] args) { 
    try { 
    CommandOptions options = CommandLineParser.parse(CommandOptions.class, args, OptionStyle.SIMPLE); 

    // and then you can pass options to your application logic... 

    } catch 
    ... 
    } 
} 

Обратите внимание, что он еще не содержит автоматически сгенерированный текст справки. Это было прототипировано, но прервано. Легко создать базовый текст справки для простых случаев, но для более сложных конфигураций (ae доступные параметры для приложения, такие как «find» или «gcc»), результат будет не очень приятным, и вы скорее всего захотите самостоятельно контролируйте макет.