以前学android的时候就曾经使用过APT在编译时解析注解,然后结合Javapoet生成代码,在flutter端其实也有这种类似的技术,这就是source_gen和code_builder,source_gen负责编译时解析注解,code_builder负责生成代码,本篇文章,就是在讲解如何使用source_gen和code_builder编译时生成代码,code_builder如何使用,请看之前的文章, 本文 github链接
具体步骤
1. 新建flutter package,命名为annotations
这个包专门用来放注解,在这个包中新建一个注解类,如下所示
class ChannelHelp {
final String channelName;
const ChannelHelp(this.channelName); //注解类,构造函数必须是Const的
}
2. 新建flutter package,命名为generate
这个包专门用来解析注解,生成代码,先在pubspec.yaml中依赖上面创建的包annotations,然后再添加依赖source_gen和build_runner,代码如下
name: generate
description: A new Flutter package.
version: 0.0.1
author:
homepage:
environment:
sdk: “>=2.7.0 ❤️.0.0”
flutter: “>=1.17.0 <2.0.0”
dependencies:
flutter:
sdk: flutter
source_gen: ^0.9.6 #需要包含代码自动库
annotations:
path: …/annotations
dev_dependencies:
flutter_test:
sdk: flutter
build_runner: ^1.10.0
flutter:
3.在generate包中新建dart类ChannelHelpGenerator
这个类继承自ChannelHelpGenerator,用于解析ChannelHelp注解,代码如下:
import ‘package:analyzer/dart/element/element.dart’;
import ‘package:annotations/channel_help.dart’;
import ‘package:build/src/builder/build_step.dart’;
import ‘package:source_gen/source_gen.dart’;
import ‘package:code_builder/code_builder.dart’;
import ‘package:dart_style/dart_style.dart’;
import ‘package:path/path.dart’ as Path;
import ‘package:build/build.dart’;
class ChannelHelpGenerator extends GeneratorForAnnotation {
static final String channelName = “_MethodChannel”;
String className;
@override
generateForAnnotatedElement(
Element element, ConstantReader annotation, BuildStep buildStep) {
final emitter = DartEmitter();
if (element is! ClassElement) {
throw InvalidGenerationSourceError(‘ChannelHelper只能用在类上’);
}
className = element.displayName;
var channelName = annotation.peek(“channelName”).stringValue;
ClassBuilder classBuilder;
var channelHelper =