Một cách tốt để phân tích các đối số dòng lệnh trong Java là gì?

Kiểm tra những điều này:

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

Hoặc tự cuộn:

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

Chẳng hạn, đây là cách bạn sử dụng commons-cliđể phân tích 2 đối số chuỗi:

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

    }

}

sử dụng từ dòng lệnh:

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

Hãy xem JCommander gần đây hơn .

Tôi đã tạo ra nó. Tôi rất vui khi nhận được câu hỏi hoặc yêu cầu tính năng.

Tôi đã cố gắng duy trì một danh sách các trình phân tích cú pháp Java CLI .

• Hãng hàng không
  • Ngã ba hoạt động: https://github.com/rvesse/airline
• argparse4j
• người lập luận
• args4j
• clajr
• phân tích cú pháp
• CmdLn
• Dòng lệnh
• DocOpt.java
• cá heo getopt
• DPML CLI (ngã ba Jakarta Commons CLI2)
• Tiến sĩ Matthias Laux
• Trung tâm thương mại Jakarta
• jargo
• biệt ngữ
• biệt ngữ
• java-getopt
• jbock
• JCLAP
• jcmdline
• jcommander
• jcommando
• jewcli (viết bởi tôi)
• Công việc đơn giản
• jsap
• tự nhiên
• Bài viết Object Mentor CLI (thêm về tái cấu trúc và TDD)
• phân tích cú pháp
• ritopt
• Rop
• Lệnh TE-Code
• picocli có trợ giúp sử dụng màu ANSI và tự động hoàn thành

Đó là năm 2020, thời gian để làm tốt hơn Commons CLI ... :-)

Bạn nên xây dựng trình phân tích cú pháp dòng lệnh Java của riêng bạn hay sử dụng một thư viện?

Nhiều ứng dụng nhỏ giống như tiện ích có thể cuộn phân tích dòng lệnh của riêng chúng để tránh phụ thuộc bên ngoài. picocli có thể là một thay thế thú vị.

Picocli là một thư viện và khung hiện đại để xây dựng các ứng dụng dòng lệnh mạnh mẽ, thân thiện với người dùng, hỗ trợ GraalVM một cách dễ dàng. Nó nằm trong 1 tệp nguồn nên các ứng dụng có thể bao gồm nó dưới dạng nguồn để tránh thêm phụ thuộc.

Nó hỗ trợ màu sắc, tự động hoàn thành, các tiểu ban, v.v. Được viết bằng Java, có thể sử dụng từ Groovy, Kotlin, Scala, v.v.

Đặc trưng:

• Chú thích dựa trên: khai báo , tránh trùng lặp và thể hiện ý định lập trình viên
• Thuận tiện: phân tích cú pháp người dùng nhập và chạy logic kinh doanh của bạn với một dòng mã
• Gõ mạnh mọi thứ - tùy chọn dòng lệnh cũng như các tham số vị trí
• POSIX cụm tùy chọn ngắn ( <command> -xvfInputFilecũng như <command> -x -v -f InputFile)
• Kiểm soát chi tiết : một mô hình arity cho phép số lượng tham số tối thiểu, tối đa và thay đổi, ví dụ "1..*","3..5"
• Các tiểu ban (có thể được lồng vào độ sâu tùy ý)
• Giàu tính năng : các nhóm đối số có thể tổng hợp, tách các đối số được trích dẫn, các tiểu ban lặp lại và nhiều hơn nữa
• Thân thiện với người dùng : thông báo trợ giúp sử dụng sử dụng màu sắc để tương phản các yếu tố quan trọng như tên tùy chọn từ phần còn lại của việc sử dụng giúp giảm tải nhận thức cho người dùng
• Phân phối ứng dụng của bạn dưới dạng hình ảnh gốc GraalVM
• Hoạt động với Java 5 trở lên
• Tài liệu mở rộng và tỉ mỉ

Thông báo trợ giúp sử dụng dễ dàng tùy chỉnh với các chú thích (không cần lập trình). Ví dụ:

( nguồn )

Tôi không thể cưỡng lại việc thêm một ảnh chụp màn hình để hiển thị những thông báo trợ giúp sử dụng nào có thể. Trợ giúp sử dụng là bộ mặt của ứng dụng của bạn, vì vậy hãy sáng tạo và vui chơi!

Disclaimer: Tôi đã tạo picocli. Phản hồi hoặc câu hỏi rất hoan nghênh.

Tôi đã sử dụng JOpt và thấy nó khá tiện dụng: http://jopt-simple.sourceforge.net/

Trang đầu cũng cung cấp một danh sách khoảng 8 thư viện thay thế, kiểm tra chúng và chọn một thư viện phù hợp nhất với nhu cầu của bạn.

Một số người chỉ cho tôi đến args4j gần đây là chú thích dựa trên. Tôi thực sự thích nó!

Đây là thư viện phân tích cú pháp dòng lệnh của Google có nguồn mở như một phần của dự án Bazel. Cá nhân tôi nghĩ rằng đó là thứ tốt nhất ngoài kia, và dễ dàng hơn nhiều so với Apache CLI.

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

Cài đặt

Bazel

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

Học sinh lớp

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>

Sử dụng

Tạo một lớp mở rộng OptionsBasevà định nghĩa @Option(các) của bạn .

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;

}

Phân tích các đối số và sử dụng chúng.

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

Hãy xem dự án Commons CLI , rất nhiều thứ hay ho trong đó.

Yeap.

