Home > Article > Backend Development > Golang builds websocket

Golang builds websocket

WBOYOriginal: 2023-05-22 19:21:071737browse

Golang is a fast-compilation, efficient, and safe programming language that is also widely used in Web development. Among them, using Golang to build Websocket is a very popular application scenario. This article will introduce how to use Golang to build a Websocket application.

1. What is Websocket

Websocket is a protocol that allows the establishment of a two-way communication connection between the browser and the server. The traditional HTTP protocol can only send requests to the server by the browser and receive responses from the server. However, using Websocket allows the server to actively send messages to the browser, realizing full-duplex communication between the server and the browser.

2. How Golang implements Websocket

Golang comes with a standard library net/http. This package provides a http.Server structure body, which can be used to build web servers. In addition, net/http also provides a websocket sub-package, which provides us with all the functions needed to build a WebSocket server.

Establishing a WebSocket connection

To establish a WebSocket connection, the client needs to send an HTTP request to the server and carry the Upgrade header to indicate that the request is upgraded to the WebSocket protocol. After receiving this request, the server needs to check the Upgrade header and process it accordingly depending on whether it is a WebSocket request.

The server can use the websocket.IsWebSocketUpgrade function to check whether the request is a WebSocket request, and use the websocket.Upgrade function to upgrade the request. After the upgrade is successful, the server can communicate with the client through the connection object of type *websocket.Conn.

func handler(w http.ResponseWriter, r *http.Request) {
    conn, err := upgrader.Upgrade(w, r, nil)
    if err != nil {
        log.Println(err)
        return
    }
    defer conn.Close()
    // 使用conn进行通信
}

Among them, upgrader is a websocket.Upgrader type variable. By setting its properties, you can control the processing method of WebSocket connection. UpgradeThe function will block when upgrading the request, so it must be run in a goroutine.

Sending and receiving WebSocket messages

Once the WebSocket connection is successfully established, both the client and the server can communicate through the *websocket.Conn object. Use this object to send and receive WebSocket messages.

Sending a message is very simple, just call the WriteMessage method:

err := conn.WriteMessage(websocket.TextMessage, []byte("hello"))

There are three ways to receive messages:

ReadMessage: Blocks reading until a message arrives
NextReader: Blocks and waits for the next message to arrive
NextWriter: Returns a io.WriteCloser object, you can use this object to send messages

Generally use the ReadMessage method to receive WebSocket messages:

_, message, err := conn.ReadMessage()
if err != nil {
    log.Println(err)
    return
}
log.Printf("recv: %s", message)

3. One Simple WebSocket application

In this example, we will create a simple chat room application. After the client sends a message, the server broadcasts the message to all connected clients.

Client side code: (using JavaScript)

<!DOCTYPE html>
<html>
<head>
    <title>Chatroom</title>
</head>
<body>
    <input type="text" id="input-message"/>
    <button onclick="sendMessage()">发送</button>
    <ul id="message-list"></ul>

    <script>
        var ws = new WebSocket("ws://localhost:8080/ws");
        ws.onmessage = function(event) {
            var message = event.data;
            var li = document.createElement("li");
            li.appendChild(document.createTextNode(message));
            document.getElementById("message-list").appendChild(li);
        };

        function sendMessage() {
            var message = document.getElementById("input-message").value;
            ws.send(message);
        }
    </script>
</body>
</html>

Server side code:

package main

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

    "github.com/gorilla/websocket"
)

var upgrader = websocket.Upgrader{}

func main() {
    http.HandleFunc("/ws", wsHandler)
    err := http.ListenAndServe(":8080", nil)
    if err != nil {
        log.Fatal("ListenAndServe: ", err)
    }
}

func wsHandler(w http.ResponseWriter, r *http.Request) {
    conn, err := upgrader.Upgrade(w, r, nil)
    if err != nil {
        log.Println(err)
        return
    }
    defer conn.Close()

    for {
        _, message, err := conn.ReadMessage()
        if err != nil {
            log.Println(err)
            break
        }
        fmt.Printf("recv: %s
", message)

        // 广播给所有客户端
        for _, conn := range conns {
            err := conn.WriteMessage(websocket.TextMessage, message)
            if err != nil {
                log.Println(err)
                break
            }
        }
    }
}

In the above code, we connect all connected websocket.ConnObjects are stored in conns variables. Whenever a new message arrives, the server broadcasts the message to all clients.

Summary

It is very simple to build a WebSocket application using Golang. You only need to import the net/http and websocket packages and use the standard library directly. The provided API can complete the development of WebSocket applications. I hope this article can be helpful to Golang Websocket development.

The above is the detailed content of Golang builds websocket. For more information, please follow other related articles on the PHP Chinese website!

Statement：

The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Previous article：Reverse linked list golangNext article：Reverse linked list golang

See more

Golang builds websocket

Related articles