flutter动态化研究之资源热修复

关于flutter资源

相比起Android系统的资源管理,flutter对资源的管理实在是简单得太多了,flutter的资源没有经过编译的任何处理,完全是以源文件的形式暴露出来,获取资源就是以文件的读取方式来进行,返回给到flutter的是资源在内存中的buffer内容,资源是以目录名+文件名来标识,如下:

关于flutter AssetManager

flutter engine内部也有一个AssetManager,源码路径是flutter/assets/asset_manager.h
AssetManager的代码不多,只是内部维护了AssetResolver的一个队列,核心的方法有两个

//往队列里面添加一个AssetResolver
void AssetManager::PushBack(std::unique_ptr<AssetResolver> resolver) {
  if (resolver == nullptr || !resolver->IsValid()) {
    return;
  }

  resolvers_.push_back(std::move(resolver));
}

//检索资源
std::unique_ptr<fml::Mapping> AssetManager::GetAsMapping(
    const std::string& asset_name) const {
  if (asset_name.size() == 0) {
    return nullptr;
  }
  TRACE_EVENT1("flutter", "AssetManager::GetAsMapping", "name",
               asset_name.c_str());
  for (const auto& resolver : resolvers_) {
    auto mapping = resolver->GetAsMapping(asset_name);
    if (mapping != nullptr) {
      return mapping;
    }
  }
  FML_DLOG(WARNING) << "Could not find asset: " << asset_name;
  return nullptr;
}

从代码里面可以看得出来,其实真正的资源是由AssetResolver提供的。

关于flutter AssetResolver

AssetResolver是个接口类,flutter资源提供者必须要实现这个接口源码是在flutter/assets/asset_resolver.h 下面,定义大致如下

namespace flutter {

class AssetResolver {
 public:
  // 无关重要的被我省略了。。。
  virtual std::unique_ptr<fml::Mapping> GetAsMapping(
      const std::string& asset_name) const = 0;

 private:
  FML_DISALLOW_COPY_AND_ASSIGN(AssetResolver);
};

}  // namespace flutter

其中最为核心的就是GetAsMapping方法,此方法返回了一个文件的MappingMapping也是个接口类,其定义也极为简单,源码是在
flutter/fml/mapping.h下面,这里直接给出

class Mapping {
 public:
  // 无关重要的被我省略了。。。
  virtual size_t GetSize() const = 0;
  virtual const uint8_t* GetMapping() const = 0;
};

其中GetSize 返回了文件的大小,GetMapping返回的是资源在内存中的地址,整个资源的管理结构大致如下图所示:

关于flutter APKAssetProvider

APKAssetProvider实现了AssetResolver接口,为flutter提供了Android平台下的资源获取能力,其本质就是把Java层的AssetManager通过AAssetManager_fromJava接口转换到C++层,然后再通过AAssetManager_open AAsset_getBuffer AAsset_close等NDK接口来读取Asset资源,
源码路径在flutter/shell/platform/android/apk_asset_provider.h 下面,代码也不多,这里直接给出调用流程

关于flutter资源动态部署的几种方案

  • Android平台

通过前面的代码分析,我们可以清楚的看见,在Android平台下面,flutter的资源其实也是由AssetManager提供的,所以我们可以借鉴热修复的原理(其实比热修复还简单得多,因为这里我们不需要做全量合成,只要做一次半全量合成就可以了,也不需要去replace系统的AssetManager只管调addAssetPath就可以了),bulk 1.0目前采用了此方案已经验证通过了,关键代码如下

    @SuppressLint("DiscouragedPrivateApi")
    private fun addResToAssetManager(str: String) {
        val assetManager = cxt.assets
        try {
            val addAssetPathMethod =
                AssetManager::class.java.getDeclaredMethod("addAssetPath", String::class.java)
            addAssetPathMethod.invoke(assetManager, str)
        } catch (e: Exception) {
            Log.d(TAG, "Exception occur in addBulkResToAssetManager err = " + e.message)
        }
    }

当然,用这种方案的话必须要解决Android 9对私有API的限制问题。

  • 跨平台通用方式

上面的方案弊端是很明显的,第一只能满足Android平台,第二需要解决系统对私有API的约束问题等,其实在做第一种方案前,作者我就已经先实现了基于c++层的跨平台通用方式,其过程及原理也是非常的简单,通过前面的分析,我们只要实现一个自己的AssetResolverMapping,然后把AssetResolver塞到flutter的AssetManager队列里面就可以了,下面也直接给出关键代码

