rice

README

rice

import "github.com/woxingliu/rice"

go mod tidy

Usage

Database

Postgresql 初始化

pg, err := rice.NewPostgres("postgres://postgres:123456@localhost:5432/test?sslmode=disable")
if err != nil {
	return err
}
defer pg.Close()

MariaDB 初始化

mariadb, err := rice.NewMaria("root:root@tcp(localhost:3306)/test?parseTime=True&loc=Local&charset=utf8mb4")
if err != nil {
	return err
}
defer mariadb.Close()

Redis 初始化

rdb, err := rice.NewRedis("localhost:6379")
if err != nil {
	return err
}
defer rdb.Close()

Pretty 封装了 database/sql 标准库里 sql.DB 和 sql.Tx 共有的一些方法，使用 Pretty 时可以在 repo 的上一层初始化，使 repo 层既可以执行 sql.DB 的方法，也可以执行 sql.Tx 的方法，下面是示例。

package repo

type Repo struct {
	Pretty
}

func NewRepo(db Pretty) Repo {
	return Repo{Pretty: db}
}

func (r Repo) Create() error { return nil }

func (r Repo) Update() error { return nil }

func (r Repo) Find() error { return nil }

package usecase

func UseCaseDB() {

	db := NewMariaDB()

	dbRepo := NewRepo(db)

	dbRepo.Find()
}

func UseCaseTx() error {

	tx, _ := NewMariaTx()
	defer tx.Rollback()

	txRepo := NewRepo(tx)

	err := txRepo.Create()
	if err != nil {
		return err
	}

	err = txRepo.Update()
	if err != nil {
		return err
	}

	if err := tx.Commit(); err != nil {
		return err
	}

	return nil
}

Documentation

Index

• func AESDecrypt(key []byte, s string) (string, error)
• func AESEncrypt(key []byte, s string) (string, error)
• func AESNewCBCDecrypter(keyString, cipherString string) (string, error)
• func AESNewCBCEncrypter(keyString, plainString string) (string, error)
• func AESNewCFBDecrypter()
• func AESNewCFBEncrypter()
• func AESNewGCMDecrypt(keyString, nonceString, ciphertext string) (string, error)
• func AESNewGCMEncrypt(keyString, plaintext string) (string, error)
• func BCryptCompareHashAndPassword(pwd, hash string) bool
• func BCryptGenerateFromPassword(pwd string) (string, error)
• func ByteString(b []byte) string
• func BytesNewBufferString(b []byte) string
• func FmtSprintfByte(b []byte) string
• func NewRedis(addr string, opts ...RedisOption) (*redis.Client, error)
• func NewRedisDB() *redis.Client
• func SliceRemoveIndex(slice []int, s int) []int
• func SliceRemoveIndexUnOrder(s []int, i int) []int
• func StrconvFormatInt(i int64) string
• func StrconvParseFloat(i int) (float64, error)
• func StrconvParseInt(s string) (int64, error)
• func StringByte(s string) []byte
• func TimeFormat(tm time.Time) string
• func TimeNowFormat() string
• func TimeParse(s string) (time.Time, error)
• func TimeUnix(sec int64) time.Time
• func UUIDNewString() string
• type MariaDB
  • func NewMaria(url string, opts ...Option) (*MariaDB, error)
  • func (db *MariaDB) Close()
• type Option
  • func ConnMaxIdleTime(d time.Duration) Option
  • func ConnMaxLifetime(d time.Duration) Option
  • func MaxIdleConns(size int) Option
  • func MaxOpenConns(size int) Option
• type Postgres
  • func NewPostgres(url string, opts ...Option) (*Postgres, error)
  • func (db *Postgres) Close()
• type Pretty
• type PrettyDB
  • func NewMariaDB() PrettyDB
  • func NewPostgresDB() PrettyDB
• type PrettyTx
  • func NewMariaTx() (PrettyTx, error)
  • func NewMariaTxContext(ctx context.Context) (PrettyTx, error)
  • func NewPostgresTx() (PrettyTx, error)
  • func NewPostgresTxContext(ctx context.Context) (PrettyTx, error)
• type RedisOption
  • func RedisDB(db int) RedisOption
  • func RedisPassword(pwd string) RedisOption
  • func RedisPoolSize(poolSize int) RedisOption

Functions

func AESDecrypt

func AESDecrypt(key []byte, s string) (string, error)

func AESEncrypt

func AESEncrypt(key []byte, s string) (string, error)

func AESNewCBCDecrypter

func AESNewCBCDecrypter(keyString, cipherString string) (string, error)

func AESNewCBCEncrypter

func AESNewCBCEncrypter(keyString, plainString string) (string, error)

func AESNewCFBDecrypter

func AESNewCFBDecrypter()

func AESNewCFBEncrypter

func AESNewCFBEncrypter()

func AESNewGCMDecrypt

func AESNewGCMDecrypt(keyString, nonceString, ciphertext string) (string, error)

