Java'da komut satırı bağımsız değişkenlerini ayrıştırmanın iyi bir yolu nedir?

Bunları kontrol et:

• http://commons.apache.org/cli/
• http://www.martiansoftware.com/jsap/
• http://picocli.info/

Veya kendi etiketinizi alın:

• http://docs.oracle.com/javase/7/docs/api/java/util/Scanner.html

Örneğin,commons-cli 2 dize bağımsız değişkenini ayrıştırmak için bu yöntemi kullanırsınız :

import org.apache.commons.cli.*;

public class Main {


    public static void main(String[] args) throws Exception {

        Options options = new Options();

        Option input = new Option("i", "input", true, "input file path");
        input.setRequired(true);
        options.addOption(input);

        Option output = new Option("o", "output", true, "output file");
        output.setRequired(true);
        options.addOption(output);

        CommandLineParser parser = new DefaultParser();
        HelpFormatter formatter = new HelpFormatter();
        CommandLine cmd;

        try {
            cmd = parser.parse(options, args);
        } catch (ParseException e) {
            System.out.println(e.getMessage());
            formatter.printHelp("utility-name", options);

            System.exit(1);
        }

        String inputFilePath = cmd.getOptionValue("input");
        String outputFilePath = cmd.getOptionValue("output");

        System.out.println(inputFilePath);
        System.out.println(outputFilePath);

    }

}

komut satırından kullanım:

$> java -jar target/my-utility.jar -i asd                                                                                       
Missing required option: o

usage: utility-name
 -i,--input <arg>    input file path
 -o,--output <arg>   output file

Daha yeni JCommander'e bir göz atın .

Ben yarattım. Soru veya özellik isteği almaktan mutluluk duyuyorum.

Java CLI ayrıştırıcılarının bir listesini tutmaya çalışıyorum .

• Havayolu
  • Aktif Çatal: https://github.com/rvesse/airline
• argparse4j
• argparser
• args4j
• clajr
• cli-ayrıştırıcı
• CmdLn
• Komut satırı
• DocOpt.java
• yunus getopt
• DPML CLI (Jakarta Commons CLI2 çatalı)
• Matthias Laux
• Jakarta Commons CLI
• Jargo
• jargp
• jargs
• java-getopt
• jbock
• JCLAP
• jcmdline
• jcommander
• jcommando
• jewelcli (benim tarafımdan yazılmış)
• JOpt basit
• jsap
• naturalcli
• Object Mentor CLI makalesi (yeniden düzenleme ve TDD hakkında daha fazla bilgi)
• ayrıştırma-cmd
• ritopt
• Rop
• TE Kodu Komutu
• picocli , ANSI renklendirilmiş kullanım yardımına ve otomatik tamamlamaya sahiptir

Bu 2020, Commons CLI daha iyi yapmak için zaman ... :-)

Kendi Java komut satırı ayrıştırıcısını oluşturmalı veya bir kütüphane mi kullanmalısınız?

Birçok küçük yardımcı program benzeri uygulama, ek harici bağımlılığı önlemek için muhtemelen kendi komut satırı ayrıştırmalarını döndürür. picocli ilginç bir alternatif olabilir.

Picocli, güçlü, kullanıcı dostu, GraalVM özellikli komut satırı uygulamaları kolaylıkla oluşturmak için modern bir kütüphane ve çerçevedir. Bir bağımlılık eklemekten kaçınmak için uygulamaların kaynak olarak dahil edebilmesi için 1 kaynak dosyasında yaşar.

Renkleri, otomatik tamamlamayı, alt komutları ve daha fazlasını destekler. Java ile yazılmış, Groovy, Kotlin, Scala vb.

Özellikleri:

