title | weight | description |
---|---|---|
Instalando o Beagle |
13 |
Nesta seção, você encontra o passo a passo da configuração do Beagle no backend. |
{{% alert color="danger" %}} Antes de iniciar a instalação, é importante você saber que as etapas abaixo são para linguagens da JVM.
Para outras linguagens, seu servidor precisa servir o JSON seguindo nossa API. Veja a implementação de [mecanismos específicos de cada linguagem]({{< ref path="/resources/platform-sorting" lang="pt" >}}). {{% /alert %}}
Antes de integrar o Beagle à sua aplicação para rodá-lo no backend, é importante validar se sua máquina está com as versões corretas instaladas dos seguintes softwares:
- JDK 8+ language (Kotlin 1.3+ é recomendado)
- Maven 3+
Se você já tiver atualizado todos estes programas, basta seguir as instruções abaixo.
No momento de criar o microsserviço, recomendamos que você utilize os mesmos mecanismos estabelecidos. Caso este não seja o seu caso, então basta seguir as configurações abaixo.
{{% alert color="warning" %}}
Se o seu time trabalha com microsserviços usando outros frameworks, acesse o [framework do Beagle]({{< ref path="/backend/kotlin/customization/beagle-framework" lang="pt" >}}).
{{% /alert %}}
Para uma configuração simples, você pode escolher entre 2 modelos de frameworks para criar seu BFF:
É um framework full-stack moderno baseado em JVM para construção modular. Fácil de testar em microsserviços e com aplicações sem servidor (serverless).
É um framework que permite programação em Java mais rápida, fácil e segura para todos. É focada em velocidade, simplicidade e produtividade, o que o tornou o framework Java mais popular.
Depois de selecionar com qual framework deseja seguir, prossiga com as configurações abaixo:
{{< tabs id="T0" >}} {{% tab name="Micronaut" %}}
Conforme descrito no quickstart do Micronaut, crie seu aplicativo através da ferramenta de CLI com o seguinte comando:
$ mn create-app bff --build maven --lang kotlin
Isso criará um projeto Micronaut
executável usando Kotlin
e Maven
em um diretório chamado bff
. Abra este projeto na IDE que escolher e siga o passo 2 para configurar as dependências.
Se você quiser adotar o Micronaut 2.0, você pode usar o novo site de construção de projeto semelhante ao do Spring.
- Clique no link a seguir para baixar um zip do projeto com as opções da imagem abaixo: Micronaut Launch para Beagle Micronaut Starter.
- Essa configuração inicial utiliza:
- Kotlin com Maven para
Java 8 (compatível com essa versão);
Junit
como biblioteca de testes unitários.
- Kotlin com Maven para
- Descompacte o arquivo na pasta que escolher para conter seu projeto BFF e abra o seu projeto na IDE de sua preferência. {{% /tab %}}
{{% tab name="Spring" %}}
Neste caso, use o site do Spring para gerar um projeto com o microsserviço já criado:
- Clique no link a seguir e você verá a página abaixo: Spring Initializer for Beagle Spring Starter
- Essa configuração inicial utiliza:
- Kotlin com Maven;
- A ultima versão do
Spring Boot Actuator dependency;
- Empacotamento
JAR
eJava 8 (compatível com essa versão).
- Clique em
GENERATE
para fazer o download de um arquivo zip que contém o projeto Spring Boot. - Descompacte o arquivo na pasta que escolher para conter seu projeto BFF e abra o seu projeto na IDE de sua preferência. {{% /tab %}} {{< /tabs >}}
Agora, você precisa complementar algumas configurações no backend. O framework que você tiver escolhido é que define como a implementação deve ser feita.
Clique na opção de Framework que você escolheu anteriormente e siga os passos para continuar a configuração.
{{< tabs id="T1" >}} {{% tab name="Micronaut Starter" %}}
{{% alert color="info" %}} Este starter configura a versão do módulo micronaut-runtime com ele e utiliza a versão Micronaut 2.0.0. {{% /alert %}}
Para seguir com esse requerimento, adicione ao seu arquivo pom.xml
a dependência abaixo.
<dependency>
<groupId>br.com.zup.beagle</groupId>
<artifactId>beagle-micronaut-starter</artifactId>
<version>${beagle.version}</version>
</dependency>
Para projetos configurados com Gradle, adicione a dependência do starter em seu arquivo build.gradle
ou build.gradle.kts
.
dependencies {
implementation("br.com.zup.beagle:beagle-micronaut-starter:${beagle.version}")
}
Insira a versão de release do Beagle no lugar de ${beagle.version}
. Ou seja, coloque a versão do Beagle destacada em azul da badge
acima, mas sem o caracter v
que antecede os números de versão.
Por exemplo: undefined-ext.beagle.version = "1.8.0"
{{% alert color="warning" %}} Lembre de sempre verificar se você está usando a versão mais recente do Beagle. Para saber disso, basta passar o mouse por cima do número da versão. Depois disso, sincronize com sua máquina. {{% /alert %}} {{% /tab %}}
{{% tab name="Spring Starter" %}}
{{% alert color="info" %}} Este starter configura a versão do módulo spring-boot-starter-web com ele e utiliza a versão Spring Boot 2.3.1. {{% /alert %}}
Para seguir com esse requerimento, adicione ao seu arquivo pom.xml
a dependência abaixo.
<dependency>
<groupId>br.com.zup.beagle</groupId>
<artifactId>beagle-spring-starter</artifactId>
<version>${beagle.version}</version>
</dependency>
Para projetos configurados com Gradle, adicione a dependência do starter em seu arquivo build.gradle
ou build.gradle.kts
.
dependencies {
implementation("br.com.zup.beagle:beagle-spring-starter:${beagle.version}")
}
Insira a versão de release do Beagle no lugar de ${beagle.version}
. Ou seja, coloque a versão do Beagle destacada em azul da badge
acima, mas sem o caracter v
que antecede os números de versão.
Por exemplo:-ext.beagle.version = "1.5.1"
{{% alert color="warning" %}} Sempre verifique se você está usando a versão mais recente do Beagle. Para saber disso, basta passar o mouse por cima do número da versão. Depois disso, sincronize com sua máquina. {{% /alert %}}
Parabéns, a configuração inicial está pronta para uso!
Você pode conferir um exemplo prático de tela ou componente Server-Driven [para testar o BFF]({{< ref path="/backend/kotlin/get-started/using-beagle" lang="pt" >}})
{{% alert color="danger" %}}
O Spring Boot tem um problema conhecido envolvendo seu WebMvcConfigurationSupport
. Sua presença substitui outras configurações do Jackson, incluindo a do Spring Starter
.
Se isso acontecer em seu projeto, é só substituir porWebMvcConfigurer.
Para mais detalhes, consulte esta issue no Github
A anotação @EnableWebMvc
causa o mesmo problema, o que requer que ela também seja removida.
{{% /alert %}}
{{% /tab %}}
{{< /tabs >}}
{{% alert color="success" %}} Pronto, a configuração inicial está pronta para uso! {{% /alert %}}
Você pode conferir um exemplo prático de [como testar o Beagle no Backend]({{< ref path="/backend/kotlin/get-started/using-beagle" lang="pt" >}}) ou componente Server-Driven para testar o BFF.
Nesta seção, você fez a instalação inicial do Beagle na sua aplicação!
Para continuar a configurar o Beagle:
👉Vá para as [configurações iniciais]({{< ref path="/backend/kotlin/get-started/using-beagle" lang="pt" >}}) para habilitar uso do Beagle no seu projeto Backend
👉 Se quiser ir direto para prática, acesse nosso [tutorial para criar um projeto do zero]({{< ref path="/backend/kotlin/get-started/creating-a-project-from-scratch" lang="pt" >}})