Room - Schema export directory is not provided to the annotation processor so we cannot export the schema

2024-04-02

Room - Schema export directory is not provided to the annotation processor so we cannot export the schema

原因

このエラーメッセージが表示される原因は、次のとおりです。

room.schemaLocation アノテーションプロセッサー引数が設定されていない
exportSchema フラグが false に設定されている

解決方法

このエラーメッセージを解決するには、次のいずれかの方法を実行する必要があります。

room.schemaLocation アノテーションプロセッサー引数を設定することで、Room にスキーマファイルの出力場所を指示できます。

defaultConfig {
  ...
  javaCompileOptions {
    annotationProcessorOptions {
      arguments += ["room.schemaLocation": "$projectDir/schemas"]
    }
  }
}

exportSchema フラグを true に設定することで、Room にスキーマファイルの自動生成を指示できます。

@Database(
  entities = [YourEntity::class],
  version = 1,
  exportSchema = true
)
abstract class AppDatabase : RoomDatabase() {
  ...
}

上記の方法で解決できない場合は、プロジェクトの build.gradle ファイルを確認してください。
Room ライブラリの公式ドキュメントも参照してください。

room.schemaLocation アノテーションプロセッサー引数は、スキーマファイルの出力場所を指定します。デフォルトでは、プロジェクトの build/generated/source/kapt/kotlin フォルダに出力されます。

exportSchema フラグ

exportSchema フラグは、Room にスキーマファイルの自動生成を指示します。デフォルトでは false に設定されています。

スキーマファイル

スキーマファイルは、データベースの構造を定義する JSON ファイルです。Room は、データベースのマイグレーションなどにこのファイルを使用します。

// データベースエンティティ
@Entity
public class User {
    @PrimaryKey(autoGenerate = true)
    public int id;
    public String name;
    public int age;
}

// データベースアクセスオブジェクト
@Dao
public interface UserDao {
    @Insert
    void insertUser(User user);

    @Query("SELECT * FROM User")
    List<User> getAllUsers();

    @Delete
    void deleteUser(User user);
}

// アプリデータベース
@Database(entities = {User.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {
    public abstract UserDao userDao();
}

// MainActivity.java
public class MainActivity extends AppCompatActivity {
    private AppDatabase db;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        db = Room.databaseBuilder(this, AppDatabase.class, "my-database").build();

        // データベースへの操作
        User user = new User();
        user.name = "John Doe";
        user.age = 30;
        db.userDao().insertUser(user);

        List<User> users = db.userDao().getAllUsers();

        // ...
    }
}

説明

User クラスは、データベースエンティティを表します。
UserDao インターフェースは、データベースアクセスオブジェクトを表します。
AppDatabase クラスは、アプリデータベースを表します。
MainActivity クラスは、データベースへの操作を行うサンプルコードです。

実行方法

上記のコードをプロジェクトに追加します。
プロジェクトの build.gradle ファイルで Room ライブラリを依存関係に追加します。
アプリを実行します。

注意事項

このコードはサンプルコードであり、実際のアプリでは必要に応じて変更する必要があります。

Room スキーマのエクスポート方法

room.schemaLocation アノテーションプロセッサー引数を使用する

これは、スキーマファイルを生成する最も一般的な方法です。

defaultConfig {
  ...
  javaCompileOptions {
    annotationProcessorOptions {
      arguments += ["room.schemaLocation": "$projectDir/schemas"]
    }
  }
}

@Database(
  entities = [YourEntity::class],
  version = 1,
  exportSchema = true
)
abstract class AppDatabase : RoomDatabase() {
  ...
}

RoomSQLiteOpenHelper クラスを使用して、データベースを手動で開くことができます。

public class MyOpenHelper extends RoomSQLiteOpenHelper {

    public MyOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {
        super(context, name, factory, 1);
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        // スキーマを手動で作成
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        // マイグレーション処理
    }
}

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        // ヘルパークラスを初期化
        new MyOpenHelper(this, "my-database", null);
    }
}