Desenvolver um aplicativo de produtor Java

Aprenda a desenvolver um aplicativo de produtor Java que se autentica com um cluster do serviço gerenciado para Apache Kafka usando Application Default Credentials (ADC). O ADC permite que aplicativos em execução em Google Cloud encontrem e usem automaticamente as credenciais certas para autenticar Google Cloud serviços.

Antes de começar

Antes de iniciar este tutorial, crie um novo cluster do serviço gerenciado para Apache Kafka. Se você já tiver um cluster, pule esta etapa.

Como criar um cluster

Console

  1. Acesse a página Serviço gerenciado para Apache Kafka > Clusters.

    Acessar Clusters

  2. Clique em Criar.
  3. Na caixa Nome do cluster, insira um nome para o cluster.
  4. Na lista Região, selecione um local para o cluster.
  5. Em Configuração de rede, configure a sub-rede em que o cluster está acessível:
    1. Em Projeto, selecione o projeto.
    2. Em Rede, selecione a rede VPC.
    3. Em Sub-rede, selecione a sub-rede.
    4. Clique em Concluído.
  6. Clique em Criar.

Depois de clicar em Criar, o estado do cluster será Creating. Quando o cluster estiver pronto, o estado será Active.

gcloud

Para criar um cluster do Kafka, execute o managed-kafka clusters create comando.

gcloud managed-kafka clusters create KAFKA_CLUSTER \
--location=REGION \
--cpu=3 \
--memory=3GiB \
--subnets=projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME \
--async

Substitua:

  • KAFKA_CLUSTER: um nome para o cluster do Kafka
  • REGION: o local do cluster
  • PROJECT_ID: ID do projeto
  • SUBNET_NAME: a sub-rede em que você quer criar o cluster, por exemplo, default

Para informações sobre os locais compatíveis, consulte Locais do serviço gerenciado para Apache Kafka.

O comando é executado de forma assíncrona e retorna um ID de operação:

Check operation [projects/PROJECT_ID/locations/REGION/operations/OPERATION_ID] for status.

Para acompanhar o progresso da operação de criação, use o gcloud managed-kafka operations describe comando:

gcloud managed-kafka operations describe OPERATION_ID \
  --location=REGION

Quando o cluster estiver pronto, a saída desse comando incluirá a entrada state: ACTIVE. Para mais informações, consulte Monitorar a operação de criação do cluster.

Funções exigidas

Para ter as permissões necessárias para criar e configurar uma VM cliente, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias usando personalizados papéis ou outros predefinidos papéis.

Criar uma VM cliente

Crie uma instância de máquina virtual (VM) do Linux no Compute Engine que possa acessar o cluster do Kafka. Ao configurar a VM, defina as seguintes opções:

  • Região. Crie a VM na mesma região do cluster do Kafka.

  • Sub-rede. Crie a VM na mesma rede VPC que a sub-rede usada na configuração do cluster do Kafka. Para mais informações, consulte Conferir as sub-redes de um cluster.

  • Escopos de acesso. Atribua o https://www.googleapis.com/auth/cloud-platform escopo de acesso à VM. Esse escopo autoriza a VM a enviar solicitações para a API Managed Kafka.

As etapas a seguir mostram como definir essas opções.

Console

  1. No Google Cloud console do, acesse a página Criar uma instância.

    Criar uma instância

  2. No painel Configuração da máquina, faça o seguinte:

    1. No campo Nome, especifique um nome para a instância. Saiba mais em Convenção de nomenclatura de recursos .

    2. Na lista Região, selecione a mesma região do cluster do Kafka.

    3. Na lista Zona, selecione uma zona.

  3. No menu de navegação, clique em Rede. No painel Rede exibido, faça o seguinte:

    1. Acesse a seção Interfaces de rede.

    2. Para expandir a interface de rede padrão, clique na seta.

    3. No campo Rede, escolha a rede VPC.

    4. Na lista Sub-rede, selecione a sub-rede.

    5. Clique em Concluído.

  4. No menu de navegação, clique em Segurança. No painel Segurança exibido, faça o seguinte:

    1. Para Escopos de acesso, selecione Definir acesso para cada API.

    2. Na lista de escopos de acesso, encontre a lista suspensa Cloud Platform e selecione Ativado.

  5. Clique em Criar para criar a VM.

