Thư viện Java để phân tích cú pháp tham số dòng lệnh?

Question

Tôi viết một ứng dụng dòng lệnh nhỏ trong Java. Ứng dụng này sẽ hoạt động với kết hợp các tham số và lệnh, tương tự như svn.

Ví dụ

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 

Wanted

• Tồn tại một thư viện để dễ dàng sử dụng cho Ja va
• Hỗ trợ phân tích như vậy lệnh dòng
• (Bonus) Tự động tạo ra một sự giúp đỡ thích hợp

Answer 1

Tôi là một fan hâm mộ của Commons CLI.

Bạn có thể đặt để hiểu lệnh, cờ (có tên ngắn và dài), có hoặc không có lệnh/công tắc nhất định được yêu cầu hoặc nếu chúng có giá trị mặc định. Nó thậm chí còn có chức năng in ra một tin nhắn loại --help hữu ích.

Trang Usage Scenarios có một số ví dụ hay về cách sử dụng.

Answer 2

Ngoài ra còn có một java getopt http://www.urbanophile.com/arenn/hacking/download.html

Answer 3

Hãy thử args4j:http://args4j.kohsuke.org

tôi thích args4j để Commons CLI. (Và tôi đã sử dụng cả hai.)

Với args4j, bạn không cần phải gọi bất kỳ chức năng nào. Mọi thứ đã hoàn tất cho bạn! (Các tham số được đặt thành các trường đối tượng thông qua sự phản chiếu.)

Answer 4

JewelCLI là Java library for command-line parsing that yields clean code. Nó sử dụng các giao diện Proxied được cấu hình với các chú thích để tự động xây dựng một API an toàn kiểu cho các tham số dòng lệnh của bạn.

Một giao diện ví dụ tham số Person.java:

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

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

Một cách sử dụng ví dụ về giao diện thông số 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()); 
     } 
    } 
} 

Lưu bản sao của các tập tin trên vào một thư mục duy nhất và tải về JewelCLI 0.7.6 JAR vào thư mục đó cũng.

Biên dịch và chạy ví dụ trong Bash trên Linux/Mac OS X/v.v.:

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

Biên dịch và chạy ví dụ trong Windows Command Prompt:

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

Chạy ví dụ nên năng suất đầu ra sau đây:

Hello John Doe 
Hello John Doe 
Hello John Doe 

Answer 5

JSAP trông khá tốt đối với tôi.

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

Answer 6

Nó cũng đáng xem xét --jopt-simple.

Nó 'cố gắng tôn vinh các cú pháp tùy chọn dòng lệnh của POSIX getopt() và GNU getopt_long().' Dường như có một số lực kéo cộng đồng, đáng chú ý là dòng lệnh phân tích cú pháp lib của sự lựa chọn cho OpenJDK (và Minecraft!).

Answer 7

Đối với đầy đủ vì chúng ta hãy thêm 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; 
} 

và một ví dụ sử dụng

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

Tôi đang sử dụng không vận cho một dự án tôi đang làm việc trên, dường như làm việc khá độc đáo:

https://github.com/airlift/airline

Simple Maven depen dency mà bạn cần phải thêm:

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

Và sau đó chú thích cũng có cách hiển thị văn bản trợ giúp khá gọn gàng.

có thể xem một ví dụ ở đây nếu nó hữu ích:

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

Answer 9

Dưới đây là một tương đối cập nhật (Tính đến tháng 8 năm 2017) danh sách các thư viện mà trả lời câu hỏi của bạn.

• picocli (2017) có sự giúp đỡ sử dụng với ANSI màu sắc, và autocomplete
• JArgs
• Jakarta Commons CLI
• TE-Code (nó có một dòng lệnh phân tích thư viện.)
• argparser
• Java port of GNU getopt
• Args4J
• JSAP
• JOpt Simple
• CLAJR
• CmdLn
• JewelCli
• JCommando
• parse-cmd
• JCommander

Nếu bạn đang tìm kiếm một đề nghị, tôi khuyên bạn nên JOpt đơn giản hoặc JewelCli.

Answer 10

Commandline là dựa trên chú thích, cho phép các quy tắc phức tạp để kết hợp các đối số (chuỗi, lồng nhau, đối số, loại, ...) và được ghi lại hợp lý.

Để sử dụng nó, thêm

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

để pom của bạn, và tuyên bố các tùy chọn có sẵn như sau:

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 
} 

và sau đó thực sự phân tích dòng lệnh, làm

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

lưu ý rằng nó chưa (chưa) chứa văn bản trợ giúp được tạo tự động. Đây là nguyên mẫu, nhưng bị hủy bỏ. Việc tạo một văn bản trợ giúp cơ bản cho các trường hợp đơn giản là dễ dàng, nhưng đối với các cấu hình phức tạp hơn (ae các tùy chọn có sẵn cho ứng dụng như "find" hoặc "gcc"), kết quả sẽ không đẹp, và bạn có thể muốn tự kiểm soát bố cục.