Envie regras de manutenção mais inteligentes: como os provedores de biblioteca podem desbloquear a otimização de código DEX no nível do app
Leitura de 6 min
Como desenvolvedores de apps e bibliotecas Android, todos nós temos o mesmo objetivo: criar apps Android de alto desempenho que ofereçam uma experiência do usuário tranquila. Uma parte importante disso envolve o R8, o otimizador de apps do Android. O R8 melhora o desempenho do app removendo códigos não utilizados e otimizando e ofuscando o restante.
O Google Play anunciou recentemente novos limites de otimização de código DEX para apps e jogos, que ajudam a melhorar os tempos de inicialização, reduzir o consumo de memória e se alinhar ao compromisso do Android de proteger a experiência do usuário contra apps que usam memória em excesso. Embora esses limites se apliquem a apps e jogos, o cumprimento deles é uma responsabilidade compartilhada em todo o ecossistema. O R8 só pode otimizar um app dentro dos parâmetros fornecidos, o que inclui as regras de manutenção agrupadas pelas bibliotecas de que o app depende.
O R8 Configuration Analyzer é uma ótima ferramenta para avaliar a otimização do app, a redução e as porcentagens de ofuscação, que são o núcleo dos requisitos técnicos do Google Play. Além de monitorar essas porcentagens, o R8 Configuration Analyzer também identifica regras de manutenção ineficientes que se originam não apenas de apps, mas também de regras de manutenção do consumidor agrupadas em bibliotecas das quais os apps dependem.
Este guia descreve como resolver alguns dos desafios mais comuns que os provedores de bibliotecas enfrentam e enviar regras restritas e de alta performance para ajudar seus clientes a atender aos requisitos técnicos do Google Play.
O que são as regras de retenção do consumidor?
As regras de manutenção do consumidor são instruções incluídas em uma biblioteca Android ou JAR que informam ao R8 quais partes do código da biblioteca não podem ser otimizadas durante o processo de compilação no nível do app. Ao contrário das regras de manutenção padrão escritas pelo app ou pela biblioteca usada na minificação de artefatos, as regras de manutenção do consumidor são incorporadas às bibliotecas e afetam como a biblioteca é minificada durante a otimização de todo o app. Isso garante que os destinos de reflexão interna e as interfaces nativas permaneçam intactos sem que o desenvolvedor do app precise identificá-los manualmente.
Regras de manutenção do consumidor intencionais e de escopo restrito são uma prática recomendada essencial que beneficia tanto a biblioteca quanto os apps que a consomem. Regras de manutenção de consumidor muito amplas preservam códigos não utilizados e, como resultado, afetam a otimização e o desempenho de um app. Com os insights da otimização de código DEX adicionados ao Play Console, as métricas que os desenvolvedores de apps vão ver representam o impacto combinado das regras do app e das bibliotecas integradas.
Como equilibrar estabilidade e desempenho
Os provedores de biblioteca geralmente têm boas intenções ao enviar regras de retenção amplas para consumidores. Ninguém quer que o SDK acione uma falha devido à remoção de classe durante a reflexão.
No entanto, regras de retenção em todo o pacote ou amplas não são recomendadas como uma solução de longo prazo para prevenção de falhas, porque limitam severamente o potencial de otimização de apps de todo o programa do R8. Confira algumas estratégias recomendadas para enviar regras restritas e de alto desempenho sem sacrificar a estabilidade:
1. Testar e implementar regras restritas
Para ajudar você a lançar regras restritas com confiança, considere estas práticas recomendadas:
- Teste em um app de exemplo: as orientações de teste local em Testar sua otimização também se aplicam a apps de exemplo. Depois de ativar o R8, teste as jornadas ideais do usuário para garantir que a funcionalidade esteja funcionando como esperado.
- Execute o Analisador de configuração do R8 no app de exemplo para ver o que os desenvolvedores de apps veem ao auditar a configuração do R8. Ele permite que você visualize facilmente os impactos das suas regras de manutenção nos apps downstream.
- Use o comando de análise da CLI do Android para avaliar a otimização do AAR ou JAR, incluindo métodos, classes e campos mantidos. É possível comparar esses números entre as versões para monitorar regressões.
- Monitorar o uso de versões da biblioteca e as falhas no Google Play SDK Console.
- Consulte as orientações de otimização para autores de bibliotecas e a documentação do R8 para conferir as práticas recomendadas.
2. Preservar destinos de reflexão e JNI sem regras de manutenção amplas
Enviar uma biblioteca com regras de manutenção amplas ou que abrangem todo o pacote não afeta apenas o SDK, mas também força os desenvolvedores a aceitar um excesso de código que reduz o tempo de inicialização do app e aumenta o tamanho do download, o uso da memória e as taxas de ANR. Também é possível que apps focados em desempenho criem regras personalizadas que substituam as que estão incluídas na biblioteca, o que também desencoraja esses apps de adotar atualizações futuras da biblioteca para reduzir riscos.
Se o SDK segmentar código nativo, como em jogos ou editores de fotos e vídeos, forneça regras para todas as classes que usam JNI. A maioria dos jogos é executada em mecanismos de jogo como Unity e Unreal, que compilam o jogo em código nativo. O código nativo do jogo e o plug-in se comunicam com o framework do Android por chamadas JNI.
As anotações do Jetpack Keep, agora em versão Alfa, podem ajudar a reduzir a manutenção necessária para a reflexão, permitindo que você anote o uso da reflexão, que pode ser usada para gerar regras de manutenção no momento do build.
Considere a geração de código em vez da reflexão
Para evitar falhas causadas por reflexão, nossa maior dica é evitar a reflexão e usar codegen sempre que possível.
A reflexão de ambiente de execução oculta o uso do código do R8 durante a compilação, o que exige regras de retenção para evitar falhas. Se você usar a geração de código, o código será otimizado durante o processo de build, permitindo que o R8 tenha a visibilidade necessária para otimizar o código com segurança com o mínimo de regras de manutenção. Cenários comuns em que a geração de código é uma ótima opção incluem serialização e desserialização, além de injeção de dependência (o Hilt é um exemplo de biblioteca que usa a geração de código).
No entanto, a geração de código não é a escolha certa para todos os cenários. Para padrões como dependências opcionais, a reflexão ainda é necessária. Recomendamos combinar a reflexão com regras de manutenção restritas que protegem apenas os pontos de entrada necessários, conforme descrito nas orientações sobre Reflexão para oferecer suporte a dependências opcionais.
Defina regras de escopo restritas, mesmo para builds de biblioteca pré-otimizados
Se não for possível evitar a reflexão, verifique se as regras de retenção do consumidor especificam apenas o que sua biblioteca reflete. Quando sua biblioteca acessa uma classe ou um método de forma dinâmica, você só precisa especificar o ponto de entrada, e o R8 cuida do resto. O R8 usa os pontos de entrada para criar um gráfico de código referenciado e remover todas as classes, métodos e campos não referenciados.
Isso também se aplica se você já otimizou ou ofuscou o build da biblioteca, o que é uma ótima prática para garantir um SDK leve e de alto desempenho. Como as regras são aplicadas durante a etapa de compilação do app, o R8 ainda pode otimizar ainda mais a biblioteca com base nas classes e nos métodos reais usados pelo app downstream. O comando de análise da CLI do Android mostra proativamente as regras de manutenção usadas e não usadas em todo o pacote que estão contribuindo para a otimização bloqueada.
Definir o escopo das regras de manutenção de forma restrita para dependências de terceiros
Este é um padrão comum que observamos:
-keep public class com.google.android.gms.** { *; }Se um app que integra seu SDK também usar outra biblioteca do GMS e incluir uma regra de manutenção para limitar a quantidade de código mantido, essa regra ampla vai substituir a outra, contribuindo para o aumento desnecessário do app.
Ao invocar bibliotecas externas, crie regras de retenção que preservem estritamente apenas os elementos específicos que sua biblioteca acessa por reflexão. Além disso, a realidade é que muitas bibliotecas (incluindo o GMS) já vêm com as próprias regras de manutenção do consumidor. Introduzir uma regra de manutenção para todo o pacote também pode incluir regras de consumidor cuidadosamente escritas e de escopo restrito da biblioteca downstream.
Considere regras de manutenção condicional para adaptadores de mediação de anúncios
Se a biblioteca de anúncios for carregada usando adaptadores de mediação, as regras de manutenção restritas ainda serão uma opção. Nesse cenário, recomendamos o uso de regras de manutenção condicional para preservar apenas determinados recursos ou formatos se o app incluir o adaptador correspondente. Isso garante que o R8 ainda possa reduzir os recursos que o app não usa. Como outra opção, em vez de escrever regras complexas manualmente, você também pode usar as anotações do Jetpack Keep para anotar suas chamadas reflexivas diretamente no código-fonte e gerar automaticamente regras de manutenção de consumidor condicionais, inclusive para módulos complementares opcionais.
Envie regras em regras do consumidor, não na documentação
Ao enviar regras de consumidor com sua biblioteca, você garante que os apps com um build habilitado para R8 possam usar sua biblioteca imediatamente e desbloquear a otimização máxima.
Especificar regras na documentação adiciona atrito à configuração manual (especialmente porque as regras de manutenção do consumidor em pacote são compatíveis com AARs e JARs há anos) e cria uma sobrecarga de manutenção contínua. Ao atualizar sua biblioteca (incluindo refatoração, renomeação de classes e mudança na forma como a reflexão é usada), você precisa atualizar a documentação, e os apps precisam verificar se há novas regras. Com o tempo, à medida que os apps são atualizados em várias versões da biblioteca, eles podem acumular regras de manutenção legadas que não são mais necessárias, levando a um aumento desnecessário do tamanho do app.
3. Como ler stack traces de versões
Talvez você tenha encontrado um stack trace ilegível devido ao código ofuscado. Para desbloquear a análise crítica, pode ser tentador usar keepnames, que permite a redução, mas impede outras otimizações, como a renomeação no aplicativo para o consumidor, os valores precisos de que você precisa ao depurar um stack trace.
Não é necessário impedir outras otimizações para receber stack traces legíveis.
O Firebase Crashlytics, o Play Console e o Logcat no Android Studio desofuscam stack traces para desenvolvedores de apps. Isso significa que, se um desenvolvedor de apps compartilhar um stack trace com você, não será necessário impedir a ofuscação para poder ler o arquivo.
Se você fizer upload do arquivo de mapeamento para o SDK Console, poderá ver stack traces desofuscados no SDK Console.
Chega de ficar adivinhando como otimizar
Otimizar sua biblioteca não precisa ser um jogo de tentativa e erro.
Ao manter as regras de retenção do consumidor, os provedores de biblioteca podem garantir que os apps em todo o ecossistema não sejam bloqueados para otimização.
Quando as bibliotecas enviam regras melhores, os apps ficam menores e mais rápidos. Comece a auditar suas regras de manutenção do consumidor hoje mesmo para ajudar os apps que dependem da sua biblioteca a ter o melhor desempenho possível.
-
InstruçõesVamos falar sobre a otimização guiada por perfil, as melhorias de desempenho do Jetpack Compose e as considerações sobre o trabalho nos bastidores.
Ben Weiss, Breana Tate, Jossi Wolf • Leitura de 8 min -
InstruçõesEste é mais um post da série "Criar apps Android inteligentes", em que você transforma um app Android básico em uma experiência personalizada, inteligente e agêntica. No post anterior, você aprendeu a se conectar ao sistema de inteligência usando as AppFunctions.
Jolanda Verhoef • Leitura de 9 min -
InstruçõesO Media3 1.11 foi lançado. Essa versão, que é usada na grande maioria dos principais apps de mídia do Android, traz novos recursos, correções de bugs e melhorias nos componentes de reprodução, edição e interface.
Toni Heidenreich • Leitura de 3 min
Receba os insights mais recentes sobre o desenvolvimento para Android na sua caixa de entrada toda semana.