Testa lokalt med hjälp av Azure Event Hubs-emulatorn

Den här artikeln sammanfattar stegen för att utveckla och testa lokalt med hjälp av Azure Event Hubs-emulatorn.

Förutsättningar

• Docker Desktop
• Minimikrav för maskinvara:
  • 2 GB RAM-minne
  • 5 GB diskutrymme
• konfiguration av Windows-undersystem för Linux (WSL) (endast för Windows):
  • Installera WSL
  • Konfigurera Docker att använda WSL

Kommentar

Innan du fortsätter med stegen i den här artikeln kontrollerar du att Docker Desktop fungerar i bakgrunden.

Kör emulatorn

Om du vill köra Event Hubs-emulatorn kan du använda ett automatiserat skript eller en Linux-container:

Automatiserat skript

Innan du kör ett automatiserat skript klonar du emulatorns GitHub-installationsplats lokalt.

Windows

Använd följande steg för att köra Event Hubs-emulatorn lokalt i Windows.

1. Öppna PowerShell och navigera till katalogen där den gemensamma skriptmappen klonas med hjälp av cd:

   cd <path to your common scripts folder> # Update this path
   
   

2. Utfärda wsl-kommandot för att öppna WSL i den här katalogen.

   wsl
   
   

3. Kör installationsskriptet./LaunchEmulator.sh Att köra skriptet innehåller två containrar: Event Hubs-emulatorn och Azurite (ett beroende för emulatorn).

   ./Launchemulator.sh
   
   
   

Linux och macOS

Så här kör du Event Hubs-emulatorn lokalt i Linux eller macOS:

• Kör installationsskriptet LaunchEmulator.sh. När skriptet körs skapas två containrar: Event Hubs-emulatorn och Azurite (ett beroende för emulatorn).

Docker (Linux-container)

1. Om du vill starta emulatorn anger du en konfiguration för de entiteter som du vill använda. Spara följande JSON-fil lokalt somconfig.json:

   {
       "UserConfig": {
           "NamespaceConfig": [
           {
               "Type": "EventHub",
               "Name": "emulatorNs1",
               "Entities": [
               {
                   "Name": "eh1",
                   "PartitionCount": "2",
                   "ConsumerGroups": [
                   {
                       "Name": "cg1"
                   }
                   ]
               }
               ]
           }
           ], 
           "LoggingConfig": {
               "Type": "File"
           }
       }
   }
   
   

2. Om du vill starta containrar för Event Hubs-emulatorn sparar du följande . yaml-fil som docker-compose.yaml.

name: microsoft-azure-eventhubs
services:
  emulator:
    container_name: "eventhubs-emulator"
    image: "mcr.microsoft.com/azure-messaging/eventhubs-emulator:latest"
    pull_policy: always
    volumes:
      - "${CONFIG_PATH}:/Eventhubs_Emulator/ConfigFiles/Config.json"
    ports:
      - "5672:5672"
      - "9092:9092"
      - "5300:5300"
    environment:
      BLOB_SERVER: azurite
      METADATA_SERVER: azurite
      ACCEPT_EULA: ${ACCEPT_EULA}
    depends_on:
      - azurite
    networks:
      eh-emulator:
        aliases:
          - "eventhubs-emulator"
  azurite:
    container_name: "azurite"
    image: "mcr.microsoft.com/azure-storage/azurite:latest"
    pull_policy: always
    ports:
      - "10000:10000"
      - "10001:10001"
      - "10002:10002"
    networks:
      eh-emulator:
        aliases:
          - "azurite"
networks:
  eh-emulator:

3. Skapa en .env-fil för att deklarera miljövariablerna för Event Hubs-emulatorn:

   # Centralized environment variables store for docker-compose
   
   # 1. CONFIG_PATH: Path to config.json file
   CONFIG_PATH="<Replace with path to config.json file>" 
   
   # 2. ACCEPT_EULA: Pass 'Y' to accept license terms. 
   ACCEPT_EULA="N"
   
   

   Argumentet ACCEPT_EULA bekräftar licensvillkoren för Microsoft-programvara. Se till att placera .env-filen i samma katalog som filen docker-compose.yaml .

   Viktigt!

   När du anger filsökvägar i Windows använder du dubbla omvänt snedstreck (\\) i stället för enkla omvänt snedstreck (\) för att undvika förvirring med escape-tecken.

4. Kör följande kommando för att köra emulatorn:

    docker compose -f <PathToDockerComposeFile> up -d
   

När stegen har slutförts kan du hitta containrarna som körs i Docker.

Interagera med emulatorn

Som standard använder emulatorn config.json konfigurationsfil. Du kan konfigurera entiteter (Event Hubs/Kafka-ämnen) genom att göra ändringar i konfigurationsfilen. Mer information finns i Göra konfigurationsändringar

Du kan använda följande anslutningssträng för att ansluta till Event Hubs-emulatorn:

• När emulatorcontainern och det interagerande programmet körs internt på den lokala datorn använder du följande anslutningssträng:

"Endpoint=sb://localhost;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

• Program (containerbaserade/icke-containerbaserade) på den olika datorn och samma lokala nätverk kan interagera med emulatorn med hjälp av datorns IPv4-adress. Använd följande anslutningssträng:

"Endpoint=sb://192.168.y.z;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

• Programcontainrar i samma bryggnätverk kan interagera med emulatorn med hjälp av dess alias eller IP. Följande anslutningssträng förutsätter att namnet på emulatorn har standardvärdet "eventhubs-emulator":

"Endpoint=sb://eventhubs-emulator;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

• Programcontainrar i det olika bryggnätverket kan interagera med emulatorn med hjälp av "host.docker.internal" som värd. Använd följande anslutningssträng:

"Endpoint=sb://host.docker.internal;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

Använda Kafka

När du interagerar med Kafka måste du ange producent- och konsumentkonfigurationen enligt följande:

        {
            BootstrapServers =  //Value of bootstrap servers would depend on kind of connection string being used
            SecurityProtocol = SecurityProtocol.SaslPlaintext,
            SaslMechanism = SaslMechanism.Plain,
            SaslUsername = "$ConnectionString",
            SaslPassword = //Value of connection string would depend on topology
        };

Värdet för BootstrapServers och SaslPassword beror på din konfigurationstopologi. Mer information finns i Avsnittet Interagera med emulatorn .

Viktigt!

När du använder Kafka är endast producent- och konsument-API:er kompatibla med Event Hubs-emulatorn.

Använda AMQP

Med de senaste klient-SDK-versionerna kan du interagera med emulatorn på olika programmeringsspråk. Mer information finns i Klient-SDK:er.

Kom igång genom att läsa Event Hubs-emulatorexempel på GitHub.

Relaterat innehåll

Översikt över Azure Event Hubs-emulatorn