gcloud

Para criar a instância de VM, use o gcloud compute instances create comando.

gcloud compute instances create VM_NAME \
  --scopes=https://www.googleapis.com/auth/cloud-platform \
  --subnet=projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET \
  --zone=ZONE

Substitua:

  • VM_NAME: o nome da VM
  • PROJECT_ID: ID do projeto
  • REGION: a região em que você criou o cluster do Kafka, por exemplo us-central1
  • SUBNET: uma sub-rede na mesma rede VPC que a sub-rede usada na configuração do cluster
  • ZONE: uma zona na região em que você criou o cluster, por exemplo us-central1-c

Para mais informações sobre como criar uma VM, consulte Criar uma instância de VM em uma sub-rede específica.

Conceder papéis do IAM

Conceda os seguintes papéis do Identity and Access Management (IAM) à conta de serviço padrão do Compute Engine:

  • Cliente Kafka gerenciado (roles/managedkafka.client)
  • Criador do token da conta de serviço (roles/iam.serviceAccountTokenCreator)
  • Criador do token OpenID da conta de serviço (roles/iam.serviceAccountOpenIdTokenCreator)

Console

  1. No Google Cloud console, acesse a página IAM.

    Acessar IAM

  2. Encontre a linha da conta de serviço padrão do Compute Engine e clique em Editar principal.

  3. Clique em Adicionar outro papel e selecione o papel Cliente Kafka gerenciado. Repita essa etapa para os papéis Criador do token da conta de serviço e Criador do token OpenID da conta de serviço.

  4. Clique em Salvar.

gcloud

Para conceder papéis do IAM, use o gcloud projects add-iam-policy-binding comando.

gcloud projects add-iam-policy-binding PROJECT_ID \
  --member="serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
  --role=roles/managedkafka.client

gcloud projects add-iam-policy-binding PROJECT_ID\
  --member="serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
  --role=roles/iam.serviceAccountTokenCreator

gcloud projects add-iam-policy-binding PROJECT_ID \
  --member="serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
  --role=roles/iam.serviceAccountOpenIdTokenCreator

Substitua:

  • PROJECT_ID: ID do projeto

  • PROJECT_NUMBER: o ID do seu projeto

Para receber o número do projeto, execute o gcloud projects describe comando:

gcloud projects describe PROJECT_ID

Para mais informações, consulte Encontrar o nome, o número e o ID do projeto.

Conectar-se à VM

Use SSH para se conectar à instância de VM.

Console

  1. Acesse a página Instâncias da VM.

    Acessar instâncias de VM

  2. Na lista de instâncias de VM, encontre o nome da VM e clique em SSH.

gcloud

Para se conectar à VM, use o gcloud compute ssh comando.

gcloud compute ssh VM_NAME \
  --project=PROJECT_ID \
  --zone=ZONE

Substitua:

  • VM_NAME: o nome da VM
  • PROJECT_ID: ID do projeto
  • ZONE: a zona em que você criou a VM

Pode ser necessária uma configuração extra para o uso do SSH pela primeira vez. Para mais informações, consulte Sobre conexões SSH.

Configurar um projeto do Apache Maven

Na sessão SSH, execute os comandos a seguir para configurar um projeto Maven.

  1. Instale o Java e o Maven com o comando: sudo apt-get install maven openjdk-17-jdk.

  2. Configure um projeto do Apache Maven.

    Esse comando vai criar um pacote com.google.example em um diretório chamado demo.

    mvn archetype:generate -DartifactId=demo -DgroupId=com.google.example\
       -DarchetypeArtifactId=maven-archetype-quickstart\
       -DarchetypeVersion=1.5 -DinteractiveMode=false
    
  3. Mude para o diretório do projeto com cd demo.

Criar um aplicativo de produtor Java

