How to Handle HTTP POST Requests for JSON-RPC in a Go Web Server?

Accessing HTTP JSONRPC from a Web Page

In the context of Go programming, the libraries net/rpc and net/rpc/jsonrpc are commonly employed for inter-process communication. However, connecting to an HTTP JSONRPC server using only the standard library's server tooling may raise questions.

Consider the following basic server setup:

arith := new(server.Arith)

server := rpc.NewServer()
server.Register(arith)

server.HandleHTTP(rpc.DefaultRPCPath, rpc.DefaultDebugPath)

listener, e := net.Listen("tcp", ":4321")
if e != nil {
    log.Fatal("listen error:", e)
}
defer listener.Close()

http.Serve(listener, http.DefaultServeMux)

This setup does not natively support POST requests from a web page. The code expects an HTTP client to initiate a CONNECT and transmit the JSON RPC request and response directly over that connection.

Solution: Creating a Custom HTTP Handler

To enable POST requests, a custom HTTP handler can be implemented to adapt the HTTP request/response to a ServerCodec. Here's an example:

type HttpConn struct {
    in  io.Reader
    out io.Writer
}

func (c *HttpConn) Read(p []byte) (n int, err error)  { return c.in.Read(p) }
func (c *HttpConn) Write(d []byte) (n int, err error) { return c.out.Write(d) }
func (c *HttpConn) Close() error                      { return nil }

type CakeBaker struct{}

func (cb *CakeBaker) BakeIt(n int, msg *string) error {
    *msg = fmt.Sprintf("your cake has been bacon (%d)", n)
    return nil
}

func TestHTTPServer(t *testing.T) {

    cb := &CakeBaker{}

    server := rpc.NewServer()
    server.Register(cb)

    listener, e := net.Listen("tcp", ":4321")
    if e != nil {
        log.Fatal("listen error:", e)
    }
    defer listener.Close()

    go http.Serve(listener, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {

        if r.URL.Path == "/bake-me-a-cake" {
            serverCodec := jsonrpc.NewServerCodec(&HttpConn{in: r.Body, out: w})
            w.Header().Set("Content-type", "application/json")
            w.WriteHeader(200)
            err := server.ServeRequest(serverCodec)
            if err != nil {
                log.Printf("Error while serving JSON request: %v", err)
                http.Error(w, "Error while serving JSON request, details have been logged.", 500)
                return
            }
        }

    }))

    resp, err := http.Post("http://localhost:4321/bake-me-a-cake", "application/json", bytes.NewBufferString(
        `{"jsonrpc":"2.0","id":1,"method":"CakeBaker.BakeIt","params":[10]}`,
    ))
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    b, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }

    fmt.Printf("returned JSON: %s\n", string(b))

}

This custom handler adapts the HTTP request/response into a suitable format for the JSON RPC server, allowing POST requests from a web page or command-line CURL call.

The above is the detailed content of How to Handle HTTP POST Requests for JSON-RPC in a Go Web Server?. For more information, please follow other related articles on the PHP Chinese website!