База даних Android Room: Як обробляти Arraylist в сутності?

Я щойно реалізував Кімната для збереження даних у режимі офлайн. Але в класі Entity я отримую таку помилку:

Error:(27, 30) error: Cannot figure out how to save this field into database. You can consider adding a type converter for it.

А клас такий:

@Entity(tableName = "firstPageData")
public class MainActivityData {

    @PrimaryKey
    private String userId;

    @ColumnInfo(name = "item1_id")
    private String itemOneId;

    @ColumnInfo(name = "item2_id")
    private String itemTwoId;

    // THIS IS CAUSING THE ERROR... BASICALLY IT ISN'T READING ARRAYS
    @ColumnInfo(name = "mylist_array")
    private ArrayList<MyListItems> myListItems;

    public String getUserId() {
        return userId;
    }

    public void setUserId(String userId) {
        this.userId = userId;
    }

    public ArrayList<MyListItems> getMyListItems() {
        return myListItems;
    }

    public void setCheckListItems(ArrayList<MyListItems> myListItems) {
        this.myListItems = myListItems;
    }

}

Отже, в основному я хочу зберегти ArrayList у базі даних, але мені не вдалося знайти нічого, що стосується цього. Чи можете ви порадити мені, як зберегти масив за допомогою Кімната?

ПРИМІТКА: Клас MyListItems Pojo містить 2 рядки (на даний момент)

Заздалегідь спасибі.

Варіант № 1: Have MyListItemsбути @Entity, так як MainActivityDataє. MyListItemsвстановив би @ForeignKeyназад до MainActivityData. У цьому випадку, однак, MainActivityDataне може бути private ArrayList<MyListItems> myListItems, як у кімнаті, сутності не посилаються на інші сутності. Хоча модель подання або подібна конструкція POJO може мати a MainActivityDataта пов'язані з нею ArrayList<MyListItems>.

Варіант №2: Налаштуйте пару @TypeConverterметодів для перетворення ArrayList<MyListItems>на базовий тип та з нього (наприклад, a String, наприклад, використовуючи JSON як формат зберігання). Тепер MainActivityDataможе мати його ArrayList<MyListItems>безпосередньо. Однак окремої таблиці для цього не буде MyListItems, тому ви не можете MyListItemsдуже добре запитувати .

Перетворювачі типів зроблені спеціально для цього. У вашому випадку ви можете використовувати наведений нижче фрагмент коду для зберігання даних у БД.

public class Converters {
    @TypeConverter
    public static ArrayList<String> fromString(String value) {
        Type listType = new TypeToken<ArrayList<String>>() {}.getType();
        return new Gson().fromJson(value, listType);
    }

    @TypeConverter
    public static String fromArrayList(ArrayList<String> list) {
        Gson gson = new Gson();
        String json = gson.toJson(list);
        return json;
    }
}

І згадайте цей клас у своїй БД кімнати так

@Database (entities = {MainActivityData.class},version = 1)
@TypeConverters({Converters.class})

Більше інформації тут

Версія Kotlin для перетворювача типів:

 class Converters {

    @TypeConverter
    fun listToJson(value: List<JobWorkHistory>?) = Gson().toJson(value)

    @TypeConverter
    fun jsonToList(value: String) = Gson().fromJson(value, Array<JobWorkHistory>::class.java).toList()
}

Я використовував JobWorkHistoryоб’єкт для своєї мети, використовуйте об’єкт власного

@Database(entities = arrayOf(JobDetailFile::class, JobResponse::class), version = 1)
@TypeConverters(Converters::class)
abstract class MyRoomDataBase : RoomDatabase() {
     abstract fun attachmentsDao(): AttachmentsDao
}

Краща версія List<String>конвертера

class StringListConverter {
    @TypeConverter
    fun fromString(stringListString: String): List<String> {
        return stringListString.split(",").map { it }
    }

    @TypeConverter
    fun toString(stringList: List<String>): String {
        return stringList.joinToString(separator = ",")
    }
}

Ось як я обробляю перетворення списку

public class GenreConverter {
@TypeConverter
public List<Integer> gettingListFromString(String genreIds) {
    List<Integer> list = new ArrayList<>();

    String[] array = genreIds.split(",");

    for (String s : array) {
       if (!s.isEmpty()) {
           list.add(Integer.parseInt(s));
       }
    }
    return list;
}

@TypeConverter
public String writingStringFromList(List<Integer> list) {
    String genreIds = "";
    for (int i : list) {
        genreIds += "," + i;
    }
    return genreIds;
}}

А потім у базі даних я роблю, як показано нижче

@Database(entities = {MovieEntry.class}, version = 1)
@TypeConverters(GenreConverter.class)

А нижче - реалізація kotlin того ж;

