查看原文
其他

iOS 实现远程推送通知国际化

F.Y云菲 小集 2022-03-15

作者 | F.Y 云菲

由于产品需求,在 APP 里增加了语言设置选项,即用户可以在不改变系统语言的情况下,只修改 APP 内的语言。可是如何让远程推送也跟随 APP 语言呢?

每个远程推送通知都包含一个 payloadpayload包含系统要显示给用户的信息,也包括你自定义的数据。有关 payload key 可以看看这里[1]

看过上面这篇文章后,小伙伴应该知道了苹果其实提供了实现语言国际化的方案,即通过 loc-key  loc-args 这两个字段。其中 loc-key 是格式化前的内容,loc-args 里面放的是 loc-key 格式化过程中需要用到的参数。比如要向小明同学推送一条消息,内容是:

小明,你的包裹已出发!

小明的手机语言设置成了英文,收到这条推送后,需要显示为:

小明,your package has sent! 

那么 loc-key  loc-args 这两个字段就应该这样写:

"loc-key": "%@,你的包裹已出发!",

"loc-args": ["小明"]

如果 app 的 Localizable.strings 文件中有这样的定义:

"%@,你的包裹已出发!"="%@,your package has sent!";

小明收到的推送就将显示为

“小明,your package has sent! ”。

看,就是这么简单!但这还不够,这只是跟随系统语言而已,如果想要跟随 app 语言,还需要做些事情。

推送文案跟随 APP 语言

首先,创建一个 Notification Service Extension,创建方法自己搜一下哈。

然后,在系统自动生成的 NotificationService.m 文件里修改 payload,代码如下:

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {

[self configLanguage]; //动态切换语言

self.contentHandler = contentHandler;
self.bestAttemptContent = [request.content mutableCopy];

NSDictionary *userInfo = self.bestAttemptContent.userInfo;
NSDictionary *alert = [[userInfo objectForKey:@"aps"] objectForKey:@"alert"];
NSArray *args = [alert objectForKey:@"loc-args"];
NSString *content = [alert objectForKey:@"loc-key"];
if (content.length) {
self.bestAttemptContent.body = [NSString stringWithFormat:NSLocalizedString(content, nil) array:args]; //根据当前语言进行格式化
}
NSString *title = [alert objectForKey:@"title"];
self.bestAttemptContent.title = title;

self.contentHandler(self.bestAttemptContent);

}

- (void)configLanguage {
NSUserDefaults *sharedUserDefaults = [[NSUserDefaults alloc] initWithSuiteName:@"group.com.test"];
NSString *language = [[self.sharedUserDefaults objectForKey:@"publicSettingKey"] objectForKey:@"kLanguageKey"];
if (language.length == 0) {
//APP 目前没有选择语言,则跟随系统
NSString *systemLanguage = [[[NSUserDefaults standardUserDefaults] objectForKey:@"AppleLanguages"] objectAtIndex:0];
if (![systemLanguage hasPrefix:@"zh"]) {
language = @"en"; //产品需求,如果系统语言不是中文,就默认设置为英文
}
}

[NSBundle setLanguage:language];

}

动态切换 APP 语言

NSBundle+Language.m

#import "NSBundle+Language.h"
#import <objc/runtime.h>

static const char _bundle = 0;

@interface BundleEx : NSBundle

@end

@implementation BundleEx

- (NSString *)localizedStringForKey:(NSString *)key value:(NSString *)value table:(NSString *)tableName {
NSBundle *bundle = objc_getAssociatedObject(self, &_bundle);
return bundle ? [bundle localizedStringForKey:key value:value table:tableName] : [super localizedStringForKey:key value:value table:tableName];
}

@end

@implementation NSBundle (Language)

+ (void)setLanguage:(NSString *)language {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
object_setClass([NSBundle mainBundle], [BundleEx class]);
});

objc_setAssociatedObject([NSBundle mainBundle], &_bundle, language ? [NSBundle bundleWithPath:[[NSBundle mainBundle] pathForResource:language ofType:@"lproj"]] : nil, OBJC_ASSOCIATION_RETAIN_NONATOMIC);

}

@end

NSBundle+Language.h

#import <Foundation/Foundation.h>

@interface NSBundle (Language)

+ (void)setLanguage:(NSString *)language;

@end

APP 与 Extension 间数据共享

应该有同学注意到了,APP 的当前语言是从这里 [[NSUserDefaults alloc] initWithSuiteName:@"group.com.test"] 取的。由于 Extension 有自己独立的 Bundle,不能直接访问主 APP 的 Bundle,这时候就要用到苹果的 App Groups 机制了。

开启主 APP 的 App Groups :

被勾选的地方就是我们要设置的 group container identifier,也就是共享数据的 bundle identifier。格式是 "group.xxx",其中 xxx 是 APP 的 bundleID。比如APP 的 bundleID 是 “com.test”,那么 group identifier 就要设置为"group.com.test"。

开启 Extension 的 App Groups,group identifier 同上。

这样,APP 和 Extension 就可以通过 group identifier 这个 bundle 来共享数据了。

首先,在 APP 里将 language 写入 [[NSUserDefaults alloc] initWithSuiteName:@"group.com.test"] .

然后,在 NotificationService.m 里就可以读取到 language 了。

总结

如果只是跟随系统语言,那么就使用 loc-key 和 loc-args,这两个字段名不可随意更改。

如果是通过 Notification Service Extension,就不是非要用  loc-key  loc-args 字段了,甚至也不用在 alert 结构里设置,在 payload 的任何地方都可以自行定义字段哦,不要和苹果的字段重复就好~

参考

[1]https://www.zybuluo.com/evolxb/note/482251

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存