Прохождения

Python

В нашем примере на Python используется фреймворк Flask . Вы можете скачать полный исходный код по предоставленным ссылкам .

При необходимости установите Python 3.7+ и убедитесь, что pip доступен.

python3 -m ensurepip --upgrade

Мы также рекомендуем вам настроить и активировать новую виртуальную среду Python.

python3 -m venv .classroom-addon-env
source .classroom-addon-env/bin/activate

В каждой подпапке с примерами, содержащими пошаговое руководство, есть файл requirements.txt . Вы можете быстро установить необходимые библиотеки с помощью pip . Используйте следующие команды для установки необходимых библиотек для первого пошагового руководства.

cd flask/01-basic-app
pip install -r requirements.txt

Node.js

В нашем примере на Node.js используется фреймворк Express . Вы можете скачать полный исходный код по предоставленным ссылкам .

Для работы этого примера требуется Node.js версии 16.13 или более поздней.

Установите необходимые модули Node.js с помощью npm .

npm install

Java

В нашем примере на Java используется фреймворк Spring Boot . Вы можете скачать полный исходный код по предоставленным ссылкам .

Установите Java 11 или более позднюю версию , если она еще не установлена ​​на вашем компьютере.

Приложения Spring Boot могут использовать Gradle или Maven для сборки и управления зависимостями. В этом примере используется обертка Maven, которая обеспечивает успешную сборку без необходимости установки самого Maven.

В каталоге, куда вы загрузили или клонировали проект, выполните следующие команды, чтобы убедиться, что у вас есть все необходимые компоненты для его запуска.

java --version
./mvnw --version

Или в Windows:

java -version
mvnw.cmd --version

Python

• В корневом каталоге находятся следующие файлы:

  • main.py — точка входа в приложение Python. В этом файле укажите желаемую конфигурацию сервера, а затем запустите его, чтобы запустить сервер.
  • requirements.txt — список модулей Python, необходимых для работы веб-приложения. Их можно установить автоматически с помощью pip install -r requirements.txt .

  • client_secret.json — файл с секретными ключами клиента, загруженный из Google Cloud. Обратите внимание, что он не включен в пример архива; вам следует переименовать и скопировать загруженный файл с учетными данными в корневую директорию каждой директории.

• config.py — параметры конфигурации для сервера Flask.

• Каталог webapp содержит содержимое веб-приложения. Он включает в себя следующее:

• Каталог /templates/ содержит шаблоны Jinja для различных страниц.

• Каталог /static/ содержит изображения, CSS-файлы и вспомогательные JavaScript-файлы.

• routes.py — методы обработчика маршрутов веб-приложения.

• __init__.py — инициализатор для модуля webapp . Этот инициализатор запускает сервер Flask и загружает параметры конфигурации, заданные в config.py .

• Дополнительные файлы, необходимые для выполнения конкретного этапа пошагового руководства.

Node.js

Каждый шаг пошагового руководства находится в отдельной подпапке <step> . Каждый шаг содержит:

• Статические файлы, такие как JavaScript, CSS и изображения, находятся в папке ./<step>/public public.
• Маршрутизаторы Express находятся в папках ./<step>/routes routes.
• HTML-шаблоны находятся в папках ./<step>/views views.
• Серверное приложение находится по адресу ./<step>/app.js .

Java

В каталог проекта входят следующие элементы:

