「UIは英語なのにアプリ内リンクは日本語だ！」を防ぐコツ / pixiv App Night 2024-10-24

スマホアプリでは利用規約やプライバシーポリシーなど、静的URLを利用することがよくあります。特に多言語対応したアプリでは端末の言語によってアクセスするURLを変えたい場合がありますが、URLの指定ミスは見た目ではわかりにくく、クラッシュやエラーも発生しないため、問題に気づきにくい課題があります。

この課題を解決するためにString Catalogを利用して静的URLの翻訳を管理し、さらにそれをTestで検証できるようにしたノウハウについてお話します。

Transcript

1. @FromAtom ʮUI͸ӳޠͳͷʹΞϓϦ಺ϦϯΫ͸೔ຊޠͩʂʯΛ๷͙ίπ
2. • ϐΫγϒגࣜձࣾ • iOSΞϓϦ෼໺ςοΫϦʔυ • ޷͖ͳSwift͸ guard @FromAtom
3. ͜͏͍͏ࣄ͋Γ·͢ΑͶʁ
4. ϔϧϓ͕ผݴޠʹͳͬͯ͠·͏ ※ಈը
5. ӳޠ༻ϔϧϓϖʔδ https://sites.google.com/view/url-l18n-demo/help-english ೔ຊޠ༻ϔϧϓϖʔδ https://sites.google.com/view/url-l18n-demo/help-japanese
6. ੩తURLΛ؅ཧ͢Δ࿩
7. switch Locale.current.identifier { case "ja_JP": // ೔ຊޠURL case "en_US": // ӳޠURL default: // ͦͷଞݴޠURL } ύοͱࢥ͍࣮ͭ͘૷͸Locale.current • ରԠݴޠ͕૿͑ͨΒʁ • "en_JP" ΍ "ja_US" ͸ʁ
8. URL΋จࣈྻͳͷͰ຋༁͠Α͏
9. String Catalogs
11. enum ExternalStaticLinks: String, CaseIterable, Sendable { case helpPage = "HelpPageURL" public var localizationValue: String.LocalizationValue { .init(rawValue) } public var url: URL { .init(string: urlString)! } public var urlString: String { .init(localized: localizationValue) } } let url = ExternalStaticLinks.helpPage.url
12. σόοά͢Δ
14. ※ಈը
15. 🧐 URL΍ରԠݴޠ͕૿͑ͨΒखಈνΣοΫେมͰ͸ʁ
16. 😀 TestΛॻ͖·͠ΐ͏
17. enum SupportLanguages: String, CaseIterable { case en = "en" case ja = "ja" var bundle: Bundle? { guard let path = Bundle.main.path(forResource: rawValue, ofType: "lproj") else { return nil } return Bundle(path: path) } } final class LinkLocalizeSampleTests: XCTestCase { func test_HelpページのURLが全言語で想定通りに返ってくる() throws { let localizationValue = ExternalStaticLinks.helpPage.localizationValue for lang in SupportLanguages.allCases { let urlString = String(localized: localizationValue, bundle: lang.bundle) switch lang { case .en: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-english") case .ja: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-japanese") } XCTAssertNotNil(URL(string: urlString)) } } }
18. enum SupportLanguages: String, CaseIterable { case en = "en" case ja = "ja" var bundle: Bundle? { guard let path = Bundle.main.path(forResource: rawValue, ofType: "lproj") else { return nil } return Bundle(path: path) } } final class LinkLocalizeSampleTests: XCTestCase { func test_HelpページのURLが全言語で想定通りに返ってくる() throws { let localizationValue = ExternalStaticLinks.helpPage.localizationValue for lang in SupportLanguages.allCases { let urlString = String(localized: localizationValue, bundle: lang.bundle) switch lang { case .en: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-english") case .ja: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-japanese") } XCTAssertNotNil(URL(string: urlString)) } } }
19. enum SupportLanguages: String, CaseIterable { case en = "en" case ja = "ja" var bundle: Bundle? { guard let path = Bundle.main.path(forResource: rawValue, ofType: "lproj") else { return nil } return Bundle(path: path) } } final class LinkLocalizeSampleTests: XCTestCase { func test_HelpページのURLが全言語で想定通りに返ってくる() throws { let localizationValue = ExternalStaticLinks.helpPage.localizationValue for lang in SupportLanguages.allCases { let urlString = String(localized: localizationValue, bundle: lang.bundle) switch lang { case .en: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-english") case .ja: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-japanese") } XCTAssertNotNil(URL(string: urlString)) } } } // => HelpPageURL
20. enum SupportLanguages: String, CaseIterable { case en = "en" case ja = "ja" var bundle: Bundle? { guard let path = Bundle.main.path(forResource: rawValue, ofType: "lproj") else { return nil } return Bundle(path: path) } } final class LinkLocalizeSampleTests: XCTestCase { func test_HelpページのURLが全言語で想定通りに返ってくる() throws { let localizationValue = ExternalStaticLinks.helpPage.localizationValue for lang in SupportLanguages.allCases { let urlString = String(localized: localizationValue, bundle: lang.bundle) switch lang { case .en: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-english") case .ja: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-japanese") } XCTAssertNotNil(URL(string: urlString)) } } }
21. enum SupportLanguages: String, CaseIterable { case en = "en" case ja = "ja" var bundle: Bundle? { guard let path = Bundle.main.path(forResource: rawValue, ofType: "lproj") else { return nil } return Bundle(path: path) } } final class LinkLocalizeSampleTests: XCTestCase { func test_HelpページのURLが全言語で想定通りに返ってくる() throws { let localizationValue = ExternalStaticLinks.helpPage.localizationValue for lang in SupportLanguages.allCases { let urlString = String(localized: localizationValue, bundle: lang.bundle) switch lang { case .en: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-english") case .ja: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-japanese") } XCTAssertNotNil(URL(string: urlString)) } } }
22. enum SupportLanguages: String, CaseIterable { case en = "en" case ja = "ja" var bundle: Bundle? { guard let path = Bundle.main.path(forResource: rawValue, ofType: "lproj") else { return nil } return Bundle(path: path) } } final class LinkLocalizeSampleTests: XCTestCase { func test_HelpページのURLが全言語で想定通りに返ってくる() throws { let localizationValue = ExternalStaticLinks.helpPage.localizationValue for lang in SupportLanguages.allCases { let urlString = String(localized: localizationValue, bundle: lang.bundle) switch lang { case .en: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-english") case .ja: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-japanese") } XCTAssertNotNil(URL(string: urlString)) } } } default: ͸࢖Θͳ͍
23. enum SupportLanguages: String, CaseIterable { case en = "en" case ja = "ja" var bundle: Bundle? { guard let path = Bundle.main.path(forResource: rawValue, ofType: "lproj") else { return nil } return Bundle(path: path) } } final class LinkLocalizeSampleTests: XCTestCase { func test_HelpページのURLが全言語で想定通りに返ってくる() throws { let localizationValue = ExternalStaticLinks.helpPage.localizationValue for lang in SupportLanguages.allCases { let urlString = String(localized: localizationValue, bundle: lang.bundle) switch lang { case .en: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-english") case .ja: XCTAssertEqual(urlString, "https://sites.google.com/view/url-l18n-demo/help-japanese") } XCTAssertNotNil(URL(string: urlString)) } } }
24. 😀 ͜ΕͰ׬ᘳʂ
25. 😭 Ͱ͸ͳ͍
26. 🫠 ৽͍͠URLΛ௥Ճͯ͠ ͦͷςετهड़ΛαϘͬͨΒʁ
27. 😀 ͦͷTest΋ॻ͖·͠ΐ͏
28. func test_ExternalStaticLinksを増減させたのにテストを修正していない時におちる() throws { // NOTE: - ここの数字を変えるだけでなくて、下記のテストを適切に修正すること XCTAssertEqual(ExternalStaticLinks.allCases.count, 11) } ※1: URLΛ1ͭফͯ͠ɺ1ͭ૿΍ͨ͠ͱ͖ʹ͸෼͔Βͳ͍ ※2: ݫີʹ΍ΔͳΒCIͰΧόϨοδ͕௿Լͨ͠ΒΞϥʔτΛग़͢
29. 🫠 String Catalogʹ͸௥Ճ͚ͨ͠Ͳɺ ͦ΋ͦ΋ΞϓϦຊମ͕ݴޠαϙʔτͯ͠ͳ͔ͬͨΒʁ
30. func test_想定している全言語の翻訳に対応している() throws { for lang in SupportLanguages.allCases { XCTAssertNotNil(lang.bundle, "Application not translated in \(lang.longName)") } }
31. ೔ຊޠɾӳޠͰผURLͳͷʹ͏͔ͬΓಉ͡URLΛొ࿥ͯ͠͠·ͬͨΒʁ ɹ⾣ UnitTestͰམͪΔ ੩తϦϯΫΛ௥Ճͨ͠ͷʹUnitTestΛ௥Ճ͠ͳ͔ͬͨΒʁ ɹ⾣ UnitTestͰམͪΔ Package.swiftͰ͸ରԠͯ͠Δݴޠ͚ͩͲΞϓϦຊମͰະରԠͩͬͨΒʁ ɹ⾣ UnitTestͰམͪΔ
32. 😀 Αͦ͞͏ʂ
33. ͓·͚ iOS 16+͔ΒBCP47ܗ͕ࣜѻ͑ΔΑ͏ʹͳͬͨɻ print(Locale.current.identifier) // en_JP print(Locale.current.identifier(.bcp47)) // en-JP
34. ·ͱΊ • ੩తϦϯΫ΋จࣈྻͳͷͰString CatalogsͰ؅ཧ͠Α͏ • bundleΛར༻֤ͯ͠ݴޠͷ຋༁Λςετ͠Α͏ • ਓؒ͸TestΛ๨Ε͕ͪͳͷͰɺॻ͔ͤΔ࢓૊ΈΛߟ͑Α͏