几需一行代码完成多语言切换

logo

背景

之前总是有开发者反馈我应用切换了语言,可是工具类获取的 string 却没有发生改变。其实这个问题很简单,你切换语言的 Context 只作用在了你的 Activity 上,并没有对你的 Application 做同样的操作,知道了这点,那么解决问题就很简单了,为了省事,我给大家封装了 LanguageUtils,直接一行代码便可完成多语言的切换,类似微信的语言切换分分钟便可完成。

使用

Gradle:

1
implementation 'com.blankj:utilcode:latest_version'

APIs

  • 语言相关 -> LanguageUtils.java -> Demo

    1
    2
    applySystemLanguage: 应用系统语言
    applyLanguage : 应用语言

原理

如果我们的应用不设置 android:configChanges="locale|layoutDirection",那么应用是跟随系统语言设置的变化而变化的,比如你应用适配了英语(values-en-rUS)和简体中文(values-zh-rCN),那么你去设置里切换成英语的话,返回到你应用中,你的 Activity 会重新创建一遍,把 Activity#Resource#Configuration#Locale 设置为当前系统语言,这样就达到了跟随系统语言设置的变化而变化,但 Application 并没有重启,所以这就导致了一开说到的问题。

要解决跟随系统变化这一点的话,只需要在 Activity#onCreate 的生命周期中把 Application#Resource#Configuration#Locale 设置为系统的 Locale 即可,那么系统的 Locale 怎么读取呢,知道之前屏幕适配方案的人应该也能想到这一方式:Resources.getSystem().getConfiguration().locale,这样,我们的 Application 便也切换成了系统语言,注意更新 Locale 需要兼容下高版本,调用具体代码可以参照如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
private static void updateLanguage(Context context, Locale locale) {
Resources resources = context.getResources();
Configuration config = resources.getConfiguration();
Locale contextLocale = config.locale;
if (equals(contextLocale.getLanguage(), locale.getLanguage())
&& equals(contextLocale.getCountry(), locale.getCountry())) {
return;
}
DisplayMetrics dm = resources.getDisplayMetrics();
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR1) {
config.setLocale(locale);
context.createConfigurationContext(config);
} else {
config.locale = locale;
}
resources.updateConfiguration(config, dm);
}

那么如果是应用内切换语言呢?我们可以仿照系统切换语言的方式,把我们自己所有的 Activity 全关掉,然后启动首页的 Activity 即可,在打开的 Activity#onCreate 中把 ActivityApplicationLocale 都设置为我们设置的语言即可,当然,这份设置是需要保存下来的,根据你的需求来确定是要保存在服务端还是本地。那么怎么关闭所有的 Activity 呢?我们可以通过增加 Intent 的 flag 为 Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_CLEAR_TASK 即可,相关代码如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
private static void applyLanguage(@NonNull final Locale locale,
final String activityClassName,
final boolean isFollowSystem) {
if (isFollowSystem) {// 如果是跟随系统,那么 sp 就什么都不存
SPUtils.getInstance().put(KEY_LOCALE, "");
} else {// 否则把设置的语言保存下来,在 onCreate 中应用该语言
String localLanguage = locale.getLanguage();
String localCountry = locale.getCountry();
SPUtils.getInstance().put(KEY_LOCALE, localLanguage + "$" + localCountry);
}
updateLanguage(Utils.getApp(), locale);// 更新 Application 的语言
Intent intent = new Intent();
String realActivityClassName// 如果传入的 activityClassName 为空,那么启动 launcher Activity。
= TextUtils.isEmpty(activityClassName) ? getLauncherActivity() : activityClassName;
intent.setComponent(new ComponentName(Utils.getApp(), realActivityClassName));
intent.addFlags(
Intent.FLAG_ACTIVITY_NEW_TASK
| Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_CLEAR_TASK
);
Utils.getApp().startActivity(intent);// 关闭其他 Activity 并启动 realActivityClassName 的 Activity
}

// 工具类调用此函数是在 ActivityLifecycleCallbacks#onActivityCreated 中
static void applyLanguage(@NonNull final Activity activity) {
final String spLocale = SPUtils.getInstance().getString(KEY_LOCALE);// 获取保存的语言
if (TextUtils.isEmpty(spLocale)) {// 为空说明是跟随系统走,那么更新系统语言即可
Locale sysLocale = Resources.getSystem().getConfiguration().locale;
updateLanguage(Utils.getApp(), sysLocale);
updateLanguage(activity, sysLocale);
return;
}
// 读取 sp 保存下来的语言并应用该语言
String[] language_country = spLocale.split("\\$");
if (language_country.length != 2) {
Log.e("LanguageUtils", "The string of " + spLocale + " is not in the correct format.");
return;
}
Locale settingLocale = new Locale(language_country[0], language_country[1]);
updateLanguage(Utils.getApp(), settingLocale);
updateLanguage(activity, settingLocale);
}

基于以上分析:

  • 如果应用是跟随系统设置语言来切换的话,那么直接依赖我的工具类即可,它会自动帮你更新 Application 的语言。
  • 如果需要应用内切换语言的话,只需在你切换语言的地方调用 LanguageUtils.applyLanguage(Locale.你要设置的语言, "com.blankj.launcher.pkg.MainActivity/* 切换语言后你要跳转到的页面,如果为空,则启动应用的 launcher Activity */") 即可;
  • 如果需要应用内切换语言变为跟随系统设置语言,那么调用 LanguageUtils.applySystemLanguage(""/* 切换语言后你要跳转到的页面,如果为空,则启动应用的 launcher Activity */); 即可。

结语

功能其实很简单,但总是缺少人能把它分析得透彻,从而做得很完美分享出来,希望我这次的分享能让你看到这一点,从而提升你之后的技能。

打个小广告

欢迎加入我的知识星球「基你太美」,我会在星球中分享 AucFrame 框架、大厂面经、AndroidUtilCode 更详尽的说明…一切我所了解的知识,你可以通过支付进入我的星球「基你太美」进行体验,加入后优先观看星球中精华的部分,如果觉得星球的内容对自身没有收益,你可以自行申请退款退出星球,也没必要加我好友;如果你已确定要留在我的星球,可以通过扫描如下二维码(备注:基你太美+你的星球昵称)加我个人微信,方便我后续拉你进群(PS:进得越早价格越便宜)。

我的二维码