Skip to content

Latest commit

 

History

History
210 lines (144 loc) · 7.27 KB

cache-go-get-started.md

File metadata and controls

210 lines (144 loc) · 7.27 KB
title description author ms.author ms.service ms.devlang ms.topic ms.date ms.custom
Use Azure Cache for Redis with Go
In this quickstart, you learn how to create a Go app that uses Azure Cache for Redis.
flang-msft
franlanglois
cache
golang
quickstart
09/09/2021
mode-api

Quickstart: Use Azure Cache for Redis with Go

In this article, you learn how to build a REST API in Go that stores and retrieves user information backed by a HASH data structure in Azure Cache for Redis.

Skip to the code on GitHub

If you want to skip straight to the code, see the Go quickstart on GitHub.

Prerequisites

Create an Azure Cache for Redis instance

[!INCLUDE redis-cache-create]

[!INCLUDE redis-cache-create]

Review the code (Optional)

If you're interested in learning how the code works, you can review the following snippets. Otherwise, feel free to skip ahead to Run the application.

The open source go-redis library is used to interact with Azure Cache for Redis.

The main function starts off by reading the host name and password (Access Key) for the Azure Cache for Redis instance.

func main() {
    redisHost := os.Getenv("REDIS_HOST")
    redisPassword := os.Getenv("REDIS_PASSWORD")
...

Then, we establish connection with Azure Cache for Redis. We use tls.Config--Azure Cache for Redis only accepts secure connections with TLS 1.2 as the minimum required version.

...
op := &redis.Options{Addr: redisHost, Password: redisPassword, TLSConfig: &tls.Config{MinVersion: tls.VersionTLS12}}
client := redis.NewClient(op)

ctx := context.Background()
err := client.Ping(ctx).Err()
if err != nil {
    log.Fatalf("failed to connect with redis instance at %s - %v", redisHost, err)
}
...

If the connection is successful, HTTP handlers are configured to handle POST and GET operations and the HTTP server is started.

Note

gorilla mux library is used for routing (although it's not strictly necessary and we could have gotten away by using the standard library for this sample application).

uh := userHandler{client: client}

router := mux.NewRouter()
router.HandleFunc("/users/", uh.createUser).Methods(http.MethodPost)
router.HandleFunc("/users/{userid}", uh.getUser).Methods(http.MethodGet)

log.Fatal(http.ListenAndServe(":8080", router))

userHandler struct encapsulates a redis.Client, which is used by the createUser, getUser methods - code for these methods isn't included for brevity.

  • createUser: accepts a JSON payload (containing user information) and saves it as a HASH in Azure Cache for Redis.
  • getUser: fetches user info from HASH or returns an HTTP 404 response if not found.
type userHandler struct {
    client *redis.Client
}
...

func (uh userHandler) createUser(rw http.ResponseWriter, r *http.Request) {
    // details omitted
}
...

func (uh userHandler) getUser(rw http.ResponseWriter, r *http.Request) {
    // details omitted
}

Clone the sample application

Start by cloning the application from GitHub.

  1. Open a command prompt and create a new folder named git-samples.

    md "C:\git-samples"

  2. Open a git terminal window, such as git bash. Use the cd command to change to the new folder where you want to clone the sample app.

    cd "C:\git-samples"

  3. Run the following command to clone the sample repository. This command creates a copy of the sample app on your computer.

    git clone https://github.com/Azure-Samples/azure-redis-cache-go-quickstart.git

Run the application

The application accepts connectivity and credentials in the form of environment variables.

  1. Fetch the Host name and Access Keys (available via Access Keys) for Azure Cache for Redis instance in the Azure portal

  2. Set them to the respective environment variables:

    set REDIS_HOST=<Host name>:<port> (e.g. <name of cache>.redis.cache.windows.net:6380)
set REDIS_PASSWORD=<Primary Access Key>

  3. In the terminal window, change to the correct folder. For example:

    cd "C:\git-samples\azure-redis-cache-go-quickstart"

  4. In the terminal, run the following command to start the application.

    go run main.go

The HTTP server will start on port 8080.

Test the application

  1. Create a few user entries. The below example uses curl:

    curl -i -X POST -d '{"id":"1","name":"foo1", "email":"[email protected]"}' localhost:8080/users/
curl -i -X POST -d '{"id":"2","name":"foo2", "email":"[email protected]"}' localhost:8080/users/
curl -i -X POST -d '{"id":"3","name":"foo3", "email":"[email protected]"}' localhost:8080/users/

  2. Fetch an existing user with its id:

    curl -i localhost:8080/users/1

    You should get JSON response as such:

    {
    "email": "foo1@bar",
    "id": "1",
    "name": "foo1"
}

  3. If you try to fetch a user who doesn't exist, you get an HTTP 404. For example:

    curl -i localhost:8080/users/100

#response

HTTP/1.1 404 Not Found
Date: Fri, 08 Jan 2021 13:43:39 GMT
Content-Length: 0

Clean up resources

If you're finished with the Azure resource group and resources you created in this quickstart, you can delete them to avoid charges.

Important

Deleting a resource group is irreversible, and the resource group and all the resources in it are permanently deleted. If you created your Azure Cache for Redis instance in an existing resource group that you want to keep, you can delete just the cache by selecting Delete from the cache Overview page.

To delete the resource group and its Redis Cache for Azure instance:

  1. From the Azure portal, search for and select Resource groups.

  2. In the Filter by name text box, enter the name of the resource group that contains your cache instance, and then select it from the search results.

  3. On your resource group page, select Delete resource group.

  4. Type the resource group name, and then select Delete.

    Delete your resource group for Azure Cache for Redis

Next steps

In this quickstart, you learned how to get started using Go with Azure Cache for Redis. You configured and ran a simple REST API-based application to create and get user information backed by a Redis HASH data structure.

[!div class="nextstepaction"] Create a simple ASP.NET web app that uses an Azure Cache for Redis.