//Mapping部分的实现,部分无关重要的代码已经被我注释掉了
//需要的话可以联系作者我
class ExternalAssetMapping : public fml::Mapping {
 public:
  ExternalAssetMapping(std::string file) 
        : m_strFile(file), m_pBuffer(NULL) {
    readFileToBuffer();
  }
  ~ExternalAssetMapping() override {
       if (m_pBuffer) {
           free(m_pBuffer);
       }
    }
  size_t GetSize() const override {
        int size = 0;
        FILE* fp = fopen(m_strFile.c_str(), "r");
        if (fp) {
            fseek(fp, 0, SEEK_END);
            size = ftell(fp);
            fclose(fp);
        }
        return size;
    }

  const uint8_t* GetMapping() const override {
        return reinterpret_cast<const uint8_t*>(m_pBuffer);
  }

  void readFileToBuffer() {
      if (!m_pBuffer) {
            int size = GetSize();
            FML_LOG(INFO) << "readFileToBuffer size : " << size;
            FILE* fp = fopen(m_strFile.c_str(), "r");
            if (size >0 && fp) {
                m_pBuffer = (char *)malloc(size);
                fread(m_pBuffer, size, 1, fp);
                fclose(fp);
            }
        }
  }
};

////AssetResolver部分的实现,部分无关重要的代码已经被我注释掉了
// |flutter::AssetResolver|
bool ExternalAssetProvider::IsValid() const {
    return true;
}

// |flutter::AssetResolver|
std::unique_ptr<fml::Mapping> ExternalAssetProvider::GetAsMapping(
    const std::string& asset_name) const {
    std::set<std::string>::iterator it = m_setFiles.find(asset_name);
    if (it != m_setFiles.end()) {
        FML_LOG(INFO) << "Get file from external provider file name : " << asset_name;
        return std::make_unique<ExternalAssetMapping>(*it);
    }
    return nullptr;
}

void ExternalAssetProvider::lookupFilesFromDirectory() {
    FML_LOG(INFO) << "lookupFilesFromDirectory directory: " << m_strDirectory.c_str();
    DIR* dir = opendir(m_strDirectory.c_str());
    if (dir == NULL) {
        FML_LOG(INFO) << "lookupFilesFromDirectory fail when open directory error : " << strerror(errno);
        return;
    }
    dirent* p = NULL;
    //struct stat statbuf = {0};
    while ((p = readdir(dir)) != NULL) {
        if (p->d_name[0] != '.') {
            //lstat(p->d_name, &statbuf); 
            FML_LOG(INFO) << "Find file name: " << p->d_name << ", st_mode: " << p->d_type;
            if (p->d_type != DT_DIR) {
                m_setFiles.insert(p->d_name);
            }
        }
    }
    closedir(dir);
}

//最后我们把自定义的AssetResolver塞进flutter的AssetManager里面即可
std::string bulk_resource = FlutterMain::Get().GetSettings().bulk_work_space + "res";
asset_manager->PushBack(std::make_unique<flutter::ExternalAssetProvider>(bulk_resource));
  • 利用flutter提供的原生支持方案

这种方式是作者昨晚在写此文章时才发现的,所以暂时还没有经过验证,不过从理论上来讲也是可行的,并且就目前来看应该是最简单,最有效的一种方案。

RunConfiguration里面我们能找到如下代码(源码路径flutter/shell/common/run_configuration.h

RunConfiguration RunConfiguration::InferFromSettings(
    const Settings& settings,
    fml::RefPtr<fml::TaskRunner> io_worker) {
  // 下面无关重要的代码已经被我删除了。。。
  if (fml::UniqueFD::traits_type::IsValid(settings.assets_dir)) {
    asset_manager->PushBack(std::make_unique<DirectoryAssetBundle>(
        fml::Duplicate(settings.assets_dir)));
  }
  asset_manager->PushBack(
      std::make_unique<DirectoryAssetBundle>(fml::OpenDirectory(
          settings.assets_path.c_str(), false, fml::FilePermission::kRead)));
}

实际上fuchsiadarwin也是用这个InferFromSettings来初始化资源管理器的(flutter跨平台,在engine工程里面随处都能看见类似于fuchsia android ios windows linux darwin等等目录结构),代码在:
/shell/platform/darwin/ios/framework/Source/FlutterDartProject.mm (darwin平台)
shell/platform/fuchsia/flutter/engine.cc(fuchsia平台)。
但是我们不能直接调这个函数,因为它会重新创建一个新的AssetManager,但是DirectoryAssetBundle却是公共的可以使用的DirectoryAssetBundle本质上也是AssetResolver的一个实现类,因此我们可以手动构造一个DirectoryAssetBundle出来专门为我们的热修复资源服务用,它的源码路径是在flutter/assets/directory_asset_bundle.h下面,这里就不再分析了,有兴趣的可以直接去看下。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容