• Ek açıklama tabanlı: bildirici , yinelemeyi önler ve programcı amacını ifade eder
• Kullanışlı: kullanıcı girişini ayrıştırın ve iş mantığınızı bir kod satırı ile çalıştırın
• Her şeyi güçlü bir şekilde yazdım - komut satırı seçenekleri ve konum parametreleri
• POSIX kümelenmiş kısa seçenekleri ( <command> -xvfInputFileyanı sıra <command> -x -v -f InputFile)
• İnce taneli kontrolü : minimum, maksimum ve parametrelerin değişken sayısını sağlayan bir Arity modeli, örneğin "1..*","3..5"
• Alt komutlar (gelişigüzel derinliğe yuvalanabilir)
• Zengin özelliklere sahip : oluşturulabilir arg grupları, alıntılanmış değişkenleri bölme, tekrarlanabilir alt komutlar ve daha fazlası
• Kullanıcı dostu : kullanım yardım mesajı , kullanıcı üzerindeki bilişsel yükü azaltmak için kullanım yardımının geri kalan kısmındaki seçenek adları gibi önemli öğeleri karşılaştırmak için renkleri kullanır
• Uygulamanızı GraalVM yerel resmi olarak dağıtma
• İle İşleri Java 5 ve üzeri
• Kapsamlı ve titiz dokümantasyon

Kullanım yardım mesajı ek açıklamalarla (programlama olmadan) kolayca özelleştirilebilir. Örneğin:

( kaynak )

Hangi kullanım yardım mesajlarının mümkün olduğunu göstermek için bir ekran görüntüsü daha eklemeye dayanamadım. Kullanım yardımı, uygulamanızın yüzüdür, bu yüzden yaratıcı olun ve eğlenin!

Feragatname: Piknik oluşturdum. Geri bildirim veya sorular çok hoş geldiniz.

JOpt kullandım ve oldukça kullanışlı buldum: http://jopt-simple.sourceforge.net/

Ön sayfa ayrıca yaklaşık 8 alternatif kütüphanenin bir listesini sunar, kontrol eder ve ihtiyaçlarınıza en uygun olanı seçer.

Birisi son zamanlarda ek açıklama tabanlı olan args4j'yi işaret etti . Gerçekten beğendim!

Bu, Bazel projesinin bir parçası olarak açık kaynaklı Google'ın komut satırı ayrıştırma kütüphanesidir. Şahsen bunun en iyisi olduğunu düşünüyorum ve Apache CLI'den çok daha kolay.

https://github.com/pcj/google-options

Kurulum

Bazel

maven_jar(
    name = "com_github_pcj_google_options",
    artifact = "com.github.pcj:google-options:jar:1.0.0",
    sha1 = "85d54fe6771e5ff0d54827b0a3315c3e12fdd0c7",
)

Gradle

dependencies {
  compile 'com.github.pcj:google-options:1.0.0'
}

Uzman

<dependency>
  <groupId>com.github.pcj</groupId>
  <artifactId>google-options</artifactId>
  <version>1.0.0</version>
</dependency>

kullanım

(Leri) OptionsBasenizi genişleten ve tanımlayan bir sınıf oluşturun @Option.

package example;

import com.google.devtools.common.options.Option;
import com.google.devtools.common.options.OptionsBase;

import java.util.List;

/**
 * Command-line options definition for example server.
 */
public class ServerOptions extends OptionsBase {

  @Option(
      name = "help",
      abbrev = 'h',
      help = "Prints usage info.",
      defaultValue = "true"
    )
  public boolean help;

  @Option(
      name = "host",
      abbrev = 'o',
      help = "The server host.",
      category = "startup",
      defaultValue = ""
  )
  public String host;

  @Option(
    name = "port",
    abbrev = 'p',
    help = "The server port.",
    category = "startup",
    defaultValue = "8080"
    )
    public int port;

  @Option(
    name = "dir",
    abbrev = 'd',
    help = "Name of directory to serve static files.",
    category = "startup",
    allowMultiple = true,
    defaultValue = ""
    )
    public List<String> dirs;

}

Argümanları ayrıştırın ve kullanın.

package example;

import com.google.devtools.common.options.OptionsParser;
import java.util.Collections;

public class Server {

