Mobile Platform as a Service:Use the mPaaS plugin

Adicione um arquivo de configuração

Adicionar um arquivo de configuração é a principal tarefa de integração. O plugin do mPaaS suporta importação manual: baixe o arquivo de configuração do console e importe-o para o projeto por meio do plugin.

Basic tools

O menu Basic tools inclui Hotpatching, Generate encrypted image (Apsara Stack configuration file), Generate signed APK for console, Generate UC Key signature information e Generate Blue Shield image.

Hotpatching

Ative o hotpatching para o aplicativo antes de usar este recurso. Para instruções de configuração, consulte Gerenciamento de Hotpatching: Integração Android — Hotpatching.

Gerar um hotpatch

Use o recurso Generate hotpatch para criar um pacote de hotpatch. As etapas variam conforme o método de integração.

1. Selecione as entradas do pacote de acordo com o método de integração.

   • Para um projeto AAR nativo, forneça o pacote APK online contendo o bug e o pacote APK corrigido. O plugin gera o pacote de hotpatch com base nas diferenças de código entre os dois.

     Nota:

     • No campo New bundle, insira o caminho local do pacote APK corrigido.

     • No campo Old bundle, insira o caminho local do pacote APK com bug.

     • No campo Whitelist, insira a lista de permissões.

   • Para um projeto baseado em componentes (Portal & Bundle), forneça o pacote de bundle com bug em uso e o pacote de bundle corrigido.

     Nota:

     • O caminho de saída do bundle é build/intermediates/bundle/xxxx-raw.jar no diretório do módulo principal. Para um pacote de release, o caminho não inclui -raw.

     • New bundle: selecione o caminho do pacote que contém a correção do bug.

     • Old bundle: selecione o caminho do pacote com bug.

     • Whitelist: selecione o arquivo de configuração .txt que especifica as classes a serem corrigidas. Para regras de formato de arquivo, consulte Regras do arquivo de configuração de lista de permissões. Esta opção é altamente recomendada para projetos AAR nativos.

     • Patch file dir: o caminho de saída para o pacote de patch.

     • Use dexPatch: selecione se deseja usar o método de hotpatching dexPatch. O plugin suporta tanto Andfix quanto dexPatch. Verifique se qualquer pacote de hotpatch está funcionando antes de liberar a versão.

       • Não selecionado: gera um pacote de hotpatch Andfix, que entra em vigor imediatamente sem reiniciar o aplicativo. O Andfix possui mais restrições em cenários corrigíveis devido à compatibilidade com modelos de dispositivos.

       • Selecionado: gera um pacote de hotpatch dexPatch, que exige o encerramento do processo para entrar em vigor. O dexPatch abrange mais cenários de correção e apresenta menos problemas de compatibilidade com dispositivos do que o Andfix.

2. Insira as informações de assinatura para gerar o pacote de hotpatch.

   Importante

   O arquivo de assinatura usado para gerar o pacote de hotpatch deve corresponder ao arquivo de assinatura do APK em execução e do APK selecionado para geração da imagem. Coloque a imagem gerada na pasta res/drawable do projeto Portal e nomeie-a como yw_1222.jpg.

Regras do arquivo de configuração de lista de permissões

O arquivo de configuração de lista de permissões (formato .txt) especifica as classes a serem corrigidas ao criar um pacote de hotpatch. Inclua os seguintes campos nesta ordem:

1. As classes a serem corrigidas. Comece com L, seguido pelo nome ofuscado da classe. Liste uma classe por linha. Por exemplo, Lxxx.xxx.clazzX.

2. Defina o tipo de patch como dexpatch. Por exemplo, PatchType: dexpatch.

3. Defina se é um bundle estático. O valor padrão é true. Por exemplo, HostDex: true.

4. Adapte para Android 11. Por exemplo, android-phone-mobilesdk-quinox-Configs: ForceEnableQSecondDex-true. Aqui, android-phone-mobilesdk-quinox é o nome do bundle. Para projetos Portal & Bundle baseados em componentes, substitua isso pelo nome real do bundle. Para integração AAR (sem projeto de bundle), use android-phone-mobilesdk-quinox como está.