class GenreConverter {
@TypeConverter
fun gettingListFromString(genreIds: String): List<Int> {
    val list = mutableListOf<Int>()

    val array = genreIds.split(",".toRegex()).dropLastWhile {
        it.isEmpty()
    }.toTypedArray()

    for (s in array) {
        if (s.isNotEmpty()) {
            list.add(s.toInt())
        }
    }
    return list
}

@TypeConverter
fun writingStringFromList(list: List<Int>): String {
    var genreIds=""
    for (i in list) genreIds += ",$i"
    return genreIds
}}

Мав таке саме повідомлення про помилку, як описано вище. Я хотів би додати: якщо ви отримуєте це повідомлення про помилку в @Query, вам слід додати @TypeConverters над анотацією @Query.

Приклад:

@TypeConverters(DateConverter.class)
@Query("update myTable set myDate=:myDate  where id = :myId")
void updateStats(int myId, Date myDate);

....

public class DateConverter {

    @TypeConverter
    public static Date toDate(Long timestamp) {
        return timestamp == null ? null : new Date(timestamp);
    }

    @TypeConverter
    public static Long toTimestamp(Date date) {
        return date == null ? null : date.getTime();
    }
}

Ця відповідь використовує Котіна для розділення комами та побудови рядка, виділеного комами. Кома повинна йти в кінці всіх, крім останнього елемента, тому це також буде обробляти списки окремих елементів.

object StringListConverter {
        @TypeConverter
        @JvmStatic
        fun toList(strings: String): List<String> {
            val list = mutableListOf<String>()
            val array = strings.split(",")
            for (s in array) {
                list.add(s)
            }
            return list
        }

        @TypeConverter
        @JvmStatic
        fun toString(strings: List<String>): String {
            var result = ""
            strings.forEachIndexed { index, element ->
                result += element
                if(index != (strings.size-1)){
                    result += ","
                }
            }
            return result
        }
    }

у моєму випадку проблема полягала в загальній основі на основі цієї відповіді

https://stackoverflow.com/a/48480257/3675925 використовувати список замість ArrayList

 import androidx.room.TypeConverter
 import com.google.gson.Gson 
 import com.google.gson.reflect.TypeToken
 class IntArrayListConverter {
     @TypeConverter
     fun fromString(value: String): List<Int> {
         val type = object: TypeToken<List<Int>>() {}.type
         return Gson().fromJson(value, type)
     }

     @TypeConverter
     fun fromArrayList(list: List<Int>): String {
         val type = object: TypeToken<List<Int>>() {}.type
         return Gson().toJson(list, type)
     } 
}

йому не потрібно додавати @TypeConverters (IntArrayListConverter :: class) до запиту в класі dao, ані поля в класі Entity, а просто додавати @TypeConverters (IntArrayListConverter :: class) до класу бази даних

@Database(entities = [MyEntity::class], version = 1, exportSchema = false)
@TypeConverters(IntArrayListConverter::class)
abstract class MyDatabase : RoomDatabase() {

Я особисто радив би @TypeConverters/ не проводити серіалізації, оскільки вони порушують відповідність нормальним формам бази даних.

У цьому конкретному випадку може бути варто визначити взаємозв'язок за допомогою анотації @Relation , яка дозволяє запитувати вкладені сутності в єдиний об'єкт без додаткової складності декларації a @ForeignKeyта написання всіх запитів SQL вручну:

@Entity
public class MainActivityData {
    @PrimaryKey
    private String userId;
    private String itemOneId;
    private String itemTwoId;
}

@Entity
public class MyListItem {
    @PrimaryKey
    public int id;
    public String ownerUserId;
    public String text;
}

/* This is the class we use to define our relationship,
   which will also be used to return our query results.
   Note that it is not defined as an @Entity */
public class DataWithItems {
    @Embedded public MainActivityData data;
    @Relation(
        parentColumn = "userId"
        entityColumn = "ownerUserId"
    )
    public List<MyListItem> myListItems;
}

/* This is the DAO interface where we define the queries.
   Even though it looks like a single SELECT, Room performs
   two, therefore the @Transaction annotation is required */
@Dao
public interface ListItemsDao {
    @Transaction
    @Query("SELECT * FROM MainActivityData")
    public List<DataWithItems> getAllData();
}

Окрім цього прикладу 1-N, можна також визначити відносини 1-1 та NM.

Додавання @TypeConvertersза допомогою класу конвертора як параметрів

до бази даних і до класу Dao, змусив мої запити працювати

Перетворення Json погано масштабуються з точки зору розподілу пам’яті, я скоріше піду на щось подібне до відповідей вище з деякою дозвільністю.

class Converters {
    @TypeConverter
    fun stringAsStringList(strings: String?): List<String> {
        val list = mutableListOf<String>()
        strings
            ?.split(",")
            ?.forEach {
                list.add(it)
            }

        return list
    }

