從 Cloud Run 服務連線至 Redis 執行個體

您可以透過直接虛擬私有雲輸出，從 Cloud Run 連線至 Redis 執行個體。

重要事項：建議您使用直接虛擬私有雲 egress，因為這樣就不需要管理連接器執行個體，可降低延遲時間、提高處理量並節省費用。

您也可以使用無伺服器虛擬私有雲存取，從 Cloud Run 連線至 Redis 執行個體。如要使用無伺服器虛擬私有雲存取連接器，請參閱「具有連接器的虛擬私有雲」。

設定

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

1. 安裝 gcloud CLI 並初始化：

   gcloud init
   

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

準備設定虛擬私有雲網路輸出

如要連線至 Redis 執行個體，Cloud Run 服務必須有權存取 Redis 執行個體的授權虛擬私有雲網路。

如要找出這個網路的名稱，請執行下列指令：

    gcloud redis instances describe INSTANCE_ID --region REGION --format "value(authorizedNetwork)"

記下網路名稱。

應用程式範例

本 HTTP 伺服器應用程式範例會從 Cloud Run 服務與 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@latest

應用程式範例：

// 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 計數器的網頁 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 模組。以下是 package.json 範例檔案：

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

將應用程式部署至 Cloud Run

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

1. 將 Dockerfile 複製到來源目錄：

   cp cloud_run_deployment/Dockerfile .
   

2. 執行下列指令，使用 Cloud Build 建構容器映像檔：

   gcloud artifacts repositories create --location REPO_REGION --repository-format=docker REPO_ID
   gcloud builds submit --pack image=REPO_REGION-docker.pkg.dev/PROJECT_ID/REPO_ID/visit-counter:v1
   

3. 執行下列指令，將容器部署至 Cloud Run：

   gcloud run deploy \
     --image REPO_REGION-docker.pkg.dev/PROJECT_ID/REPO_ID/visit-counter:v1 \
     --allow-unauthenticated \
     --region REGION \
     --network NETWORK \
     --subnet SUBNET \
     --set-env-vars REDISHOST=REDIS_IP,REDISPORT=REDIS_PORT
   

   其中：

   • REPO_REGION 是存放區的地區。
   • REPO_ID 是包含應用程式映像檔的存放區名稱。
   • PROJECT_ID 是專案 ID。 Google Cloud
   • REGION 是 Redis 執行個體所在的地區。
   • NETWORK 是 Redis 執行個體所附加的授權虛擬私有雲網路名稱。
   • SUBNET 是子網路的名稱。子網路不得小於 /26。直接虛擬私有雲輸出支援 IPv4 範圍 RFC 1918、RFC 6598 和 E 類。
   • REDIS_IP 和 REDIS_PORT 是 Redis 執行個體的 IP 位址和通訊埠編號。

部署作業順利完成後，指令列會顯示 Cloud Run 服務的網址。在網路瀏覽器中前往這個網址 (或使用 curl 等工具)，每次造訪服務時，Redis 執行個體上的計數就會增加。