一个快速上手、轻量级 Golang 公共类库 (golang_common)

e421083458 · · 892 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

功能定位

配置 Golang 基础服务(mysql、redis、http.client、log)比较繁琐,如果想 快速接入 基础服务可以使用本类库。
没有多余复杂的功能,方便你拓展其他功能。
你可以 import 引用使用,也可以拷贝代码到自己项目中使用。
项目地址:https://github.com/e421083458/golang_common

功能

  1. 支持多套配置文件设置,比如:dev、prod,以及设置自定义配置文件。
  2. 支持mysql、redis多套数据源配置,以及查询日志。
  3. 支持日志文件、命令行输出,以及6种错误级别设置和自动切分滚动日志功能。

安装及使用

  1. 需要确保已经安装了 Go 1.8+,然后执行以下命令
go get -v github.com/e421083458/golang_common
  1. 将配置文件拷贝到你的项目中,配置文件请参考:https://github.com/e421083458/golang_common/tree/master/conf/dev

  2. 引入到你的项目:

package main

import (
	"github.com/e421083458/golang_common/lib"
	"log"
	"time"
)

func main(){
	if err:=lib.Init("./conf/dev/");err!=nil{
		log.Fatal(err)
	}

	//todo sth
	lib.Log.TagInfo(lib.NewTrace(), lib.DLTagUndefind, map[string]interface{}{"message": "todo sth"})
	time.Sleep(time.Second)

	lib.Destroy()
}
  1. 运行代码
go run main.go

输出:

2019/05/19 18:55:17 [INFO]  config=./conf/dev/
2019/05/19 18:55:17 [INFO]  start loading resources.
2019/05/19 18:55:17 [INFO]  success loading resources.
------------------------------------------------------------------------
2019-05-19T18:55:17.783 [INFO] log.go:58 _undef||message=todo sth||traceid=c0a8fe315ce13615b6c0fc6e104dc7b0||cspanid=||spanid=9c49c824380704bb
2019/05/19 18:55:18 [INFO]  start destroy resources.
------------------------------------------------------------------------
2019/05/19 18:55:18 [INFO]  success destroy resources.

其他功能举例

  • 初始化当前运行环境
//初始化测试用例
func InitTest()  {
	initOnce.Do(func() {
		if err:=Init("../conf/dev/");err!=nil{
			log.Fatal(err)
		}
	})
}
  • 获取当前运行环境
//获取 程序运行环境 dev prod
func Test_GetConfEnv(t *testing.T) {
	InitTest()
	fmt.Println(GetConfEnv())
	DestroyTest()
}
  • 加载自定义配置文件
type HttpConf struct {
	ServerAddr     string   `toml:"server_addr"`
	ReadTimeout    int      `toml:"read_timeout"`
	WriteTimeout   int      `toml:"write_timeout"`
	MaxHeaderBytes int      `toml:"max_header_bytes"`
	AllowHost      []string `toml:"allow_host"`
}
// 加载自定义配置文件
func Test_ParseLocalConfig(t *testing.T) {
	InitTest()
	httpProfile := &HttpConf{}
	err:=ParseLocalConfig("http.toml",httpProfile)
	if err!=nil{
		t.Fatal(err)
	}
	fmt.Println(httpProfile)
	DestroyTest()
}
  • 测试PostJson请求
//测试PostJson请求
func TestJson(t *testing.T) {
	InitTestServer()
	jsonStr := "{\"source\":\"control\",\"cityId\":\"12\",\"trailNum\":10,\"dayTime\":\"2018-11-21 16:08:00\",\"limit\":2,\"andOperations\":{\"cityId\":\"eq\",\"trailNum\":\"gt\",\"dayTime\":\"eq\"}}"
	url := "http://"+addr+"/json"
	_, res, err := HttpJSON(NewTrace(), url, jsonStr, 1000, nil)
	fmt.Println(string(res))
	if err != nil {
		fmt.Println(err.Error())
	}
}
  • 测试Get请求
//测试Get请求
func TestGet(t *testing.T) {
	InitTestServer()
	a := url.Values{
		"city_id": {"12"},
	}
	url := "http://"+addr+"/get"
	_, res, err := HttpGET(NewTrace(), url, a, 1000, nil)
	fmt.Println("city_id="+string(res))
	if err != nil {
		fmt.Println(err.Error())
	}
}
  • 测试Post请求
//测试Post请求
func TestPost(t *testing.T) {
	InitTestServer()
	a := url.Values{
		"city_id": {"12"},
	}
	url := "http://"+addr+"/post"
	_, res, err := HttpPOST(NewTrace(), url, a, 1000, nil, "")
	fmt.Println("city_id="+string(res))
	if err != nil {
		fmt.Println(err.Error())
	}
}
  • 测试日志打点
