如何在 Android Studio 上准备闭源 SDK 模块？

Question

背景

我正在开发一个非常受欢迎的应用程序，以至于它的一部分应该成为 SDK（可供开发人员使用），并且该应用程序将拆分为 2 个应用程序（两者都使用SDK）。

据我所知，有多种方法可以创建 SDK 模块（以前在 Eclipse 上称为“项目”）：

1. 完全开源（Android 库） - 所有源和资源都是开源的，可以修改。一个例子可能是 Facebook 的 SDK 和大量的 Github 存储库。

2. 单个 Jar 文件，可以关闭源代码。

问题

遗憾的是，我无法将 SDK 开源，并且它应该相对受到保护而不是窥探（混淆等...）。

这里的问题是，SDK 需要使用自己的一些资源（drawables、strings、...），到目前为止（因为我没有很多创建 SDK 的经验）我发现处理 SDK 资源的 2 种方法：

1. 使用反射和/或“context.getResources().getIdentifier”。这很混乱，因为我失去了代码的整个“R”用法。此外，正如我在here 中所写的那样，它存在“styleable”问题。这也使得找到未使用的资源变得困难。

2. 更糟糕的方法：将资源放入 assets 文件夹，将文件以古怪的方式放入 jar 文件中，...

请注意，SDK 的一部分包含自定义视图（例如，从 TextView 扩展的类），因此即使我将 SDK 拆分为 2 个模块 - 资源和 java 文件，两者都可能存在依赖问题（每个都使用另一个）。

问题

有没有办法解决这个问题？

SDK 的代码部分是否可以保持封闭源代码，像往常一样访问“R”文件，让我和任何使用 SDK 的人都能轻松使用？

然后我将如何生成通过 Android Studio 混淆的 jar 文件？是否可以准备好以后通过 gradle 使用它？

我可以将 SDK 的 Android 库制作成一个模糊的 jar 文件，而不用担心“R”文件吗？我问这个是因为这样我可以享受两个世界：对于我们的应用程序，它将保持开源，而对于第三方应用程序，它将是封闭源代码。

---

编辑：看到这应该很容易，我自己尝试过。我创建了一个全新的 POC 项目，其中包含一个名为“sdkmodule”的 Android 库模块，并将此类添加到其中：

public class SdkClass
      {
      public String doIt(Context context)
        {
        return context.getResources().getString(R.string.app_name);
        }
      }

然后，我让应用程序的模块使用这个，我在里面写了这段代码：

  @Override
  protected void onCreate(Bundle savedInstanceState)
    {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    SdkClass sdkClass=new SdkClass();
    Log.d("AppLog","string from SDK:"+sdkClass.doIt(this));
    Log.d("AppLog","string with same ID name from app:"+getResources().getString(R.string.app_name));
    }

我的预期是第一个日志会打印 SDK 模块中的字符串，第二个日志会显示当前项目的字符串，但我得到了一个异常：

java.lang.NoClassDefFoundError: Failed resolution of: Lcom/example/user/sdkmodule/R$string;

在另一次尝试中，我得到了与应用程序本身（使用 SDK 模块的那个）相同的字符串。而且，在另一次运行中，SDK 生成了我想要的所需字符串。

怎么可能？我该怎么办？

此外，我尝试在 SDK 本身中创建第二个活动，并在那里创建了一个资源，该资源与应用程序本身具有相同的资源名称（用于其布局中的 textView），但是具有不同的值，但是当我到达此活动时，我已经看到了应用程序使用的那个。

这是项目，已压缩（忽略文件夹的名称，我也想尝试风味）：

https://drive.google.com/file/d/0B-PZZGk2vPohX25WUDNKTmotUTg/view?usp=sharing

Answer 1

您的问题的答案是将您的库打包并分发为AAR bundle

此格式允许您提供经过混淆的 SDK jar 及其资源和 R 映射文件。

这个格式是一个标准并且被maven-android-plugin完全支持（实际上它是旧的APKLib格式的替换，它只支持源文件的分发）。

当然 Gradle 和 Android Studio 也支持它。

Answer 2

Android Archive (AAR) format 可以满足您的需求。它就像一个特定于 Android 的 JAR 文件，包含已编译的代码，但包含自己的资源和清单。您还可以将混淆作为构建过程的一部分。默认情况下，当前版本的 Android Studio (1.2) 和 Gradle 会自动为您在项目中创建的所有库模块构建 .AAR 文件。

您可以将应用模块更改为将发布 AAR 文件的库项目，只需在模块的 Gradle 文件中将 apply plugin: 'com.android.application' 更改为 apply plugin: 'com.android.library'。 .AAR 文件将在每次构建后放置在您的MODULENAME/build/outputs/aar 文件夹中。一些more information is available here。

编辑 1，问题更新后：

当最终的 APK 编译完成时，您的 AAR 中的资源会与应用模块合并。应用程序资源将覆盖库的。这可能是设计使然，允许使用 3rd 方库的人在创建他们的应用程序时自定义其资源，而无需重新构建库。我认为解决资源冲突问题的最简单方法就是将 sdkmodule 资源命名为更独特的名称。为什么不将字符串键设为R.string.com_example_sdk_name 之类的？

不，AAR 库默认不会被混淆，但您可以set up ProGuard in the Gradle build file 让您的 AAR 库处理此问题。也可以使用其他工具。