隨心所欲學Java - Swing國際化，控件實時刷新觀察者方式實現

 之前說到要想看看Swing。不知道爲啥我第一個想到的問題是界面語言顯示的國際化問題。管他呢，既然隨心所遇學，想到了就實現來看看。

想要國際化，首先還是要有國際化資源文件。

 

 我們所要做的就是在切換語言的時候，從對應的資源文件中讀取值信息，顯示出來。

要實時響應語言的變化，可以採用JDK自帶的觀察者方式來實現。

 

  

這裏封裝了一個ObserverCenter，用於統一發送被觀察實例的變化狀態信息。

 

/**
 * 觀察者中心，用於統一通知發送變更信
 *
 * @author lihzh
 * @date 2012-3-17 下午9:54:15
 */
public class ObserveCenter extends Observable {

    private static ObserveCenter observeCenter;
    private ObserveCenter(){}

    public static ObserveCenter getInstance() {
        if (observeCenter == null) {
            observeCenter = new ObserveCenter();
        }
        return observeCenter;
    }

    /**
     * 發送變更消息, 相當於{@link #notifyChange(null)}
     *
     * @author lihzh
     * @date 2012-3-17 下午9:58:19
     */
    public void notifyChange() {
        notifyChange(null);
    }

    /**
     * 發送變更信息
     *
     * @param obj
     * @author lihzh
     * @date 2012-3-17 下午10:01:50
     */
    public void notifyChange(Object obj) {
        setChanged();
        notifyObservers(obj);
    }

}

LocaleHandler類用於設置區域信息，同時在設置區域信息後，發送通過ObserverCenter發送狀態改變通知。

 

/**
 * 當前位置(國際化信息所用)管理類
 *
 * @author lihzh
 * @date 2012-3-17 下午4:26:43
 */
public class LocaleHandler {

    private static final Logger logger = LoggerFactory.getLogger(LocaleHandler.class);

    public static final Locale DEFAULT_LOCAL = Locale.CHINA;
    private static Locale locale = DEFAULT_LOCAL;

    static {
        ObserveCenter.getInstance().addObserver(new I18nUIHandler());
        ObserveCenter.getInstance().addObserver(new ResourceBundleLoader());
    }

    /**
     * 獲取國際化區域信息
     *
     * @return
     * @author lihzh
     * @date 2012-3-17 下午9:32:13
     */
    public static Locale getLocale() {
        return locale;
    }

    /**
     * 設置國際化區域信息
     *
     * @param locale
     * @author lihzh
     * @date 2012-3-17 下午9:31:47
     */
    public static void setLocale(Locale locale) {
        LocaleHandler.locale = locale == null ? DEFAULT_LOCAL : locale;
        logger.info("Current locale is: [{}]", LocaleHandler.locale.toString());
        refresh();
    }

    /**
     * 設置國際化區域信息，相當於{@link #setLocale(DEFAULT_LOCAL)}
     *
     * @author lihzh
     * @date 2012-3-17 下午9:35:00
     */
    public static void setLocale() {
        setLocale(DEFAULT_LOCAL);
    }

    /**
     * 刷新國際化信息
     *
     * @author lihzh
     * @date 2012-3-17 下午9:31:58
     */
    private static void refresh() {
        ObserveCenter.getInstance().notifyChange();
    }

}

ResourceBundleLoader類，用於根據區域設置加載對應的國際化配置文件。該類實現了Observer接口。在Locale信息變化時，會收到通知，改變需要加載的國際化文件。

 

/**
 * 國際化文件讀取類，提供靜態方法和靜態引用
 *
 * @author lihzh
 * @date 2012-3-17 下午4:07:24
 */
public class ResourceBundleLoader implements Observer {

    private static final String RESOURCE_CLASSLOADER_PATH_PREFIX = "i18n.i18n_";
    private static String RESOURCE_CLASSLOADER_PATH_FULL;
    private static ResourceBundle resourceBundle;

    /**
     * 讀取國際化文件中定義的值
     *
     * @param key
     * @return
     * @author lihzh
     * @date 2012-3-17 下午4:33:32
     */
    public static String getValue(String key) {
        return resourceBundle.getString(key);
    }

    /*
     * 當Locale環境變量改變時更改resourceBundle實例加載的國際化文件
     */
    @Override
    public void update(Observable o, Object arg) {
        refreshBundle();
    }

    /**
     * 刷新讀取的Bundle信息
     *
     * @author lihzh
     * @date 2012-3-17 下午10:13:26
     */
    private static void refreshBundle() {
        RESOURCE_CLASSLOADER_PATH_FULL = RESOURCE_CLASSLOADER_PATH_PREFIX
                + getLocale().toString();
        resourceBundle = ResourceBundle.getBundle(
                RESOURCE_CLASSLOADER_PATH_FULL, getLocale());
    }
}

至此，剩下的工作就是刷新當前系統中的所有控件了！

我想我們當然不希望每個空間都實現一個監聽，各自進行刷新。這樣雖然可以實現功能，但是開發效率是比較低下的，而且也不易維護。所以，我考慮用一個“控件池”ComponentPool去統一管理當前系統中的所有控件。

 

/**
 * UI控件池，用於保存當前所有的UI控件
 *
 * @author lihzh
 * @date 2012-3-18 下午10:21:14
 */
public class ComponentPool {

    // 按鈕池
    private static final Map<String, GenericButton> buttonPool = new HashMap<String, GenericButton>();

