Flutter 插件开发遇到的问题及解决方案

柔光的暖阳◎ 2024-05-02 20:23 127阅读 0赞

本文主要对笔者flutter插件开发过程中如下问题做了解决。

##### 一、Flutter插件android模块中的代码报红问题解决 #####

##### 二、Flutter Plugin 开发中引入本地 aar 包报错的问题。 #####

##### 三、Flutter插件项目中获取到 Activity #####

### 一、Flutter插件android模块中的代码报红问题解决 ###

1、在开发Flutter插件时，打开插件的android项目，准备编写native端的代码时，发现各种报红，代码无法跳转，体验十分不好。就像我下面的截图一样：  
![flutter插件项目安卓目录下的代码爆红][flutter]  
2、这是因为android项目中没有依赖Flutter库。利用local.properties中的flutter.sdk路径来加载。（我们文件中一般自动加了flutter.sdk的路径，加上了的不用管，没加的加上就行）。  
![在这里插入图片描述][bba81ecd8bd64ca7bbfd8d00752d1911.jpeg_pic_center]  
3、有些人可能在项目工程中没有看到该文件，原因可能是将local.properties文件隐藏了。  
在 File => Settings => Editor => File Types =》Ignored Files and Folders 中移除就可以了。  
![将相关文件设置为不忽略][4e589c92bec544cd8891dc435d52cbb9.jpeg_pic_center]  
4、在插件工程的android目录下的build.gradle文件中添加如下代码  
![在这里插入图片描述][9283453020284cbc84e37d4865569d97.jpeg_pic_center]

//获取local.properties配置文件
        def localProperties = new Properties()
        def localPropertiesFile = rootProject.file('local.properties')
        if (localPropertiesFile.exists()) {
        
            localPropertiesFile.withReader('UTF-8') {
         reader ->
                localProperties.load(reader)
            }
        }
        //获取flutter的sdk路径
        def flutterRoot = localProperties.getProperty('flutter.sdk')
        if (flutterRoot == null) {
        
            throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
        }
    
        dependencies {
        
            compileOnly files("$flutterRoot/bin/cache/artifacts/engine/android-arm/flutter.jar")
        }

5、重新加载编译就不会爆红了。

### 二、Flutter Plugin 开发中引入本地 aar 包报错的问题。 ###

1、我是直接在插件的安卓工程（不是example项目中的安卓工程！！）中的根目录新建了libs目录，将aar复制到该目录中，随后在builld.gradle文件中通过如下方式引用。

implementation files('libs/speedata/scandecode-release.aar')

![在这里插入图片描述][1b83e5564d3f4af783f3f7a665610b00.jpeg]  
最后编译报错。报错内容如下：

> `Direct local .aar file dependencies are not supported when building an AAR. The resulting AAR would be broken because the classes and Android resources from any local .aar file dependencies would not be packaged in the resulting AAR. Previous versions of the Android Gradle Plugin produce broken AARs in this case too (despite not throwing this error). The following direct local .aar file dependencies of the :bytedcert project caused this error`

本人通过 stack overflow 上苦苦搜寻终于得以解决。  
解决方案如下 ：  
1、在插件项目的android目录下建立 `lbs`目录放置你要引入的arr包，我这里是多建了一层speedata。  
2、在build.gradle文件中的 `rootProject.allprojects`部分 的 repositories 代码块下加入如下代码

flatDir{
        
        dirs project(':插件名称').file('目录名称')
    }

如下图：  
![在这里插入图片描述][f80d85955c5e4ae780a28455ac7f0318.png]  
3、在`build.gradle`文件的 `dependencies` 代码块中加入如下内容

implementation (name: '不带后缀的aar名称', ext: 'aar')

如图  
![在这里插入图片描述][b8c9e9a5d86942519cc515abdc612d25.png]  
4、网上其他人说做到这里就够了，但是我重新加载项目会报如下错误。  
`Project with path <plugin_name> could not be found in root project <project_name>` <plugin\_name>和<plugin\_name>为你的插件项目名称。

5、遇到这种错误，在你的`settings.gradle`文件中加入如下内容，再编译就能通过了。

include '你的插件项目名称'

如图  
![在这里插入图片描述][673a00ca99c1406b8e5771635f2db2dc.png]  
原文可以看：[怎么在flutter插件项目中引入本地aar？How to use local aar inside flutter plugin?][flutter_aar_How to use local aar inside flutter plugin]

### 三、Flutter插件项目中获取到 Activity ###

笔者开发的插件需要获取到当前`activity`上下文对象，可以在你的插件入口类中实现`ActivityAware`接口，重写四个方法（onAttachedToActivity、onDetachedFromActivityForConfigChanges、onReattachedToActivityForConfigChanges、onDetachedFromActivity），可以在`onAttachedToActivity`方法中拿到activity。  
我的代码如图：  
![在这里插入图片描述][0d1d92d91c7b4274b8e04526a8722c58.png]  
千万注意，方法调用的顺序！！！！  
先是连接上 flutter 引擎 再是连接到 activity。  
方法调用顺序为：onAttachedToEngine ⇒ onAttachedToActivity。  
所以先在 onAttachedToEngine 设置方法调通道， 再去 onAttachedToActivity 利用 activity 对象做其它操作。

原文可以看：[在flutter 插件项目中获取 activity。Get activity reference in flutter plugin.][flutter _ activity_Get activity reference in flutter plugin.]

[flutter]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/02/6b3faebb99154347afbc1fe88fc99db0.png
[bba81ecd8bd64ca7bbfd8d00752d1911.jpeg_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/02/3690b7bca7a94562ad3dc962fb00b1b4.jpeg
[4e589c92bec544cd8891dc435d52cbb9.jpeg_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/02/daaea5fbc034489888db46cfbb8d7e09.jpeg
[9283453020284cbc84e37d4865569d97.jpeg_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/02/a4860f2d7b9d4858b05f368fa0b99a84.jpeg
[1b83e5564d3f4af783f3f7a665610b00.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/02/5afea54ae5b84ef2806e62bc6049c548.jpeg
[f80d85955c5e4ae780a28455ac7f0318.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/02/9c61bdd353ee48f18efdc55b5d0a3dd8.png
[b8c9e9a5d86942519cc515abdc612d25.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/02/adad5ab467c6480f9cd173888aeebc3e.png
[673a00ca99c1406b8e5771635f2db2dc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/02/c5b65d548ce14000bf777567d961d2db.png
[flutter_aar_How to use local aar inside flutter plugin]: https://stackoverflow.com/questions/50971022/how-to-use-local-aar-inside-flutter-plugin
[0d1d92d91c7b4274b8e04526a8722c58.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/02/265937e4156b4ff0ab2638e168a9f969.png
[flutter _ activity_Get activity reference in flutter plugin.]: https://stackoverflow.com/questions/59887901/get-activity-reference-in-flutter-plugin