Usar o servidor de desenvolvimento local

Pode usar o servidor de desenvolvimento local para simular a execução da sua aplicação do App Engine em produção, bem como usá-lo para aceder aos serviços incluídos do App Engine.

O ambiente simulado aplica algumas restrições da sandbox, como funções de sistema restritas e importações de módulos PHP 5, mas não outras, como limites de tempo ou quotas de pedidos.

O servidor de desenvolvimento local também simula os serviços fornecidos pelas bibliotecas no SDK do App Engine, incluindo o armazenamento de dados, a cache de memória e as filas de tarefas, executando as respetivas tarefas localmente. Quando a sua aplicação está a ser executada no servidor de desenvolvimento, continua a poder fazer chamadas de API remotas para a infraestrutura de produção através dos pontos finais HTTP das APIs Google.

Antes de começar

Uma vez que o PHP 5 atingiu o fim do apoio técnico, já não pode usar a versão mais recente do dev_appserver.py para executar localmente as suas aplicações. Para transferir uma versão arquivada do devapp_server.py, siga estes passos:

  1. A partir do arquivo, transfira a pasta comprimida que contém o dev_appserver.py servidor para tempos de execução que atingiram o fim do apoio técnico.

  2. Extraia o conteúdo do diretório para o seu sistema de ficheiros local, como o diretório /home. Pode encontrar o dev_appserver.py no diretório google_appengine/.

Configure o servidor de desenvolvimento local

Para executar a ferramenta de servidor de desenvolvimento local, tem de configurar o seguinte:

  1. Verifique se instalou um intérprete do Python 2 da versão 2.7.12 ou posterior.

  2. Defina a variável de ambiente DEVAPPSERVER_ROOT na sua shell para o caminho do seu intérprete do Python 2.

Execute o servidor de desenvolvimento local

Depois de configurar o servidor de desenvolvimento local e criar o ficheiro de configuração app.yaml para a sua app, pode usar o comando dev_appserver.py para executar a app localmente.

Para iniciar o servidor de desenvolvimento local:

  1. No diretório que contém o ficheiro de configuração app.yaml, execute o comando dev_appserver.py.

    Windows / macOS

    Especifique o caminho do diretório para a sua app, por exemplo: 

         python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py [PATH_TO_YOUR_APP]

    Em alternativa, pode especificar o ficheiro de configuração de um serviço específico, por exemplo: 

         python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py app.yaml

    Para alterar a porta, inclua a opção --port: 

         python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py --port=9999 [PATH_TO_YOUR_APP]

    Substitua [DEVAPPSERVER_ROOT] pelo caminho para a pasta onde extrai a versão arquivada de devapp_server.py.

    Linux / cust. php-cgi

    Se estiver no Linux ou quiser usar uma versão personalizada do php-cgi, tem de especificar o caminho do diretório para o php-cgi:

    1. Crie a sua própria versão da extensão PHP do App Engine na sua máquina local.

    2. Inicie o servidor de desenvolvimento local com as opções --php_executable_path e --php_gae_extension_path:

       python2 DEVAPPSERVER_ROOT/google_appengine/dev_appserver.py --php_executable_path=[PATH_TO_PHP_CGI] --php_gae_extension_path=[PATH_TO_APPENGINE_EXTENSION] app.yaml

      Substituição:

      • DEVAPPSERVER_ROOT com o caminho para a pasta onde extrai a versão arquivada do devapp_server.py.
      • --php_executable_path com a localização do intérprete PHP.
      • --php_gae_extension_path com a localização do ficheiro gae_runtime_module.so que criou no passo anterior.

    Para saber mais acerca das opções de comando dev_appserver.py, consulte as opções do servidor de desenvolvimento local.

  2. O servidor de programação local está agora em execução e a ouvir pedidos. Pode visitar http://localhost:8080/ no seu navegador de Internet para ver a app em ação.

    Se especificou uma porta personalizada com a opção --port, lembre-se de abrir o seu navegador nessa porta.

Para parar o servidor local a partir da linha de comandos, prima o seguinte:

  • macOS ou Linux: Control+C
  • Windows: Control+Break

