golib

README

Golib เป็นโปรเจ็คที่รวบรวมเอา Package ที่มีการใช้งานบ่อยๆ มาแพ็ครวมกัน และทำ function พร้อม configuration พื้นฐานให้สามารถนำไปใช้งานได้ง่ายๆ

⚙️ Installation

ใช้ได้กับ Go version 1.16 ขึ้นไป ซึ่งสามารถดาวโหลด และติดตั้งได้ที่นี่ Go version 1.16

หลังจากนั้นก็เริ่มต้นโปรเจ็คใหม่ของคุณ และใช้คำสั่ง go get เพื่อติดตั้ง golib ใช้งาน

go get -u github.com/patcharp/golib/v2

🎯 สารบัญ package ในโปรเจ็ค

• cache สำหรับการเชื่อมต่อหา Redis และ Key-Value อื่นๆ ที่ใช้ Protocol มาตรฐานของ Redis มีทั้งการเชื่อมต่อแบบ node เดี่ยว และแบบ cluster
• crontab สำหรับสร้าง crontab service ในตัว Go Application
• crypto ใช้เกี่ยวกับการเข้ารหัสข้อมูล ทั้ง shared key และ public key และการเข้ารหัสแบบ default ของ crypto-js ใน node.js
• database สำหรับการเชื่อมต่อ database ชนิดต่างโดยใช้ GORM มี function keepalive สำหรับ automatic reconnection ได้เอง
• geomap สำหรับคำนวน geomap แบบใช้ polygon และ พิกัด latitude, longitude
• hashing ใช้ hash ข้อมูลแบบมาตรฐาน โดยใช้ algorithm ของ SHA256
• helper function ช่วยเหลือต่างๆ ประกอบไปด้วยการแปลงวันเดือนปี การ response api body ของ gofiber และการแปลงวันเดือนปีให้เป็นภาษาไทย
• imagik สำหรับการประมวลผลรูปภาพ (image processing) และการ grab รูปภาพจาก website
• lokilog เป็น log output ของ logrus เพื่อ push ขึ้นไปยัง Grafana Loki
• mq สำหรับการเชื่อมต่อหา Message Queue แบบต่างๆ เช่น RabbitMQ
• one package ช่วยเหลือสำหรับ INET One Platform ซึ่งตอนนี้ประกอบไปด้วย OneChat, CMP และ OneID
• requests function สำหรับ Call API โดยใช้แรงบันดาลใจมาจาก lib requests ของ Python ที่สามารถ Customize parameter ต่างๆ ได้เอง
• server เป็น package สำหรับการทำ web application โดยใช้ Go Fiber และเครื่องมือช่วยเหลือต่างๆ เพื่อให้การพัฒนา web application ง่ายขึ้น
• util function utilities ต่างๆ ที่จะรวมรวบเครื่องไม้เครื่องมือมาไว้ใช้งานประกอบไปด้วย
  • httputil สำหรับ web application ไม่ว่าจะ header และ function อำนวยความสะดวก
  • function common ต่างๆ เช่นกัน getenv, atoi, atof, contain และ function ของ time

👀 ตัวอย่างการใช้งาน

ตัวอย่างการใช้งาน package หรือ function สำหรับอำนวยความสะดวกต่างๆ ของ package นี้

📖 Web Api โดยใช้ package server และ helper

package main

import (
	"github.com/gofiber/fiber/v2"
	"github.com/patcharp/golib/v2/server"
	"github.com/sirupsen/logrus"
	"net/http"
)

func main() {
	s := server.New(server.Config{
		Host: "127.0.0.1",
		Port: "5000",
	})

	s.App().Get("/api/hello", func(ctx *fiber.Ctx) error {
		return ctx.Status(http.StatusOK).JSON(fiber.Map{
			"message": "Hello GoLib v2",
		})
	})

	s.App().Get("/api/hello_v2", func(ctx *fiber.Ctx) error {
		return helper.HttpOk(ctx, fiber.Map{
			"message": "Hello GoLib v2",
		})
	})

	if err := s.Run(); err != nil {
		logrus.Errorln("Start server error ->", err)
	}
}

📖 การเรียก API โดยใช้ package requests

package main

import (
	"github.com/patcharp/golib/v2/requests"
	"github.com/sirupsen/logrus"
)

func main() {
	url := "https://www.google.com"
	resp, err := requests.Get(
		url, // url
		nil, // header
		nil, // body
		0,   // timeout (second)
	)
	if err != nil {
		logrus.Errorln("Request to", url, "error ->", err)
		return
	}

	logrus.Infoln("Response code:", resp.Code)
	logrus.Infoln("Response body:", string(resp.Body))
}

📖 การ Connect ไป Database โดยใช้ MySQL หรือ MariaDB พร้อมทั้ง Query ข้อมูลจาก database

package main

import (
	"github.com/patcharp/golib/v2/database"
	"github.com/sirupsen/logrus"
	"gorm.io/gorm"
)

type User struct {
	Id   int64
	Name string
}

func main() {
	db := database.NewWithConfig(database.Config{
		Host:     "127.0.0.1",
		Port:     "3306",
		Username: "username",
		Password: "password",
		Name:     "db_name",
	},
		database.DriverMySQL,
	)

	if err := db.Connect(); err != nil {
		logrus.Errorln("Connect to database error ->", err)
		return
	}
	defer db.Close()

	// Query all users in table
	var users []User
	if err := db.Ctx().Find(&users).Error; err != nil {
		logrus.Errorln("Query all user in users table error ->", err)
		return
	}
	logrus.Infoln("=== Query all users in table ===")
	for _, u := range users {
		logrus.Infoln("ID:", u.Id, "\tName:", u.Name)
	}

	// Query specific user where id equal to 10
	var user User
	if err := db.Ctx().Where("id=?", 10).First(&user).Error; err != nil {
		if gorm.ErrRecordNotFound == err {
			logrus.Errorln("User who has id = 10 was not found")
			return
		}
		// Unknown error occur
		logrus.Errorln("Query specific user error ->", err)
		return
	}
	logrus.Infoln("=== Specific user who has id equal to 10 is ===")
	logrus.Infoln("ID:", user.Id, "\tName:", user.Name)
}

👍 Contribute

ถ้าคุณชอบที่สามารถนำไปใช้งานได้ในโครงการของคุณ และต้องการขอบคุณ กรุณากดให้ GitHub Star แก่เราด้วย เพื่อเป็นกำลังใจให้พัฒนาต่อไป

‍💻 Code Contributors

⚠️ License

Copyright (c) 2021 Patcharapong and Contributors โดยที่ GoLib นี้เป็น Open Source ที่ทุกคนสามารถนำไปใช้งานได้ฟรี ภายใต้อนุสัญญา MIT License ตาม package ต้นทางที่เราได้นำมาใช้งาน