//测试日志打点
func TestInitLog(t *testing.T) {
	InitTest()
	Log.TagInfo(NewTrace(), DLTagMySqlSuccess, map[string]interface{}{
		"sql": "dltag",
	})
	time.Sleep(time.Second)
	DestroyTest()
}
  • 测试mysql普通sql
func Test_DBPool(t *testing.T)  {
	InitTest()

	//获取链接池
	dbpool, err := GetDBPool("default")
	if err!=nil{
		t.Fatal(err)
	}
	//开始事务
	trace:=NewTrace()
	if _, err := DBPoolLogQuery(trace, dbpool, beginSQL);err!=nil{
		t.Fatal(err)
	}

	//创建表
	if _, err := DBPoolLogQuery(trace, dbpool, createTableSQL);err!=nil{
		DBPoolLogQuery(trace, dbpool, rollbackSQL)
		t.Fatal(err)
	}

	//插入数据
	if _, err := DBPoolLogQuery(trace, dbpool, insertSQL);err!=nil{
		DBPoolLogQuery(trace, dbpool, rollbackSQL)
		t.Fatal(err)
	}

	//循环查询数据
	current_id := 0
	table_name := "test1"
	fmt.Println("begin read table ",table_name,"")
	fmt.Println("------------------------------------------------------------------------")
	fmt.Printf("%6s | %6s\n","id", "created_at")
	for {
		rows, err := DBPoolLogQuery(trace, dbpool, "SELECT id,created_at FROM test1 WHERE id>? order by id asc", current_id)
		defer rows.Close()
		row_len := 0
		if err != nil {
			DBPoolLogQuery(trace, dbpool, "rollback;")
			t.Fatal(err)
		}
		for rows.Next() {
			var create_time string
			if err := rows.Scan(&current_id, &create_time); err != nil {
				DBPoolLogQuery(trace, dbpool, "rollback;")
				t.Fatal(err)
			}
			fmt.Printf("%6d | %6s\n",current_id, create_time)
			row_len++
		}
		if row_len == 0 {
			break
		}
	}
	fmt.Println("------------------------------------------------------------------------")
	fmt.Println("finish read table ",table_name,"")

	//删除表
	if _, err := DBPoolLogQuery(trace, dbpool, dropTableSQL);err!=nil{
		DBPoolLogQuery(trace, dbpool, rollbackSQL)
		t.Fatal(err)
	}

	//提交事务
	DBPoolLogQuery(trace, dbpool, commitSQL)
	DestroyTest()
}
  • 测试Gorm
func Test_GORM(t *testing.T)  {
	InitTest()

	//获取链接池
	dbpool, err := GetGormPool("default")
	if err!=nil{
		t.Fatal(err)
	}
	db:=dbpool.Begin()
	if err:=db.Exec(createTableSQL).Error;err!=nil{
		db.Rollback()
		t.Fatal(err)
	}
	t1:= &Test1{Name:"test_name",CreatedAt:time.Now()}
	if err:=db.Save(t1).Error;err!=nil{
		db.Rollback()
		t.Fatal(err)
	}
	list:=[]Test1{}
	if err:=db.Where("name=?","test_name").Find(&list).Error;err!=nil{
		db.Rollback()
		t.Fatal(err)
	}
	fmt.Println(list)
	if err:=db.Exec(dropTableSQL).Error;err!=nil{
		db.Rollback()
		t.Fatal(err)
	}
	db.Commit()
	DestroyTest()
}
  • 测试redis查询
func Test_Redis(t *testing.T) {
	InitTest()

	c,err:=RedisConnFactory("default")
	if err!=nil{
		t.Fatal(err)
	}
	defer c.Close()

	// 调用SET
	trace:=NewTrace()
	redisKey:="test_key1"
	RedisLogDo(trace, c,"SET", redisKey, "test_dpool")
	RedisLogDo(trace, c,"expire", "test_key1", 10)

	// 调用GET
	v, err := redis.String(RedisLogDo(trace, c,"GET", redisKey))
	fmt.Println(v)
	if v!="test_dpool" || err!=nil{
		t.Fatal("test redis get fatal!")
	}

	DestroyTest()
}
  • 销毁当前运行环境
//销毁测试用例
func DestroyTest()  {
	Destroy()
}

你的 star ,我的动力。有任何关于类库的问题,请提交issue,谢谢。


有疑问加站长微信联系(非本文作者)

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:701969077

892 次点击  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传