Reading data from multiple different resource bundle property files in Java

Question

I have class structure to read the data from resource bundle (property files).

import java.util.Locale;
import java.util.Objects;
import java.util.ResourceBundle;

/**
 * The class will be used to read the resource bundle to achieve localization
 * and internationalization
 *
 */
public class ResourceBundleReader {

  private String resourceBundle = null;

  /**
   * Constructor of the class
   *
   * @param resourceBundle
   * @throws NullPointerException
   *           if resourceBundle is null
   */
  public ResourceBundleReader(final String resourceBundle) {

    Objects.requireNonNull(resourceBundle);

    this.resourceBundle = resourceBundle;
  }

  /**
   * Return message by input key for default locale
   *
   * @param key
   * @return
   */
  public String getMessage(final String key) {

    return getMessage(key, Locale.getDefault());
  }

  /**
   * Return message by input key for input locale locale
   *
   * @param key
   * @return
   */
  public String getMessage(final String key, final Locale locale) {
    final ResourceBundle mybundle = ResourceBundle.getBundle(resourceBundle, locale);
    return mybundle.getString(key);
  }
}

As there are multiple type of resource bundles, I have created individual implementation for that. For example below two:

Exception Message:

public final class ExceptionMessageResolver {

  private static final String EXCEPTION_MESSAGES_RESOURCE = "exceptionmessages"; //$NON-NLS-1$

  private static final ResourceBundleReader RESOURCE_BUNDLE_READER = new ResourceBundleReader(
      EXCEPTION_MESSAGES_RESOURCE);

  /**
   * Private constructor to prevent instantiation Constructor of the class
   */
  private ExceptionMessageResolver() {
    super();
  }

  /**
   * return exception message by default locale
   *
   * @param key
   * @return
   */
  public static String getMessage(final String key) {

    return getMessage(key, Locale.getDefault());
  }

  /**
   * Return exception message for input locale
   *
   * @param key
   * @param locale
   * @return
   */
  public static String getMessage(final String key, final Locale locale) {
    return RESOURCE_BUNDLE_READER.getMessage(key, locale);
  }

}

Label Messages:

public final class ResourceLabelResolver {

  private static final String LABEL_RESOURCE = "resourcelabels"; //$NON-NLS-1$

  private static final ResourceBundleReader RESOURCE_BUNDLE_READER = new ResourceBundleReader(LABEL_RESOURCE);

  /**
   * Private constructor to prevent instantiation Constructor of the class
   */
  private ResourceLabelResolver() {
    super();
  }

  /**
   * return label message by default locale
   *
   * @param key
   * @return
   */
  public static String getMessage(final String key) {

    return getMessage(key, Locale.getDefault());
  }

  /**
   * Return label message for input locale
   *
   * @param key
   * @param locale
   * @return
   */
  public static String getMessage(final String key, final Locale locale) {
    return RESOURCE_BUNDLE_READER.getMessage(key, locale);
  }

}

Is there any more elegant way for this? Or any way to create abase class for my two readers to prevent duplicate methods in code?

Moch Yusup · Accepted Answer · 2021-05-03 05:47:07Z

I don't see the need to implement sub classes in your code example above. You need inheritance only if you add specific implementation on the sub class. All you need is to create an interface to encapsulate the resolver (IResourceBundle) for abstraction, then create a factory for them.

public interface IResourceBundle {
    String getMessage(final String key);
    String getMessage(final String key, final Locale locale);
}

public enum ResourceBundles {
    EXCEPTION_MESSAGE("exceptionmessages"),
    LABEL("resourcelabels");    
    private String bundleName;
    private ResourceBundles(String name) {
        bundleName = name;
    }
    public String toString() {
        return bundleName;
    }
}

public final class ResourceResolverFactory {
    private Map<ResourceBundles, IResourceBundle> resolvers;
    private ResourceResolverFactory() {
        resolvers = new HashMap<ResourceBundles, IResourceBundle>();
    }
    public IResourceBundle getBundle(final ResourceBundles resourceBundle) {
        IResourceBundle resolver = resolvers.get(resourceBundle);
        if(resolver != null) {
            return resolver;
        }
        resolver = new ResourceBundleReader(resourceBundle.toString());
        resolvers.put(resourceBundle, resolver);
        return resolver;
    }
    private static final ResourceResolverFactory instance = new ResourceResolverFactory();
    public static ResourceResolverFactory getInstance() {
        return instance;
    }
}

public class ResourceBundleReader implements IResourceBundle {
    private String resourceBundle = null;
    public ResourceBundleReader(final String resourceBundle) {
        Objects.requireNonNull(resourceBundle);
        this.resourceBundle = resourceBundle;
    }
    public String getMessage(final String key) {
        return getMessage(key, Locale.getDefault());
    }
    public String getMessage(final String key, final Locale locale) {
        final ResourceBundle mybundle = ResourceBundle.getBundle(resourceBundle, locale);
        return mybundle.getString(key);
    }
}

public class Main {
    public static void main(String[] args) {
        ResourceResolverFactory factory = ResourceResolverFactory.getInstance();
        IResourceBundle exceptionMessageResolver = factory.getBundle(ResourceBundles.EXCEPTION_MESSAGES_RESOURCE);    
        // do something with exceptionMessageResolver
        IResourceBundle labelResolver = factory.getBundle(ResourceBundles.EXCEPTION_MESSAGES_RESOURCE);
        // do something with labelResolver
    }
}

In this case, adding more resource bundle means adding new enum in ResourceBundles not introducing new sub-class.

Thanks a lot for providing the solution. I don't want the user to call factory method again and again, so want the dedicated implementation class. As this code will be called very frequently. — Gaurav Jeswani
– Gaurav Jeswani, Commented May 3, 2021 at 7:57
It doesn't have to be factory method, you can register at register it with keyed dependency injection if there's any framework to do that in java (I'm not a java dev, so my knowledge is very limited). But if you prefer a sub class approach, then you can use template design pattern: public class ExceptionMessageResolver extends ResourceBundleReader { public ExceptionMessageResolver(){super(resourceBundle.toString())} }, that way you don't have to implement the same methods over and over again on every sub class. — Moch Yusup
– Moch Yusup, Commented May 3, 2021 at 12:44
1. Given the usage, String getMessage(final String key); should actually be default String getMessage(String key) { return getMessage(key, Locale.getDefault()); } 2. The default enum toString() should not be changed, instead create bundleName() to return the bundle name. 3. ResourceResolverFactory::getBundle can be simplified as return resolvers.computeIfAbsent(resourceBundle, (rb) -> new ResourceBundleReader(rb.bundleName())); 4. Why name IResourceBundle? This is Java not C#, in Java, interfaces shouldn't be prefixed with I. — Olivier Grégoire
– Olivier Grégoire, Commented May 4, 2021 at 11:33
5. ResourceBundleReader shouldn't use call ResourceBundle.getBundle for every call, but rather cache the bundles. 6. If something is a resolver, call it AbcResolver, not IResourceBundle. It's not a resource bundle, but a resolver. — Olivier Grégoire
– Olivier Grégoire, Commented May 4, 2021 at 11:34
Thanks for the input. And yes I'm c# dev, so I'm sorry for not following to the naming convention and best practice of java programming language. I'd suggest to post new answer as well with the code to help the original poster. — Moch Yusup
– Moch Yusup, Commented May 5, 2021 at 4:38

Stack Exchange Network

Reading data from multiple different resource bundle property files in Java

1 Answer 1

You must log in to answer this question.

Hot Network Questions

Reading data from multiple different resource bundle property files in Java

1 Answer 1

You must log in to answer this question.

Related

Hot Network Questions