Adicione qualquer biblioteca GitHub ao Android Studio, usando Maven, JCenter e JitPack

Autor: Lewis Jackson
Data De Criação: 13 Poderia 2021
Data De Atualização: 1 Julho 2024
Anonim
build.gradle: Adding Build Dependencies || How To’s #4
Vídeo: build.gradle: Adding Build Dependencies || How To’s #4

Contente


Muito poucos projetos Android são uma ilha! A maioria dos projetos Android depende de vários outros componentes, incluindo bibliotecas Android de terceiros.

Uma biblioteca Android contém os mesmos arquivos que você encontraria em um projeto Android normal, como código fonte, recursos e um manifesto. No entanto, em vez de compilar em um APK Package Kit (Android) que pode ser executado em um dispositivo Android, uma biblioteca é compilada em um arquivo de código que você pode usar como dependência do projeto. Essas bibliotecas oferecem acesso a uma ampla gama de funcionalidades adicionais, incluindo alguns recursos que não estão incluídos na plataforma baunilha Android.

Um dos melhores lugares para encontrar bibliotecas Android, é o GitHub. No entanto, nem sempre é fácil obter uma biblioteca da página do GitHub e do projeto, especialmente porque existem vários repositórios diferentes que os desenvolvedores podem usar para distribuir seus projetos do GitHub - e nem sempre é óbvio qual repositório o desenvolvedor está usando!


Neste artigo, mostrarei como importar qualquer biblioteca descoberta no GitHub para o seu projeto Android, independentemente de você querer adicionar a biblioteca como uma dependência remota ou local.

Adicionando dependências remotas

O sistema de criação Gradle do Android Studio adiciona bibliotecas ao seu projeto como módulo dependências. Essas dependências podem estar localizadas em um repositório remoto, como Maven ou JCenter, ou podem ser armazenadas dentro do seu projeto, como uma dependência local - você só precisa informar à Gradle onde pode encontrar essas dependências.

Adicionar uma biblioteca como uma dependência remota é normalmente a maneira mais rápida e fácil de inserir o código de uma biblioteca em seu projeto. Portanto, este é o método que analisaremos primeiro. Quando você adiciona uma biblioteca como uma dependência remota, Gradle garante que a dependência tenha tudo o que precisa para ser executado, incluindo qualquer transitivo dependências, então você normalmente deseja adicionar uma biblioteca como dependência remota sempre que possível.


Para adicionar uma dependência remota, você precisa fornecer à Gradle duas informações:

  • O repositório. Gradle precisa conhecer o repositório (ou repositórios) onde deve procurar sua biblioteca (ou bibliotecas). As bibliotecas do Android tendem a ser distribuídas via Maven Central ou JCenter.
  • A declaração de compilação. Ele contém o nome do pacote da biblioteca, o nome do grupo da biblioteca e a versão da biblioteca que você deseja usar.

Idealmente, a página GitHub da biblioteca deve fornecer todas essas informações. Na realidade, esse nem sempre é o caso, mas vamos começar com o melhor cenário e supor que a página GitHub da biblioteca inclua essas informações.

Adicionando uma dependência remota com o JCenter

StyleableToast é uma biblioteca que permite personalizar todas as partes dos brindes do Android, incluindo a alteração da cor do plano de fundo, o raio do canto e a fonte e a adição de ícones. Ele também fornece todas as informações necessárias para adicionar esta biblioteca ao seu projeto, na seção dedicada "Instalação". Aqui, podemos ver que este projeto é distribuído via JCenter.

Quando você cria um projeto com as versões mais recentes do Android Studio, os arquivos build.gradle do seu projeto já estão configurados para oferecer suporte ao JCenter. Se você abrir o arquivo build.gradle no nível do projeto, verá que o JCenter já está incluído na seção "todos os projetos / repositórios":

allprojects {repositories {jcenter ()}}

Observe que o arquivo build.gradle no nível do projeto contém dois blocos de 'repositórios', mas o bloco 'buildscript / repositories' é onde você define como a Gradle executa essa construção. Você não deve adicionar nenhuma dependência de módulo a esta seção.

Como seu projeto já está configurado para verificar o JCenter, a única coisa que precisamos fazer é adicionar nossa instrução de compilação ao arquivo build.gradle no nível do módulo.

Mais uma vez, o StyleableToast nos fornece exatamente as informações de que precisamos, então copie a declaração de compilação da página do GitHub da StyleableToast e cole-a no seu arquivo Gradle:

dependências {compile com.muddzdev: styleabletoast: 1.0.8}

Sincronize seus arquivos Gradle, clicando no banner "Sincronizar" ou selecionando o ícone "Sincronizar projeto com arquivos Gradle" na barra de ferramentas. Gradle consultará o servidor JCenter para verificar se a biblioteca Styleablastast existe e fará o download de todos os seus arquivos. Agora você está pronto para começar a usar esta biblioteca!

