Codificar e testar o Azure Functions localmente

Sempre que possível, você deve criar e validar seu projeto de código do Azure Functions em um ambiente de desenvolvimento local. O Azure Functions Core Tools fornece uma versão de runtime local do Azure Functions que se integra às ferramentas de desenvolvimento populares para um desenvolvimento integrado, depuração e implantações. Suas funções locais podem até mesmo se conectar aos serviços dinâmicos do Azure.

Este artigo fornece algumas diretrizes compartilhadas para o desenvolvimento local, como trabalhar com o arquivolocal.settings.json. Ele também se vincula a diretrizes específicas do ambiente de desenvolvimento.

Ambientes de desenvolvimento locais

A maneira como você desenvolve funções em seu computador local depende de seu idioma e preferências de ferramentas. Escolha seu idioma preferido na parte superior do artigo.

Você pode usar esses ambientes de desenvolvimento para codificar funções localmente em seu idioma preferido:

Cada um desses ambientes de desenvolvimento local permite criar projetos de aplicativos de funções e usar modelos de funções predefinidos para criar novas funções. Cada um usa as Ferramentas Essenciais para que você possa testar e depurar suas funções com relação ao runtime do Functions em seu próprio computador, assim como faria com qualquer outro aplicativo. Você também pode publicar seu projeto de aplicativo de funções de qualquer um desses ambientes no Azure.

Arquivos de projeto locais

Um diretório de projeto do Functions contém os seguintes arquivos na pasta raiz do projeto, independentemente da linguagem:

Outros arquivos no projeto dependem da linguagem e das funções específicas. Para saber mais, confira o guia do desenvolvedor em seu idioma.

Arquivo de configurações local

O local.settings.json arquivo armazena as configurações do aplicativo e das ferramentas de desenvolvimento locais. As configurações no arquivo local.settings.json são usadas somente quando você executa o projeto localmente. Ao publicar seu projeto no Azure, adicione também as configurações necessárias às configurações do aplicativo para o aplicativo de funções.

O local.settings.json arquivo tem essa estrutura:

{
  "IsEncrypted": false,
  "Values": {
    "FUNCTIONS_WORKER_RUNTIME": "<language worker>",
    "AzureWebJobsStorage": "<connection-string>",
    "MyBindingConnection": "<binding-connection-string>",
    "AzureWebJobs.HttpExample.Disabled": "true"
  },
  "Host": {
    "LocalHttpPort": 7071,
    "CORS": "*",
    "CORSCredentials": false
  },
  "ConnectionStrings": {
    "SQLConnectionString": "<sqlclient-connection-string>"
  }
}

Essas configurações têm suporte quando você executa projetos localmente:

As seguintes configurações de aplicativo podem ser incluídas na matriz Values ao serem executadas localmente:

Sincronizar configurações

Ao desenvolver suas funções localmente, quaisquer configurações locais exigidas pelo aplicativo também devem estar presentes nas configurações do aplicativo de funções no qual o código é implantado. Talvez você também precise baixar as configurações atuais do aplicativo de funções para seu projeto local. Embora você possa definir manualmente as configurações do aplicativo no portal do Azure, as ferramentas a seguir também permitem sincronizar as configurações do aplicativo com as configurações locais em seu projeto:

• Código do Visual Studio
• Visual Studio
• Ferramentas principais do Azure Functions

Gatilhos e associações

Ao desenvolver suas funções localmente, você precisa levar em consideração os comportamentos de gatilho e associação. Para gatilhos HTTP, você pode chamar o ponto de extremidade HTTP no computador local, usando http://localhost/. Para funções não acionadas por HTTP, há várias opções para serem executadas localmente:

