Do not cache default config, and use context class loader to load it

So we get any reference.conf from the context class loader.

This does NOT fix loading non-default configs, we need new API
to allow passing in a class loader for that. It also makes
things a bit less efficient since it no longer caches;
in the future we could do a per-class-loader cache.
This commit is contained in:
Havoc Pennington 2012-02-29 10:44:24 -05:00
parent e2c0979422
commit 9733578ebb
6 changed files with 93 additions and 58 deletions

View File

@ -11,7 +11,6 @@ import java.util.Map;
import java.util.Properties; import java.util.Properties;
import com.typesafe.config.impl.ConfigImpl; import com.typesafe.config.impl.ConfigImpl;
import com.typesafe.config.impl.ConfigImplUtil;
import com.typesafe.config.impl.Parseable; import com.typesafe.config.impl.Parseable;
/** /**
@ -103,8 +102,6 @@ public final class ConfigFactory {
.resolve(resolveOptions); .resolve(resolveOptions);
} }
private static class DefaultConfigHolder {
private static Config loadDefaultConfig() { private static Config loadDefaultConfig() {
int specified = 0; int specified = 0;
@ -137,17 +134,13 @@ public final class ConfigFactory {
try { try {
return load(parseURL(new URL(url))); return load(parseURL(new URL(url)));
} catch (MalformedURLException e) { } catch (MalformedURLException e) {
throw new ConfigException.Generic( throw new ConfigException.Generic("Bad URL in config.url system property: '"
"Bad URL in config.url system property: '" + url + "': " + url + "': " + e.getMessage(), e);
+ e.getMessage(), e);
} }
} }
} }
} }
static final Config defaultConfig = loadDefaultConfig();
}
/** /**
* Loads a default configuration, equivalent to {@link #load(String) * Loads a default configuration, equivalent to {@link #load(String)
* load("application")} in most cases. This configuration should be used by * load("application")} in most cases. This configuration should be used by
@ -176,11 +169,7 @@ public final class ConfigFactory {
* @return configuration for an application * @return configuration for an application
*/ */
public static Config load() { public static Config load() {
try { return loadDefaultConfig();
return DefaultConfigHolder.defaultConfig;
} catch (ExceptionInInitializerError e) {
throw ConfigImplUtil.extractInitializerError(e);
}
} }
/** /**

View File

@ -397,21 +397,12 @@ public class ConfigImpl {
return envVariablesAsConfigObject().toConfig(); return envVariablesAsConfigObject().toConfig();
} }
private static class ReferenceHolder {
private static final Config unresolvedResources = Parseable
.newResources(ConfigImpl.class, "/reference.conf", ConfigParseOptions.defaults())
.parse().toConfig();
static final Config referenceConfig = systemPropertiesAsConfig().withFallback(
unresolvedResources).resolve();
}
/** For use ONLY by library internals, DO NOT TOUCH not guaranteed ABI */ /** For use ONLY by library internals, DO NOT TOUCH not guaranteed ABI */
public static Config defaultReference() { public static Config defaultReference() {
try { Config unresolvedResources = Parseable
return ReferenceHolder.referenceConfig; .newResources(Thread.currentThread().getContextClassLoader(), "reference.conf",
} catch (ExceptionInInitializerError e) { ConfigParseOptions.defaults()).parse().toConfig();
throw ConfigImplUtil.extractInitializerError(e); return systemPropertiesAsConfig().withFallback(unresolvedResources).resolve();
}
} }
private static class DebugHolder { private static class DebugHolder {

View File

@ -0,0 +1 @@
a=1

View File

@ -0,0 +1 @@
b=2

View File

@ -464,4 +464,28 @@ class PublicApiTest extends TestUtils {
assertEquals("\"a\"", ConfigUtil.quoteString("a")) assertEquals("\"a\"", ConfigUtil.quoteString("a"))
assertEquals("\"\\n\"", ConfigUtil.quoteString("\n")) assertEquals("\"\\n\"", ConfigUtil.quoteString("\n"))
} }
@Test
def usesContextClassLoader() {
val loaderA1 = new TestClassLoader(this.getClass().getClassLoader(),
Map("reference.conf" -> resourceFile("a_1.conf").toURI.toURL()))
val loaderB2 = new TestClassLoader(this.getClass().getClassLoader(),
Map("reference.conf" -> resourceFile("b_2.conf").toURI.toURL()))
val configA1 = withContextClassLoader(loaderA1) {
ConfigFactory.load()
}
assertEquals(1, configA1.getInt("a"))
assertFalse("no b", configA1.hasPath("b"))
val configB2 = withContextClassLoader(loaderB2) {
ConfigFactory.load()
}
assertEquals(2, configB2.getInt("b"))
assertFalse("no a", configB2.hasPath("a"))
val configPlain = ConfigFactory.load()
assertFalse("no a", configPlain.hasPath("a"))
assertFalse("no b", configPlain.hasPath("b"))
}
} }

View File

@ -19,6 +19,9 @@ import java.io.ByteArrayInputStream
import java.io.ObjectInputStream import java.io.ObjectInputStream
import org.apache.commons.codec.binary.Hex import org.apache.commons.codec.binary.Hex
import scala.annotation.tailrec import scala.annotation.tailrec
import java.net.URL
import java.util.concurrent.Executors
import java.util.concurrent.Callable
abstract trait TestUtils { abstract trait TestUtils {
protected def intercept[E <: Throwable: Manifest](block: => Unit): E = { protected def intercept[E <: Throwable: Manifest](block: => Unit): E = {
@ -547,4 +550,30 @@ abstract trait TestUtils {
protected def resourceFile(filename: String) = { protected def resourceFile(filename: String) = {
new File(resourceDir, filename) new File(resourceDir, filename)
} }
protected class TestClassLoader(parent: ClassLoader, val additions: Map[String, URL]) extends ClassLoader(parent) {
override def findResources(name: String) = {
import scala.collection.JavaConverters._
val other = super.findResources(name).asScala
additions.get(name).map({ url => Iterator(url) ++ other }).getOrElse(other).asJavaEnumeration
}
override def findResource(name: String) = {
additions.get(name).getOrElse(null)
}
}
protected def withContextClassLoader[T](loader: ClassLoader)(body: => T): T = {
val executor = Executors.newSingleThreadExecutor()
val f = executor.submit(new Callable[T] {
override def call(): T = {
val t = Thread.currentThread()
val old = t.getContextClassLoader()
t.setContextClassLoader(loader)
val result = body
t.setContextClassLoader(old)
result
}
})
f.get
}
} }