前言

javac有很多選項,在jdk1.8中,通過javac -help 可以看到如下資訊的輸出:

關於這個option所對應的類就是Option.接下來我們就來看一下這個類

解析

Option類是一個列舉,代表javac的選項.處理命令列選項的特定選項是通過按順序搜尋此列舉的成員來標識的,找到第一個匹配的.

其中,Option又分為OptionKind,OptionGroup,ChoiceKind不同的型別.這三種也是列舉,定義如下:

OptionKind

該類代表命令列引數的型別,通過-help 和 -X來使用的.

public enum OptionKind {
    // 標準的選項,被-help所文件化
    STANDARD,
    // 擴充套件的選項,被-X所文件化
    EXTENDED,
    // 隱藏的選項,沒有被文件化
    HIDDEN,
}
 

OptionGroup

OptionGroup --> option的組別,這決定了該option在什麼情況下是可被接受的.

enum OptionGroup {
    // 基本的option,可以通過命令列或者編譯器api來使用
    BASIC,
	 // 一個javac 標準的JavaFileManager的選項,其他的file manager可能不支援這個選項
    FILEMANAGER,
   	// 一個請求資訊的命令列選項,比如 -help
    INFO,
    // 一個代表檔案或者類名的命令列選項
    OPERAND
}

ChoiceKind

ChoiceKind --> 關於 選擇的型別.

    enum ChoiceKind {
        // 在可供選擇的選項中有確定的值
        ONEOF,
        // 選項值需要都存在
        ANYOF
    }

舉例說明如下:

-Xpkginfo: 這個編譯選項是處理package-info 檔案的,該選項的值是{always,legacy,nonempty} 中的任意一個,此時ChoiceKind為ONEOF.

-g: 這個編譯選項是生成某些除錯資訊(lines,vars,source). 這個選項只能是(lines,vars,source),不能是其他的值.如果傳入的引數值為 -g:vars,-g:xx,則最終不會進行編譯

關於這兩個選項的區別,可以通過檢視原始碼的方式來觀察:

	// com.sun.tools.javac.main.Option.matches(String)
    public boolean matches(String option) {
        if (!hasSuffix)
            return option.equals(text);

        if (!option.startsWith(text))
            return false;

        if (choices != null) {
            String arg = option.substring(text.length());
            if (choiceKind == ChoiceKind.ONEOF)
                return choices.keySet().contains(arg);
            else {
                for (String a: arg.split(",+")) {
                    if (!choices.keySet().contains(a))
                        return false;
                }
            }
        }

        return true;
    }

可以看到,如果choiceKind為ONEOF,則只要在選項集中有對應的值即可,而ANYOF,則要求選項值需要在選項集中都存在.

–

Option的欄位,建構函式如下:

    public final String text; // 選項所對應的文字

    final OptionKind kind; // 選項的型別

    final OptionGroup group; // 選項的組別

    final String argsNameKey; // 有關引數的文件key

    final String descrKey; // 該選項的說明所對應的key

    final boolean hasSuffix; // 該選項是否有後綴. 當選擇是=或者:結尾的,則認為該選項是有後綴的,如: (-foo=bar or -foo:bar)

    final ChoiceKind choiceKind; // 選擇的型別

    final Map<String,Boolean> choices; // 選項的值集合


    Option(String text, String descrKey,
            OptionKind kind, OptionGroup group) {
        this(text, null, descrKey, kind, group, null, null, false);
    }

    Option(String text, String argsNameKey, String descrKey,
            OptionKind kind, OptionGroup group) {
        this(text, argsNameKey, descrKey, kind, group, null, null, false);
    }

    Option(String text, String argsNameKey, String descrKey,
            OptionKind kind, OptionGroup group, boolean doHasSuffix) {
        this(text, argsNameKey, descrKey, kind, group, null, null, doHasSuffix);
    }

    Option(String text, String descrKey,
            OptionKind kind, OptionGroup group,
            ChoiceKind choiceKind, Map<String,Boolean> choices) {
        this(text, null, descrKey, kind, group, choiceKind, choices, false);
    }

    Option(String text, String descrKey,
            OptionKind kind, OptionGroup group,
            ChoiceKind choiceKind, String... choices) {
        this(text, null, descrKey, kind, group, choiceKind,
                createChoices(choices), false);
    }
    // where
        private static Map<String,Boolean> createChoices(String... choices) {
            Map<String,Boolean> map = new LinkedHashMap<String,Boolean>();
            for (String c: choices)
                map.put(c, false);
            return map;
        }

    private Option(String text, String argsNameKey, String descrKey,
            OptionKind kind, OptionGroup group,
            ChoiceKind choiceKind, Map<String,Boolean> choices,
            boolean doHasSuffix) {
        this.text = text;
        this.argsNameKey = argsNameKey;
        this.descrKey = descrKey;
        this.kind = kind;
        this.group = group;
        this.choiceKind = choiceKind;
        this.choices = choices;
        char lastChar = text.charAt(text.length()-1);
        this.hasSuffix = doHasSuffix || lastChar == ':' || lastChar == '=';
    }