• A maneira mais fácil de testar associações durante o desenvolvimento local é usar cadeias de conexão direcionadas aos serviços dinâmicos do Azure. Você pode ter como alvo serviços dinâmicos adicionando as configurações de cadeia de conexão apropriadas na matriz Values no arquivo local.settings.json. Quando você faz isso, as execuções locais durante o teste podem afetar seus serviços de produção. Em vez disso, considere a configuração de serviços separados a serem usados durante o desenvolvimento e o teste e, em seguida, alterne para serviços diferentes durante a produção.
• Para gatilhos baseados em armazenamento, você pode usar um emulador de armazenamento local.
• Você pode executar manualmente funções de acionamento não HTTP usando endpoints especiais de administrador. Para obter mais informações, consulte Executar manualmente uma função não disparada por HTTP.

Durante o teste local, você deve executar o host fornecido pelo Core Tools (func.exe) localmente. Para obter mais informações, consulte Azure Functions Core Tools.

Ferramentas de Teste de HTTP

Durante o desenvolvimento, é fácil chamar qualquer um dos pontos de extremidade de função de um navegador da Web quando eles dão suporte ao método HTTP GET. No entanto, para outros métodos HTTP que dão suporte a cargas, como POST ou PUT, você precisa usar uma ferramenta de teste de HTTP para criar e enviar essas solicitações HTTP para seus pontos de extremidade de função.

Você pode manter seus dados seguros escolhendo uma ferramenta de teste de HTTP que funciona offline ou localmente, não sincroniza seus dados com a nuvem e não exige que você entre em uma conta online. Algumas ferramentas também podem proteger seus dados contra exposição acidental implementando recursos de segurança específicos.

Evite usar ferramentas que armazenam centralmente seu histórico de solicitação HTTP (incluindo informações confidenciais), que não seguem as práticas recomendadas de segurança ou não respeitam as preocupações de privacidade de dados.

Considere usar uma dessas ferramentas para enviar solicitações HTTP com segurança para seus pontos de extremidade de função:

• Visual Studio Code com uma extensão do Visual Studio Marketplace, como Cliente REST
• Invoke-RestMethod do PowerShell
• Microsoft Edge – ferramenta Console de Rede
• Bruno
• curl

Emulador de armazenamento local

Durante o desenvolvimento local, você pode usar o emulador Azurite local ao testar funções com associações do Armazenamento do Azure (Armazenamento de Filas, Armazenamento de Blobs e Armazenamento de Tabelas), sem precisar se conectar aos serviços de armazenamento remoto. O Azurite se integra ao Visual Studio Code e ao Visual Studio, e você também pode executá-lo no prompt de comando usando o npm. Para obter mais informações, consulte Usar o emulador Azurite para desenvolvimento local do armazenamento do Azure.

A seguinte configuração na coleção Values do arquivo local.settings.json informa ao host local do Functions para usar o Azurite para a conexão AzureWebJobsStorage padrão:

"AzureWebJobsStorage": "UseDevelopmentStorage=true"

Com esse valor de configuração, qualquer gatilho ou associação do Armazenamento do Azure que usa AzureWebJobsStorage como conexão se conecta ao Azurite ao ser executado localmente. Tenha essas considerações em mente ao usar a emulação de armazenamento durante a execução local:

• Você precisa ter o Azurite instalado e em execução.
• Você deve testá-lo com uma conexão de armazenamento real com os serviços do Azure antes de publicá-lo no Azure.
• Ao publicar seu projeto, não publique a configuração AzureWebJobsStorage como UseDevelopmentStorage=true. No Azure, a configuração AzureWebJobsStorage precisa ser sempre a cadeia de conexão da conta de armazenamento usada pelo aplicativo de funções. Para obter mais informações, consulte AzureWebJobsStorage.

Artigos relacionados

• Para saber mais sobre o desenvolvimento local de funções usando o Visual Studio Code em um computador Mac, Linux ou Windows, consulte Desenvolver o Azure Functions usando o Visual Studio Code.
• Para saber mais sobre como desenvolver funções do prompt de comando ou do terminal, consulte Trabalhar com as Ferramentas Essenciais do Azure Functions.