AndroidでHtml.toHtml/fromHtmlを使用時に改行が削除されてしまう

Question

実現したいこと

・EditTextに入力した文字を任意で装飾しRealmに保存
・その後、保存したデータを読み込み、EditTextに正しく表示を行いたいと考えています

前提

入力した文字を範囲選択し、ボタンを押下することで文字の装飾（文字色、ボールド 等）を行うことができるメモ帳のようなアプリを作成しています。

発生している問題・エラーメッセージ

前提に記載したアプリを実現するため、入力された文字（装飾含む）をHTML化してRealmに保存。
次回起動時にRealmからデータを読み込み再表示を行ったのですが、一部の改行が削除されてしまいました。

具体的には、

１
２

３


４



５




６

が

１
２
３
４

５


６

となってしまいます。

該当のソースコード

val button = findViewById<Button>(R.id.button)
button.setOnClickListener {
    val editTest1 =  findViewById<EditText>(R.id.editText1)
    val editTest2 =  findViewById<EditText>(R.id.editText2)

    val htmlString = Html.toHtml(editTest1.text, Html.TO_HTML_PARAGRAPH_LINES_CONSECUTIVE)

    val htmlSpanned = Html.fromHtml(htmlString, Html.FROM_HTML_MODE_COMPACT)
    editTest2.setText(htmlSpanned)
}

※6行目：editTest1.textの値
１\n２\n\n３\n\n\n４\n\n\n\n５\n\n\n\n\n６

※6行目：htmlStringの値
<p dir="ltr">&#65297;<br>
&#65298;</p>
<p dir="ltr">&#65299;<br></p>
<p dir="ltr">&#65300;<br><br></p>
<p dir="ltr">&#65301;<br><br><br></p>
<p dir="ltr">&#65302;</p>

※8行目：htmlSpannedの値
１\n２\n３\n４\n\n５\n\n\n６\n

試したこと

「改行が2個以上なら改行コードを2個追加すれば良い」という記載をしているサイトがあったので正規表現で置換しようとしましたが上手くいきませんでした。

補足情報

そもそもの書き方が悪いのか、正規表現で2個追加するという力業が正しいのか、何も分からない状況で恐縮なのですが、解決方法がわかる方がいればご教示お願いいたします。

正しい書き方、正規表現での対応方法、どちらでも構いません。
どうぞよろしくお願いいたします。

Comments

[hoshi-takanori]

たぶんそういう仕様じゃないかと…。
https://stackoverflow.com/questions/11625330/html-fromhtml-line-breaks-disappearing

[jimbe]

どのようなテキストがどのような html になったのでしょうか。
改行やタグが見えるようにご提示ください。

[bluvenz]

hoshi-takanori様
やはりそうなんですね…。
記載いただいたURL内にあるように自力で書くしかないのかもしれませんが、使用する全ての装飾（タグ）を全て書くのは辛く、他に何か良い方法は思いつかないでしょうか…。

jimbe様
いつもありがとうございます。情報が不足しており申し訳ありません。
ご指摘の通り追記いたしましたのでご確認いただけますと幸いです。

[hoshi-takanori]

あれ？ br タグがちゃんとある。ってことは fromHtml の問題か…。

[jimbe]

(回答に移しました)

Answer 1

まず、 toHtml と fromHtml はお互いを実行することで完全に元に戻ることが保証されたモノでは無いことは理解しておく必要があるでしょう。
その上で、公式のドキュメント https://developer.android.com/reference/android/text/Html#FROM_HTML_MODE_COMPACT
の記述が参考になります。

This inverts the Spanned to HTML string conversion done with the option TO_HTML_PARAGRAPH_LINES_INDIVIDUAL.
これは、 Spannedオプションで行われた HTML 文字列への変換を 逆にしますTO_HTML_PARAGRAPH_LINES_INDIVIDUAL。(Google 翻訳)

つまり、追加頂いたデータで改行が ほぼ 再現されるフラグの組み合わせは、
Html.TO_HTML_PARAGRAPH_LINES_INDIVIDUAL
Html.FROM_HTML_MODE_COMPACT
と思われます。

ただ、 realm で保存・再生する為に HTMLを介するのが正しいのかという点は再考する余地はあるように感じます。

---

操作できず表示の確認だけですが、 json を用いるようにしてみました。
Span 毎に処理を行う必要があるため、 サンプルとして AbsoluteSizeSpan と ForegroundColorSpan だけに対応です。

import androidx.appcompat.app.AppCompatActivity;

import android.graphics.Color;
import android.os.*;
import android.text.*;
import android.text.style.*;
import android.util.Log;
import android.widget.*;

import com.google.gson.Gson;
import com.google.gson.annotations.SerializedName;

import java.lang.reflect.*;
import java.util.regex.*;

class EditedText {
  private static final class SpanObject {
    private static class What {
      private static final class Param {
        final String type, value;
        Param(int value) {
          type = int.class.getCanonicalName();
          this.value = "" + value;
        }
        Param(boolean value) {
          type = boolean.class.getCanonicalName();
          this.value = "" + value;
        }
        Class<?> getType() {
          switch(type) {
            case "int": return int.class;
            case "boolean": return boolean.class;
            default: return String.class;
          }
        }
        Object getValue() {
          switch(type) {
            case "int": return Integer.parseInt(value);
            case "boolean": return Boolean.parseBoolean(value);
            default: return value;
          }
        }
        @Override
        public String toString() { return "[type="+type+",value="+value+"]"; }
      }
      @SerializedName("class")
      String className;
      Param[] params;
      What(Class<?> clazz, int size) {
        className = clazz.getCanonicalName();
        params = new Param[size];
      }
      What(AbsoluteSizeSpan span) {
        this(span.getClass(), 2);
        params[0] = new Param(span.getSize());
        params[1] = new Param(span.getDip());
      }
      What(ForegroundColorSpan span) {
        this(span.getClass(), 1);
        params[0] = new Param(span.getForegroundColor());
      }
      Object generate() throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, IllegalAccessException, InstantiationException {
        Class<?>[] paramTypes = new Class[params.length];
        Object[] initargs = new Object[params.length];
        for(int i=0; i<params.length; i++) {
          paramTypes[i] = params[i].getType();
          initargs[i] = params[i].getValue();
        }
        return Class.forName(className).getConstructor(paramTypes).newInstance(initargs);
      }
      @Override
      public String toString() {
        StringBuilder sb = new StringBuilder("[");
        sb.append("class=").append(className);
        sb.append(",params=[");
        for(int i=0; i<params.length; i++) sb.append(i > 0 ? "," : "").append(params[i]);
        sb.append("]");
        return sb.append("]").toString();
      }
    }
    @SerializedName("object")
    What what;
    int start, end, flags;

    @Override
    public String toString() {
      StringBuilder sb = new StringBuilder("[");
      sb.append("what=").append(what);
      sb.append(",start=").append(start);
      sb.append(",end=").append(end);
      sb.append(",flags=").append(flags);
      return sb.append("]").toString();
    }
  }
  private String text;
  private SpanObject[] spans;

  EditedText(Spanned spanned) {
    text = spanned.toString();
    Object[] spans = spanned.getSpans(0, spanned.length(), Object.class);
    this.spans = new SpanObject[spans.length];
    for(int i=0; i<spans.length; i++) {
      SpanObject span = new SpanObject();
      if(spans[i] instanceof AbsoluteSizeSpan) {
        span.what = new SpanObject.What((AbsoluteSizeSpan)spans[i]);
      } else if(spans[i] instanceof ForegroundColorSpan) {
        span.what = new SpanObject.What((ForegroundColorSpan)spans[i]);
      }
      span.start = spanned.getSpanStart(spans[i]);
      span.end = spanned.getSpanEnd(spans[i]);
      span.flags = spanned.getSpanFlags(spans[i]);
      this.spans[i] = span;
    }
  }

  Spanned toSpanned() throws ClassNotFoundException, InvocationTargetException, NoSuchMethodException, IllegalAccessException, InstantiationException {
    SpannableStringBuilder ssb = new SpannableStringBuilder(text);
    for(SpanObject span : spans) ssb.setSpan(span.what.generate(), span.start, span.end, span.flags);
    return ssb;
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder("[");
    sb.append("text=").append(text);
    sb.append(",spans=[");
    for(int i=0; i<spans.length; i++) sb.append(i > 0 ? "," : "").append(spans[i]);
    sb.append("]");
    return sb.append("]").toString();
  }
}

public class MainActivity extends AppCompatActivity {
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    EditText editText = findViewById(R.id.editText);
    TextView textView = findViewById(R.id.textView);

    SpannableStringBuilder ssb = new SpannableStringBuilder("ACDEFG");
    ssb.setSpan(new AbsoluteSizeSpan(50, true), 2, 4, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
    ssb.setSpan(new ForegroundColorSpan(Color.RED), 3, 5, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
    //editText.setText("１\n２\n\n３\n\n\n４\n\n\n\n５\n\n\n\n\n６");
    editText.setText(ssb);

    EditedText editedText = new EditedText(ssb);
    Log.d("*** toString ***", editedText.toString());

    Gson gson = new Gson();
    String json = gson.toJson(editedText);
    Log.d("*** toJson ***", json);

    EditedText newEdtedText = gson.fromJson(json, EditedText.class);
    try {
      textView.setText(newEdtedText.toSpanned());
    } catch(ClassNotFoundException|
            InvocationTargetException|
            NoSuchMethodException|
            IllegalAccessException|
            InstantiationException e) {
      e.printStackTrace();
    }
  }

  //コントロールコードを文字化
  private String toText(Spanned htmlSpanned) {
    StringBuilder sb = new StringBuilder();
    Pattern p = Pattern.compile("[\u0000-\u001F]");
    int last = 0;
    for(Matcher m=p.matcher(htmlSpanned); m.find(last); last=m.end()) {
      sb.append(htmlSpanned.subSequence(last, m.start()));
      char c = m.group().charAt(0);
      sb.append("^").append((char)(c + '@'));
    }
    sb.append(htmlSpanned.subSequence(last, htmlSpanned.length()));
    return sb.toString();
  }
}

res/layout/activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