下面舉例來說明 text,argsNameKey,descrKey的作用,以-cp選項為例:

CP("-cp", "opt.arg.path", "opt.classpath", STANDARD, FILEMANAGER) {
    @Override
    public boolean process(OptionHelper helper, String option, String arg) {
        return super.process(helper, "-classpath", arg);
    }
}

可以看到,-cp對應的是CP,其text = -cp, argsNameKey = opt.arg.path, descrKey = opt.classpath.

這裡補充一點,javac中的任何資訊的輸出都是本地化了的,其對應的資原始檔在com/sun/tools/javac/resources下,如圖:

當我們輸入javac -help時,對於-cp,輸出的內容如下:

-cp <路徑> 指定查詢使用者類檔案和註釋處理程式的位置

那麼這是如何實現的呢？

首先是輸出CP的text,然後在javac_zh_CN.properties 中獲得javac.opt.arg.path 對應的value,當前為 javac.opt.arg.path=<路徑>, 然後再獲得javac.opt.classpath的value,當前為 javac.opt.classpath=指定查詢使用者類檔案和註釋處理程式的位置.

這部分所對應的原始碼如下:

	// com.sun.tools.javac.main.Option.helpSynopsis(Log)
    private String helpSynopsis(Log log) {
        StringBuilder sb = new StringBuilder();
        sb.append(text);
        if (argsNameKey == null) {
            if (choices != null) {
                String sep = "{";
                for (Map.Entry<String,Boolean> e: choices.entrySet()) {
                    if (!e.getValue()) {
                        sb.append(sep);
                        sb.append(e.getKey());
                        sep = ",";
                    }
                }
                sb.append("}");
            }
        } else {
            if (!hasSuffix)
                sb.append(" ");
            sb.append(log.localize(PrefixKind.JAVAC, argsNameKey));

        }

        return sb.toString();
    }

在Option中還定義了一個process函式,是用來處理編譯器選項的.如下:

public boolean process(OptionHelper helper, String option) {
    if (hasSuffix)
        return process(helper, text, option.substring(text.length()));
    else
        return process(helper, option, option);
}

public boolean process(OptionHelper helper, String option, String arg) {
    if (choices != null) {
        if (choiceKind == ChoiceKind.ONEOF) {
            // some clients like to see just one of option+choice set
            for (String s: choices.keySet())
                helper.remove(option + s);
            String opt = option + arg;
            helper.put(opt, opt);
            // some clients like to see option (without trailing ":")
            // set to arg
            String nm = option.substring(0, option.length() - 1);
            helper.put(nm, arg);
        } else {
            // set option+word for each word in arg
            for (String a: arg.split(",+")) {
                String opt = option + a;
                helper.put(opt, opt);
            }
        }
    }
    helper.put(option, arg);
    return false;
}

經過這個函式的處理,就將選項值加入到了Main中的OptionHelper.關於這部分的程式碼我們後續在講解.

總結

現通過表格的方式,將Option的所有選項列出: