如何在 Android 中将格式化字符串与占位符一起使用？

Question

在 Android 中，可以在字符串中使用占位符，例如：

<string name="number">My number is %1$d</string>

然后在 Java 代码中（在Activity的子类中）：

String res = getString(R.string.number);
String formatted = String.format(res, 5);

甚至更简单：

String formatted = getString(R.string.number, 5);

也可以在 Android 字符串资源中使用一些 HTML 标签：

<string name="underline"><u>Underline</u> example</string>

由于String本身不能保存任何有关格式的信息，因此应该使用getText(int)而不是getString(int)方法：

CharSequence formatted = getText(R.string.underline);

然后可以将返回的CharSequence传递给 Android 小部件，例如TextView ，并且标记的短语将带有下划线。

但是，我找不到如何组合这两种方法，使用格式化字符串和占位符：

<string name="underlined_number">My number is <u>%1$d</u></string>

如何在 Java 代码中处理上述资源以将其显示在TextView ，将%1$d替换为整数？

Answer 1

最后我设法找到了一个可行的解决方案并编写了我自己的方法来替换占位符，保留格式：

public static CharSequence getText(Context context, int id, Object... args) {
    for(int i = 0; i < args.length; ++i)
        args[i] = args[i] instanceof String? TextUtils.htmlEncode((String)args[i]) : args[i];
    return Html.fromHtml(String.format(Html.toHtml(new SpannedString(context.getText(id))), args));
}

这种方法不需要在格式化的字符串或替换占位符的字符串中手动转义 HTML 标签。

Answer 2

<resources>
  <string name="welcome_messages">Hello, %1$s! You have &lt;b>%2$d new messages&lt;/b>.</string>
</resources>


Resources res = getResources();
String text = String.format(res.getString(R.string.welcome_messages), username, mailCount);
CharSequence styledText = Html.fromHtml(text);

更多信息在这里： http : //developer.android.com/guide/topics/resources/string-resource.html

Answer 3

Kotlin 扩展函数

• 适用于所有 API 版本
• 处理多个参数

示例用法

textView.text = context.getText(R.string.html_formatted, "Hello in bold")

包含在 CDATA 部分中的 HTML 字符串资源

<string name="html_formatted"><![CDATA[ bold text: <B>%1$s</B>]]></string>

结果

粗体文字：你好，粗体

代码

/**
* Create a formatted CharSequence from a string resource containing arguments and HTML formatting
*
* The string resource must be wrapped in a CDATA section so that the HTML formatting is conserved.
*
* Example of an HTML formatted string resource:
* <string name="html_formatted"><![CDATA[ bold text: <B>%1$s</B> ]]></string>
*/
fun Context.getText(@StringRes id: Int, vararg args: Any?): CharSequence =
    HtmlCompat.fromHtml(String.format(getString(id), *args), HtmlCompat.FROM_HTML_MODE_COMPACT)

Answer 4

对于您想要替换没有数字格式的占位符（即前导零、逗号后的数字）的简单情况，您可以使用 Square Phrase库。

用法非常简单：首先，您必须将字符串资源中的占位符更改为这种更简单的格式：

<string name="underlined_number">My number is <u> {number} </u></string>

那么你可以像这样进行替换：

CharSequence formatted = Phrase.from(getResources(), R.string.underlined_number)
   .put("number", 5)
   .format()

格式化的CharSequence也有样式。 如果您需要格式化您的数字，您总是可以使用String.format("%03d", 5)预先格式化它们，然后在.put()函数中使用结果字符串。

Answer 5

与接受的答案类似，我尝试为此编写 Kotlin 扩展方法。

这是 Kotlin 中公认的答案

@Suppress("DEPRECATION")
fun Context.getText(id: Int, vararg args: Any): CharSequence {
    val escapedArgs = args.map {
        if (it is String) TextUtils.htmlEncode(it) else it
    }.toTypedArray()
    return Html.fromHtml(String.format(Html.toHtml(SpannedString(getText(id))), *escapedArgs))
}

接受的答案的问题在于，当格式参数本身被设置样式（即跨度，而不是字符串）时，它似乎不起作用。 通过实验，它似乎做了一些奇怪的事情，可能与我们没有转义非 String CharSequences 的事实有关。 我看到如果我打电话

context.getText(R.id.my_format_string, myHelloSpanned)

其中 R.id.my_format_string 是：

<string name="my_format_string">===%1$s===</string>

而 myHelloSpanned 是一个看起来像<b>hello</b> 的Spanned（即它会有 HTML <i>&lt;b&gt;hello&lt;/b&gt;</i> ）然后我得到 === hello === (即 HTML ===<b>hello</b>=== ）。

那是错误的，我应该得到 === <b>hello</b> ===。

我试图通过在应用String.format之前将所有 CharSequences 转换为 HTML 来解决这个问题，这是我的结果代码。

@Suppress("DEPRECATION")
fun Context.getText(@StringRes resId: Int, vararg formatArgs: Any): CharSequence {
    // First, convert any styled Spanned back to HTML strings before applying String.format. This
    // converts the styling to HTML and also does HTML escaping.
    // For other CharSequences, just do HTML escaping.
    // (Leave any other args alone.)
    val htmlFormatArgs = formatArgs.map {
        if (it is Spanned) {
            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
                Html.toHtml(it, Html.TO_HTML_PARAGRAPH_LINES_CONSECUTIVE)
            } else {
                Html.toHtml(it)
            }
        } else if (it is CharSequence) {
            Html.escapeHtml(it)
        } else {
            it
        }
    }.toTypedArray()

    // Next, get the format string, and do the same to that.
    val formatString = getText(resId);
    val htmlFormatString = if (formatString is Spanned) {
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
            Html.toHtml(formatString, Html.TO_HTML_PARAGRAPH_LINES_CONSECUTIVE)
        } else {
            Html.toHtml(formatString)
        }
    } else {
        Html.escapeHtml(formatString)
    }

    // Now apply the String.format
    val htmlResultString = String.format(htmlFormatString, *htmlFormatArgs)

    // Convert back to a CharSequence, recovering any of the HTML styling.
    return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
        Html.fromHtml(htmlResultString, Html.FROM_HTML_MODE_LEGACY)
    } else {
        Html.fromHtml(htmlResultString)
    }
}