Mesclar patches

Apenas um pacote de hotpatch pode ser executado em uma determinada versão do aplicativo por vez. Se uma versão do cliente tiver dois bugs, use Merge patches para combinar os dois pacotes de hotpatch em um só antes da liberação.

Por exemplo: se você já liberou o pacote de hotpatch A para uma versão específica e depois encontrou outro bug, gere o pacote de hotpatch B localmente, mescle A e B e libere o pacote mesclado.

Nota

Esta seção aplica-se apenas a projetos baseados em componentes (Portal & Bundle). Para projetos AAR nativos, crie um novo patch que inclua a correção sobre o pacote original não corrigido.

Procedimento

1. Defina os caminhos dos pacotes de hotpatch.

   • Merge dir: selecione o diretório contendo todos os pacotes de hotpatch a serem mesclados. Os nomes dos pacotes devem terminar com .jar ou .apk.

   • Patch file dir: selecione o diretório de saída para o pacote mesclado.

2. Configure as informações de assinatura.

Uma mensagem de sucesso será exibida após a conclusão da mesclagem.

Gerar uma imagem criptografada (arquivo de configuração do Apsara Stack)

Por motivos de segurança, alguns componentes do mPaaS precisam criptografar conteúdo ao acessar a rede.

• Uma imagem com o nome especial yw_1222.jpg fornece a chave para criptografia e descriptografia. Os componentes do mPaaS usam essa imagem automaticamente para criptografia e descriptografia, sem exigir operações extras.

• Essa imagem criptografada foi descontinuada no ambiente de nuvem pública. Usuários da nuvem pública podem pular esta seção.

Pré-requisitos

A imagem criptografada está vinculada à assinatura do APK. Prepare um APK assinado para o projeto Portal antes de prosseguir. Para etapas de assinatura, consulte Assinar seu aplicativo no site de desenvolvedores Android.

Nota

• O APK deve usar o mesmo arquivo de assinatura que o APK da Published Version.

• A imagem criptografada gerada funciona apenas com aquele projeto de APK.

Procedimento

Gere a imagem criptografada usando o plugin do mPaaS:

1. No Android Studio, escolha mPaaS > Basic tools > Generate encrypted image (Apsara Stack configuration file).

2. No campo Release Apk, selecione o arquivo APK assinado do projeto Portal. O campo RSA será preenchido automaticamente.

3. No campo mPaaS Config File, selecione o arquivo .config do projeto Portal. Os campos workSpaceId, appId e packageName serão preenchidos automaticamente. Caso contrário, preencha-os a partir do arquivo .config do projeto.

4. Insira o appsecret.

   Nota: Como administrador do lado do servidor, consulte o appsecret correspondente ao appid no console.

5. No campo jpg Version, insira o número da versão da imagem do Security Guard.

   Nota

   Verifique a versão do securityguard no arquivo build.gradle do módulo principal do projeto Portal. Se a versão for anterior a 5.4, insira 4. Por exemplo, se a baseline fornecer securityguard-build:5.1.38.180402194514, insira 4. Caso contrário, insira 5.

6. No campo outPath, selecione o caminho de saída local para yw_1222.jpg.

7. Clique em OK para gerar a imagem criptografada.

Uso

1. Salve yw_1222.jpg na pasta res/drawable do projeto Portal.

2. Se você usar o ProGuard, impeça que a imagem criptografada seja ofuscada.

   1. Verifique se o seguinte está configurado no build.gradle:

      minifyEnabled true
      shrinkResources true

   2. Se essa configuração existir, crie um arquivo keep.xml no diretório res/raw para isentar a imagem criptografada da ofuscação:

      <?xml version="1.0" encoding="utf-8"?>
      <resources xmlns:tools="http://schemas.android.com/tools"
      tools:keep="@drawable/yw_1222*" /><!--tools:discard="@layout/unused2"-->

Gerar uma imagem Blue Shield

Se o valor absBase64Code no arquivo .config baixado do console do mPaaS estiver vazio, execute a operação Generate Blue Shield image. Isso se aplica a cenários do Apsara Stack.

Importante