  public static void main(String[] args) {
    OptionsParser parser = OptionsParser.newOptionsParser(ServerOptions.class);
    parser.parseAndExitUponError(args);
    ServerOptions options = parser.getOptions(ServerOptions.class);
    if (options.host.isEmpty() || options.port < 0 || options.dirs.isEmpty()) {
      printUsage(parser);
      return;
    }

    System.out.format("Starting server at %s:%d...\n", options.host, options.port);
    for (String dirname : options.dirs) {
      System.out.format("\\--> Serving static files at <%s>\n", dirname);
    }
  }

  private static void printUsage(OptionsParser parser) {
    System.out.println("Usage: java -jar server.jar OPTIONS");
    System.out.println(parser.describeOptions(Collections.<String, String>emptyMap(),
                                              OptionsParser.HelpVerbosity.LONG));
  }

}

https://github.com/pcj/google-options

Commons CLI projesine bir göz atın, orada birçok iyi şey.

Yeap.

Bence böyle bir şey arıyorsunuz: http://commons.apache.org/cli

Apache Commons CLI kitaplığı, komut satırı arabirimlerini işlemek için bir API sağlar.

Buradaki insanların çoğunun benim yolumu sevmemek için 10 milyon neden bulacağını biliyorum, ama boş. Ben şeyleri basit tutmak istiyorum, bu yüzden sadece '=' kullanarak anahtarı değerden ayırmak ve böyle bir HashMap saklamak:

Map<String, String> argsMap = new HashMap<>();
for (String arg: args) {
    String[] parts = arg.split("=");
    argsMap.put(parts[0], parts[1]);
} 

Her zaman beklediğiniz argümanların bir listesini tutabilirsiniz, bir argümanı unutması veya yanlış bir kullanması durumunda kullanıcıya yardımcı olmak için ... Ancak, çok fazla özellik istiyorsanız bu çözüm zaten sizin için değildir.

Belki bunlar

• Java için JArgs komut satırı seçeneği ayrıştırma paketi - bu küçük proje, Java programcılarının kullanımı için kullanışlı, kompakt, önceden paketlenmiş ve kapsamlı olarak belgelenmiş bir komut satırı seçeneği ayrıştırıcıları paketi sağlar. Başlangıçta GNU tarzı 'getopt' ile uyumlu ayrıştırma sağlanır.

• ritopt, Java için Ultimate Options Parser - Birkaç komut satırı seçenek standardı önerilmiş olmasına rağmen, ritopt opt ​​paketinde belirtilen kurallara uyar.

Mutsuzluğun bu meta-makalesini bir atlama noktası olarak ilginç bulabilirsiniz:

http://furiouspurpose.blogspot.com/2008/07/command-line-parsing-libraries-for-java.html

Bir tane daha yazdım: http://argparse4j.sourceforge.net/

Argparse4j, Java için Python'un argparse'ına dayanan bir komut satırı bağımsız değişken ayrıştırıcı kütüphanesidir.

Gnu getopt hakkında bilginiz varsa, şu adreste bir Java bağlantı noktası vardır: http://www.urbanophile.com/arenn/hacking/download.htm .

Bunu yapan bazı sınıflar var gibi görünüyor:

• http://docs.sun.com/source/816-5618-10/netscape/ldap/util/GetOpt.html
• http://xml.apache.org/xalan-j/apidocs/org/apache/xalan/xsltc/cmdline/getopt/GetOpt.html

havayolu @ Github iyi görünüyor. Ek açıklamaya dayanır ve Git komut satırı yapılarını taklit etmeye çalışır.

Zaten Spring Boot kullanıyorsanız, argüman ayrıştırma kutunun dışına çıkar.

Başlangıçtan sonra bir şey çalıştırmak istiyorsanız, ApplicationRunnerarayüzü uygulayın:

@SpringBootApplication
public class Application implements ApplicationRunner {

  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }

  @Override
  public void run(ApplicationArguments args) {
    args.containsOption("my-flag-option"); // test if --my-flag-option was set
    args.getOptionValues("my-option");     // returns values of --my-option=value1 --my-option=value2 
    args.getOptionNames();                 // returns a list of all available options
    // do something with your args
  }
}

Kişisel runbağlam başarıyla çalıştırılması ardından yöntemi çağrılır.

Uygulama bağlamınızı tetiklemeden önce bağımsız değişkenlere erişmeniz gerekiyorsa, yalnızca uygulama bağımsız değişkenlerini manuel olarak ayrıştırabilirsiniz:

@SpringBootApplication
public class Application implements ApplicationRunner {

  public static void main(String[] args) {
    ApplicationArguments arguments = new DefaultApplicationArguments(args);
    // do whatever you like with your arguments
    // see above ...
    SpringApplication.run(Application.class, args);
  }

}

Ve son olarak, bir fasulye içindeki argümanlarınıza erişmeniz gerekiyorsa, şunları enjekte edin ApplicationArguments:

@Component
public class MyBean {

   @Autowired
   private ApplicationArguments arguments;

   // ...
}

Argparse4j bulduğum en iyisidir. Python'un çok kullanışlı ve güçlü argparse libaryerini taklit eder.

Hafif (kavanoz boyutu ~ 20 kb) ve kullanımı basit bir şey istiyorsanız, bağımsız değişken ayrıştırıcıyı deneyebilirsiniz . Çoğu kullanım durumunda kullanılabilir, argümanda dizileri belirtmeyi destekler ve başka herhangi bir kütüphaneye bağımlılığı yoktur. Java 1.5 veya üstü için çalışır. Aşağıdaki alıntı, nasıl kullanılacağına dair bir örnek göstermektedir:

public static void main(String[] args) {
    String usage = "--day|-d day --mon|-m month [--year|-y year][--dir|-ds directoriesToSearch]";
    ArgumentParser argParser = new ArgumentParser(usage, InputData.class);
    InputData inputData = (InputData) argParser.parse(args);
    showData(inputData);

    new StatsGenerator().generateStats(inputData);
}

Daha fazla örnek burada bulunabilir

Apache Common CLINon-threadsafe olduğu için kütüphane kullanmanızı tavsiye etmem .

Dahili çalışma yapmak için statik değişkenler ve yöntemler içeren durumsal sınıflar kullanır (örn. OptionBuilder) Ve yalnızca tek iş parçacıklı güçlü kontrol edilen durumlarda kullanılmalıdır.

Daha önce bahsedilen yorumlardan biri olarak ( https://github.com/pcj/google-options ) başlamak için iyi bir seçim olacaktır.

Eklemek istediğim bir şey:

1) Ayrıştırıcı yansıması hatasıyla karşılaşırsanız, lütfen guava'nın daha yeni bir sürümünü kullanmayı deneyin. benim durumumda:

maven_jar(
    name = "com_google_guava_guava",
    artifact = "com.google.guava:guava:19.0",
    server = "maven2_server",
)

maven_jar(
    name = "com_github_pcj_google_options",
    artifact = "com.github.pcj:google-options:jar:1.0.0",
    server = "maven2_server",
)

maven_server(
    name = "maven2_server",
    url = "http://central.maven.org/maven2/",
)

2) Komut satırını çalıştırırken:

bazel run path/to/your:project -- --var1 something --var2 something -v something

3) Kullanım yardımına ihtiyacınız olduğunda, şunu yazın:

bazel run path/to/your:project -- --help

Bahar kullanıcıları için ayrıca https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/env/SimpleCommandLinePropertySource.html ve ikiz kardeşi https: //docs.spring'den de bahsetmeliyiz. .io / spring / docs / current / javadoc-api / org / springframework / core / env / JOptCommandLinePropertySource.html (Aynı işlevselliğin JOpt uygulaması). İlkbahardaki avantaj, komut satırı argümanlarını özniteliklere doğrudan bağlayabilmenizdir, burada bir örnek var https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/env/ CommandLinePropertySource.html