Skip to content

Add proguard docs #825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ktoso merged 2 commits into from
Jul 10, 2026
Merged

Add proguard docs #825

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fca17e
add docs to proguard
madsodgaard Jul 10, 2026
46424b1
typos
madsodgaard Jul 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion Sources/SwiftJavaDocumentation/Documentation.docc/Android.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
# Android
# Android

## R8/Proguard Rules

Since swift-java uses JNI and reflection APIs, we must tell the R8 optimizer to ignore our wrapped types,
otherwise we will run into runtime crashes, because types are stripped from the APK/AAR.

The `SwiftKit` Java library already contains a [Proguard consumer file](https://developer.anbdroid.com/topic/performance/app-optimization/library-optimization),
which is automatically detected by R8, so any `org.swift.swiftkit` types are already ignored.
However, you must still provide rules for your own types.

For example, if your library is named is `org.swift.exampleapp`, then add the following rules to your proguard file:

```
-keep class org.swift.exampleapp.** { *; }
-keep interface org.swift.exampleapp.** { *; }
```

## Android Core Library Desugaring

Expand Down
Loading