How to include Android binding dependencies and avoid ClassNotFoundExceptions
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- android, csharp
- 领域
- documentation, mobile
调研方向
先从 Facebook 示例的 build.gradle.kts 和 Sample.csproj 开始,然后阅读链接的 Java Dependency Verification 和 Resolving Java Dependencies 文档。构建该示例以观察 XA4241 和 XA4242 依赖项输出。完成的标准是记录如何声明 Maven artifact、评估报告的依赖项,以及在不出现 ClassNotFoundExceptions 的情况下验证部署。
由索引模型根据 Issue 内容生成。
描述
Handling transitive dependencies is common challenge with .NET for Android and Android Native Library Interop binding projects when attempting to bind a Maven artifact. This story is further complicated by the fact that .NET for Android binds and redistributes AndroidX and other support libraries via NuGet packages, and MAUI projects depend on a handful of these libraries.
Starting in .NET 9 there are a few build items that can be used to help validate your Java dependency tree which are outlined in the Java Dependency Verification and Resolving Java Dependencies docs.
We can look at the Facebook sample in this repo for an example on how to use these items with Native Library Interop. Here's a quick overview of how the various pieces fit together.
- In your
build.gradle.ktsfile, declare the Maven artifact(s) you are interested in binding: https://github.com/CommunityToolkit/Maui.NativeLibraryInterop/blob/e91dadd35f0c4ceb333034c3fd7b3c6ceebf4c94/facebook/android/native/mauifacebook/build.gradle.kts#L31 - In your application project, add the same Maven artifact(s) as an
@(AndroidMavenLibrary)item. Set the%(Bind)metadata to false; we do not want to bind this artifact again. We are only including this reference to opt-in to the Java dependency verification system mentioned above to figure out which artifact dependencies we will need to bring into the app:
<AndroidMavenLibrary Include="com.facebook.android:facebook-android-sdk" Version="17.0.2" Bind="false" />
- Build your application project, and you should see a list of unfulfilled dependencies:
error XA4241: Java dependency 'com.facebook.android:facebook-core:17.0.2' is not satisfied.
error XA4241: Java dependency 'com.facebook.android:facebook-common:17.0.2' is not satisfied.
error XA4241: Java dependency 'com.facebook.android:facebook-login:17.0.2' is not satisfied.
error XA4241: Java dependency 'com.facebook.android:facebook-share:17.0.2' is not satisfied.
error XA4241: Java dependency 'com.facebook.android:facebook-applinks:17.0.2' is not satisfied.
error XA4241: Java dependency 'com.facebook.android:facebook-messenger:17.0.2' is not satisfied.
error XA4241: Java dependency 'com.facebook.android:facebook-gamingservices:17.0.2' is not satisfied.
error XA4242: Java dependency 'org.jetbrains.kotlin:kotlin-stdlib:1.5.10' is not satisfied. Microsoft maintains the NuGet package 'Xamarin.Kotlin.StdLib' that could fulfill this dependency.
- It's recommended that you include all of the dependencies listed in this output in your application project. However, given the scope of what you are trying to bind, you can try to reason about which of these dependencies you could safely exclude. In the case of the Facebookj sample, I replaced the
facebook-android-sdkdependency with the first dependency listed above (facebook-core) and rebuilt:
https://github.com/CommunityToolkit/Maui.NativeLibraryInterop/blob/e91dadd35f0c4ceb333034c3fd7b3c6ceebf4c94/facebook/sample/Sample.csproj#L65
error XA4241: Java dependency 'com.facebook.android:facebook-bolts:17.0.2' is not satisfied.
error XA4242: Java dependency 'androidx.annotation:annotation:1.1.0' is not satisfied. Microsoft maintains the NuGet package 'Xamarin.AndroidX.Annotation' that could fulfill this dependency.
error XA4242: Java dependency 'androidx.legacy:legacy-support-core-utils:1.0.0' is not satisfied. Microsoft maintains the NuGet package 'Xamarin.AndroidX.Legacy.Support.Core.Utils' that could fulfill this dependency.
error XA4242: Java dependency 'com.android.installreferrer:installreferrer:1.0' is not satisfied. Microsoft maintains the NuGet package 'Xamarin.Google.Android.InstallReferrer' that could fulfill this dependency.
error XA4242: Java dependency 'androidx.core:core-ktx:1.3.2' is not satisfied. Microsoft maintains the NuGet package 'Xamarin.AndroidX.Core.Core.Ktx' that could fulfill this dependency.
error XA4242: Java dependency 'org.jetbrains.kotlin:kotlin-stdlib:1.5.10' is not satisfied. Microsoft maintains the NuGet package 'Xamarin.Kotlin.StdLib' that could fulfill this dependency.
- After adding the full set of dependencies you should be able to deploy and run the application on an emulator or device. If you are attempting to only include a subset you may encounter a crash at runtime and likely need to return to the list from step 3 and start adding back any dependencies that were excluded.
The live Facebook sample code demonstrates the end result of this iterative process, and contains a trimmed down list of dependencies that were initially presented. These were the only dependencies required to light up the small code path I was trying to bind. This solution is not perfect and can still lead to unexpected behavior due to the complexity and size of some Maven artifacts.
We should continue to build out better documentation around these challenges and potential solutions. We're also hoping to continue to make improvements to this area of the .NET for Android binding experience in the future.
Please feel free to also use this issue to provide feedback on how this process interacts with Native Library Interop.
- 主要语言
- C#
- 星标
- 249
- 派生
- 48
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
CommunityToolkit/Maui.NativeLibraryInterop 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 35/100
CommunityToolkit/Maui.NativeLibraryInterop#107 · 8 条评论 · 1 个 reaction ·
-
难度 5/5 一周以上 新手友好度 25/100
CommunityToolkit/Maui.NativeLibraryInterop#106 · 1 个 reaction ·
-
难度 4/5 3-5 天 新手友好度 35/100
CommunityToolkit/Maui.NativeLibraryInterop#105 · 2 条评论 ·
-
Facebook iOS Bindings are outdated可能已有人在做 @thisisthekap 于 460 天前认领。 未关闭
难度 4/5 3-5 天 新手友好度 35/100
-
难度 3/5 3-5 天 新手友好度 30/100
CommunityToolkit/Maui.NativeLibraryInterop#101 · 3 条评论 · 4 个 reaction ·
查看 CommunityToolkit/Maui.NativeLibraryInterop 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复
-
area:re1 bounty help wanted needs-game
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 68/100
StackExchange/StackExchange.Redis#3274 ·
维护者通常 1 天内回复
-
affected/v17 affected/v18 area/frontend type/bug
难度 2/5 1-3 小时 新手友好度 82/100
umbraco/Umbraco-CMS#24186 ·
维护者通常 2 天内回复