glib

README

glib

Install glib

#install glib
go get github.com/carltd/glib
dep ensure

Usage

start consul as config center

consul agent -ui -server -data-dir=/tmp

vi ~/glib-test.go

intput content:

package main

import (
	"time"

	"github.com/micro/go-log"

	"github.com/carltd/glib"
	_ "github.com/carltd/glib/cache/memcache"
	_ "github.com/carltd/glib/cache/redis"
	"gopkg.in/mgo.v2/bson"
)

type User struct {
	Id   uint   `xorm:"id"`
	Name string `xorm:"name"`
}

const (
	cacheKey    = "test-k"
	cacheValue  = "1"
	cacheExpire = time.Hour
)

func main() {
	var (
		user   User
		err    error
		exists bool
	)

	// init glib with config center(consul)
	if err = glib.Init(glib.WithServiceDomain("com.carltd.srv.demo")); err != nil {
		log.Fatal(err)
	}
	defer glib.Destroy()

	// cache usage
	log.Log(glib.Cache("rc").Put(cacheKey, cacheValue, cacheExpire))
	log.Log(glib.Cache("mc").Put(cacheKey, cacheValue, cacheExpire))

	log.Log(glib.Cache("rc").Get(cacheKey))
	log.Log(glib.Cache("mc").Get(cacheKey))

	// mysql usage
	exists, err = glib.DB("db1").Get(&user)
	if err != nil {
		log.Fatal(err)
	}
	if exists {
		log.Logf("%+v", user)
	}

	// mongodb usage
	var v interface{}
	s := glib.MgoShareClone("mgo")
	err = s.DB("test").C("col1").Find(bson.M{}).One(&v)
	s.Close()
	if err != nil {
		log.Fatal(err)
	}
	log.Logf("%+v", v)


	s = glib.MgoShareCopy("mgo")
	err = s.DB("test").C("col1").Find(bson.M{}).One(&v)
	s.Close()
	if err != nil {
		log.Fatal(err)
	}
	log.Logf("%+v", v)
}

config consul kv \com.carltd.srv.demo\glib-supports:

{
    "db": true,
    "cache": true,
    "mgo": true
}

\com.carltd.srv.demo\glib-db:

[{
    "alias": "db1",
    "driver": "mysql",
    "showSql": false,
    "logLevel": "debug",
    "dsn": "root:@tcp(127.0.0.1:3306)/test",
    "enable": true,
    "ttl": 30
}]

\com.carltd.srv.demo\glib-cache:

[{
    "alias": "rc",
    "driver": "redis",
    "dsn": ":123456@127.0.0.1:6379/0",
    "enable": true,
    "ttl": 30
},{
    "alias":"mc",
    "driver":"memcache",
    "dsn": "127.0.0.1:11211",
    "enable": true,
    "ttl": 30
}]

\com.carltd.srv.demo\glib-mgo:

[{
    "enable": true,
    "alias": "mgo",
    "ttl":60,
    "dsn": "mongodb://127.0.0.1:27017"
}]

at last, run glib-test.go

go run glib-test.go

Documentation

Index

• Constants
• func Cache(alias string) internal.Cacher
• func Consumer(alias string) queue.Consumer
• func DB(alias string) *gorm.DB
• func Destroy() error
• func Init(opts ...option) error
• func MgoShareClone(alias string) *mgo.Session
• func MgoShareCopy(alias string) *mgo.Session
• func NewId() string
• func Publisher(alias string) queue.Publisher
• func Redis(alias string) redis_wrapper.RedisWrapper
• func WithDiscoverAddr(addr string) option
• func WithNoStorage() option
• func WithServiceDomain(domain string) option
• type ConfigObject
  • func GetConfig(keyPath string) ConfigObject

Constants

const (
	BrokerTypePublisher = "publisher"
	BrokerTypeConsumer  = "consumer"
)

Functions

func Cache

func Cache(alias string) internal.Cacher

func Consumer

func Consumer(alias string) queue.Consumer

func DB

func DB(alias string) *gorm.DB

DB will return a instance of `xorm.EngineGroup`, panic if it's not exists

func Destroy

func Destroy() error

Destroy - 释放glib管理资源

func Init

func Init(opts ...option) error

Init enabled features

func MgoShareClone

func MgoShareClone(alias string) *mgo.Session

MgoShareClone will return a clone instance of `*mgo.Session`, panic if it's not exists example:

var v = make([]interface{}, 0)
s := glib.MgoShareClone("something")
defer s.Close()
// use it
err := s.DB("somedb").C("col").Find(&v)

func MgoShareCopy

func MgoShareCopy(alias string) *mgo.Session

MgoShareCopy will return a copy instance of `*mgo.Session`, panic if it's not exists example:

var v = make([]interface{}, 0)
s := glib.MgoShareCopy("something")
defer s.Close()
// use it
err := s.DB("somedb").C("col").Find(&v)

func NewId

func NewId() string

NewId - return a global unique id

func Publisher

func Publisher(alias string) queue.Publisher

func Redis

func Redis(alias string) redis_wrapper.RedisWrapper

func WithDiscoverAddr

func WithDiscoverAddr(addr string) option

WithDiscoverAddr - config center address

func WithNoStorage

func WithNoStorage() option

WithNoStorage - none db, cache, mgo etc.

func WithServiceDomain

func WithServiceDomain(domain string) option

WithServiceDomain - set the service's domain used prefix

Types

type ConfigObject

type ConfigObject interface {
	Bool(def bool) bool
	Int(def int) int
	String(def string) string
	Float64(def float64) float64
	Duration(def time.Duration) time.Duration
	StringSlice(def []string) []string
	StringMap(def map[string]string) map[string]string
	Scan(val interface{}) error
	Bytes() []byte
}

func GetConfig

func GetConfig(keyPath string) ConfigObject

get custom config Object