    @TypeConverter
    fun stringListAsString(strings: List<String>?): String {
        var result = ""
        strings?.forEach { element ->
            result += "$element,"
        }
        return result.removeSuffix(",")
    }
}

Для простих типів даних можна використовувати вищезазначене, інакше для складних типів даних Room надає Embedded

Ось приклад додавання типів customObject до таблиці DB кімнати. https://mobikul.com/insert-custom-list-and-get-that-list-in-room-database-using-typeconverter/

Додавання перетворювача типів було простим, мені просто потрібен був метод, який міг би перетворити список об’єктів на рядок, і метод, який міг би робити зворотне. Для цього я використовував gson.

public class Converters {

    @TypeConverter
    public static String MyListItemListToString(List<MyListitem> list) {
        Gson gson = new Gson();
        return gson.toJson(list);
    }

    @TypeConverter
    public static List<Integer> stringToMyListItemList(@Nullable String data) {
        if (data == null) {
            return Collections.emptyList();
        }

        Type listType = new TypeToken<List<MyListItem>>() {}.getType();

        Gson gson = new Gson();
        return gson.fromJson(data, listType);
    }
}

Потім я додав анотацію до поля в сутності:

@TypeConverters(Converters.class)

public final ArrayList<MyListItem> myListItems;

Коли ми використовуємо TypaConverters, тоді тип даних повинен бути типом повернення методу TypeConverter. Приклад методу TypeConverter Повернення рядка, а потім додавання таблиці COloum має бути рядком

 private static final Migration MIGRATION_1_2 = new Migration(1, 2) {
    @Override
    public void migrate(@NonNull SupportSQLiteDatabase database) {
        // Since we didn't alter the table, there's nothing else to do here.
        database.execSQL("ALTER TABLE "+  Collection.TABLE_STATUS  + " ADD COLUMN deviceType TEXT;");
        database.execSQL("ALTER TABLE "+  Collection.TABLE_STATUS  + " ADD COLUMN inboxType TEXT;");
    }
};

 @Query("SELECT * FROM business_table")
 abstract List<DatabaseModels.Business> getBusinessInternal();


 @Transaction @Query("SELECT * FROM business_table")
 public ArrayList<DatabaseModels.Business> getBusiness(){
        return new ArrayList<>(getBusinessInternal());
 }

Усі наведені вище відповіді стосуються списку рядків. Але нижче допоможе вам знайти конвертер для списку ваших об’єктів.

Просто, замість " YourClassName ", додайте свій клас Object.

 @TypeConverter
        public String fromValuesToList(ArrayList<**YourClassName**> value) {
            if (value== null) {
                return (null);
            }
            Gson gson = new Gson();
            Type type = new TypeToken<ArrayList<**YourClassName**>>() {}.getType();
            return gson.toJson(value, type);
        }
    
        @TypeConverter
        public ArrayList<**YourClassName**> toOptionValuesList(String value) {
            if (value== null) {
                return (null);
            }
            Gson gson = new Gson();
            Type type = new TypeToken<List<**YourClassName**>>() {
            }.getType();
            return gson.fromJson(value, type);
        }

Усі відповіді вище правильні. Так, якщо ДІЙСНО вам потрібно зберегти масив чогось в одному полі SQLite, рішення TypeConverter є рішенням.

І я використовував прийняту відповідь у своїх проектах.

Але не робіть цього !!!

Якщо вам потрібен масив магазину в Entity у 90% випадків, вам потрібно створити відносини один-до-багатьох або багато-до-багатьох.

В іншому випадку ваш наступний SQL-запит на вибір чогось із ключем всередині цього масиву буде абсолютно пекельним ...

Приклад:

Об'єкт foo поставляється як json: [{id: 1, name: "abs"}, {id: 2, name: "cde"}

Панель об’єктів: [{id, 1, foos: [1, 2], {...}]

Тож не робіть сутність такою:

@Entity....
data class bar(
...
val foos: ArrayList<Int>)

Зробіть як наступне:

@Entity(tablename="bar_foo", primaryKeys=["fooId", "barId"])
data class barFoo(val barId: Int, val fooId: Int)

І болять ваші ноги: [] як записи в цій таблиці.

Власна версія Kotlin з використанням компонента серіалізації Kotlin - kotlinx.serialization .

1. Додайте плагін Kotle для серіалізації Kotle до своїх build.gradle:

apply plugin: 'kotlinx-serialization'

dependencies {
   ...
   implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.0.1"
}

2. Додайте перетворювачі типів у свій клас Converter;

@TypeConverter
fun fromList(value : List<String>) = Json.encodeToString(value)

@TypeConverter
fun toList(value: String) = Json.decodeFromString<List<String>>(value)

3. Додайте клас Converter до класу бази даних:

@TypeConverters(Converters::class)
abstract class YourDatabase: RoomDatabase() {...}

І готово!

Додаткові ресурси:

• Перетворювачі типу
• Серіалізація Котліна

Використовуйте офіційне рішення з приміщення, @Embedded анотація:

@Embedded(prefix = "mylist_array") private ArrayList<MyListItems> myListItems