一 約定優於配置

約定優於配置（convention over configuration），也稱作按約定程式設計，是一種軟體設計正規化，旨在減少軟體開發人員需做決定的數量，獲得簡單的好處，而又不失靈活性。大量的配置檔案，確實可以讓程式在一定程度上具有很大的靈活性，但是也要有度的限制，並不是越多越好；約定一些預設的配置，有助於減少配置檔案的數量。當然，全部使用約定而不支援配置也是不可取的，必然有失靈活性；因此約定優於配置不代表不是用配置，而是一種要同時提供約定和配置兩種方式。

rootAppender約定：
使用log4j列印日誌，需要配置日誌例項得輸出樣式以及目的地等等資訊，不是必須配置的。
log4j約定了一種無須配置的日誌例項的輸出方式，提供了一個基本的控制檯appender，所有建立的日誌例項列印的日誌都會按照這個appender輸出。
只需要在建立日誌例項之前呼叫預設初始化即可：

static {
    BasicConfigurator.configure();
    logger = LogManager.getLogger(Log4jOneTest.class);
} 

控制檯輸出格式如下，不輸出trace級別日誌：

配置檔案路徑的約定：
log4j約定了配置檔案在類路徑種的位置，無需在程式中指定配置檔案路徑，log4j會在其指定的預設類路徑下尋找配置，也就是在classpath得根路徑：

二 配置檔案如何載入

有時約定在classpaht根路徑下的配置檔案多了，會導致配置檔案沒有層次結構，很難發現配置檔案的功能；因此此時需要自定義log4j配置檔案的路徑。
尋找配置檔案：

static {
        // By default we use a DefaultRepositorySelector which always returns 'h'.
        Hierarchy h = new Hierarchy(new RootLogger((Level) Level.DEBUG));
        repositorySelector = new DefaultRepositorySelector(h);

        /** Search for the properties file log4j.properties in the CLASSPATH.  */
 

        // 獲取名為log4j.defaultInitOverride的vm變數，該變數決定日誌的初始化是否被過載
        String override = OptionConverter.getSystemProperty(DEFAULT_INIT_OVERRIDE_KEY,
                null);

        // if there is no default init override, then get the resource
        // specified by the user or the default config file.
        if (override == null || "false".equalsIgnoreCase(override)) {
            // DEFAULT_CONFIGURATION_KEY的值為log4j.configuration，獲取名為log4j.configuration的vm變數
            String configurationOptionStr = OptionConverter.getSystemProperty(
                    DEFAULT_CONFIGURATION_KEY,
                    null);

            String configuratorClassName = OptionConverter.getSystemProperty(
                    CONFIGURATOR_CLASS_KEY,
                    null);

            URL url = null;

            // if the user has not specified the log4j.configuration
            // property, we search first for the file "log4j.xml" and then
            // "log4j.properties"
            // 如果在vm系統變數中沒有找到log4j.configuration，則先在classpath根目錄找log4j.xml，
            // 再尋找log4j.properties檔案
            if (configurationOptionStr == null) {
                url = Loader.getResource(DEFAULT_XML_CONFIGURATION_FILE);
                if (url == null) {
                    url = Loader.getResource(DEFAULT_CONFIGURATION_FILE);
                }
            } else {
                // 若配置了vm系統變數log4j.configuration，則使用該變數的值作為配置檔案的類路徑
                try {
                    url = new URL(configurationOptionStr);
                } catch (MalformedURLException ex) {
                    // so, resource is not a URL:
                    // attempt to get the resource from the class path
                    url = Loader.getResource(configurationOptionStr);
                }
            }

            // If we have a non-null url, then delegate the rest of the
            // configuration to the OptionConverter.selectAndConfigure
            // method.
            if (url != null) {
                LogLog.debug("Using URL [" + url + "] for automatic log4j configuration.");
                try {
                    OptionConverter.selectAndConfigure(url, configuratorClassName,
                            LogManager.getLoggerRepository());
                } catch (NoClassDefFoundError e) {
                    LogLog.warn("Error during default initialization", e);
                }
            } else { // 沒有找到配置檔案則報錯
                LogLog.debug("Could not find resource: [" + configurationOptionStr + "].");
            }
        } else {
            LogLog.debug("Default initialization of overridden by " +
                    DEFAULT_INIT_OVERRIDE_KEY + "property.");
        }
    }

因此，LogManager在初始化時：

1.查詢log4j.defaultInitOverrideVM系統變數，確認初始化是否過載；
2.沒要被過載的情況下，查詢log4j.configurationVM系統變數，確認是否自定義配置檔案路徑；
3.沒要配置log4j.configurationVM系統變數，順序查詢根類路徑下的log4j.xml,log4j.properties

使用配置檔案：
分析LogManager,在查詢到配置檔案後，呼叫了：

OptionConverter.selectAndConfigure(url, configuratorClassName, LogManager.getLoggerRepository());

來處理配置，其中url就是配置檔案。

static
    public void selectAndConfigure(URL url, String clazz, LoggerRepository hierarchy) {
        Configurator configurator = null;
        String filename = url.getFile();
        // 根據配置檔名字尾選擇使用DOMConfigurator還是PropertyConfigurator來處理
        if (clazz == null && filename != null && filename.endsWith(".xml")) {
            clazz = "org.apache.log4j.xml.DOMConfigurator";
        }

        if (clazz != null) {
            LogLog.debug("Preferred configurator class: " + clazz);
            configurator = (Configurator) instantiateByClassName(clazz,
                    Configurator.class,
                    null);
            if (configurator == null) {
                LogLog.error("Could not instantiate configurator [" + clazz + "].");
                return;
            }
        } else {
            configurator = new PropertyConfigurator();
        }
        // 處理配置
        configurator.doConfigure(url, hierarchy);
    }

最後看看DOMConfigurator處理配置檔案的doConfigure方法：

public
  void doConfigure(final URL url, LoggerRepository repository) {
      ParseAction action = new ParseAction() {
          public Document parse(final DocumentBuilder parser) throws SAXException, IOException {
              URLConnection uConn = url.openConnection();
              uConn.setUseCaches(false);
              InputStream stream = uConn.getInputStream();
              try {
                InputSource src = new InputSource(stream);
                src.setSystemId(url.toString());
                return parser.parse(src);
              } finally {
                stream.close();
              }
          }
          public String toString() {
              return "url [" + url.toString() + "]";
          }
      };
      doConfigure(action, repository);
  }

可以看到讀取了配置檔案內容。PropertyConfigurator也是一樣的

三 自定義配置檔案路徑

瞭解了log4j如何載入配置檔案之後，就可以自定義配置檔案路徑了；

設值vm系統變數：
簡單的，在獲取logManager初始化值前，通過設定vm系統變數log4j.configuration的值為配置檔案路徑，可以達到目的：

static {
    String customizedPath = "log/log4j.xml";
    System.setProperty("log4j.configuration", customizedPath);
    logger = LogManager.getLogger(Log4jOneTest.class);
}

PropertyConfigurator或DOMConfigurator：
DOMConfigurator中有一個doConfigure()的static版本，對應xml配置方式，PropertyConfigurator也一樣，對應properties配置方式，通過呼叫這個方法也能指定配置檔案位置：

static public void configure(URL url) throws FactoryConfigurationError {
        new DOMConfigurator().doConfigure(url, LogManager.getLoggerRepository());
}

具體如下：

static {
    String customizedPath = "log/log4j.xml";
    DOMConfigurator.configure(getResource(customizedPath));
    logger = LogManager.getLogger(Log4jOneTest.class);
}