Apa cara yang baik untuk mem-parsing argumen baris perintah di Jawa?

Lihat ini:

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

Atau gulir sendiri:

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

Misalnya, ini adalah bagaimana Anda gunakan commons-cliuntuk mem-parsing 2 argumen string:

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);

    }

}

penggunaan dari baris perintah:

$> 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

Lihatlah JCommander yang lebih baru .

Saya membuatnya. Saya senang menerima pertanyaan atau permintaan fitur.

Saya telah mencoba mempertahankan daftar parser Java CLI .

• Perusahaan penerbangan
  • Garpu Aktif: https://github.com/rvesse/airline
• argparse4j
• juru bicara
• args4j
• Clajr
• cli-parser
• CmdLn
• Garis komando
• DocOpt.java
• Lumba-lumba mendapatkan
• DPML CLI (garpu Jakarta Commons CLI2)
• Matthias Laux
• CLI Commons Jakarta
• Jargo
• jargp
• jargs
• java-getopt
• jbock
• JCLAP
• jcmdline
• komandan
• jcommando
• jewelcli (ditulis oleh saya)
• Sederhana
• jsap
• naturalcli
• Objek artikel Mentor CLI (lebih lanjut tentang refactoring dan TDD)
• parse-cmd
• ritopt
• Rop
• Perintah TE-Code
• picocli memiliki bantuan penggunaan berwarna ANSI dan pelengkapan otomatis

Ini tahun 2020, waktu untuk melakukan yang lebih baik daripada Commons CLI ... :-)

Haruskah Anda membuat parser baris perintah Java Anda sendiri, atau menggunakan perpustakaan?

Banyak aplikasi kecil yang mirip utilitas mungkin memutar parsing baris perintah mereka sendiri untuk menghindari ketergantungan eksternal tambahan. picocli mungkin menjadi alternatif yang menarik.

Picocli adalah pustaka dan kerangka kerja modern untuk membangun aplikasi baris perintah yang kuat, mudah digunakan, dan mendukung GraalVM dengan mudah. Ia hidup dalam 1 file sumber sehingga aplikasi dapat memasukkannya sebagai sumber untuk menghindari penambahan ketergantungan.

Ini mendukung warna, pelengkapan otomatis, sub-perintah, dan banyak lagi. Ditulis di Jawa, dapat digunakan dari Groovy, Kotlin, Scala, dll.

Fitur:

• Berbasis anotasi: deklaratif , menghindari duplikasi dan mengekspresikan maksud programmer
• Nyaman: parse input pengguna dan jalankan logika bisnis Anda dengan satu baris kode
• Sangat diketik semuanya - opsi baris perintah serta parameter posisi
• Opsi pendek berkerumun POSIX ( <command> -xvfInputFiledan juga <command> -x -v -f InputFile)
• Kontrol berbutir halus : model arity yang memungkinkan jumlah parameter minimum, maksimum dan variabel, misalnya "1..*","3..5"
• Sub-perintah (dapat disarangkan ke kedalaman sewenang-wenang)
• Kaya fitur : grup arg yang dapat dikomposisikan, yang membagi argumen yang dikutip, sub-perintah berulang, dan banyak lagi
• User-friendly : pesan bantuan penggunaan menggunakan warna untuk membedakan elemen-elemen penting seperti nama opsi dari sisa penggunaan bantuan untuk mengurangi beban kognitif pada pengguna
• Distribusikan aplikasi Anda sebagai gambar asli GraalVM
• Bekerja dengan Java 5 dan lebih tinggi
• Dokumentasi yang luas dan teliti

Pesan bantuan penggunaan mudah disesuaikan dengan anotasi (tanpa pemrograman). Sebagai contoh:

( sumber )

Saya tidak bisa menolak menambahkan satu tangkapan layar lagi untuk menunjukkan pesan bantuan penggunaan apa yang mungkin. Bantuan penggunaan adalah wajah aplikasi Anda, jadi jadilah kreatif dan bersenang-senang!

Penafian: Saya membuat picocli. Umpan balik atau pertanyaan sangat disambut.

Saya telah menggunakan JOPT dan merasa cukup berguna: http://jopt-simple.sourceforge.net/

Halaman depan juga menyediakan daftar sekitar 8 perpustakaan alternatif, periksa dan pilih satu yang paling sesuai dengan kebutuhan Anda.

Seseorang menunjuk saya ke args4j akhir-akhir ini yang didasarkan pada penjelasan. Aku benar-benar menyukainya!

Ini adalah parsing library baris perintah Google yang bersumber terbuka sebagai bagian dari proyek Bazel. Secara pribadi saya pikir itu yang terbaik di luar sana, dan jauh lebih mudah daripada Apache CLI.

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

Instalasi

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

Maven

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

Pemakaian

Buat kelas yang memperluas OptionsBasedan mendefinisikan @Option(s) Anda.

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;

}

Pecahkan argumen dan gunakan.

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

Lihatlah proyek Commons CLI , banyak hal bagus di sana.

Yap.

Saya pikir Anda sedang mencari sesuatu seperti ini: http://commons.apache.org/cli

Pustaka Apache Commons CLI menyediakan API untuk memproses antarmuka baris perintah.

Saya tahu kebanyakan orang di sini akan menemukan 10 juta alasan mengapa mereka tidak menyukai cara saya, tetapi tidak pernah. Saya suka menjaga hal-hal sederhana, jadi saya hanya memisahkan kunci dari nilai menggunakan '=' dan menyimpannya dalam HashMap seperti ini:

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

Anda selalu dapat mempertahankan daftar dengan argumen yang Anda harapkan, untuk membantu pengguna jika dia lupa argumen atau menggunakan yang salah ... Namun, jika Anda ingin terlalu banyak fitur, solusi ini bukan untuk Anda.

Mungkin ini

• Paket parsing opsi perintah JArgs untuk Java - proyek mungil ini menyediakan rangkaian parser opsi perintah baris yang nyaman, kompak, pra-paket dan didokumentasikan secara komprehensif untuk penggunaan programmer Java. Awalnya, parsing kompatibel dengan 'getopt' gaya GNU disediakan.

• ritopt, Parser Opsi Utama untuk Java - Meskipun, beberapa standar opsi baris perintah telah disiapkan, ritopt mengikuti konvensi yang ditentukan dalam paket opt.

Anda mungkin menemukan meta-artikel ketidakbahagiaan ini menarik sebagai titik tolak:

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

Saya menulis satu lagi: http://argparse4j.sourceforge.net/

Argparse4j adalah parser argumen argumen baris perintah untuk Java, berdasarkan argparse Python.

Jika Anda terbiasa dengan gnu getopt, ada port Java di: http://www.urbanophile.com/arenn/hacking/download.htm .

Tampaknya ada beberapa kelas yang melakukan ini:

• 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

airline @ Github terlihat bagus. Ini didasarkan pada anotasi dan mencoba untuk meniru struktur baris perintah Git.

Jika Anda sudah menggunakan Spring Boot, parsing argumen keluar dari kotak.

Jika Anda ingin menjalankan sesuatu setelah startup, terapkan ApplicationRunnerantarmuka:

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

runMetode Anda akan dipanggil setelah konteksnya berhasil dimulai.

Jika Anda memerlukan akses ke argumen sebelum menjalankan konteks aplikasi Anda, Anda cukup menguraikan argumen aplikasi secara manual:

@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);
  }

}

Dan akhirnya, jika Anda membutuhkan akses ke argumen Anda dalam kacang, cukup menyuntikkan ApplicationArguments:

@Component
public class MyBean {

   @Autowired
   private ApplicationArguments arguments;

   // ...
}

Argparse4j adalah yang terbaik yang saya temukan. Ini meniru perpustakaan argparse Python yang sangat nyaman dan kuat.

Jika Anda menginginkan sesuatu yang ringan (ukuran tabung ~ 20 kb) dan mudah digunakan, Anda dapat mencoba parser argumen . Ini dapat digunakan di sebagian besar kasus penggunaan, mendukung menentukan array dalam argumen dan tidak memiliki ketergantungan pada pustaka lain. Ini berfungsi untuk Java 1.5 atau lebih tinggi. Kutipan di bawah ini menunjukkan contoh cara menggunakannya:

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);
}

Lebih banyak contoh dapat ditemukan di sini

Saya tidak akan merekomendasikan menggunakan Apache Common CLIperpustakaan, karena ini adalah non-threadsafe.

Ia menggunakan kelas stateful dengan variabel statis dan metode untuk melakukan pekerjaan internal (misalnya OptionBuilder) dan hanya boleh digunakan dalam situasi berulir kuat yang dikontrol.

Sebagai salah satu komentar yang disebutkan sebelumnya ( https://github.com/pcj/google-options ) akan menjadi pilihan yang baik untuk memulai.

Satu hal yang ingin saya tambahkan adalah:

1) Jika Anda mengalami kesalahan refleksi parser, coba gunakan versi jambu yang lebih baru. dalam hal ini:

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) Saat menjalankan commandline:

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

3) Saat Anda membutuhkan bantuan penggunaan, ketikkan:

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

Untuk pengguna Spring, kami juga harus menyebutkan https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/env/SimpleCommandLinePropertySource.html dan saudara kembarnya https: //docs.spring .io / spring / docs / current / javadoc-api / org / springframework / core / env / JOptCommandLinePropertySource.html (Implementasi JOpt dengan fungsi yang sama). Keuntungan di Spring adalah Anda dapat langsung mengikat argumen baris perintah ke atribut, ada contoh di sini https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/env/ CommandLinePropertySource.html