文字列リソースファイル内で文字列を連結する方法
リソースファイルで内部エンティティが使える話
Created at Updated at

1134 Words
⚠️

追記 (2021-01-16)

外部エンティティ宣言ができない ことについて、一応自分で試してみたので内容を修正。


前提

次のようにアプリ名を@string/app_nameとして文字列リソースに用意しているとする。

<resources>
    <string name="app_name">HogeApp</string>
</resources>

別の文字列リソースの部分文字列として@string/app_nameを含めたい場合、
通常であれば、たとえば次のようにしてコード側やデータバインドで値を挿入した結果の文字列を生成する必要がある。

<resources>
    <string name="app_name">HogeApp</string>
    <string name="author">suihan</string>
    <!-- 「アプリ名: HogeApp」と表示したい(雑な例だが) -->
    <string name="hoge">アプリ名: %s, 作者: %s</string>
</resources>
val str = String.format(
    context.getString(R.string.hoge),
    context.getString(R.string.app_name),
    context.getString(R.string.author)
)
<TextView
    android:text="@{@string/hoge(@string/app_name,@string/author)}"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
/>

今回はそうではなく、string.xml内で複数の文字列リソースで部分文字列を共有する方法について記述する。

内部エンティティ宣言を使用する方法

次のようにDTD内に記述したエンティティは&名前;の形で定数的に各文字列リソースに挿入することができる。

これはAndroidアプリ開発に限った話ではなく、xmlのエンティティ宣言という要素らしい。
Android Developersのリファレンスにはこの方法に関する記述は見つからなかったのだが、これは単にリソースファイルがxmlだから当たり前すぎて書いていないのか、推奨されない何らかの理由があるのかその辺はよくわからない。

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE resources [
    <!ENTITY appName "HogeApp">
    <!ENTITY author "suihan">
]>

<resources>
    <string name="app_name">&appName;</string>
    <string name="author">&author;</string>
    <!-- 「アプリ名: HogeApp, 作者: suihan」と表示したい(雑な例だが) -->
    <string name="hoge">アプリ名: &appName;, 作者: &author;</string>
</resources>

ちなみにエンティティ名入力時にはコード補完が普通に効く。

参考

Reference one string from another string in strings.xml? - Stack Overflow

注意点

  • この方法を使用する場合、Android Studioで翻訳エディタやCtrl+Numpad-などでリソース名を折り畳むとエンティティの挿入部分は空文字列になってしまう。

  • xmlにはエンティティ宣言を外部ファイル化する方法もあるのだが、少なくともAndroid Studio 4.1.1時点では宣言の参照に失敗するため使用できない。
    つまり、多言語用に複数のstrings.xmlを用意している場合、それぞれのファイルで内容の共通するエンティティを外部ファイルに置いてインクルードして使う、ということができない。
    以下試したこと。

    • strings.xmlファイルからの相対パスで参照する必要

    • <!ENTITY % ents SYSTEM "path"> %ents;で一度にロードする方法ではビルド失敗。エンティティごとに<!ENTITY hoge SYSTEM "path">を書くとビルドは通る

    • ビルドには成功しても実行時に表示されない


こういうGradleプラグインを作ってる人もいるらしい。 外部依存増やすことに問題が無ければ、こういうの使った方が普通に楽そう。

LikeTheSalad / android-string-reference

See Also