從 App Engine 彈性環境應用程式連線到 Redis 執行個體

App Engine 應用程式必須與 Redis 執行個體位於相同的授權網路上,才能存取 Redis 執行個體。

設定

如果您已安裝 Google Cloud CLI 並建立 Redis 執行個體,可以略過這些步驟。

  1. 安裝 gcloud CLI 並初始化:

    gcloud init
    
  2. 按照快速入門指南中的說明建立 Redis 執行個體。請記下 Redis 執行個體的區域、IP 位址和通訊埠。

應用程式範例

這個 HTTP 伺服器應用程式範例會從 App Engine 彈性環境執行個體建立與 Redis 執行個體的連線。

複製所需程式語言的存放區,然後前往包含範例程式碼的資料夾:

Go

git clone https://github.com/GoogleCloudPlatform/golang-samples
cd golang-samples/memorystore/redis

Java

git clone https://github.com/GoogleCloudPlatform/java-docs-samples
cd java-docs-samples/memorystore/redis

Node.js

git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
cd nodejs-docs-samples/memorystore/redis

Python

git clone https://github.com/GoogleCloudPlatform/python-docs-samples
cd python-docs-samples/memorystore/redis

這個範例應用程式會在每次存取 / 端點時遞增 Redis 計數器。

Go

這個應用程式使用 github.com/gomodule/redigo/redis 用戶端。執行下列指令即可安裝:

go get github.com/gomodule/redigo/redis

// Command redis is a basic app that connects to a managed Redis instance.
package main

import (
	"fmt"
	"log"
	"net/http"
	"os"

	"github.com/gomodule/redigo/redis"
)

var redisPool *redis.Pool

func incrementHandler(w http.ResponseWriter, r *http.Request) {
	conn := redisPool.Get()
	defer conn.Close()

	counter, err := redis.Int(conn.Do("INCR", "visits"))
	if err != nil {
		http.Error(w, "Error incrementing visitor counter", http.StatusInternalServerError)
		return
	}
	fmt.Fprintf(w, "Visitor number: %d", counter)
}

func main() {
	redisHost := os.Getenv("REDISHOST")
	redisPort := os.Getenv("REDISPORT")
	redisAddr := fmt.Sprintf("%s:%s", redisHost, redisPort)

	const maxConnections = 10
	redisPool = &redis.Pool{
		MaxIdle: maxConnections,
		Dial:    func() (redis.Conn, error) { return redis.Dial("tcp", redisAddr) },
	}

	http.HandleFunc("/", incrementHandler)

	port := os.Getenv("PORT")
	if port == "" {
		port = "8080"
	}
	log.Printf("Listening on port %s", port)
	if err := http.ListenAndServe(":"+port, nil); err != nil {
		log.Fatal(err)
	}
}

Java

本應用程式以 Jetty 3.1 Servlet 為基礎。

這個程式碼使用 Jedis 程式庫:

<dependency>
  <groupId>redis.clients</groupId>
  <artifactId>jedis</artifactId>
  <version>5.1.0</version>
</dependency>

AppServletContextListener 類別用於建立長效 Redis 連線集區:


package com.example.redis;

import java.io.IOException;
import java.util.Properties;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;

@WebListener
public class AppServletContextListener implements ServletContextListener {

  private Properties config = new Properties();

  private JedisPool createJedisPool() throws IOException {
    String host;
    Integer port;
    config.load(
        Thread.currentThread()
            .getContextClassLoader()
            .getResourceAsStream("application.properties"));
    host = config.getProperty("redis.host");
    port = Integer.valueOf(config.getProperty("redis.port", "6379"));

    JedisPoolConfig poolConfig = new JedisPoolConfig();
    // Default : 8, consider how many concurrent connections into Redis you will need under load
    poolConfig.setMaxTotal(128);

    return new JedisPool(poolConfig, host, port);
  }

  @Override
  public void contextDestroyed(ServletContextEvent event) {
    JedisPool jedisPool = (JedisPool) event.getServletContext().getAttribute("jedisPool");
    if (jedisPool != null) {
      jedisPool.destroy();
      event.getServletContext().setAttribute("jedisPool", null);
    }
  }

  // Run this before web application is started
  @Override
  public void contextInitialized(ServletContextEvent event) {
    JedisPool jedisPool = (JedisPool) event.getServletContext().getAttribute("jedisPool");
    if (jedisPool == null) {
      try {
        jedisPool = createJedisPool();
        event.getServletContext().setAttribute("jedisPool", jedisPool);
      } catch (IOException e) {
        // handle exception
      }
    }
  }
}

VisitCounterServlet 類別是用來遞增 Redis 計數器的 Web Servlet:


package com.example.redis;

import java.io.IOException;
import java.net.SocketException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;

@WebServlet(name = "Track visits", value = "")
public class VisitCounterServlet extends HttpServlet {

  @Override
  public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
    try {
      JedisPool jedisPool = (JedisPool) req.getServletContext().getAttribute("jedisPool");

      if (jedisPool == null) {
        throw new SocketException("Error connecting to Jedis pool");
      }
      Long visits;

      try (Jedis jedis = jedisPool.getResource()) {
        visits = jedis.incr("visits");
      }

      resp.setStatus(HttpServletResponse.SC_OK);
      resp.getWriter().println("Visitor counter: " + String.valueOf(visits));
    } catch (Exception e) {
      resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
    }
  }
}

Node.js

這個應用程式會使用 redis 模組。