• В директории src.main находится исходный код и конфигурация для успешного запуска приложения. Эта директория включает в себя следующее: + директория java.com.addons.spring содержит файлы Application.java и Controller.java . Файл Application.java отвечает за запуск сервера приложений, а файл Controller.java обрабатывает логику конечных точек. + директория resources содержит директорию templates с HTML- и JavaScript-файлами. Она также содержит файл application.properties , который указывает порт для запуска сервера, путь к файлу хранилища ключей и путь к директории templates . В этом примере файл хранилища ключей находится в директории resources . Вы можете хранить его где угодно, но убедитесь, что вы обновили файл application.properties , указав соответствующий путь.
  • pom.xml содержит информацию, необходимую для сборки проекта и определения требуемых зависимостей.
  • .gitignore содержит имена файлов, которые не следует загружать в Git. Убедитесь, что вы добавили путь к вашему хранилищу ключей в этот файл .gitignore . В приведенном примере это secrets/*.p12 (назначение хранилища ключей обсуждается в разделе ниже). Для второго и последующих шагов также следует указать путь к файлу client_secret.json , чтобы гарантировать, что ваши секреты не будут включены в удаленный репозиторий. Для третьего и последующих шагов следует добавить путь к файлу базы данных H2 и фабрике файловых хранилищ данных. Более подробную информацию о настройке этих хранилищ данных можно найти в третьем шаге, посвященном обработке повторных посещений .
  • mvnw и mvnw.cmd — это исполняемые файлы-оболочки Maven для Unix и Windows соответственно. Например, запуск ./mvnw --version в Unix выводит версию Apache Maven, а также другую информацию.
  • В директории .mvn содержится конфигурация для Maven-оболочки.

Python

Учетные данные OAuth

Создайте и загрузите свои учетные данные OAuth, как описано ранее . Поместите JSON-файл в корневой каталог рядом с файлом запуска сервера вашего приложения.

Настройте сервер

У вас есть несколько вариантов запуска веб-сервера. В конце вашего Python-файла добавьте один из следующих вариантов:

1. Незащищенный localhost . Обратите внимание, что это подходит только для непосредственного тестирования в окне браузера; незащищенные домены нельзя загрузить во фрейм дополнения Classroom.

   if __name__ == "__main__":
     # Disable OAuthlib's HTTPs verification.
     os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "1"
   
     # Run the web app at http://localhost:5000.
     app.run(debug=True)
   

2. Защитите localhost . Для аргумента ssl_context необходимо указать кортеж файлов SSL-ключей.

   if __name__ == "__main__":
     # Run the web app at https://localhost:5000.
     app.run(host="localhost",
             ssl_context=("localhost.pem", "localhost-key.pem"),
             debug=True)
   

3. Сервер Gunicorn . Подходит для серверов, готовых к использованию в производственной среде, или для облачных развертываний. Рекомендуем установить переменную среды PORT для использования с этим вариантом запуска.

   if __name__ == "__main__":
     # Run the web app at https://<your domain>:<server_port>.
     # Defaults to https://<your domain>:8080.
     server_port = os.environ.get("PORT", "8080")
     app.run(debug=True, port=server_port, host="0.0.0.0")
   

Запустите сервер

Запустите ваше приложение на Python, чтобы запустить сервер, как было настроено на предыдущем шаге.

python main.py

Чтобы открыть веб-приложение в браузере и убедиться в его корректной работе, щелкните по появившемуся URL-адресу.

Node.js

Настройте сервер

Для запуска сервера по протоколу HTTPS необходимо создать самосертификат, используемый для запуска приложения по HTTPS. Эти учетные данные следует сохранить в виде файлов sslcert/cert.pem и sslcert/key.pem в корневой папке репозитория. Возможно, вам потребуется добавить эти ключи в связку ключей вашей операционной системы, чтобы ваш браузер мог их принять.

Убедитесь, что расширение *.pem присутствует в вашем файле .gitignore , поскольку вы не хотите добавлять этот файл в Git.

Запустите сервер

Вы можете запустить приложение с помощью следующей команды, заменив step01 на правильный шаг, который вы хотите запустить в качестве сервера (например, step01 для 01-basic-app и step02 для 02-sign-in).

npm run step01

или

npm run step02

Это запускает веб-сервер по адресу https://localhost:5000 .

Вы можете завершить работу сервера, нажав Control + C в терминале.

Java

Настройте сервер

Для запуска сервера по протоколу HTTPS необходимо создать самосертификат, который будет использоваться для запуска приложения по протоколу HTTPS.

Рекомендуется использовать mkcert для локальной разработки. После установки mkcert следующие команды сгенерируют локально сохраненный сертификат для работы по протоколу HTTPS.

mkcert -install
mkcert -pkcs12 -p12-file <path_to_keystore> <domain_name>

В этом примере файл хранилища ключей находится в каталоге ресурсов. Вы можете хранить его где угодно, но обязательно обновите файл application.properties , указав соответствующий путь. Доменное имя — это домен, на котором запущен проект (например, localhost ).

Убедитесь, что расширение *.p12 присутствует в вашем файле .gitignore , поскольку вы не хотите добавлять этот файл в Git.

Запустите сервер

Запустите сервер, выполнив метод main в файле Application.java . Например, в IntelliJ вы можете либо щелкнуть правой кнопкой мыши по Application.java > Run 'Application' в каталоге src/main/java/com/addons/spring , либо открыть файл Application.java и щелкнуть зеленую стрелку слева от сигнатуры метода main(String[] args) . В качестве альтернативы вы можете запустить проект в окне терминала:

./mvnw spring-boot:run

или в Windows:

mvnw.cmd spring-boot:run

Это запустит сервер по https://localhost:5000 или на порту, указанном в application.properties .