Tôi nghĩ rằng bạn đang tìm kiếm một cái gì đó như thế này: http://commons.apache.org/cli

Thư viện CLI Apache Commons cung cấp API để xử lý giao diện dòng lệnh.

Tôi biết hầu hết mọi người ở đây sẽ tìm thấy 10 triệu lý do tại sao họ không thích cách của tôi, nhưng không bao giờ. Tôi muốn giữ mọi thứ đơn giản, vì vậy tôi chỉ tách khóa khỏi giá trị bằng cách sử dụng '=' và lưu trữ chúng trong HashMap như thế này:

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

Bạn luôn có thể duy trì một danh sách với các đối số bạn đang mong đợi, để giúp người dùng trong trường hợp anh ta quên một đối số hoặc sử dụng một đối số sai ... Tuy nhiên, nếu bạn muốn quá nhiều tính năng thì giải pháp này không dành cho bạn.

Có lẽ những

• Bộ phân tích cú pháp tùy chọn dòng lệnh JArss cho Java - dự án nhỏ này cung cấp một bộ trình phân tích cú pháp tùy chọn dòng lệnh tiện lợi, nhỏ gọn, được đóng gói sẵn và toàn diện để sử dụng cho các lập trình viên Java. Ban đầu, phân tích cú pháp tương thích với 'getopt' kiểu GNU được cung cấp.

• ritopt, Trình phân tích tùy chọn cuối cùng cho Java - Mặc dù, một số tiêu chuẩn tùy chọn dòng lệnh đã được đặt trước, ritopt tuân theo các quy ước được quy định trong gói opt.

Bạn có thể thấy bài báo meta về sự bất hạnh này thú vị như một điểm xuất phát:

http://fquilpurpose.blogspot.com/2008/07/command-line-parsing-lologists-for-java.html

Tôi đã viết một cái khác: http://argparse4j.sourceforge.net/

Argparse4j là một thư viện trình phân tích cú pháp đối số dòng lệnh cho Java, dựa trên argparse của Python.

Nếu bạn đã quen thuộc với gnu getopt, có một cổng Java tại: http://www.urbanophile.com/arenn/hacking/doad.htmlm .

Dường như có một số lớp làm điều này:

• 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

hãng hàng không @ Github có vẻ tốt. Nó dựa trên chú thích và đang cố gắng mô phỏng các cấu trúc dòng lệnh Git.

Nếu bạn đã sử dụng Spring Boot, phân tích cú pháp đối số sẽ xuất hiện.

Nếu bạn muốn chạy một cái gì đó sau khi khởi động, hãy thực hiện ApplicationRunnergiao diệ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
  }
}

runPhương pháp của bạn sẽ được gọi sau khi bối cảnh đã khởi động thành công.

Nếu bạn cần truy cập vào các đối số trước khi kích hoạt bối cảnh ứng dụng của mình, bạn chỉ cần phân tích cú pháp các đối số ứng dụng theo cách thủ công:

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

}

Và cuối cùng, nếu bạn cần quyền truy cập vào các đối số của mình trong một bean, chỉ cần thêm ApplicationArguments:

@Component
public class MyBean {

   @Autowired
   private ApplicationArguments arguments;

   // ...
}

Argparse4j là tốt nhất tôi đã tìm thấy. Nó bắt chước ngôn ngữ lập luận của Python rất tiện lợi và mạnh mẽ.

Nếu bạn muốn một cái gì đó nhẹ (kích thước jar ~ 20 kb) và đơn giản để sử dụng, bạn có thể thử trình phân tích cú pháp đối số . Nó có thể được sử dụng trong hầu hết các trường hợp sử dụng, hỗ trợ chỉ định mảng trong đối số và không phụ thuộc vào bất kỳ thư viện nào khác. Nó hoạt động cho Java 1.5 trở lên. Đoạn trích dưới đây cho thấy một ví dụ về cách sử dụng nó:

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

Thêm ví dụ có thể được tìm thấy ở đây

Tôi không khuyên bạn nên sử dụng Apache Common CLIthư viện, vì nó không an toàn.

Nó sử dụng các lớp trạng thái với các biến và phương thức tĩnh để thực hiện công việc nội bộ (ví dụ OptionBuilder) và chỉ nên được sử dụng trong các tình huống được kiểm soát mạnh mẽ đơn luồng.

Là một trong những ý kiến ​​được đề cập trước đó ( https://github.com/pcj/google-options ) sẽ là một lựa chọn tốt để bắt đầu.

Một điều tôi muốn thêm vào là:

1) Nếu bạn gặp phải một số lỗi phản ánh của trình phân tích cú pháp, vui lòng thử sử dụng phiên bản mới hơn của ổi. trong trường hợp của tôi:

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) Khi chạy dòng lệnh:

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

3) Khi bạn cần trợ giúp sử dụng, chỉ cần gõ:

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

Đối với người dùng Spring, chúng tôi cũng nên đề cập https://docs.spring.io/spring/docs/civerse/javadoc-api/org/springframework/core/env/SimpleCommandLinePropertySource.html và anh em sinh đôi của mình https: //docs.spring .io / mùa xuân / docs / hiện tại / javadoc-api / org / spring Framework / lõi / env / JOptCommandLinePropertySource.html (JOpt thực hiện chức năng tương tự). Ưu điểm trong Spring là bạn có thể liên kết trực tiếp các đối số dòng lệnh với các thuộc tính, có một ví dụ ở đây https://docs.spring.io/spring/docs/civerse/javadoc-api/org/springframework/core/env/ CommandLinePropertySource.html