引導
在上一篇文章中凉当,我們進行了apply patch文件,那么我們來看看apply的文件茂契,具體做了哪些事情】可以看到是在common.dart文件做了更改掉冶,和新加了一個aspectd.dart文件
common.dart文件
該文件所在目錄:
packages/flutter_tools/lib/build_system/targets/common.dart
可以看到在build方法新增了如下代碼:
@override
Future<void> build(Environment environment) async {
// 這是原來的代碼
await buildImpl(environment);
// 這是新增代碼
if (await AspectdHook.isAspectdEnabled()) {
await AspectdHook().runBuildDillCommand(environment);
}
}
AspectdHook.isAspectdEnabled()
上面代碼調(diào)用了AspectdHook.isAspectdEnabled(),看看這里面做了什么
static Future<bool> isAspectdEnabled() async {
final Directory currentDirectory = globals.fs.currentDirectory;
// 獲取到aspectd_impl對應的目錄脐雪,詳情見下面
final Directory aspectdDirectory = getAspectdImplDirectory(currentDirectory);
// 如果該目錄不存在厌小,返回false,不走aspectd邏輯
if (!aspectdDirectory.existsSync()) {
return false;
}
// 拿到aspectd_imple項目下的.packages文件战秋,因為要取該文件璧亚,所以我們需要先執(zhí)行 pub get
final String aspectdImplPackagesPath = globals.fs.path.join(aspectdDirectory.absolute.path, '.packages');
// 通過.package文件中的數(shù)據(jù),得到aspectd目錄获询,從而得到frontend_server.dart.snapshot所在的目錄涨岁,具體見下方
final Directory flutterFrontendServerDirectory = await getFlutterFrontendServerDirectory(aspectdImplPackagesPath);
// 判斷如果aspectd_impl項目不存在或frontend_server.dart.snapshot對應目錄不存在 及 對應的文件不存在的話返回false
if (!(aspectdDirectory.existsSync() &&
flutterFrontendServerDirectory.existsSync() &&
currentDirectory.absolute.path != aspectdDirectory.absolute.path &&
globals.fs
.file(globals.fs.path.join(aspectdDirectory.path, 'pubspec.yaml'))
.existsSync() &&
globals.fs
.file(
globals.fs.path.join(aspectdDirectory.path, '.packages'))
.existsSync() &&
globals.fs
.file(globals.fs.path.join(
aspectdDirectory.path, 'lib', aspectdImplPackageName + '.dart'))
.existsSync())) {
return false;
}
// 生成frontend_server.dart.snapshot,具體見下方
return await checkAspectdFlutterFrontendServerSnapshot(aspectdImplPackagesPath);
}
下面就是獲取到aspectd_impl目錄的具體方法
const String aspectdImplPackageRelPath = '..';
const String aspectdImplPackageName = 'aspectd_impl';
.
.
.
static Directory getAspectdImplDirectory(Directory rootProjectDir) {
return globals.fs.directory(globals.fs.path.normalize(globals.fs.path.join(
rootProjectDir.path,
aspectdImplPackageRelPath,
aspectdImplPackageName)));
}
獲取aspectd對應的項目吉嚣,及該項目下的flutter_frontend_server目錄
static Future<Directory> getFlutterFrontendServerDirectory(
String packagesPath) async {
// 找到aspectd對應項目的路徑后梢薪,添加具體flutter_frontend_server對應的路徑
return globals.fs.directory(globals.fs.path.join(
(await getPackagePathFromConfig(packagesPath, 'aspectd')).absolute.path,
'lib',
'src',
'flutter_frontend_server'));
}
static Future<Directory> getPackagePathFromConfig(String packageConfigPath, String packageName) async {
// 取出.package中的信息
final PackageConfig packageConfig = await loadPackageConfigWithLogging(globals.fs.file(packageConfigPath),logger: globals.logger,);
if ((packageConfig?.packages?.length ?? 0) > 0) {
final Package aspectdPackage = packageConfig.packages.toList().firstWhere(
// 找到我們要找的信息
(Package element) => element.name == packageName,
orElse: () => null);
// 返回找到的路徑
return globals.fs.directory(aspectdPackage.root.toFilePath());
}
return null;
}
生成frontend_server.dart.snapshot
const String frontendServerDartSnapshot = 'frontend_server.dart.snapshot';
static Future<bool> checkAspectdFlutterFrontendServerSnapshot(
String packagesPath) async {
// 獲取到frontend_server.dart.snapshot對應上級目錄,及文件對應路徑
final Directory flutterFrontendServerDirectory = await getFlutterFrontendServerDirectory(packagesPath);
final String aspectdFlutterFrontendServerSnapshot = globals.fs.path.join(flutterFrontendServerDirectory.absolute.path,frontendServerDartSnapshot);
// 獲取到系統(tǒng)的frontend_server.dart.snapshot對應的路徑
final String defaultFlutterFrontendServerSnapshot = globals.artifacts.getArtifactPath(Artifact.frontendServerSnapshotForEngineDartSdk);
// 如果frontend_server.dart.snapshot不存在尝哆,那么進行創(chuàng)建
if (!globals.fs.file(aspectdFlutterFrontendServerSnapshot).existsSync()) {
// 在getDartSdkDependency中執(zhí)行pub get以便獲取到aspectd對應項目中的.package,從而能得到dartSdkDir秉撇,詳情見下方
final String dartSdkDir = await getDartSdkDependency((await getPackagePathFromConfig(packagesPath, 'aspectd')).absolute.path);
// 獲取到flutter_frontend_server文件夾下的package_config.json
final String frontendServerPackageConfigJsonFile = '${flutterFrontendServerDirectory.absolute.path}/package_config.json';
// 獲取到flutter_frontend_server文件夾下的rebased_package_config.json,一開始是不存在的,下面會往里面放東西
final String rebasedFrontendServerPackageConfigJsonFile = '${flutterFrontendServerDirectory.absolute.path}/rebased_package_config.json';
// 讀取package_config.json中數(shù)據(jù)
String frontendServerPackageConfigJson = globals.fs.file(frontendServerPackageConfigJsonFile).readAsStringSync();
// 把上面讀取到的數(shù)據(jù)中的../../../third_party/dart/替換為真是的dartSdkDir目錄,即上面得到的kernel目錄
frontendServerPackageConfigJson = frontendServerPackageConfigJson.replaceAll('../../../third_party/dart/', dartSdkDir);
// 將上面替換后的數(shù)據(jù)寫到rebased_package_config.json文件中
globals.fs.file(rebasedFrontendServerPackageConfigJsonFile).writeAsStringSync(frontendServerPackageConfigJson);
// 準備生成frontend_server.dart.sanpshot文件對應的命令
final List<String> commands = <String>[
globals.artifacts.getArtifactPath(Artifact.engineDartBinary),
'--deterministic',
'--packages=$rebasedFrontendServerPackageConfigJsonFile',
'--snapshot=$aspectdFlutterFrontendServerSnapshot',
'--snapshot-kind=kernel',
'${flutterFrontendServerDirectory.absolute.path}/starter.dart'
];
// 執(zhí)行命令生成frontend_server.dart.snapshot
final ProcessResult processResult =await globals.processManager.run(commands);
// 刪除上面拷貝的那一份rebased_package_config.json文件(已經(jīng)生成frontend_server.dart.server琐馆,所以不需要了)
globals.fs.file(rebasedFrontendServerPackageConfigJsonFile).deleteSync();
//異常判斷
if (processResult.exitCode != 0 || globals.fs.file(aspectdFlutterFrontendServerSnapshot).existsSync() ==false) {
throwToolExit('Aspectd unexpected error: ${processResult.stderr.toString()}');
}
}
// 查看系統(tǒng)中的frontend_server.dart.snapshot是否存在规阀,存在的話刪除掉
if (globals.fs.file(defaultFlutterFrontendServerSnapshot).existsSync()) {
globals.fs.file(defaultFlutterFrontendServerSnapshot).deleteSync();
}
// 把剛才生成的文件拷貝到系統(tǒng)
globals.fs.file(aspectdFlutterFrontendServerSnapshot).copySync(defaultFlutterFrontendServerSnapshot);
return true;
}
static Future<String> getDartSdkDependency(String aspectdDir) async {
// 在aspectdDir下(即aspectd所在項目)執(zhí)行pub get從而生成.package文件
final ProcessResult processResult = await globals.processManager.run(
<String>[
globals.fs.path.join(
globals.artifacts.getArtifactPath(Artifact.engineDartSdkPath),
'bin',
'pub'),
'get',
'--verbosity=warning'
],
workingDirectory: aspectdDir,
environment: <String, String>{'FLUTTER_ROOT': Cache.flutterRoot});
// 異常卡控
if (processResult.exitCode != 0) {
throwToolExit(
'Aspectd unexpected error: ${processResult.stderr.toString()}');
}
// 根據(jù).package文件找到kernel對應的具體目錄瘦麸,也就是dart sdk的目錄
final Directory kernelDir = await getPackagePathFromConfig(
globals.fs.path.join(aspectdDir, '.packages'), 'kernel');
return kernelDir.parent.parent.uri.toString();
}
綜合谁撼,在調(diào)用isAspectdEnabled方法的時候,做了2件事情:1.判斷是否存在aspectd_impl和aspectd項目滋饲,不存在就不走aspectd這一套厉碟,防止其他項目有問題,2.生成frontend_server.dart.snapshot文件屠缭,并替換掉系統(tǒng)中的該文件箍鼓。
frontend_server.dart.snapshot的作用:把我們的dart代碼編譯成app.dill
AspectdHook().runBuildDillCommand(environment)
上面只是做了一些準備工作,之后就是真正的將dart代碼編譯成dill
Future<void> runBuildDillCommand(Environment environment) async {
// 把系統(tǒng)的當前指向目錄切換到aspectd_impl目錄下方
final Directory aspectdDir = getAspectdImplDirectory(globals.fs.currentDirectory);
final Directory previousDirectory = globals.fs.currentDirectory;
globals.fs.currentDirectory = aspectdDir;
// 指定產(chǎn)物所在的目錄呵曹,及編譯工作所在的目錄
String relativeDir = environment.outputDir.absolute.path.substring(environment.projectDir.absolute.path.length + 1);
final String outputDir = globals.fs.path.join(aspectdDir.path, relativeDir);
final String buildDir =globals.fs.path.join(aspectdDir.path, '.dart_tool', 'flutter_build');
// 指定要編譯的dart文件款咖,這里是aspectd_impl.dart,改文件起到了承上啟下的作用,能把要插入的代碼和我們寫的代碼串到一起奄喂,見下方
final Map<String, String> defines = environment.defines;
defines[kTargetFile] = globals.fs.path.join(aspectdDir.path, 'lib', aspectdImplPackageName + '.dart');
// 準備編譯環(huán)境
final Environment auxEnvironment = Environment(
projectDir: aspectdDir,
outputDir: globals.fs.directory(outputDir),
cacheDir: environment.cacheDir,
flutterRootDir: environment.flutterRootDir,
fileSystem: environment.fileSystem,
logger: environment.logger,
artifacts: environment.artifacts,
processManager: environment.processManager,
engineVersion: environment.engineVersion,
buildDir: globals.fs.directory(buildDir),
defines: defines,
inputs: environment.inputs);
const KernelSnapshot auxKernelSnapshot = KernelSnapshot();
// 進行編譯铐殃,獲得產(chǎn)物
final CompilerOutput compilerOutput = await auxKernelSnapshot.buildImpl(auxEnvironment);
// 把生成的產(chǎn)物拷貝到我們寫的項目的.dart_tool/flutter_build/對應目錄下(因為上方生成的app.dill產(chǎn)物是在aspectd_impl項目中)
final String aspectdDill = compilerOutput.outputFilename;
final File originalDillFile = globals.fs.file(globals.fs.path.join(environment.buildDir.absolute.path, 'app.dill'));
// 這里是把我們寫的項目中存在的app.dill進行了備份
if (originalDillFile.existsSync()) {
originalDillFile.renameSync(originalDillFile.absolute.path + '.bak');
}
// 具體的拷貝app.dill方法
globals.fs.file(aspectdDill).copySync(originalDillFile.absolute.path);
globals.fs.currentDirectory = previousDirectory;
}
import 'package:sensors_demo/main.dart' as app;
// 下面就是導入的要插入的代碼,它里面的注解能夠使它雖沒被引用砍聊,依然能參與編譯
import 'sensorsdata_aop_impl.dart';
import 'sa_autotrack.dart';
// 這里調(diào)用的是我們寫的代碼中的main方法背稼,所以生成的app.dill中包含aspect_impl及我們寫的代碼
void main()=> app.main();
總結
aspectd中都做了哪些事情:
- 判斷當前執(zhí)行項目的上一級中是否有aspect_impl項目,有的話就走aspectd邏輯玻蝌。
- 生成frontend_server.dart.snapshot文件,并替換flutter sdk中對應的該文件词疼。aspectd源碼中的flutter_frontend_server文件下的就是對應做這個事情的俯树。(frontend_server.dart.snapshot是用來把dart代碼編譯成dill)
- 把我們寫的代碼及要插入的代碼一起編譯成app.dill。我們寫的代碼是通過aspect_impl項目中的main方法調(diào)用了我們項目中的main方法贰盗。而插入的代碼是通過注解實現(xiàn)的许饿,在frontend_server.dart.snapshot將dart編譯成app.dill過程中,會把注解轉換為具體代碼插入到抽象語法樹(AST)中舵盈。涉及到的就是aspectd源碼中的transformer中的文件陋率。這也是為什么要用自己生成的frontend_server.dart.snapshot文件替換系統(tǒng)的該文件,因為aspectd生成的frontend_server.dart.snapshot中能夠把注解轉換為具體代碼插入到AST中秽晚,從而最后生成的app.dill中是包含所有的代碼瓦糟。
為了好理解,寫的有些啰嗦赴蝇,悟性好的直接看阿里提供的圖:
image