fankes/moshi
2
0
Fork 0
mirror of https://github.com/fankes/moshi.git synced 2025-10-18 23:49:21 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Embed ProGuard rules in the jar

Browse Source
This commit is contained in:
Gabriel Ittner
2018-08-19 10:32:00 +02:00
parent 83f60d6bd7
commit 4bbc5b2ff8
3 changed files with 26 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -578,34 +578,14 @@ implementation 'com.squareup.moshi:moshi:1.6.0'
Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].
ProGuard
R8 / ProGuard
--------
If you are using ProGuard you might need to add the following options:
```
-dontwarn okio.**
-dontwarn javax.annotation.**
-keepclasseswithmembers class * {
@com.squareup.moshi.* <methods>;
}
-keep @com.squareup.moshi.JsonQualifier interface *
```
Additional rules are needed if you are using Kotlin:
If you are using R8 or ProGuard add the options from [this file](https://github.com/square/moshi/blob/master/moshi/src/main/resources/META-INF/proguard/moshi.pro).
*...If you are using the reflect API (i.e. `KotlinJsonAdapterFactory`):*
```
-keepclassmembers class kotlin.Metadata {
public <methods>;
}
```
*...If you are using the codegen API (i.e. `JsonClass(generateAdapter = true)`):*
```
-keep class **JsonAdapter {
<init>(...);
<fields>;
}
-keepnames @com.squareup.moshi.JsonClass class *
```
The `moshi-kotlin` artifact additionally requires the options from [this file](https://github.com/square/moshi/blob/master/kotlin/reflect/src/main/resources/META-INF/proguard/moshi-kotlin.pro)
You might also need rules for Okio which is a dependency of this library.
License
--------

3
kotlin/reflect/src/main/resources/META-INF/proguard/moshi-kotlin.pro Normal file
View File

@@ -0,0 +1,3 @@
-keepclassmembers class kotlin.Metadata {
public <methods>;
}

18
moshi/src/main/resources/META-INF/proguard/moshi.pro Normal file
View File

@@ -0,0 +1,18 @@
# JSR 305 annotations are for embedding nullability information.
-dontwarn javax.annotation.**
-keepclasseswithmembers class * {
@com.squareup.moshi.* <methods>;
}
-keep @com.squareup.moshi.JsonQualifier interface *
# The name of @JsonClass types is used to look up the generated adapter
-keepnames @com.squareup.moshi.JsonClass class *
# Retain generated JsonAdapters if annotated type is retained
-if @com.squareup.moshi.JsonClass class *
-keep class <1>JsonAdapter {
<init>(...);
<fields>;
}