2. Adicionando uma dependência remota com o Maven Central

Como alternativa, se a página GitHub do projeto indicar que essa biblioteca é distribuída via Maven Central, você precisará solicitar que Gradle verifique o Maven Central.

Abra o arquivo build.gradle no nível do projeto e adicione o Maven Central ao bloco "allprojects":

allprojects {repositories {mavenCentral ()}}

A partir daqui, o restante do processo é exatamente o mesmo: abra o arquivo build.gradle no nível do módulo, adicione a instrução compile e sincronize com o Gradle.

3. Adicionando uma dependência remota hospedada em seu próprio servidor

Ocasionalmente, você pode encontrar um projeto que ainda é distribuído via JCenter ou Maven Central, mas o desenvolvedor optou por hospedar o projeto em seu próprio servidor. Nesse caso, a página do GitHub do projeto deve solicitar que você use um URL muito específico, por exemplo, o repositório do Crashlytics Kit do Fabric está localizado em https://maven.fabric.io/public.

Se você vir esse tipo de URL, será necessário abrir o arquivo build.gradle no nível do projeto e declarar o repositório (nesse caso, Maven) junto com o URL exato:

repositórios {maven {url https://maven.fabric.io/public}}

Você pode adicionar a instrução de compilação e sincronizar seus arquivos normalmente.

E se eu não conseguir encontrar o repositório e / ou a instrução de compilação?

Até agora, ficamos otimistas e assumimos que o GitHub do projeto sempre informa todas as informações que você precisa saber. Infelizmente, esse nem sempre é o caso; portanto, vamos mudar do melhor cenário para o pior cenário e imagine que a página GitHub do projeto não forneça informações sobre o repositório e a declaração de compilação que você precisa usar.

Nesse cenário, você pode:

  • Use o JitPack.
  • Clone o repositório inteiro e importe seu código para o seu projeto como seu próprio módulo.

Usando o JitPack

O JitPack é um repositório de pacotes para o Git que permite adicionar qualquer projeto do GitHub como uma dependência remota. Enquanto a biblioteca contiver um arquivo de construção, o JitPack poderá gerar todas as informações necessárias para adicionar essa biblioteca ao seu projeto.

A primeira etapa é abrir o arquivo build.gradle no nível do projeto e adicionar o JitPack como um repositório:

allprojects {repositórios {maven {url https://jitpack.io}}}}

Você pode usar o site do JitPack para gerar uma declaração de compilação, com base no URL do GitHub desse projeto:

  • No seu navegador, navegue até a página GitHub da biblioteca. Copie seu URL.
  • Vá para o site do JitPack.
  • Cole o URL no campo de pesquisa do site e clique no botão "Pesquisar" que o acompanha.
  • A página da Web exibirá uma tabela de todas as versões desta biblioteca, dividida em várias guias: Liberações, Compilações, Ramificações e Confirmações. Normalmente, as liberações tendem a ser mais estáveis, enquanto a seção Confirmar contém as alterações mais recentes.

  • Depois de decidir qual versão você deseja usar, clique no botão 'Obter' que o acompanha.
  • O site deve ser atualizado para exibir a instrução exata de compilação que você precisa usar.

  • Copie / cole esta declaração de compilação no arquivo build.gradle no nível do módulo do seu projeto.
  • Sincronize seus arquivos Gradle e você estará pronto para começar a usar sua biblioteca!

Clonando um projeto GitHub

Como alternativa, quando você não tiver certeza do repositório de uma biblioteca e / ou da declaração de compilação, convém clone o projeto GitHub. A clonagem cria uma cópia de todo o código e recursos do projeto GitHub e armazena essa cópia na sua máquina local. Você pode importar o clone para o seu projeto como seu próprio módulo e usá-lo como uma dependência do módulo.

Esse método pode ser demorado e a importação de todo o código de um projeto pode causar conflitos com o restante do projeto. No entanto, a clonagem fornece acesso a todo o código da biblioteca; portanto, esse método é ideal se você deseja personalizar a biblioteca, por exemplo, ajustando seu código para se integrar melhor ao restante do seu projeto ou até mesmo adicionando novos recursos (embora se você sentir que outras pessoas podem se beneficiar de suas alterações, considere contribuir com suas melhorias de volta ao projeto).

Para clonar um projeto do GitHub:

  • Crie uma conta no GitHub.
  • Selecione "Finalizar compra no controle de versão" na tela "Bem-vindo" do Android Studio.
  • Digite suas credenciais do GitHub.
  • Abra seu navegador da Web, navegue até o repositório do GitHub que você deseja clonar e copie / cole seu URL na caixa de diálogo do Android Studio.
  • Especifique o diretório local em que deseja armazenar o repositório clonado.
  • Dê um nome a este diretório e clique em "Clonar".

Agora você tem uma cópia do código da biblioteca, pode importar esta biblioteca para o seu projeto Android, como um novo módulo:

  • Abra o projeto em que deseja usar sua biblioteca clonada e selecione "Arquivo> Novo> Importar módulo" na barra de ferramentas do Android Studio.
  • Clique no botão de três pontos e navegue para o seu repositório clonado. Selecione este repositório e clique em "OK".
  • Clique em "Concluir".
  • Selecione "Arquivo> Estrutura do projeto" na barra de ferramentas do Android Studio.
  • No menu à esquerda, selecione o módulo em que deseja usar esta biblioteca.
  • Selecione a guia "Dependências".

  • Selecione o pequeno ícone '+', seguido de 'Dependência do módulo'.
  • Selecione seu módulo de biblioteca e clique em "OK".
  • Saia da janela "Estrutura do projeto".

Dependendo da biblioteca que você está usando, pode ser necessário fazer alguns ajustes no seu código importado antes da compilação do seu projeto. Por exemplo, se a guia do Android Studio estiver reclamando de minSdkVersions incompatíveis, é provável que as APIs usadas pela biblioteca não sejam compatíveis com as versões da plataforma Android definidas no arquivo build.gradle do seu projeto. Da mesma forma, se o Android Studio estiver reclamando da buildToolsVersion do seu projeto, é provável que haja uma incompatibilidade entre a versão definida na biblioteca e a versão definida em outra parte do seu projeto. Nos dois cenários, você precisará verificar os valores definidos nos arquivos build.gradle e alterá-los de acordo.

Solução de problemas

Quando você está trabalhando com qualquer tipo de software de terceiros, como regra geral, é mais provável que você encontre incompatibilidades, bugs e problemas gerais estranho comportamento, comparado a quando você está usando um conjunto de software desenvolvido pela mesma equipe e em que cada peça do quebra-cabeça foi projetada especificamente para trabalhar em conjunto.

Se você tiver problemas após adicionar uma biblioteca ao seu projeto, tente as seguintes correções:

  • Verifique se você não adicionou acidentalmente várias versões da mesma biblioteca. Se o Android Studio estiver relatando um erro "vários arquivos DEX definem ...", é possível que você tenha adicionado a mesma biblioteca ao seu projeto mais de uma vez. Você pode revisar as dependências do seu módulo selecionando "Arquivo> Estrutura do projeto" na barra de ferramentas do Android Studio, selecionando o módulo que deseja examinar e clicando na guia "Dependências". Se uma biblioteca aparecer nesta janela várias vezes, selecione a duplicata e clique no pequeno ícone '-' para removê-la.
  • Pesquise na internet. Sempre há uma chance de que outras pessoas tenham encontrado o mesmo problema que você; portanto, faça uma pesquisa rápida no Google para ver se alguém postou sobre esse problema em fóruns ou comunidades como Stackoverflow. Você pode até ter sorte e encontrar um blog ou um tutorial que inclua instruções sobre como resolver esse problema exato.
  • Limpe e reconstrua seu projeto. Às vezes, selecionar "Compilar> Limpar projeto" na barra de ferramentas do Android Studio, seguido de "Compilar> Reconstruir projeto", pode ser suficiente para resolver seu problema.
  • E se tudo mais falhar ... Às vezes, conseguir que o software de terceiros funcione corretamente requer um pouco de tentativa e erro; portanto, se houver um método alternativo de importar a biblioteca escolhida, vale sempre a pena tentar. Só porque seu projeto se recusa a compilar após a importação de um repositório clonado, não significa necessariamente que terá a mesma reação se você tentar usar a mesma biblioteca como uma dependência remota.

Empacotando

Neste artigo, vimos como você pode adicionar qualquer biblioteca descoberta no GitHub ao seu projeto Android, independentemente de essa biblioteca ser distribuída via JCenter ou Maven Central. E, mesmo que você não tenha idéia de qual repositório ou instrução de compilação precisa usar, sempre terá a opção de usar o JitPack ou clonar o código da biblioteca.

Você descobriu grandes bibliotecas Android no GitHub? Deixe-nos saber nos comentários abaixo!

Vimo muita renderizaçõe vazada pertencente ao amung Galaxy Note 10 e Note 10 Plu. Agora, recebemo uma aparência aparente do amung Galaxy Note 10 Plu 5G, além de poívei detalhe...

A amung já lançou eu Galaxy 10 5G na Coréia do ul, marcando um grande pao na tranição para a conectividade de próxima geração. Também não para por a&#...

Publicações Fascinantes