Flutter auto_route带前缀导入模型时路由代码生成异常问题

问题场景 #

在Flutter项目中使用AutoRoute时，页面类通过带前缀的方式导入模型并作为参数，但生成的router.gr.dart文件中未正确生成带前缀的类型，导致Undefined class 'Data'错误：

页面类代码：

import 'package:project_mobile/features/brand/model/brand_response_model.dart'
as model_brand;

class AppointmentCreatePage extends StatefulWidget {
  const AppointmentCreatePage({Key? key, this.brandData}) : super(key: key);

  final model_brand.Data? brandData; // 使用带前缀的导入
  @override
  State<AppointmentCreatePage> createState() => _AppointmentCreatePageState();
}

生成的错误代码（router.gr.dart）：

/// generated route for
/// [AppointmentCreatePage]
class AppointmentCreateRoute extends PageRouteInfo<AppointmentCreateRouteArgs> {
  AppointmentCreateRoute({
    Key? key,
    Data? brandData, // 错误：Undefined class 'Data'
  }) : super(
    AppointmentCreateRoute.name,
    path: '/appointment-create-page',
    args: AppointmentCreateRouteArgs(
     key: key, 
     brandData: brandData,
    ),
   );
  static const String name = 'AppointmentCreateRoute';
}

class AppointmentCreateRouteArgs {
  const AppointmentCreateRouteArgs({
    this.key,        
    this.brandData,
  });
  final Key? key;
  final Data? brandData; // 错误：Undefined class 'Data'
  @override
  String toString() {
    return 'AppointmentCreateRouteArgs{key: $key, brandData: $brandData}';
  }
}

解决方案 #

1. 在router.dart中手动添加带前缀的模型导入 #

在路由配置文件（router.dart）中，提前导入带前缀的模型文件，确保生成器能识别该类型的前缀，同时关闭相对导入偏好适配绝对路径带前缀的导入：

import 'package:project_mobile/features/brand/model/brand_response_model.dart' 
as model_brand; // 手动添加带前缀的导入
part 'router.gr.dart';

@MaterialAutoRouter(              
  replaceInRouteName: 'Page,Route',
  preferRelativeImports: false,
  routes: <AutoRoute>[
    // ...其他路由
    AutoRoute(page: AppointmentCreatePage),
    
  ],              
)
class AppRouter extends _$AppRouter{}

2. 重新运行AutoRoute生成命令 #

执行生成路由文件的命令，让生成器基于更新后的router.dart重新生成代码：

flutter pub run build_runner build --delete-conflicting-outputs

3. 验证生成结果 #

生成的router.gr.dart会自动复用router.dart中的带前缀导入，并生成正确的参数类型：

// router.gr.dart中会自动添加对应导入
import 'package:project_mobile/features/brand/model/brand_response_model.dart' as model_brand;

// ...生成的路由类
class AppointmentCreateRouteArgs {
  const AppointmentCreateRouteArgs({
    this.key,        
    this.brandData,
  });
  final Key? key;
  final model_brand.Data? brandData; // 正确生成带前缀的类型
  @override
  String toString() {
    return 'AppointmentCreateRouteArgs{key: $key, brandData: $brandData}';
  }
}

额外优化建议 #

如果上述方法仍不生效，可尝试：

• 确保页面类中的参数类型始终使用完整的带前缀形式（model_brand.Data），避免省略前缀的写法
• 先清理build缓存再重新生成：flutter pub run build_runner clean后执行build命令

内容的提问来源于stack exchange，提问作者rooxane.mac