Se você estiver em um ambiente de nuvem pública e o valor absBase64Code estiver vazio, faça upload de um APK assinado corretamente primeiro e baixe o arquivo .config novamente. Para detalhes, consulte Preencher informações de configuração e fazer upload do APK assinado.

Escolha mPaaS > Basic tools > Generate Blue Shield encrypted image, insira as informações necessárias e gere a imagem.

Principais parâmetros:

• Release Apk: o APK de release assinado do projeto integrado ao mPaaS.

• MD5: preenchido automaticamente após o upload do APK de release. Esta é a public md5 key do pacote APK.

• mPaaS config File: clique em Download Config no console do mPaaS para baixar o arquivo .config e forneça-o aqui.

• appSecret: visualize este valor no console do mPaaS.

• appId, packageName e outPath são detectados e preenchidos automaticamente após você fornecer as entradas anteriores.

Adicione a imagem gerada ao diretório assets do projeto.

Gerar um APK assinado para o console

Ao obter um arquivo de configuração do console do mPaaS, você deve fazer upload de um APK assinado. Se você ainda não criou um projeto ou compilou um APK assinado, esse requisito bloqueia o processo. O recurso Generate signed APK for console resolve isso gerando um APK assinado usando apenas parâmetros relacionados à assinatura.

Geração

1. Escolha mPaaS > Basic tools > Generate signed APK for console para abrir a página Construct Signed APK.

2. Insira as informações de configuração necessárias.

3. Clique em OK para gerar o arquivo APK assinado.

4. Clique em Reveal in Finder para localizar o arquivo gerado, chamado mpaas-signed.apk.

   Este arquivo APK é pequeno e já está assinado.

Gerar informações de assinatura da UC Key

Integrar o kit de desenvolvimento de software (SDK) da UC resolve problemas de compatibilidade com navegadores de diversos fabricantes. Antes de adicionar o SDK da UC, solicite a autorização do SDK da UC. Este recurso ajuda a obter a autorização rapidamente. A seção a seguir descreve o procedimento completo para solicitar a autorização do SDK da UC.

Nota

Este recurso está disponível desde a V2.20062211. Para mais informações, consulte Notas de lançamento da V2.20062211.

Procedimento

1. Adicione a dependência UC Kernel (UCCORE) ao projeto.

2. Forneça o nome do pacote nativo Android do aplicativo.

3. Escolha mPaaS > Basic tools > Generate UC Key signature information para abrir a página Query Signature Information.

4. Insira as informações de configuração necessárias e clique em Next.

5. Copie as informações SHA1 recuperadas.

6. Preencha e envie o formulário de solicitação de chave UC.

   Nota

   Devido a uma mudança na estratégia do produto, a UC não aceita mais solicitações públicas. Desde 1º de dezembro de 2022, solicitações públicas para UC Keys não são suportadas. Preencha o formulário com as informações relevantes — a equipe do mPaaS analisará sua solicitação e fornecerá feedback.

7. Adicione a chave obtida ao arquivo AndroidManifest.xml do projeto Portal: <meta-data android:name="UCSDKAppKey" android:value="the key you applied for"/>.

   Nota

   A autorização do SDK da UC está vinculada ao nome do pacote e à assinatura do APK. Se o UCWebView não funcionar, verifique se a assinatura e o nome do pacote correspondem aos usados durante a solicitação.

Help

Ferramenta de diagnóstico de log

1. Escolha mPaaS > Help > Log diagnosis tool.

2. Cole o conteúdo do log na caixa de entrada e clique em Next.

3. Aguarde a conclusão da análise.

4. Revise os resultados. Cada resultado inclui a causa e a solução. Atualize o código com base nas informações específicas fornecidas.

5. Após fazer as alterações, clique em Finish para fechar a janela.

FAQ

Escolha mPaaS > Help > FAQ para abrir o FAQ de Integração Android, que lista problemas comuns encontrados durante a integração.

Visualizar documentos

Escolha mPaaS > Help > View documents para abrir a Central de Documentação do mPaaS e navegar pela documentação de cada componente.

Build

No Android Studio, escolha mPaaS > Build para compilar o projeto.