Flutter aspectd (二)源碼解析

引導

在上一篇文章中凉当,我們進行了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中都做了哪些事情:

  1. 判斷當前執(zhí)行項目的上一級中是否有aspect_impl項目,有的話就走aspectd邏輯玻蝌。
  2. 生成frontend_server.dart.snapshot文件,并替換flutter sdk中對應的該文件词疼。aspectd源碼中的flutter_frontend_server文件下的就是對應做這個事情的俯树。(frontend_server.dart.snapshot是用來把dart代碼編譯成dill)
  3. 把我們寫的代碼及要插入的代碼一起編譯成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
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末菩浙,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌劲蜻,老刑警劉巖陆淀,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異先嬉,居然都是意外死亡轧苫,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進店門疫蔓,熙熙樓的掌柜王于貴愁眉苦臉地迎上來含懊,“玉大人,你說我怎么就攤上這事鳄袍【钜” “怎么了?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵拗小,是天一觀的道長重罪。 經(jīng)常有香客問我,道長哀九,這世上最難降的妖魔是什么剿配? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮阅束,結果婚禮上呼胚,老公的妹妹穿的比我還像新娘。我一直安慰自己息裸,他們只是感情好蝇更,可當我...
    茶點故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著呼盆,像睡著了一般年扩。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上访圃,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天厨幻,我揣著相機與錄音,去河邊找鬼腿时。 笑死况脆,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的批糟。 我是一名探鬼主播格了,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼跃赚!你這毒婦竟也來了笆搓?” 一聲冷哼從身側響起性湿,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎满败,沒想到半個月后肤频,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡算墨,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年宵荒,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片净嘀。...
    茶點故事閱讀 40,040評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡报咳,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出挖藏,到底是詐尸還是另有隱情暑刃,我是刑警寧澤,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布膜眠,位于F島的核電站岩臣,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏宵膨。R本人自食惡果不足惜架谎,卻給世界環(huán)境...
    茶點故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望辟躏。 院中可真熱鬧谷扣,春花似錦、人聲如沸捎琐。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽瑞凑。三九已至在塔,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間拨黔,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工绰沥, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留篱蝇,地道東北人。 一個月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓徽曲,卻偏偏與公主長得像零截,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子秃臣,可洞房花燭夜當晚...
    茶點故事閱讀 44,979評論 2 355

推薦閱讀更多精彩內(nèi)容

  • 初入Flutter的開發(fā)者涧衙,首先需要了解的便是如何編譯運行flutter應用哪工。與通常Android工程項目的編譯不...
    千山0xA2DB01D閱讀 40,060評論 15 95
  • Dart VM 介紹 譯 前言 Dart VM 是一個執(zhí)行 Dart 語言的組件集合,包括但不限于以下組件: 運...
    妖怪來了閱讀 6,467評論 5 6
  • 我是黑夜里大雨紛飛的人啊 1 “又到一年六月弧哎,有人笑有人哭雁比,有人歡樂有人憂愁,有人驚喜有人失落撤嫩,有的覺得收獲滿滿有...
    陌忘宇閱讀 8,536評論 28 53
  • 信任包括信任自己和信任他人 很多時候偎捎,很多事情,失敗序攘、遺憾茴她、錯過,源于不自信程奠,不信任他人 覺得自己做不成丈牢,別人做不...
    吳氵晃閱讀 6,190評論 4 8
  • 步驟:發(fā)微博01-導航欄內(nèi)容 -> 發(fā)微博02-自定義TextView -> 發(fā)微博03-完善TextView和...
    dibadalu閱讀 3,138評論 1 3