flutter 使用source_gen和code_builder编译时生成代码

《Android学习笔记总结+最新移动架构视频+大厂安卓面试真题+项目实战源码讲义》

完整开源地址：https://docs.qq.com/doc/DSkNLaERkbnFoS0ZF

}

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 = Class((builder) {
classBuilder = builder;

classBuilder.constructors.add(Constructor((constructorBuild) {
constructorBuild.name = “_internal”;
}));

classBuilder.name = 'KaTeX parse error: Expected '}', got 'EOF' at end of input: …dModifier.final;
fieldBuild.assignment = Code(‘MethodChannel(“$channelName”)’);
}));

classBuilder.fields.add(Field((fieldBuild) {
fieldBuild.name = “_$className";fieldBuild.type=refer("$className”);
fieldBuild.static = true;
}));

classBuilder.methods.add(Method((methodBuild) {
methodBuild.name = “getInstance”;
methodBuild.returns = refer(‘$className’);
methodBuild.static = true;
methodBuild.body = _generatorSingleInstantBody();
}));

ClassElement classElement = element as ClassElement;
List methodElements = classElement.methods;
if (methodElements != null && methodElements.length > 0) {
methodElements.forEach((methodElement) {
classBuilder.methods.add(Method((methodBuild) {
methodBuild.name = methodElement.name;
methodBuild.modifier = MethodModifier.async;
methodBuild.returns =
refer(“${methodElement.returnType.getDisplayString()}”);
methodBuild.annotations.add(TypeReference((build) {
// 给方法添加注解
build.symbol = “override”; //注解类型是override
}));
var parameters = methodElement.parameters;
methodBuild.body = _generatorBody(methodElement, parameters);
}));
});
}
});

String channelHelperStr =
DartFormatter().format(‘${channelHelper.accept(emitter)}’);

return “”"

part of ‘${Path.basename(buildStep.inputId.path)}’;

$channelHelperStr
“”";
}

Code generatorSingleInstantBody() {
final blocks = [];
blocks.add(Code("if(KaTeX parse error: Expected group after '_' at position 44: …cks .add(Code("_̲className = ${className}Imp._internal() as KaTeX parse error: Expected 'EOF', got '}' at position 33: …ocks.add(Code("}̲")); blocks.add…className;"));
return Block.of(blocks);
}

// ignore: missing_return
Code _generatorBody(
MethodElement methodElement, List parameters) {
final blocks = [];
if (parameters == null || parameters.length == 0) {
blocks.add(Code(
“dynamic _result = await $channelName.invokeMethod{(}^{\prime }${methodElement.name}');”));
}
blocks.add(_generatorResult(methodElement));
return Block.of(blocks);
}

Code _generatorResult(MethodElement methodElement) {
final blocks = [];
return Block.of(blocks);
}
}

4.在generate包中新建dart文件channel_help_builder

这个包用于加载ChannelHelpGenerator，指定生成的文件后缀，代码如下：

import ‘package:source_gen/source_gen.dart’;
import ‘package:build/build.dart’;
import ‘channel_help_generator.dart’;

Builder nativeCallBuilder(BuilderOptions options) =>
LibraryBuilder(ChannelHelpGenerator(), generatedExtension: ‘.nc.g.dart’);

5.在generate包中新建文件build.yaml

代码如下：

builders:
channel_help_builder:
target: “:annotations” #目标库
import: ‘package:generate/channel_help_builder.dart’ #build文件
builder_factories: [‘nativeCallBuilder’]