{
  "name": "memorystore-redis",
  "description": "An example of using Memorystore(Redis) with Node.js",
  "version": "0.0.1",
  "private": true,
  "license": "Apache Version 2.0",
  "author": "Google Inc.",
  "engines": {
    "node": ">=16.0.0"
  },
  "dependencies": {
    "redis": "^4.0.0"
  }
}

'use strict';
const http = require('http');
const redis = require('redis');

const REDISHOST = process.env.REDISHOST || 'localhost';
const REDISPORT = process.env.REDISPORT || 6379;

const client = redis.createClient(REDISPORT, REDISHOST);
client.on('error', err => console.error('ERR:REDIS:', err));

// create a server
http
  .createServer((req, res) => {
    // increment the visit counter
    client.incr('visits', (err, reply) => {
      if (err) {
        console.log(err);
        res.status(500).send(err.message);
        return;
      }
      res.writeHead(200, {'Content-Type': 'text/plain'});
      res.end(`Visitor number: ${reply}\n`);
    });
  })
  .listen(8080);

Python

此應用程式使用 Flask 提供網頁服務,並使用 redis-py 套件與 Redis 執行個體通訊。

Flask==3.0.3
gunicorn==23.0.0
redis==6.0.0
Werkzeug==3.0.3
import logging
import os

from flask import Flask
import redis

app = Flask(__name__)

redis_host = os.environ.get("REDISHOST", "localhost")
redis_port = int(os.environ.get("REDISPORT", 6379))
redis_client = redis.StrictRedis(host=redis_host, port=redis_port)


@app.route("/")
def index():
    value = redis_client.incr("counter", 1)
    return f"Visitor number: {value}"


@app.errorhandler(500)
def server_error(e):
    logging.exception("An error occurred during a request.")
    return (
        """
    An internal error occurred: <pre>{}</pre>
    See logs for full stacktrace.
    """.format(
            e
        ),
        500,
    )


if __name__ == "__main__":
    # This is used when running locally. Gunicorn is used to run the
    # application on Google App Engine and Cloud Run.
    # See entrypoint in app.yaml or Dockerfile.
    app.run(host="127.0.0.1", port=8080, debug=True)

準備應用程式以進行部署

如要存取 Redis 執行個體,App Engine 執行個體必須部署在與 Redis 執行個體相同的授權網路上,且您必須提供 Redis 執行個體的連線詳細資料。您可以執行下列指令,找出 Redis 執行個體的授權網路、IP 位址和埠:

 gcloud redis instances describe [INSTANCE_ID] --region [REGION]
  1. 建立 App Engine 應用程式

  2. 更新應用程式的設定,指定 Redis 執行個體的 IP 位址、通訊埠和網路:

    Go

    更新 gae_flex_deployment/app.yaml 檔案:

    runtime: go
    env: flex
    
    # Update with Redis instance details
    env_variables:
      REDISHOST: '<REDIS_IP>'
      REDISPORT: '6379'
    
    # Update with Redis instance network name
    network:
      name: default

    詳情請參閱「使用 app.yaml 設定應用程式」。

    Java

    更新 gae_flex_deployment/app.yaml 檔案,指定 Redis 執行個體的網路:

    runtime: java
    env: flex
    
    # Update with Redis instance network name
    network:
      name: default

    並更新 src/main/resources/application.properties 檔案,加入 Redis 執行個體的 IP 位址和通訊埠:

    redis.host=REDIS_HOST_IP
    redis.port=6379

    如要進一步瞭解如何設定應用程式,請參閱「使用 app.yaml 設定應用程式」。

    Node.js

    更新 gae_flex_deployment/app.yaml 檔案:

    runtime: nodejs
    env: flex
    
    # Update with Redis instance details
    env_variables:
      REDISHOST: '<REDIS_IP>'
      REDISPORT: '6379'
    
    # Update with Redis instance network name
    network:
      name: default

    詳情請參閱「使用 app.yaml 設定應用程式」。

    Python

    更新 gae_flex_deployment/app.yaml 檔案:

    runtime: python
    env: flex
    entrypoint: gunicorn -b :$PORT main:app
    
    runtime_config:
      python_version: 3
    
    # Update with Redis instance IP and port
    env_variables:
      REDISHOST: '<REDIS_IP>'
      REDISPORT: '6379'
    
    # Update with Redis instance network name
    network:
      name: default

    詳情請參閱「使用 app.yaml 設定應用程式」。

將應用程式部署至 App Engine 彈性環境

如要部署應用程式,請按照下列步驟操作:

  1. 將必要的設定檔複製到來源目錄:

    Go

    app.yaml 檔案複製到來源目錄:

    cp gae_flex_deployment/app.yaml .
    

    Java

    app.yaml 檔案複製到來源目錄:

    mkdir -p src/main/appengine
    cp gae_flex_deployment/app.yaml src/main/appengine/
    

    Node.js

    app.yaml 檔案複製到來源目錄:

    cp gae_flex_deployment/app.yaml .
    

    Python

    app.yaml 檔案複製到來源目錄:

    cp gae_flex_deployment/app.yaml .
    
  2. 執行部署指令:

    Go

    gcloud app deploy
    

    這可能需要幾分鐘的時間。

    Java

    mvn appengine:deploy
    

    這可能需要幾分鐘的時間。

    Node.js

    gcloud app deploy
    

    這可能需要幾分鐘的時間。

    Python

    gcloud app deploy
    

    這可能需要幾分鐘的時間。

部署作業完成後,請前往以下網址存取應用程式,並將 [PROJECT_ID] 替換為您的 Google Cloud 專案 ID:

https://[PROJECT_ID].appspot.com

每次造訪應用程式時,Redis 執行個體的計數就會增加。