Esta seção orienta você na criação de um aplicativo Java que produz mensagens para um tópico do Kafka. Grave e compile o código Java usando o Maven, configure os parâmetros necessários em um arquivo kafka-client.properties e execute o aplicativo para enviar mensagens.

Escrever o código do produtor

Substitua o código em src/main/java/com/google/example/App.java pelo seguinte:

  package com.google.example;

  import java.util.Properties;
  import org.apache.kafka.clients.producer.KafkaProducer;
  import org.apache.kafka.clients.producer.ProducerRecord;
  import org.apache.kafka.clients.producer.RecordMetadata;
  import org.apache.kafka.clients.producer.Callback;


  class SendCallback implements Callback {
          public void onCompletion(RecordMetadata m, Exception e){
              if (e == null){
                System.out.println("Produced a message successfully.");
              } else {
                System.out.println(e.getMessage());
              }
          }
  }

  public class App {
      public static void main(String[] args) throws Exception {
          Properties p = new Properties();
          p.load(new java.io.FileReader("kafka-client.properties"));

          KafkaProducer producer = new KafkaProducer(p);
          ProducerRecord message = new ProducerRecord("topicName", "key", "value");
          SendCallback callback = new SendCallback();
          producer.send(message,callback);
          producer.close();
      }
  }

Compilar o aplicativo

Para compilar esse aplicativo, você precisa de pacotes relacionados aos clientes do Kafka em geral e à lógica de autenticação específica para Google Cloud.

  1. No diretório do projeto de demonstração, você encontra pom.xml com as configurações do Maven para esse projeto. Adicione as seguintes linhas à <dependencies> seção de pom.xml.

    <dependency>
        <groupId>org.apache.kafka</groupId>
        <artifactId>kafka-clients</artifactId>
        <version>3.7.2</version>
    </dependency>
    <dependency>
        <groupId>com.google.cloud.hosted.kafka</groupId>
        <artifactId>managed-kafka-auth-login-handler</artifactId>
        <version>1.0.5</version>
    </dependency>
    
  2. Compile o aplicativo com mvn compile.

Configurar e executar o aplicativo

  1. Consulte o endereço de inicialização do cluster do Kafka seguindo Conferir o endereço de inicialização de um cluster

  2. O produtor espera parâmetros de configuração do cliente em um arquivo chamado kafka-client.properties. Crie esse arquivo no diretório do projeto de demonstração (o diretório que contém pom.xml) com o seguinte conteúdo:

    bootstrap.servers=BOOTSTRAP
    value.serializer=org.apache.kafka.common.serialization.StringSerializer
    key.serializer=org.apache.kafka.common.serialization.StringSerializer
    security.protocol=SASL_SSL
    sasl.mechanism=OAUTHBEARER
    sasl.login.callback.handler.class=com.google.cloud.hosted.kafka.auth.GcpLoginCallbackHandler
    sasl.jaas.config=org.apache.kafka.common.security.oauthbearer.OAuthBearerLoginModule required;
    

    Substitua BOOTSTRAP pelo endereço do cluster, incluindo o número da porta.

  3. Agora você já pode executar o aplicativo:

    mvn exec:java -Dexec.mainClass="com.google.example.App" --quiet
    

Limpar

Para evitar cobranças na conta do Google Cloud pelos recursos usados nesta página, siga as etapas abaixo.

Console

  1. Exclua a instância de VM.

    1. Acesse a página Instâncias da VM.

      Acessar instâncias de VM

    2. Selecione a VM e clique em Excluir.

  2. Exclua o cluster do Kafka.

    1. Acesse a página Serviço gerenciado para Apache Kafka > Clusters.

      Acessar Clusters

    2. Selecione o cluster do Kafka e clique em Excluir.

gcloud

  1. Para excluir a VM, use o gcloud compute instances delete comando.

    gcloud compute instances delete VM_NAME --zone=ZONE
    
  2. Para excluir o cluster do Kafka, use o gcloud managed-kafka clusters delete comando.

    gcloud managed-kafka clusters delete CLUSTER_ID \
      --location=REGION --async
    

A seguir

Apache Kafka® é uma marca registrada da The Apache Software Foundation ou afiliadas nos Estados Unidos e/ou em outros países.