diff --git a/g/container/container.go b/g/container/container.go deleted file mode 100644 index 065333f05..000000000 --- a/g/container/container.go +++ /dev/null @@ -1,7 +0,0 @@ -// Copyright 2017 gf Author(https://github.com/gogf/gf). All Rights Reserved. -// -// This Source Code Form is subject to the terms of the MIT License. -// If a copy of the MIT was not distributed with this file, -// You can obtain one at https://github.com/gogf/gf. - -package container diff --git a/g/crypto/crypto.go b/g/crypto/crypto.go deleted file mode 100644 index cbad3d077..000000000 --- a/g/crypto/crypto.go +++ /dev/null @@ -1,7 +0,0 @@ -// Copyright 2019 gf Author(https://github.com/gogf/gf). All Rights Reserved. -// -// This Source Code Form is subject to the terms of the MIT License. -// If a copy of the MIT was not distributed with this file, -// You can obtain one at https://github.com/gogf/gf. - -package crypto diff --git a/g/database/database.go b/g/database/database.go deleted file mode 100644 index 17dbb4497..000000000 --- a/g/database/database.go +++ /dev/null @@ -1,7 +0,0 @@ -// Copyright 2017 gf Author(https://github.com/gogf/gf). All Rights Reserved. -// -// This Source Code Form is subject to the terms of the MIT License. -// If a copy of the MIT was not distributed with this file, -// You can obtain one at https://github.com/gogf/gf. - -package database diff --git a/g/database/gdb/gdb_model.go b/g/database/gdb/gdb_model.go index d87a85fd6..1626fe24f 100644 --- a/g/database/gdb/gdb_model.go +++ b/g/database/gdb/gdb_model.go @@ -456,6 +456,7 @@ func (md *Model) All() (Result, error) { // 链式操作，查询单条记录 func (md *Model) One() (Record, error) { + md.limit = 1 list, err := md.All() if err != nil { return nil, err diff --git a/g/database/gredis/gredis.go b/g/database/gredis/gredis.go index 45d25abb3..b23bf0c42 100644 --- a/g/database/gredis/gredis.go +++ b/g/database/gredis/gredis.go @@ -107,7 +107,7 @@ func New(config Config) *Redis { // return redis instance with default group. // // 获取指定分组名称的Redis单例对象，底层根据配置信息公用的连接池（连接池单例）。 -func Instance(name...string) *Redis { +func Instance(name ...string) *Redis { group := DEFAULT_GROUP_NAME if len(name) > 0 { group = name[0] diff --git a/g/encoding/encoding.go b/g/encoding/encoding.go deleted file mode 100644 index 5faed76ca..000000000 --- a/g/encoding/encoding.go +++ /dev/null @@ -1,7 +0,0 @@ -// Copyright 2017 gf Author(https://github.com/gogf/gf). All Rights Reserved. -// -// This Source Code Form is subject to the terms of the MIT License. -// If a copy of the MIT was not distributed with this file, -// You can obtain one at https://github.com/gogf/gf. - -package encoding diff --git a/g/frame/frame.go b/g/frame/frame.go deleted file mode 100644 index 32d65c3de..000000000 --- a/g/frame/frame.go +++ /dev/null @@ -1,7 +0,0 @@ -// Copyright 2017 gf Author(https://github.com/gogf/gf). All Rights Reserved. -// -// This Source Code Form is subject to the terms of the MIT License. -// If a copy of the MIT was not distributed with this file, -// You can obtain one at https://github.com/gogf/gf. - -package frame diff --git a/g/g.go b/g/g.go index 806053be0..b83d71781 100644 --- a/g/g.go +++ b/g/g.go @@ -9,13 +9,9 @@ package g import "github.com/gogf/gf/g/container/gvar" // Universal variable type, like generics. -// -// 动态变量类型，可以用该类型替代interface{}类型 type Var = gvar.Var // Frequently-used map type alias. -// -// 常用map数据结构(使用别名) type Map = map[string]interface{} type MapAnyAny = map[interface{}]interface{} type MapAnyStr = map[interface{}]string @@ -28,8 +24,6 @@ type MapIntStr = map[int]string type MapIntInt = map[int]int // Frequently-used slice type alias. -// -// 常用list数据结构(使用别名) type List = []Map type ListAnyStr = []map[interface{}]string type ListAnyInt = []map[interface{}]int @@ -41,8 +35,6 @@ type ListIntStr = []map[int]string type ListIntInt = []map[int]int // Frequently-used slice type alias. -// -// 常用slice数据结构(使用别名) type Slice = []interface{} type SliceAny = []interface{} type SliceStr = []string diff --git a/g/g_func.go b/g/g_func.go index 78c54497b..670e28136 100644 --- a/g/g_func.go +++ b/g/g_func.go @@ -13,38 +13,28 @@ import ( "github.com/gogf/gf/g/util/gutil" ) -// NewVar creates a *Var. -// -// 动态变量 +// NewVar returns a *gvar.Var. func NewVar(i interface{}, unsafe...bool) *Var { return gvar.New(i, unsafe...) } // Wait blocks until all the web servers shutdown. -// -// 阻塞等待HTTPServer执行完成(同一进程多HTTPServer情况下) func Wait() { ghttp.Wait() } // Dump dumps a variable to stdout with more manually readable. -// -// 格式化打印变量. func Dump(i...interface{}) { gutil.Dump(i...) } // Export exports a variable to string with more manually readable. -// -// 格式化导出变量. func Export(i...interface{}) string { return gutil.Export(i...) } -// Throw throws a exception, which can be caught by Catch function. +// Throw throws a exception, which can be caught by TryCatch function. // It always be used in TryCatch function. -// -// 抛出一个异常 func Throw(exception interface{}) { gutil.Throw(exception) } @@ -55,12 +45,8 @@ func TryCatch(try func(), catch ... func(exception interface{})) { } // IsEmpty checks given value empty or not. -// false: integer(0), bool(false), slice/map(len=0), nil; -// true : other. -// -// 判断给定的变量是否为空。 -// 整型为0, 布尔为false, slice/map长度为0, 其他为nil的情况，都为空。 -// 为空时返回true，否则返回false。 +// It returns false if value is: integer(0), bool(false), slice/map(len=0), nil; +// or else true. func IsEmpty(value interface{}) bool { return empty.IsEmpty(value) } \ No newline at end of file diff --git a/g/g_logger.go b/g/g_logger.go index 551bade79..c32a2cfb8 100644 --- a/g/g_logger.go +++ b/g/g_logger.go @@ -10,23 +10,17 @@ import ( "github.com/gogf/gf/g/os/glog" ) -// Disable/Enabled debug of logging globally. -// -// 是否显示调试信息 +// SetDebug disables/enables debug level for logging globally. func SetDebug(debug bool) { glog.SetDebug(debug) } -// Set the logging level globally. -// -// 设置日志的显示等级 +// SetLogLevel sets the logging level globally. func SetLogLevel(level int) { glog.SetLevel(level) } -// Get the global logging level. -// -// 获取设置的日志显示等级 +// GetLogLevel returns the global logging level. func GetLogLevel() int { return glog.GetLevel() } \ No newline at end of file diff --git a/g/g_object.go b/g/g_object.go index f8799b02d..8bb8feaed 100644 --- a/g/g_object.go +++ b/g/g_object.go @@ -17,59 +17,42 @@ import ( "github.com/gogf/gf/g/os/gcfg" ) -// Get an instance of http server with specified name. -// -// HTTPServer单例对象 +// Server returns an instance of http server with specified name. func Server(name...interface{}) *ghttp.Server { return ghttp.GetServer(name...) } -// Get an instance of tcp server with specified name. -// -// TCPServer单例对象 +// TCPServer returns an instance of tcp server with specified name. func TCPServer(name...interface{}) *gtcp.Server { return gtcp.GetServer(name...) } -// Get an instance of udp server with specified name. -// -// UDPServer单例对象 +// UDPServer returns an instance of udp server with specified name. func UDPServer(name...interface{}) *gudp.Server { return gudp.GetServer(name...) } -// Get an instance of template engine object with specified name. -// -// 核心对象：View +// View returns an instance of template engine object with specified name. func View(name...string) *gview.View { return gins.View(name...) } -// Get an instance of config object with specified default config file name. -// -// Config配置管理对象, -// 配置文件目录查找依次为：启动参数cfgpath、当前程序运行目录 +// Config returns an instance of config object with specified name. func Config(file...string) *gcfg.Config { return gins.Config(file...) } -// Get an instance of database ORM object with specified configuration group name. -// -// 数据库操作对象，使用了连接池 +// Database returns an instance of database ORM object with specified configuration group name. func Database(name...string) gdb.DB { return gins.Database(name...) } -// Alias of Database. -// -// (别名)Database +// Alias of Database. See Database. func DB(name...string) gdb.DB { return gins.Database(name...) } -// Get an instance of redis client with specified configuration group name. -// -// Redis操作对象，使用了连接池 +// Redis returns an instance of redis client with specified configuration group name. func Redis(name...string) *gredis.Redis { return gins.Redis(name...) } \ No newline at end of file diff --git a/g/g_setting.go b/g/g_setting.go index c12f43b98..71e093a73 100644 --- a/g/g_setting.go +++ b/g/g_setting.go @@ -8,9 +8,8 @@ package g import "github.com/gogf/gf/g/net/ghttp" -// SetServerGraceful enables/disables graceful reload feature of ghttp Web Server. -// -// 是否开启WebServer的平滑重启特性。 +// SetServerGraceful enables/disables graceful/hot reload feature of http Web Server. +// This feature is disabled in default. func SetServerGraceful(enabled bool) { ghttp.SetGraceful(enabled) } diff --git a/g/net/net.go b/g/net/net.go deleted file mode 100644 index 9d9f1a11e..000000000 --- a/g/net/net.go +++ /dev/null @@ -1 +0,0 @@ -package net diff --git a/g/os/gtime/gtime.go b/g/os/gtime/gtime.go index 749a8e9fe..089806709 100644 --- a/g/os/gtime/gtime.go +++ b/g/os/gtime/gtime.go @@ -147,7 +147,7 @@ func parseDateStr(s string) (year, month, day int) { return } year, _ = strconv.Atoi(array[2]) - day, _ = strconv.Atoi(array[1]) + day, _ = strconv.Atoi(array[0]) } // 年是否为缩写，如果是，那么需要补上前缀 if year < 100 { diff --git a/g/os/os.go b/g/os/os.go deleted file mode 100644 index cf1f67e04..000000000 --- a/g/os/os.go +++ /dev/null @@ -1 +0,0 @@ -package os diff --git a/g/test/gtest/gtest.go b/g/test/gtest/gtest.go index 30d61b9a2..0b520e0a8 100644 --- a/g/test/gtest/gtest.go +++ b/g/test/gtest/gtest.go @@ -4,9 +4,7 @@ // If a copy of the MIT was not distributed with this file, // You can obtain one at https://github.com/gogf/gf. -// Package gtest provides simple and useful test utils. -// -// 测试模块. +// Package gtest provides convenient test utils for unit testing. package gtest import ( @@ -19,7 +17,9 @@ import ( "testing" ) -// 封装一个测试用例 +// Case creates an unit test case. +// The param is the pointer to testing.T of stdlib (*testing.T). +// The param is the callback function for unit test case. func Case(t *testing.T, f func()) { defer func() { if err := recover(); err != nil { @@ -30,7 +30,7 @@ func Case(t *testing.T, f func()) { f() } -// 断言判断, 相等 +// Assert checks and EQUAL. func Assert(value, expect interface{}) { rvValue := reflect.ValueOf(value) rvExpect := reflect.ValueOf(expect) @@ -50,14 +50,9 @@ func Assert(value, expect interface{}) { } } -// 断言判断, 相等, 包括数据类型 +// AssertEQ checks and EQUAL, including their TYPES. func AssertEQ(value, expect interface{}) { - // 类型判断 - t1 := reflect.TypeOf(value) - t2 := reflect.TypeOf(expect) - if t1 != t2 { - panic(fmt.Sprintf(`[ASSERT] EXPECT TYPE %v == %v`, t1, t2)) - } + // Value assert. rvValue := reflect.ValueOf(value) rvExpect := reflect.ValueOf(expect) if rvValue.Kind() == reflect.Ptr { @@ -74,9 +69,15 @@ func AssertEQ(value, expect interface{}) { if fmt.Sprintf("%v", value) != fmt.Sprintf("%v", expect) { panic(fmt.Sprintf(`[ASSERT] EXPECT %v == %v`, value, expect)) } + // Type assert. + t1 := reflect.TypeOf(value) + t2 := reflect.TypeOf(expect) + if t1 != t2 { + panic(fmt.Sprintf(`[ASSERT] EXPECT TYPE %v[%v] == %v[%v]`, value, t1, expect, t2)) + } } -// 断言判断, 不相等 +// AssertNE checks and NOT EQUAL. func AssertNE(value, expect interface{}) { rvValue := reflect.ValueOf(value) rvExpect := reflect.ValueOf(expect) @@ -96,7 +97,9 @@ func AssertNE(value, expect interface{}) { } } -// 断言判断, value > expect; 注意: 仅有字符串、整形、浮点型才可以比较 +// AssertGT checks is GREATER THAN . +// Notice that, only string, integer and float types can be compared by AssertGT, +// others are invalid. func AssertGT(value, expect interface{}) { passed := false switch reflect.ValueOf(expect).Kind() { @@ -117,7 +120,9 @@ func AssertGT(value, expect interface{}) { } } -// 断言判断, value >= expect; 注意: 仅有字符串、整形、浮点型才可以比较 +// AssertGTE checks is GREATER OR EQUAL THAN . +// Notice that, only string, integer and float types can be compared by AssertGTE, +// others are invalid. func AssertGTE(value, expect interface{}) { passed := false switch reflect.ValueOf(expect).Kind() { @@ -138,7 +143,9 @@ func AssertGTE(value, expect interface{}) { } } -// 断言判断, value < expect; 注意: 仅有字符串、整形、浮点型才可以比较 +// AssertLT checks is LESS EQUAL THAN . +// Notice that, only string, integer and float types can be compared by AssertLT, +// others are invalid. func AssertLT(value, expect interface{}) { passed := false switch reflect.ValueOf(expect).Kind() { @@ -159,7 +166,9 @@ func AssertLT(value, expect interface{}) { } } -// 断言判断, value <= expect; 注意: 仅有字符串、整形、浮点型才可以比较 +// AssertLTE checks is LESS OR EQUAL THAN . +// Notice that, only string, integer and float types can be compared by AssertLTE, +// others are invalid. func AssertLTE(value, expect interface{}) { passed := false switch reflect.ValueOf(expect).Kind() { @@ -180,16 +189,18 @@ func AssertLTE(value, expect interface{}) { } } - -// 断言判断, value IN expect; 注意: expect必须为slice类型。 -// 注意：value参数可以为普通变量，也可以为slice类型。 +// AssertIN checks is IN . +// The should be a slice, +// but the can be a slice or a basic type variable. +// TODO map support. func AssertIN(value, expect interface{}) { passed := true switch reflect.ValueOf(expect).Kind() { case reflect.Slice, reflect.Array: + expectSlice := gconv.Interfaces(expect) for _, v1 := range gconv.Interfaces(value) { result := false - for _, v2 := range gconv.Interfaces(expect) { + for _, v2 := range expectSlice { if v1 == v2 { result = true break @@ -206,7 +217,10 @@ func AssertIN(value, expect interface{}) { } } -// 断言判断, value NOT IN expect; 注意: expect必须为slice类型 +// AssertNI checks is NOT IN . +// The should be a slice, +// but the can be a slice or a basic type variable. +// TODO map support. func AssertNI(value, expect interface{}) { passed := true switch reflect.ValueOf(expect).Kind() { @@ -230,18 +244,18 @@ func AssertNI(value, expect interface{}) { } } -// 提示错误不退出进程执行 +// Error panics with given . func Error(message...interface{}) { panic(fmt.Sprintf("[ERROR] %s", fmt.Sprint(message...))) } -// 提示错误并退出进程执行 +// Fatal prints to stderr and exit the process. func Fatal(message...interface{}) { fmt.Fprintf(os.Stderr, "[FATAL] %s\n%s", fmt.Sprint(message...), getBacktrace()) os.Exit(1) } -// Map比较，如果相等返回nil，否则返回错误信息. +// compareMap compares two maps, returns nil if they are equal, or else returns error. func compareMap(value, expect interface{}) error { rvValue := reflect.ValueOf(value) rvExpect := reflect.ValueOf(expect) @@ -253,8 +267,9 @@ func compareMap(value, expect interface{}) error { if rvExpect.Kind() == reflect.Map { if rvValue.Kind() == reflect.Map { if rvExpect.Len() == rvValue.Len() { - // 将两个map类型转换为同一个map类型, 才能执行比较, - // 直接使用 rvValue.MapIndex(key).Interface() 当key类型不一致时会报错。 + // Turn two interface maps to the same type for comparison. + // Direct use of rvValue.MapIndex(key).Interface() will panic + // when the key types are inconsistent. mValue := make(map[string]string) mExpect := make(map[string]string) ksValue := rvValue.MapKeys() @@ -280,7 +295,8 @@ func compareMap(value, expect interface{}) error { return nil } -// 获取文件调用回溯字符串，参数skip表示调用端往上多少级开始回溯 +// getBacktrace returns the caller backtrace content from getBacktrace. +// The param indicates the skip count of the caller backtrace from getBacktrace. func getBacktrace(skip...int) string { customSkip := 0 if len(skip) > 0 { @@ -289,7 +305,7 @@ func getBacktrace(skip...int) string { backtrace := "" index := 1 from := 0 - // 首先定位业务文件开始位置 + // Ignore current gtest lines and find the beginning index of caller file. for i := 0; i < 10; i++ { if _, file, _, ok := runtime.Caller(i); ok { if reg, _ := regexp.Compile(`gtest\.go$`); !reg.MatchString(file) { @@ -298,7 +314,7 @@ func getBacktrace(skip...int) string { } } } - // 从业务文件开始位置根据自定义的skip开始backtrace + // Get the caller backtrace from business caller file. goRoot := runtime.GOROOT() for i := from + customSkip; i < 10000; i++ { if _, file, cline, ok := runtime.Caller(i); ok && file != "" { diff --git a/g/util/util.go b/g/util/util.go deleted file mode 100644 index c7d868219..000000000 --- a/g/util/util.go +++ /dev/null @@ -1 +0,0 @@ -package util diff --git a/geg/other/test.go b/geg/other/test.go index 7028e0f04..e4b2f208e 100644 --- a/geg/other/test.go +++ b/geg/other/test.go @@ -2,10 +2,12 @@ package main import ( "fmt" - "github.com/gogf/gf/g/os/gcfg" + "github.com/gogf/gf/g/container/gring" ) func main() { - fmt.Println(gcfg.Instance().GetString("viewpath")) - fmt.Println(gcfg.Instance().GetString("database.default.0.host")) + r := gring.New(3) + r.Put(1) + r.Put(2) + fmt.Println(r.Val()) } \ No newline at end of file