func AESNewGCMEncrypt

func AESNewGCMEncrypt(keyString, plaintext string) (string, error)

func BCryptCompareHashAndPassword

func BCryptCompareHashAndPassword(pwd, hash string) bool

BCryptCompareHashAndPassword true or false

func BCryptGenerateFromPassword

func BCryptGenerateFromPassword(pwd string) (string, error)

BCryptGenerateFromPassword generate hash from password

func ByteString

func ByteString(b []byte) string

ByteString []byte to string

func BytesNewBufferString

func BytesNewBufferString(b []byte) string

BytesNewBufferString []byte to string

func FmtSprintfByte

func FmtSprintfByte(b []byte) string

FmtSprintfByte []byte to string

func NewRedis

func NewRedis(addr string, opts ...RedisOption) (*redis.Client, error)

func NewRedisDB

func NewRedisDB() *redis.Client

func SliceRemoveIndex

func SliceRemoveIndex(slice []int, s int) []int

SliceRemoveIndex 移除 slice 中的一个元素

func SliceRemoveIndexUnOrder

func SliceRemoveIndexUnOrder(s []int, i int) []int

SliceRemoveIndexUnOrder 移除 slice 中的一个元素（无序，但效率高）

func StrconvFormatInt

func StrconvFormatInt(i int64) string

StrconvFormatInt 1645270804 to "1645270804"

func StrconvParseFloat

func StrconvParseFloat(i int) (float64, error)

StrconvParseFloat int/100 to float64 保留 2 位小数点 example: 2333 -> 23.33

func StrconvParseInt

func StrconvParseInt(s string) (int64, error)

StrconvParseInt "1645270804" to 1645270804

func StringByte

func StringByte(s string) []byte

StringByte string to []byte

func TimeFormat

func TimeFormat(tm time.Time) string

TimeFormat time.Time to "2006-01-02 15:04:05"

func TimeNowFormat

func TimeNowFormat() string

TimeNowFormat time.Time to "2006-01-02 15:04:05"

func TimeParse

func TimeParse(s string) (time.Time, error)

TimeParse "2006-01-02 15:04:05" to time.Time

func TimeUnix

func TimeUnix(sec int64) time.Time

TimeUnix 1645270804 to time.Time

func UUIDNewString

func UUIDNewString() string

UUIDNewString creates a new random UUID

Types

type MariaDB

type MariaDB struct {
	*sql.DB
	// contains filtered or unexported fields
}

func NewMaria

func NewMaria(url string, opts ...Option) (*MariaDB, error)

func (*MariaDB) Close

func (db *MariaDB) Close()

type Option

type Option func(*sql.DB)

func ConnMaxIdleTime

func ConnMaxIdleTime(d time.Duration) Option

ConnMaxIdleTime 一个连接空闲的最大时长

func ConnMaxLifetime

func ConnMaxLifetime(d time.Duration) Option

ConnMaxLifetime 一个连接使用的最大时长

func MaxIdleConns

func MaxIdleConns(size int) Option

MaxIdleConns 最大闲置的连接数

func MaxOpenConns

func MaxOpenConns(size int) Option

MaxOpenConns 最大打开的连接数

type Postgres

type Postgres struct {
	*sql.DB
}

func NewPostgres

func NewPostgres(url string, opts ...Option) (*Postgres, error)

func (*Postgres) Close

func (db *Postgres) Close()

type Pretty

type Pretty interface {
	PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
	Prepare(query string) (*sql.Stmt, error)
	ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
	Exec(query string, args ...interface{}) (sql.Result, error)
	QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)
	Query(query string, args ...interface{}) (*sql.Rows, error)
	QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row
	QueryRow(query string, args ...interface{}) *sql.Row
}

type PrettyDB

type PrettyDB interface {
	Pretty
	BeginTx(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error)
	Begin() (*sql.Tx, error)
}

func NewMariaDB

func NewMariaDB() PrettyDB

func NewPostgresDB

func NewPostgresDB() PrettyDB

type PrettyTx

type PrettyTx interface {
	Pretty
	Commit() error
	Rollback() error
	StmtContext(ctx context.Context, stmt *sql.Stmt) *sql.Stmt
	Stmt(stmt *sql.Stmt) *sql.Stmt
}

func NewMariaTx

func NewMariaTx() (PrettyTx, error)

func NewMariaTxContext

func NewMariaTxContext(ctx context.Context) (PrettyTx, error)

func NewPostgresTx

func NewPostgresTx() (PrettyTx, error)

func NewPostgresTxContext

func NewPostgresTxContext(ctx context.Context) (PrettyTx, error)

type RedisOption

type RedisOption func(*redis.Options)

func RedisDB

func RedisDB(db int) RedisOption

func RedisPassword

func RedisPassword(pwd string) RedisOption

func RedisPoolSize

func RedisPoolSize(poolSize int) RedisOption