Flutter Floor数据库自定义返回类型定义失败问题求助

错误原因 #

Floor要求查询返回的类型必须是已注册的实体类（带@Entity注解）、数据库视图（带@DatabaseView注解），或是基本类型/Map。你的JoinedResults既不是实体也未配置为视图，导致Floor无法解析该返回类型。

解决方案 #

方法1：使用@DatabaseView定义视图（推荐） #

通过数据库视图封装关联查询逻辑，让Floor能识别自定义类作为返回类型：

1. 修改JoinedResults类，添加@DatabaseView注解并实现fromMap构造函数：

import 'package:floor/floor.dart';

@DatabaseView('SELECT Question.question_id, Question.question_text, Question.question_type, Question.is_mandatory, Question.correct_option_id, OptionLists.option_id, OptionLists.option_list_text FROM Question INNER JOIN OptionLists ON Question.question_id = OptionLists.questionId')
class JoinedResults {
  final int? question_id;
  final String? question_text;
  final String? question_type;
  final bool? is_mandatory;
  final int? correct_option_id;
  final int? option_id;
  final String? option_list_text;

  JoinedResults({
    this.question_id,
    this.question_text,
    this.question_type,
    this.is_mandatory,
    this.correct_option_id,
    this.option_id,
    this.option_list_text,
  });

  // 必须实现fromMap构造函数，用于Floor映射查询结果
  JoinedResults.fromMap(Map<String, dynamic> map) :
    question_id = map['question_id'] as int?,
    question_text = map['question_text'] as String?,
    question_type = map['question_type'] as String?,
    is_mandatory = map['is_mandatory'] as bool?,
    correct_option_id = map['correct_option_id'] as int?,
    option_id = map['option_id'] as int?,
    option_list_text = map['option_list_text'] as String?;
}

2. 在数据库类中注册视图：

@Database(
  version: 1,
  entities: [Question, OptionLists],
  views: [JoinedResults], // 加入自定义视图
)
abstract class AppDatabase extends FloorDatabase {
  QuestionDao get questionDao;
}

3. 修改DAO查询语句，直接查询视图：

@dao
abstract class QuestionDao {
  @Query('SELECT * FROM JoinedResults')
  Future<List<JoinedResults>> getAllQuestionsWithOptions();    
}

4. 重新生成Floor代码：
   运行命令让Floor重新生成数据库相关代码：

flutter packages pub run floor generate

方法2：返回Map后手动转换（快速临时方案） #

如果不想使用视图，可以先返回原始Map数据，再手动转换成JoinedResults列表：

1. 修改DAO方法返回类型：

@dao
abstract class QuestionDao {
  @Query('SELECT Question.question_id, Question.question_text, Question.question_type, Question.is_mandatory, Question.correct_option_id, OptionLists.option_id,OptionLists.option_list_text FROM Question INNER JOIN OptionLists ON Question.question_id = OptionLists.questionId')
  Future<List<Map<String, dynamic>>> getAllQuestionsWithOptionsRaw();    
}

2. 调用时手动转换：

// 获取原始数据并转换
final rawData = await questionDao.getAllQuestionsWithOptionsRaw();
final joinedResults = rawData.map((item) => JoinedResults(
  question_id: item['question_id'] as int?,
  question_text: item['question_text'] as String?,
  question_type: item['question_type'] as String?,
  is_mandatory: item['is_mandatory'] as bool?,
  correct_option_id: item['correct_option_id'] as int?,
  option_id: item['option_id'] as int?,
  option_list_text: item['option_list_text'] as String?,
)).toList();

注意事项 #

• 移除JoinedResults中未在查询语句返回的id字段，避免映射错误。
• 确保Question和OptionLists实体类已正确添加@Entity注解并在数据库类中注册。

内容的提问来源于stack exchange，提问作者Muhammad Ans