public class ResourceBundleMessageSource extends AbstractResourceBasedMessageSource implements org.springframework.beans.factory.BeanClassLoaderAware
MessageSource implementation that
accesses resource bundles using specified basenames. This class relies
on the underlying JDK's ResourceBundle implementation,
in combination with the JDK's standard message parsing provided by
MessageFormat.
This MessageSource caches both the accessed ResourceBundle instances and
the generated MessageFormats for each message. It also implements rendering of
no-arg messages without MessageFormat, as supported by the AbstractMessageSource
base class. The caching provided by this MessageSource is significantly faster
than the built-in caching of the java.util.ResourceBundle class.
The basenames follow ResourceBundle conventions: essentially,
a fully-qualified classpath location. If it doesn't contain a package qualifier
(such as org.mypackage), it will be resolved from the classpath root.
Note that the JDK's standard ResourceBundle treats dots as package separators:
This means that "test.theme" is effectively equivalent to "test/theme".
AbstractResourceBasedMessageSource.setBasenames(java.lang.String...),
ReloadableResourceBundleMessageSource,
ResourceBundle,
MessageFormatlogger| Constructor and Description |
|---|
ResourceBundleMessageSource() |
| Modifier and Type | Method and Description |
|---|---|
protected ResourceBundle |
doGetBundle(String basename,
Locale locale)
Obtain the resource bundle for the given basename and Locale.
|
protected ClassLoader |
getBundleClassLoader()
Return the ClassLoader to load resource bundles with.
|
protected MessageFormat |
getMessageFormat(ResourceBundle bundle,
String code,
Locale locale)
Return a MessageFormat for the given bundle and code,
fetching already generated MessageFormats from the cache.
|
protected ResourceBundle |
getResourceBundle(String basename,
Locale locale)
Return a ResourceBundle for the given basename and code,
fetching already generated MessageFormats from the cache.
|
protected String |
getStringOrNull(ResourceBundle bundle,
String key)
Efficiently retrieve the String value for the specified key,
or return
null if not found. |
protected ResourceBundle |
loadBundle(Reader reader)
Load a property-based resource bundle from the given reader.
|
protected MessageFormat |
resolveCode(String code,
Locale locale)
Resolves the given message code as key in the registered resource bundles,
using a cached MessageFormat instance per message code.
|
protected String |
resolveCodeWithoutArguments(String code,
Locale locale)
Resolves the given message code as key in the registered resource bundles,
returning the value found in the bundle as-is (without MessageFormat parsing).
|
void |
setBeanClassLoader(ClassLoader classLoader) |
void |
setBundleClassLoader(ClassLoader classLoader)
Set the ClassLoader to load resource bundles with.
|
String |
toString()
Show the configuration of this MessageSource.
|
addBasenames, getBasenameSet, getCacheMillis, getDefaultEncoding, isFallbackToSystemLocale, setBasename, setBasenames, setCacheMillis, setCacheSeconds, setDefaultEncoding, setFallbackToSystemLocalegetCommonMessages, getDefaultMessage, getDefaultMessage, getMessage, getMessage, getMessage, getMessageFromParent, getMessageInternal, getParentMessageSource, isUseCodeAsDefaultMessage, resolveArguments, setCommonMessages, setParentMessageSource, setUseCodeAsDefaultMessagecreateMessageFormat, formatMessage, isAlwaysUseMessageFormat, renderDefaultMessage, setAlwaysUseMessageFormatpublic void setBundleClassLoader(ClassLoader classLoader)
Default is the containing BeanFactory's
bean ClassLoader,
or the default ClassLoader determined by
ClassUtils.getDefaultClassLoader()
if not running within a BeanFactory.
protected ClassLoader getBundleClassLoader()
Default is the containing BeanFactory's bean ClassLoader.
public void setBeanClassLoader(ClassLoader classLoader)
setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAwareprotected String resolveCodeWithoutArguments(String code, Locale locale)
resolveCodeWithoutArguments in class AbstractMessageSourcecode - the code of the message to resolvelocale - the locale to resolve the code for
(subclasses are encouraged to support internationalization)null if not foundAbstractMessageSource.resolveCode(java.lang.String, java.util.Locale),
MessageFormatprotected MessageFormat resolveCode(String code, Locale locale)
resolveCode in class AbstractMessageSourcecode - the code of the message to resolvelocale - the locale to resolve the code for
(subclasses are encouraged to support internationalization)null if not foundAbstractMessageSource.resolveCodeWithoutArguments(String, java.util.Locale)protected ResourceBundle getResourceBundle(String basename, Locale locale)
basename - the basename of the ResourceBundlelocale - the Locale to find the ResourceBundle fornull if none
found for the given basename and Localeprotected ResourceBundle doGetBundle(String basename, Locale locale) throws MissingResourceException
basename - the basename to look forlocale - the Locale to look forMissingResourceException - if no matching bundle could be foundResourceBundle.getBundle(String, Locale, ClassLoader),
getBundleClassLoader()protected ResourceBundle loadBundle(Reader reader) throws IOException
The default implementation returns a PropertyResourceBundle.
reader - the reader for the target resourceIOException - in case of I/O failurePropertyResourceBundle.PropertyResourceBundle(Reader)protected MessageFormat getMessageFormat(ResourceBundle bundle, String code, Locale locale) throws MissingResourceException
bundle - the ResourceBundle to work oncode - the message code to retrievelocale - the Locale to use to build the MessageFormatnull if no message
defined for the given codeMissingResourceException - if thrown by the ResourceBundleprotected String getStringOrNull(ResourceBundle bundle, String key)
null if not found.
As of 4.2, the default implementation checks containsKey
before it attempts to call getString (which would require
catching MissingResourceException for key not found).
Can be overridden in subclasses.
bundle - the ResourceBundle to perform the lookup inkey - the key to look upnull if noneResourceBundle.getString(String),
ResourceBundle.containsKey(String)