关于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 resolver) {
if (resolver == nullptr || !resolver->IsValid()) {
return;
}
resolvers_.push_back(std::move(resolver));
}
//检索资源
std::unique_ptr 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 GetAsMapping(
const std::string& asset_name) const = 0;
private:
FML_DISALLOW_COPY_AND_ASSIGN(AssetResolver);
};
} // namespace flutter
其中最为核心的就是GetAsMapping方法，此方法返回了一个文件的Mapping，Mapping也是个接口类，其定义也极为简单，源码是在
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++层的跨平台通用方式，其过程及原理也是非常的简单，通过前面的分析，我们只要实现一个自己的AssetResolver跟Mapping，然后把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(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 ExternalAssetProvider::GetAsMapping(
const std::string& asset_name) const {
std::set::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(*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(bulk_resource));
-
利用flutter提供的原生支持方案
这种方式是作者昨晚在写此文章时才发现的，所以暂时还没有经过验证，不过从理论上来讲也是可行的，并且就目前来看应该是最简单，最有效的一种方案。
在RunConfiguration里面我们能找到如下代码（源码路径flutter/shell/common/run_configuration.h）
RunConfiguration RunConfiguration::InferFromSettings(
const Settings& settings,
fml::RefPtr io_worker) {
// 下面无关重要的代码已经被我删除了。。。
if (fml::UniqueFD::traits_type::IsValid(settings.assets_dir)) {
asset_manager->PushBack(std::make_unique(
fml::Duplicate(settings.assets_dir)));
}
asset_manager->PushBack(
std::make_unique(fml::OpenDirectory(
settings.assets_path.c_str(), false, fml::FilePermission::kRead)));
}
实际上fuchsia跟darwin也是用这个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下面，这里就不再分析了，有兴趣的可以直接去看下。