gRPC CRUD Service in Go ♋️

This repository contains an example of a simple gRPC CRUD service implemented in Go. The service allows users to create, read, update, and delete users. The service uses Protocol Buffers as the interface definition language (IDL) for defining the service API and for serializing and transmitting the data.

Prerequisites

Go 1.14 or higher Protocol Buffers 3.x gRPC 1.33 or higher

Setting up the development environment

Installing the Protocol Buffers and gRPC library for Go project: To get started, you need to install the Protocol Buffers compiler (protoc) and the gRPC library for Go. You can do this by running the following command:

# install Protocol Buffers compiler
brew install protobuf

# install Go plugins
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc

Generate the gRPC Golang code

Using the protoc compiler, compile this project-defined Protocol Buffers message for the user service into Golang code:

protoc --proto_path=. --go_out=. \
  --go-grpc_out=. \
  ./api/*.proto

Check the /gen for the generated Golang code.

Running and building

Use the go build command to spin up the gRPC server like below:

# build server
go build -o=./grpc-server./cmd/server/*

# Run the executable
./grpc-server

Using the CLI client, we can either create, read, update or delete a user from the in-memory repository.

# Create a random user
go run ./cmd/client -c

# Retrieve a user using the return id from '-c' command
go run ./cmd/client -r <user_id>

# Update a user info
go run ./cmd/client -u <user_id>

# Delete a user
go run ./cmd/client -d <user_id>

Testing

gRPC-service comes with mixed bag of unit and integration tests (coming soon). To run them, use the default go test command:

go test ./...

Miscellaenous

I added a sample project out of curiosity comparing the size of serialized data output from JSON, XML and Protocol Buffer serialization. Check the sizecompare directory for the comparison functionalities.

# run to see output for each serialization
go run ./cmd/sizecompare/ 

Benchmark Testing

Run benchmark test function multiple times to compares each output against each, assessing the code’s overall performance level.

cd ./cmd/sizecompare && go test -bench=. -count 5 -run=^# -benchmem

Outcome on my hardware:

goos: darwin
goarch: arm64
pkg: github.com/IkehAkinyemi/grpc-service/cmd/sizecompare
BenchmarkSerializeToJSON-8       1667995               707.0 ns/op           480 B/op          1 allocs/op
BenchmarkSerializeToJSON-8       1686784               713.0 ns/op           480 B/op          1 allocs/op
BenchmarkSerializeToJSON-8       1672173               715.5 ns/op           480 B/op          1 allocs/op
BenchmarkSerializeToJSON-8       1673404               717.4 ns/op           480 B/op          1 allocs/op
BenchmarkSerializeToJSON-8       1668206               719.9 ns/op           480 B/op          1 allocs/op
BenchmarkSerializeToXML-8         489782              2341 ns/op            5216 B/op         10 allocs/op
BenchmarkSerializeToXML-8         492550              2342 ns/op            5216 B/op         10 allocs/op
BenchmarkSerializeToXML-8         496192              2340 ns/op            5216 B/op         10 allocs/op
BenchmarkSerializeToXML-8         487257              2343 ns/op            5216 B/op         10 allocs/op
BenchmarkSerializeToXML-8         497938              2360 ns/op            5216 B/op         10 allocs/op
BenchmarkSerializeToProto-8     11307571               107.4 ns/op           384 B/op          1 allocs/op
BenchmarkSerializeToProto-8     10754984               105.6 ns/op           384 B/op          1 allocs/op
BenchmarkSerializeToProto-8     11198925               106.2 ns/op           384 B/op          1 allocs/op
BenchmarkSerializeToProto-8      9485875               107.0 ns/op           384 B/op          1 allocs/op
BenchmarkSerializeToProto-8     10498231               107.6 ns/op           384 B/op          1 allocs/op
PASS
ok      github.com/IkehAkinyemi/grpc-service/cmd/sizecompare    22.960s

Security

If you discover a security vulnerability within gRPC-service, please raise an issue on this repository or send an e-mail to mrikehchukwuka@gmail.com.

All issues and reports will be promptly addressed, and you'll be credited accordingly.

Future work & contribution

You could help continuing its development by:

• Contribute to the source code
• Suggest new features and report issues