    /**
     * 註冊按鈕
     *
     * @param button
     * @author lihzh
     * @date 2012-3-18 下午10:26:35
     */
    public static void addButton(GenericButton button) {
        if (button == null) {
            throw new IllegalArgumentException(
                    "The registing button can not be null.");
        }
        if (button.getName() == null) {
            throw new IllegalArgumentException(
                    "The registing button's name can not be null.");
        }
        buttonPool.put(button.getName(), button);
    }

    /**
     * 獲取按鈕
     *
     * @param buttonName
     * @return
     * @author lihzh
     * @date 2012-3-18 下午10:30:31
     */
    public static GenericButton getButton(String buttonName) {
        return buttonPool.get(buttonName);
    }

    /**
     * 獲取所有的Button
     *
     * @return
     * @author lihzh
     * @date 2012-3-18 下午10:52:50
     */
    public static Map<String, GenericButton> getAllButtons() {
        return buttonPool;
    }

}

我們以Button爲例。首先定義一個Button類型控件的基類GenericButton，所有具體的Button都需繼承自該基類。

 

/**
 * 所有按鈕的基類，可統一處理國際化通用事件, 統一將name設置爲國際化文件中的key值
 *
 * @author lihzh
 * @date 2012-3-18 下午5:15:01
 */
public class GenericButton extends JButton {

    private static final long serialVersionUID = -5971509297727392232L;

    public GenericButton(String name) {
        super();
        this.setName(name);
        ComponentPool.addButton(this);
    }

    /*
     * 設置名字，同時設置顯示值
     * @see java.awt.Component#setName(java.lang.String)
     *
     * @author lihzh
     * @date 2012-3-19 下午12:34:28
     */
    @Override
    public void setName(String name) {
        super.setName(name);
        setText(ResourceBundleLoader.getValue(name));
    }

    /**
     * 在國際化位置發生改變時執行
     *
     * @author lihzh
     * @date 2012-3-18 下午10:35:54
     */
    public void onLocaleChange() {
        this.setText(ResourceBundleLoader.getValue(this.getName()));
        afterTextChange();
    }

    /**
     * 在國際化位置發生改變時執行，用於子類複寫其特有操作。在文本刷新前執行
     *
     * @author lihzh
     * @date 2012-3-18 下午10:57:06
     */
    protected void beforeTextChange() {
    }

    /**
     * 在國際化位置發生改變時執行，用於子類複寫其特有操作。在文本刷新後執行
     *
     * @author lihzh
     * @date 2012-3-18 下午10:57:06
     */
    protected void afterTextChange() {
    }

該基類的構造函數中統一處理了Button顯示的文字信息，同時將當前Button註冊到了Pool中。

我們同樣的用I18UIHandler類去實現了Observer接口，同時觀察Locale變化的事件（注意與ResourceBundleLoader的先後順序）。

 

/**
 * UI界面國際化管理類
 *
 * @author lihzh
 * @date 2012-3-18 下午10:09:29
 */
public class I18nUIHandler implements Observer {

    /*
     * @see java.util.Observer#update(java.util.Observable, java.lang.Object)
     *
     * @author lihzh
     * @date 2012-3-19 下午12:33:27
     */
    @Override
    public void update(Observable o, Object arg) {
        // 刷新按鈕
        refreshButton();

    }

    /**
     * 刷新按鈕
     *
     * @author lihzh
     * @date 2012-3-18 下午10:53:02
     */
    private void refreshButton() {
        Map<String, GenericButton> buttons = ComponentPool.getAllButtons();
        Iterator<Entry<String, GenericButton>> butEntryIt = buttons.entrySet().iterator();
        while (butEntryIt.hasNext()) {
            Entry<String, GenericButton> entry = butEntryIt.next();
            GenericButton button = entry.getValue();
            button.onLocaleChange();
        }
    }

}

在接口到變化後，從池中分類獲取所有控件。例如現在只有按鈕空間，則從池中獲取所有的按鈕，然後循環調用基類中onLocaleChange()方法，即可實現控件文字的動態刷新。如圖：

 系統中其他控件均可按此方式，實現國際化的動態切換。這樣一個簡單的Swing國際化框架的雛形就完成了。

具體控件代碼舉例：

 

/**
 * 中文按鈕
 *
 * @author lihzh
 * @date 2012-3-18 下午11:00:46
 */
public class CNConfirmButton extends GenericButton {

    private static final long serialVersionUID = 1481761153745275594L;

    public CNConfirmButton(String name) {
        super(name);
        setBounds(100, 80, 80, 30);
        addActionListener(new ActionListener() {
            @Override
            public void actionPerformed(ActionEvent e) {
                LocaleHandler.setLocale(Locale.CHINA);
            }
        });
    }

}

容器代碼舉例：

 

/**
 * @author lihzh
 * @date 2012-3-15 下午10:57:16
 */
public class MainContainer extends JFrame {

    private static final long serialVersionUID = -4379994966214808467L;
    private static final Logger logger = LoggerFactory
            .getLogger(MainContainer.class);

    public MainContainer() {

        logger.info("Begin to initialize the UI container.");
        this.setSize(300, 200);
        this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        this.setResizable(false);
        this.setTitle(getValue(TITLE_MAIN));
        this.getContentPane().setLayout(null);
        JButton usButton = new USConfirmButton(COMBO_LANGUAGE_US);
        JButton cnButton = new CNConfirmButton(COMBO_LANGUAGE_ZH);
        this.add(usButton, null);
        this.add(cnButton, null);
    }

}

注：

1、這裏的容器並未實現國際化的動態刷新。

2、代碼import部分均爲加上，需自行引用。有些靜態方法和常量未加類名因爲採用的是靜態引用。

3、Log採用的是slf4j+logback

PS：所有源碼已上傳至GitHub：

git://github.com/lihongzheshuai/ForFun.git