Especifique os IDs das aplicações

Para aceder ao ID da app no servidor local, por exemplo, para roubar um endereço de email, use a função AppIdentityService::getApplicationId. Para obter o nome do anfitrião da app em execução, use a função AppIdentityService::getDefaultVersionHostname.

Detetar o ambiente de tempo de execução da aplicação

Para determinar se o seu código está a ser executado em produção ou no servidor de desenvolvimento local, pode verificar o valor da variável de ambiente SERVER_SOFTWARE:

if (strpos(getenv('SERVER_SOFTWARE'), 'Development') === 0){
  echo 'Local development server';
} else {
  echo 'Production';
}

Armazene dados

O App Engine para PHP suporta a leitura e a escrita no Cloud Storage através da API streams do PHP. Pode ler e escrever no Cloud Storage especificando um URI do Cloud Storage (gs://) quando usar qualquer função PHP que suporte a implementação de Streams PHP, como fopen, fwrite ou file_get_contents.

O servidor de desenvolvimento local emula esta funcionalidade lendo e escrevendo em ficheiros locais temporários que são preservados entre pedidos.

Explore o Armazenamento de dados local

Se a sua app tiver escrito dados no Datastore local através do servidor de desenvolvimento local, pode procurá-los na consola de desenvolvimento local.

Para procurar no Armazenamento de dados local:

  1. Inicie o servidor de programação.

  2. Aceda ao Datastore Viewer na consola de desenvolvimento local. (O URL é http://localhost:8000/datastore.)

  3. Ver o conteúdo do seu Armazenamento de dados local.

Use o serviço Users

O App Engine fornece um serviço de utilizadores para simplificar a autenticação e a autorização da sua aplicação. O servidor de desenvolvimento local simula o comportamento das Contas Google com as suas próprias páginas de início e fim de sessão. Quando executadas no servidor de desenvolvimento local, as funções createLoginURL e createLogoutURL devolvem URLs para /_ah/login e /_ah/logout no servidor local.

Use o Mail

O servidor de desenvolvimento local pode enviar emails para chamadas ao serviço de email do App Engine através de um servidor SMTP ou de uma instalação local do Sendmail.

Usar o SMTP

Para ativar o suporte de correio com um servidor SMTP, invoque dev_appserver.py da seguinte forma:

   python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py --smtp_host=smtp.example.com --smtp_port=25 \
    --smtp_user=ajohnson --smtp_password=k1tt3ns [PATH_TO_YOUR_APP]

Substituição:

  • [DEVAPPSERVER_ROOT] com o caminho para a pasta onde extrai a versão arquivada do devapp_server.py.
  • --smtp_host, --smtp_port, --smtp_user e --smtp_password opções com os seus próprios valores de configuração.

Usar o Sendmail

Para ativar o apoio técnico por email com o Sendmail, invoque dev_appserver.py da seguinte forma:

   python2 [DEVAPPSERVER_ROOT]/google_appengine/dev_appserver.py --enable_sendmail=yes [PATH_TO_YOUR_APP]

Substitua [DEVAPPSERVER_ROOT] pelo caminho para a pasta onde extraiu a versão arquivada de devapp_server.py.

O servidor local usa o comando sendmail para enviar mensagens de email com a configuração predefinida da sua instalação.

Use a obtenção de URLs

Quando a sua aplicação usa a API URL Fetch para fazer um pedido HTTP, o servidor de desenvolvimento local faz o pedido diretamente a partir do seu computador. O comportamento da obtenção de URLs no servidor local pode diferir do App Engine de produção se usar um servidor proxy para aceder a Websites.

Depure localmente com o XDebug

Se tiver um depurador compatível com o depurador XDebug e tiver o módulo xdebug instalado, pode usar o XDebug com o servidor de desenvolvimento local.

Para ativar o XDebug no servidor de desenvolvimento no Linux ou macOS:

  1. Exporte a variável de ambiente XDEBUG_CONFIG com uma idekey para que o seu IDE se ligue a

    export XDEBUG_CONFIG="idekey=netbeans-xdebug remote_host=localhost"

  2. Invoque o servidor de programação com --php_remote_debugging=yes