但是，这并不完全有效，因为当您调用Html.toHtml它会在所有内容周围放置<p>标记，即使输入中没有额外的填充。 换句话说， Html.fromHtml(Html.toHtml(myHelloSpanned))不等于myHelloSpanned - 它有额外的填充。 我不知道如何很好地解决这个问题。

Answer 6

更新：这个答案https://stackoverflow.com/a/56944152/6007104已经更新，现在是首选答案

这是一个更具可读性的 Kotlin 扩展，它不使用已弃用的 API，适用于所有 Android 版本，并且不需要将字符串包装在 CDATA 部分中：

fun Context.getText(id: Int, vararg args: Any): CharSequence {

    val escapedArgs = args.map {
        if (it is String) TextUtils.htmlEncode(it) else it
    }.toTypedArray()

    val resource = SpannedString(getText(id))
    val htmlResource = HtmlCompat.toHtml(resource, HtmlCompat.TO_HTML_PARAGRAPH_LINES_CONSECUTIVE)
    val formattedHtml = String.format(htmlResource, *escapedArgs)
    return HtmlCompat.fromHtml(formattedHtml, HtmlCompat.FROM_HTML_MODE_LEGACY)
}

您可以添加别名作为 Fragment 的扩展名 - 请记住将 args 分散在它们之间：

fun Fragment.getText(id: Int, vararg args: Any) = requireContext().getText(id, *args)

Answer 7

这是最终对我有用的代码

字符串.xml

<string name="launch_awaiting_instructions">Contact <b>our</b> team on %1$s to activate.</string>
<string name="support_contact_phone_number"><b>555 555 555</b> Opt <b>3</b></string>

科特林代码

fun Spanned.toHtmlWithoutParagraphs(): String {
    return HtmlCompat.toHtml(this, HtmlCompat.TO_HTML_PARAGRAPH_LINES_CONSECUTIVE)
        .substringAfter("<p dir=\"ltr\">").substringBeforeLast("</p>")
}

fun Resources.getText(@StringRes id: Int, vararg args: Any): CharSequence {
    val escapedArgs = args.map {
        if (it is Spanned) it.toHtmlWithoutParagraphs() else it
    }.toTypedArray()
    val resource = SpannedString(getText(id))
    val htmlResource = resource.toHtmlWithoutParagraphs()
    val formattedHtml = String.format(htmlResource, *escapedArgs)
    return HtmlCompat.fromHtml(formattedHtml, HtmlCompat.FROM_HTML_MODE_LEGACY)
}

使用它，我也能够在 Android 上使用样式占位符渲染样式文本

输出

联系我们的团队555 555 555选项3以激活。

然后，我能够扩展此解决方案以创建以下 Compose 方法。

Jetpack Compose 用户界面

@Composable
fun annotatedStringResource(@StringRes id: Int, vararg formatArgs: Any): AnnotatedString {
    val resources = LocalContext.current.resources
    return remember(id) {
        val text = resources.getText(id, *formatArgs)
        spannableStringToAnnotatedString(text)
    }
}

@Composable
fun annotatedStringResource(@StringRes id: Int): AnnotatedString {
    val resources = LocalContext.current.resources
    return remember(id) {
        val text = resources.getText(id)
        spannableStringToAnnotatedString(text)
    }
}

private fun spannableStringToAnnotatedString(text: CharSequence): AnnotatedString {
    return if (text is Spanned) {
        val spanStyles = mutableListOf<AnnotatedString.Range<SpanStyle>>()
        spanStyles.addAll(text.getSpans(0, text.length, UnderlineSpan::class.java).map {
            AnnotatedString.Range(
                SpanStyle(textDecoration = TextDecoration.Underline),
                text.getSpanStart(it),
                text.getSpanEnd(it)
            )
        })
        spanStyles.addAll(text.getSpans(0, text.length, StyleSpan::class.java).map {
            AnnotatedString.Range(
                SpanStyle(fontWeight = FontWeight.Bold),
                text.getSpanStart(it),
                text.getSpanEnd(it)
            )
        })
        AnnotatedString(text.toString(), spanStyles = spanStyles)
    } else {
        AnnotatedString(text.toString())
    }
}

Answer 8

您可以在 Kotlin 中使用 java.lang.String 进行字符串格式化

fun main(args : Array<String>) {
  var value1 = 1
  var value2 = "2"
  var value3 = 3.0
  println(java.lang.String.format("%d, %s, %6f", value1, value2, value3))
}