Hướng dẫn từng bước

Python

Ví dụ về Python của chúng tôi sử dụng khung Flask. Bạn có thể tải mã nguồn đầy đủ xuống từ các đường liên kết được cung cấp.

Nếu cần, hãy cài đặt Python 3.7+ và đảm bảo rằng pip có sẵn.

python3 -m ensurepip --upgrade

Bạn cũng nên thiết lập và kích hoạt một môi trường ảo Python mới.

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

Có một requirements.txt trong mỗi thư mục con hướng dẫn trong các ví dụ đã tải xuống. Bạn có thể nhanh chóng cài đặt các thư viện bắt buộc bằng cách sử dụng pip. Sử dụng các lệnh sau để cài đặt các thư viện cần thiết cho hướng dẫn đầu tiên.

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

Node.js

Ví dụ Node.js của chúng tôi sử dụng khung Express. Bạn có thể tải mã nguồn hoàn chỉnh xuống từ đường liên kết được cung cấp.

Ví dụ này yêu cầu phiên bản Node.js v16.13 trở lên.

Cài đặt các mô-đun nút bắt buộc bằng npm.

npm install

Java

Ví dụ về Java của chúng tôi sử dụng khung Spring Boot. Bạn có thể tải mã nguồn hoàn chỉnh xuống từ đường liên kết được cung cấp.

Cài đặt Java 11 trở lên nếu bạn chưa cài đặt trên máy.

Các ứng dụng Spring Boot có thể sử dụng Gradle hoặc Maven để xử lý bản dựng và quản lý các phần phụ thuộc. Ví dụ này bao gồm trình bao bọc Maven đảm bảo bản dựng thành công mà không yêu cầu bạn phải tự cài đặt Maven.

Trong thư mục mà bạn đã tải xuống hoặc sao chép dự án, hãy chạy các lệnh sau nhằm đảm bảo bạn có điều kiện tiên quyết để chạy dự án.

java --version
./mvnw --version

Hoặc trên Windows:

java -version
mvnw.cmd --version

Python

• Thư mục gốc chứa các tệp sau:

  • main.py – điểm truy cập của ứng dụng Python. Chỉ định cấu hình máy chủ mà bạn muốn sử dụng trong tệp này, rồi chạy cấu hình đó để khởi động máy chủ.
  • requirements.txt – các mô-đun Python cần thiết để chạy ứng dụng web. Bạn có thể tự động cài đặt các mô-đun này bằng pip install -r requirements.txt.

  • client_secret.json – tệp mật khẩu ứng dụng khách được tải xuống từ Google Cloud. Xin lưu ý rằng tệp này không có trong tệp lưu trữ mẫu; bạn nên đổi tên và sao chép tệp thông tin xác thực đã tải xuống vào mỗi thư mục gốc.

• config.py – các tuỳ chọn cấu hình cho máy chủ Flask.

• Thư mục webapp chứa nội dung cho ứng dụng web. Gói này bao gồm những công cụ sau:

• Thư mục /templates/ có các mẫu Jinja cho nhiều trang.

• Thư mục /static/ chứa hình ảnh, CSS và các tệp JavaScript phụ.

• routes.py – các phương thức xử lý cho các tuyến ứng dụng web.

• __init__.py – trình khởi tạo cho mô-đun webapp. Trình khởi động này sẽ khởi động máy chủ Flask và tải các tuỳ chọn cấu hình được đặt trong config.py.

• Các tệp bổ sung theo yêu cầu của một bước cụ thể trong hướng dẫn.

Node.js

Bạn có thể tìm thấy từng bước của hướng dẫn trong thư mục con <step> riêng. Mỗi bước bao gồm:

• Bạn có thể tìm thấy các tệp tĩnh như JavaScript, CSS và hình ảnh trong thư mục ./<step>/public.
• Bạn có thể tìm thấy bộ định tuyến Express trong thư mục ./<step>/routes.
• Bạn có thể tìm thấy các mẫu HTML trong thư mục ./<step>/views.
• Ứng dụng máy chủ là ./<step>/app.js.

Java

Thư mục dự án bao gồm các phần sau:

• Thư mục src.main chứa mã nguồn và cấu hình để chạy ứng dụng thành công. Thư mục này bao gồm: + Thư mục java.com.addons.spring chứa tệp Application.java và Controller.java. Tệp Application.java chịu trách nhiệm chạy máy chủ ứng dụng trong khi tệp Controller.java xử lý logic điểm cuối. + Thư mục resources chứa thư mục templates với các tệp HTML và JavaScript. Tệp này cũng chứa tệp application.properties chỉ định cổng để chạy máy chủ, đường dẫn đến tệp kho khoá và đường dẫn đến thư mục templates. Ví dụ này bao gồm tệp kho khoá trong thư mục resources. Bạn có thể lưu trữ tệp này ở bất cứ đâu bạn muốn, nhưng hãy đảm bảo rằng bạn cập nhật tệp application.properties bằng đường dẫn tương ứng.
  • pom.xml chứa thông tin cần thiết để xây dựng dự án và xác định các phần phụ thuộc bắt buộc.
  • .gitignore chứa tên tệp không được tải lên git. Hãy đảm bảo rằng bạn thêm đường dẫn vào kho khoá của mình trong .gitignore này. Trong ví dụ được cung cấp, đây là secrets/*.p12 (mục đích của kho khoá được thảo luận trong phần bên dưới). Đối với hướng dẫn 2 trở lên, bạn cũng nên thêm đường dẫn đến tệp client_secret.json để đảm bảo rằng bạn không đưa các thông tin bảo mật vào kho lưu trữ từ xa. Đối với hướng dẫn từng bước 3 trở lên, bạn nên thêm đường dẫn vào tệp cơ sở dữ liệu H2 và nhà máy kho dữ liệu của tệp. Bạn có thể xem thêm thông tin về cách thiết lập các kho dữ liệu này trong hướng dẫn từng bước thứ ba về cách xử lý lượt truy cập lặp lại.
  • mvnw và mvnw.cmd là các tệp thực thi trình bao bọc Maven tương ứng cho Unix và Windows. Ví dụ: việc chạy ./mvnw --version trên Unix sẽ tạo ra phiên bản Apache Maven và nhiều thông tin khác.
  • Thư mục .mvn chứa cấu hình cho trình bao bọc Maven.

Python

Thông tin xác thực OAuth

Tạo và tải thông tin đăng nhập OAuth xuống như mô tả trước đó. Đặt tệp JSON vào thư mục gốc cùng với tệp chạy máy chủ của ứng dụng.

Định cấu hình máy chủ

Bạn có một số lựa chọn để chạy máy chủ web. Ở cuối tệp Python, hãy thêm một trong những nội dung sau:

1. localhost không an toàn. Xin lưu ý rằng phương thức này chỉ phù hợp để kiểm thử trực tiếp trong cửa sổ trình duyệt; bạn không thể tải các miền không an toàn trong iframe của tiện ích bổ sung Lớp học.

   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. Bảo mật localhost. Bạn phải chỉ định một bộ dữ liệu gồm các tệp khoá SSL cho đối số ssl_context.

   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. Máy chủ Gunicorn. Cách này phù hợp với máy chủ sẵn sàng phát hành công khai hoặc triển khai trên đám mây. Bạn nên đặt biến môi trường PORT để sử dụng với tuỳ chọn khởi chạy này.

   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")
   

Khởi chạy máy chủ

Chạy ứng dụng Python để chạy máy chủ như đã định cấu hình trong bước trước.

python main.py

Nhấp vào URL xuất hiện để xem ứng dụng web của bạn trong trình duyệt và xác nhận rằng ứng dụng đó đang chạy đúng cách.

Node.js

Định cấu hình máy chủ

Để chạy máy chủ qua HTTPS, bạn cần tạo một chứng chỉ tự chứng nhận dùng để chạy ứng dụng qua HTTPS. Bạn nên lưu các thông tin xác thực này dưới dạng sslcert/cert.pem và sslcert/key.pem trong thư mục gốc của kho lưu trữ. Bạn có thể cần thêm các khoá này vào chuỗi khoá của hệ điều hành để trình duyệt chấp nhận các khoá đó.

Hãy đảm bảo rằng *.pem nằm trong tệp .gitignore vì bạn không muốn xác nhận tệp này vào git.

Khởi chạy máy chủ

Bạn có thể chạy ứng dụng bằng lệnh sau, thay thế step01 cho bước chính xác mà bạn muốn chạy dưới dạng máy chủ (ví dụ: step01 cho 01-basic-app và step02 cho 02-sign-in).

npm run step01

hoặc

npm run step02

Thao tác này sẽ khởi chạy máy chủ web tại https://localhost:5000.

Bạn có thể chấm dứt máy chủ bằng Control + C trong thiết bị đầu cuối.

Java

Định cấu hình máy chủ

Để chạy máy chủ qua HTTPS, bạn cần tạo một chứng chỉ tự ký dùng để chạy ứng dụng qua HTTPS.

Cân nhắc sử dụng mkcert để phát triển cục bộ. Sau khi bạn cài đặt mkcert, các lệnh sau sẽ tạo một chứng chỉ được lưu trữ cục bộ để chạy qua HTTPS.

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

Ví dụ này bao gồm tệp kho khoá trong thư mục tài nguyên. Bạn có thể lưu trữ tệp này ở bất cứ đâu bạn muốn, nhưng hãy đảm bảo rằng bạn cập nhật tệp application.properties theo đường dẫn tương ứng. Tên miền là miền mà bạn chạy dự án (ví dụ: localhost).

Đảm bảo rằng *.p12 nằm trong tệp .gitignore vì bạn không muốn gửi tệp đó vào git.

Khởi chạy máy chủ

Chạy máy chủ bằng cách chạy phương thức main trong tệp Application.java. Ví dụ: trong IntelliJ, bạn có thể nhấp chuột phải vào Application.java > Run 'Application' trong thư mục src/main/java/com/addons/spring hoặc mở tệp Application.java để nhấp vào mũi tên màu xanh lục ở bên trái chữ ký phương thức main(String[] args). Ngoài ra, bạn có thể chạy dự án trong cửa sổ dòng lệnh:

./mvnw spring-boot:run

hoặc trên Windows:

mvnw.cmd spring-boot:run

Thao tác này sẽ khởi chạy máy chủ tại https://localhost:5000 hoặc tại cổng mà bạn đã chỉ định trong application.properties.