Biblioteca de Java para analizar los parámetros de línea de comandos?

Question

Escribo una pequeña aplicación de línea de comandos en Java. Esta aplicación debería funcionar con una combinación de parámetros y comandos, similar a svn.

Ejemplos

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 

deseada

• Existe una biblioteca de fácil uso para Ja VA
• Soporta análisis de tales líneas de comandos
• (Bonus) crea automáticamente una ayuda adecuada

Answer 1

Soy un fan de Commons CLI.

Puede configurarlo para que comprenda los comandos, los indicadores (con nombres cortos y largos), si se requieren ciertos comandos/conmutadores o si tienen valores predeterminados. Incluso tiene la funcionalidad para imprimir un útil mensaje de tipo --help.

La página Usage Scenarios tiene algunos buenos ejemplos de cómo se puede utilizar.

Answer 2

También hay un java getopt http://www.urbanophile.com/arenn/hacking/download.html

Answer 3

Trate args4j:http://args4j.kohsuke.org

prefiero a args4j Commons CLI. (Y he usado ambos.)

Con args4j, no necesita llamar a ninguna función. ¡Todo está hecho para ti! (Los parámetros se establecen en los campos del objeto a través de la reflexión.)

Answer 4

JewelCLI es un Java library for command-line parsing that yields clean code. Utiliza las interfaces proxy configuradas con anotaciones para construir dinámicamente una API segura para sus parámetros de línea de comandos.

Un ejemplo de interfaz de parámetros Person.java:

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

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

Un ejemplo de uso de la interfaz de parámetros 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()); 
     } 
    } 
} 

Guardar copias de los archivos anteriores a un solo directorio y descargar el JewelCLI 0.7.6 JAR a ese directorio también.

Compila y ejecuta el ejemplo en Bash en 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 

compilar y ejecutar el ejemplo en el símbolo del sistema de 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 

Ejecutar el ejemplo debe dar el siguiente resultado:

Hello John Doe 
Hello John Doe 
Hello John Doe 

Answer 5

JSAP se ve muy bien para mí.

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

Answer 6

Es también digno de mirar --jopt-simple.

Intenta respetar las sintaxis de la opción de línea de comandos de POSIX getopt() y GNU getopt_long(). ' Parece tener algo de tracción en la comunidad, notablemente es la línea de comando que analiza la lib de elección para el OpenJDK (¡y Minecraft!).

Answer 7

Para completarlo vamos a añadir 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; 
} 

y un ejemplo de uso

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

estoy usando puente aéreo para un proyecto que estoy trabajando, parece que funciona bastante bien:

https://github.com/airlift/airline

Simple Maven dependen dencia de que es necesario agregar:

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

Y después de eso es sobre la base de anotación y tiene una manera bastante ordenada de mostrar el texto de ayuda también.

puede ver un ejemplo aquí si es útil:

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

Answer 9

He aquí una lista relativamente al día (Desde la Ago 2017) de bibliotecas que respondan a su pregunta.

• picocli (2017) tiene ayuda de uso, con colores ANSI, y autocompletar
• JArgs
• Jakarta Commons CLI
• TE-Code (que tiene una línea de comandos de análisis biblioteca.)
• argparser
• Java port of GNU getopt
• Args4J
• JSAP
• JOpt Simple
• CLAJR
• CmdLn
• JewelCli
• JCommando
• parse-cmd
• JCommander

Si usted está buscando una recomendación, recomiendo JOpt simple o JewelCli.

Answer 10

Commandline está basado en anotaciones, permite reglas complejas para combinar argumentos (secuencias, anidamiento, argumentos, tipos, ...) y está razonablemente bien documentado.

Para usarlo, añadir

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

a su pom, y declarar las opciones disponibles de la siguiente manera:

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 
} 

y luego para realmente analizar la línea de comandos, haga

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 
    ... 
    } 
} 

tenga en cuenta que aún no contiene un texto de ayuda generado automáticamente. Esto fue prototipo, pero abortado. Es fácil generar un texto de ayuda básico para casos simples, pero para configuraciones más complejas (por ejemplo, las opciones disponibles para una aplicación como "buscar" o "gcc"), el resultado no será bonito, y es probable que prefiera controla el diseño tú mismo.