  <EditText
      android:id="@+id/editText"
      android:layout_width="0dp"
      android:layout_height="0dp"
      android:textSize="30dp"
      app:layout_constraintBottom_toTopOf="@id/textView"
      app:layout_constraintEnd_toEndOf="parent"
      app:layout_constraintStart_toStartOf="parent"
      app:layout_constraintTop_toTopOf="parent" />
  <TextView
      android:id="@+id/textView"
      android:layout_width="0dp"
      android:layout_height="0dp"
      android:textSize="30dp"
      android:background="#e0e0e0"
      app:layout_constraintBottom_toBottomOf="parent"
      app:layout_constraintEnd_toEndOf="parent"
      app:layout_constraintStart_toStartOf="parent"
      app:layout_constraintTop_toBottomOf="@id/editText" />
</androidx.constraintlayout.widget.ConstraintLayout>

エミュレータ実行結果

実行時ログ

D/*** toString ***: [text=ACDEFG,spans=[[what=[class=android.text.style.AbsoluteSizeSpan,params=[[type=int,value=50],[type=boolean,value=true]]],start=2,end=4,flags=33],[what=[class=android.text.style.ForegroundColorSpan,params=[[type=int,value=-65536]]],start=3,end=5,flags=33]]]
D/*** toJson ***: {"spans":[{"end":4,"flags":33,"start":2,"object":{"class":"android.text.style.AbsoluteSizeSpan","params":[{"type":"int","value":"50"},{"type":"boolean","value":"true"}]}},{"end":5,"flags":33,"start":3,"object":{"class":"android.text.style.ForegroundColorSpan","params":[{"type":"int","value":"-65536"}]}}],"text":"ACDEFG"}

Comments

[bluvenz]

ありがとうございます！
ご教示いただいた変更で無事に実現することができました。
公式も見たつもりだったのですが、見逃していたようで反省しています…。

ただ、今度は行頭に半角スペースが1つだけの場合に削除されてしまうことに気が付きました。
jimbe様の仰る通り別の方法を検討した方が良いのでしょうね。
もし思うところがあればご意見いただきたいのですが、こういった場合はHTMLを経由する以外でどういった方法が考えられますでしょうか。

[jimbe]

根本的には、 HTML 自体が "文字列を修飾するモノ" ではありません。
HTML は "文章構造を記述するモノ" で、たまたま(?) 修飾することが出来たために本来の使い方をされなくなってしまっただけです。
問題となっている文字列において、 "PARAGRAPH であるという情報" は無いのにも関わらず <p> タグが使用されている時点で、文字列の意図を HTML 化出来ていないとも言えます。

Spanned/Spannable を調べますと、内部データは String と Span で構成され、別々に取得できることが分かります。
そして、 Span は ParcelableSpan を implements し、 ParcelableSpan はその名の通り Parcelable を継承しているようです。
つまり、 Spanned/Spannable 自体は Parcelable ではありませんが、分解すればそれぞれが Serializable/Parcelable ですので"データ化"出来ることになります。

※注：試していません

[jimbe]

parcial は長期保存には向かないので、 json を用いるコードを作って回答に追加しました。

[bluvenz]

HTMLについて、たまたま修飾ができているという点、納得いたしました。
先ほど書かせていただいた行頭の半角スペース問題などは、まさにHTMLで初心者が悩むような問題ですね。

また、サンプルまで作成いただいて本当にありがとうございます。
ニュアンスは解るのですが、理解しきれていない部分が多くあるため、１つずつ追って確認しようと思います。
多くのお時間を割いていただき感謝してもしきれません。本当にありがとうございました。

[jimbe]

>ニュアンスは解るのですが、理解しきれていない部分が

Spanned を EditedText の内部に展開し、 EditedText を json 化することで文字列にしています。
戻す時は逆に json から EditedText を生成して、 EditedText のメソッドで Spanned を生成しています。
スパンはクラス名とコンストラクタパラメータが分かればリフレクションで生成できます(Whatクラスのgenerateメソッド)ので、 instanceof でスパンのクラスを調べ(EditedTextクラスのコンストラクタ内のforループ)て、コンストラクタパラメータになるデータを取得してテキストとして保存しています(Whatクラスのコンストラクタ)。

new AbsoluteSizeSpan(50, true);

を json で

{
"class":"android.text.style.AbsoluteSizeSpan",
"params":[ {"type":"int", "value":"50"}, {"type":"boolean", "value":"true"}]
}

と表す風にしています。

kotlin 案件なのに java コードで申し訳ないです。
EditedText を別 java ファイルとして、 MainActivity くらいは kotlin で良かったかもしれません。