README
¶
GoFrame
GoFrame is a modular, powerful, high-performance and enterprise-class application development framework of Golang.
Features
- modular, loosely coupled design
- rich components, out-of-the-box
- automatic codes generating for efficiency
- simple and easy to use, detailed documentation
- interface designed components, with high scalability
- fully supported tracing and error stack feature
- specially developed and powerful ORM component
- robust engineering design specifications
- convenient development CLI tool provide
- OpenTelemetry observability features support
- OpenAPIV3 documentation generating, automatically
- much, much more...ready to explore?
Installation
Enter your repo. directory and execute following command:
primary module
go get -u -v github.com/gogf/gf/v2
cli tool
go install github.com/gogf/gf/cmd/gf/v2
Limitation
golang version >= 1.15
Architecture
Documentation
- Chinese Official Site(中文官网): https://goframe.org
- GoDoc API: https://pkg.go.dev/github.com/gogf/gf
License
GoFrame is licensed under the MIT License, 100% free and open-source, forever.
Part Of Users
We list part of the users here, if your company or products are using
GoFrame, please let us know here.
Contributors
This project exists thanks to all the people who contribute. [Contributors].
Donators
If you love GoFrame, why not buy developer a cup of coffee?
Sponsors
We appreciate any kind of sponsorship for GoFrame development. If you've got some interesting, please contact WeChat 389961817 / Email john@goframe.org.
Thanks
Documentation
¶
Index ¶
Constants ¶
View Source
const AUTHORS = "john<john@goframe.org>"
View Source
const VERSION = "v2.2.0-beta2"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
container
|
|
|
garray
Package garray provides most commonly used array containers which also support concurrent-safe/unsafe switch feature.
|
Package garray provides most commonly used array containers which also support concurrent-safe/unsafe switch feature. |
|
glist
Package glist provides most commonly used doubly linked list container which also supports concurrent-safe/unsafe switch feature.
|
Package glist provides most commonly used doubly linked list container which also supports concurrent-safe/unsafe switch feature. |
|
gmap
Package gmap provides most commonly used map container which also support concurrent-safe/unsafe switch feature.
|
Package gmap provides most commonly used map container which also support concurrent-safe/unsafe switch feature. |
|
gpool
Package gpool provides object-reusable concurrent-safe pool.
|
Package gpool provides object-reusable concurrent-safe pool. |
|
gqueue
Package gqueue provides dynamic/static concurrent-safe queue.
|
Package gqueue provides dynamic/static concurrent-safe queue. |
|
gring
Package gring provides a concurrent-safe/unsafe ring(circular lists).
|
Package gring provides a concurrent-safe/unsafe ring(circular lists). |
|
gset
Package gset provides kinds of concurrent-safe/unsafe sets.
|
Package gset provides kinds of concurrent-safe/unsafe sets. |
|
gtree
Package gtree provides concurrent-safe/unsafe tree containers.
|
Package gtree provides concurrent-safe/unsafe tree containers. |
|
gtype
Package gtype provides high performance and concurrent-safe basic variable types.
|
Package gtype provides high performance and concurrent-safe basic variable types. |
|
gvar
Package gvar provides an universal variable type, like generics.
|
Package gvar provides an universal variable type, like generics. |
|
crypto
|
|
|
gaes
Package gaes provides useful API for AES encryption/decryption algorithms.
|
Package gaes provides useful API for AES encryption/decryption algorithms. |
|
gcrc32
Package gcrc32 provides useful API for CRC32 encryption algorithms.
|
Package gcrc32 provides useful API for CRC32 encryption algorithms. |
|
gdes
Package gdes provides useful API for DES encryption/decryption algorithms.
|
Package gdes provides useful API for DES encryption/decryption algorithms. |
|
gmd5
Package gmd5 provides useful API for MD5 encryption algorithms.
|
Package gmd5 provides useful API for MD5 encryption algorithms. |
|
gsha1
Package gsha1 provides useful API for SHA1 encryption algorithms.
|
Package gsha1 provides useful API for SHA1 encryption algorithms. |
|
database
|
|
|
gdb
Package gdb provides ORM features for popular relationship databases.
|
Package gdb provides ORM features for popular relationship databases. |
|
gredis
Package gredis provides convenient client for redis server.
|
Package gredis provides convenient client for redis server. |
|
debug
|
|
|
gdebug
Package gdebug contains facilities for programs to debug themselves while they are running.
|
Package gdebug contains facilities for programs to debug themselves while they are running. |
|
encoding
|
|
|
gbase64
Package gbase64 provides useful API for BASE64 encoding/decoding algorithm.
|
Package gbase64 provides useful API for BASE64 encoding/decoding algorithm. |
|
gbinary
Package gbinary provides useful API for handling binary/bytes data.
|
Package gbinary provides useful API for handling binary/bytes data. |
|
gcharset
Package gcharset implements character-set conversion functionality.
|
Package gcharset implements character-set conversion functionality. |
|
gcompress
Package gcompress provides kinds of compression algorithms for binary/bytes data.
|
Package gcompress provides kinds of compression algorithms for binary/bytes data. |
|
ghash
Package ghash provides some classic hash functions(uint32/uint64) in go.
|
Package ghash provides some classic hash functions(uint32/uint64) in go. |
|
ghtml
Package ghtml provides useful API for HTML content handling.
|
Package ghtml provides useful API for HTML content handling. |
|
gini
Package gini provides accessing and converting for INI content.
|
Package gini provides accessing and converting for INI content. |
|
gjson
Package gjson provides convenient API for JSON/XML/INI/YAML/TOML data handling.
|
Package gjson provides convenient API for JSON/XML/INI/YAML/TOML data handling. |
|
gproperties
Package gproperties provides accessing and converting for .properties content.
|
Package gproperties provides accessing and converting for .properties content. |
|
gtoml
Package gtoml provides accessing and converting for TOML content.
|
Package gtoml provides accessing and converting for TOML content. |
|
gurl
Package gurl provides useful API for URL handling.
|
Package gurl provides useful API for URL handling. |
|
gxml
Package gxml provides accessing and converting for XML content.
|
Package gxml provides accessing and converting for XML content. |
|
gyaml
Package gyaml provides accessing and converting for YAML content.
|
Package gyaml provides accessing and converting for YAML content. |
|
errors
|
|
|
gcode
Package gcode provides universal error code definition and common error codes implements.
|
Package gcode provides universal error code definition and common error codes implements. |
|
gerror
Package gerror provides rich functionalities to manipulate errors.
|
Package gerror provides rich functionalities to manipulate errors. |
|
frame
|
|
|
gins
Package gins provides instances and core components management.
|
Package gins provides instances and core components management. |
|
i18n
|
|
|
gi18n
Package gi18n implements internationalization and localization.
|
Package gi18n implements internationalization and localization. |
|
internal
|
|
|
command
Package command provides console operations, like options/arguments reading.
|
Package command provides console operations, like options/arguments reading. |
|
consts
Package consts defines constants that are shared all among packages of framework.
|
Package consts defines constants that are shared all among packages of framework. |
|
deepcopy
Package deepcopy makes deep copies of things using reflection.
|
Package deepcopy makes deep copies of things using reflection. |
|
empty
Package empty provides functions for checking empty/nil variables.
|
Package empty provides functions for checking empty/nil variables. |
|
fileinfo
Package fileinfo provides virtual os.FileInfo for given information.
|
Package fileinfo provides virtual os.FileInfo for given information. |
|
intlog
Package intlog provides internal logging for GoFrame development usage only.
|
Package intlog provides internal logging for GoFrame development usage only. |
|
json
Package json provides json operations wrapping ignoring stdlib or third-party lib json.
|
Package json provides json operations wrapping ignoring stdlib or third-party lib json. |
|
mutex
Package mutex provides switch of concurrent safe feature for sync.Mutex.
|
Package mutex provides switch of concurrent safe feature for sync.Mutex. |
|
reflection
Package reflection provides some reflection functions for internal usage.
|
Package reflection provides some reflection functions for internal usage. |
|
rwmutex
Package rwmutex provides switch of concurrent safety feature for sync.RWMutex.
|
Package rwmutex provides switch of concurrent safety feature for sync.RWMutex. |
|
tracing
Package tracing provides some utility functions for tracing functionality.
|
Package tracing provides some utility functions for tracing functionality. |
|
utils
Package utils provides some utility functions for internal usage.
|
Package utils provides some utility functions for internal usage. |
|
net
|
|
|
gclient
Package gclient provides convenient http client functionalities.
|
Package gclient provides convenient http client functionalities. |
|
ghttp
Package ghttp provides powerful http server and simple client implements.
|
Package ghttp provides powerful http server and simple client implements. |
|
ghttp/internal/swaggerui
Package swaggerui provides packed swagger ui static files using resource manager.
|
Package swaggerui provides packed swagger ui static files using resource manager. |
|
gipv4
Package gipv4 provides useful API for IPv4 address handling.
|
Package gipv4 provides useful API for IPv4 address handling. |
|
gipv6
Package gipv6 provides useful API for IPv6 address handling.
|
Package gipv6 provides useful API for IPv6 address handling. |
|
goai
Package goai implements and provides document generating for OpenApi specification.
|
Package goai implements and provides document generating for OpenApi specification. |
|
gsel
Package gsel provides selector definition and implements.
|
Package gsel provides selector definition and implements. |
|
gsvc
Package gsvc provides service registry and discovery definition.
|
Package gsvc provides service registry and discovery definition. |
|
gtcp
Package gtcp provides TCP server and client implementations.
|
Package gtcp provides TCP server and client implementations. |
|
gtrace
Package gtrace provides convenience wrapping functionality for tracing feature using OpenTelemetry.
|
Package gtrace provides convenience wrapping functionality for tracing feature using OpenTelemetry. |
|
gudp
Package gudp provides UDP server and client implementations.
|
Package gudp provides UDP server and client implementations. |
|
os
|
|
|
gbuild
Package gbuild manages the build-in variables from "gf build".
|
Package gbuild manages the build-in variables from "gf build". |
|
gcache
Package gcache provides kinds of cache management for process.
|
Package gcache provides kinds of cache management for process. |
|
gcfg
Package gcfg provides reading, caching and managing for configuration.
|
Package gcfg provides reading, caching and managing for configuration. |
|
gcmd
Package gcmd provides console operations, like options/arguments reading and command running.
|
Package gcmd provides console operations, like options/arguments reading and command running. |
|
gcron
Package gcron implements a cron pattern parser and job runner.
|
Package gcron implements a cron pattern parser and job runner. |
|
gctx
Package gctx wraps context.Context and provides extra context features.
|
Package gctx wraps context.Context and provides extra context features. |
|
genv
Package genv provides operations for environment variables of system.
|
Package genv provides operations for environment variables of system. |
|
gfile
Package gfile provides easy-to-use operations for file system.
|
Package gfile provides easy-to-use operations for file system. |
|
gfpool
Package gfpool provides io-reusable pool for file pointer.
|
Package gfpool provides io-reusable pool for file pointer. |
|
gfsnotify
Package gfsnotify provides a platform-independent interface for file system notifications.
|
Package gfsnotify provides a platform-independent interface for file system notifications. |
|
glog
Package glog implements powerful and easy-to-use levelled logging functionality.
|
Package glog implements powerful and easy-to-use levelled logging functionality. |
|
gmlock
Package gmlock implements a concurrent-safe memory-based locker.
|
Package gmlock implements a concurrent-safe memory-based locker. |
|
gmutex
Package gmutex implements graceful concurrent-safe mutex with more rich features.
|
Package gmutex implements graceful concurrent-safe mutex with more rich features. |
|
gproc
Package gproc implements management and communication for processes.
|
Package gproc implements management and communication for processes. |
|
gres
Package gres provides resource management and packing/unpacking feature between files and bytes.
|
Package gres provides resource management and packing/unpacking feature between files and bytes. |
|
grpool
Package grpool implements a goroutine reusable pool.
|
Package grpool implements a goroutine reusable pool. |
|
gsession
Package gsession implements manager and storage features for sessions.
|
Package gsession implements manager and storage features for sessions. |
|
gspath
Package gspath implements file index and search for folders.
|
Package gspath implements file index and search for folders. |
|
gstructs
Package gstructs provides functions for struct information retrieving.
|
Package gstructs provides functions for struct information retrieving. |
|
gtime
Package gtime provides functionality for measuring and displaying time.
|
Package gtime provides functionality for measuring and displaying time. |
|
gtimer
Package gtimer implements timer for interval/delayed jobs running and management.
|
Package gtimer implements timer for interval/delayed jobs running and management. |
|
gview
Package gview implements a template engine based on text/template.
|
Package gview implements a template engine based on text/template. |
|
test
|
|
|
gtest
Package gtest provides convenient test utilities for unit testing.
|
Package gtest provides convenient test utilities for unit testing. |
|
text
|
|
|
gregex
Package gregex provides high performance API for regular expression functionality.
|
Package gregex provides high performance API for regular expression functionality. |
|
gstr
Package gstr provides functions for string handling.
|
Package gstr provides functions for string handling. |
|
util
|
|
|
gconv
Package gconv implements powerful and convenient converting functionality for any types of variables.
|
Package gconv implements powerful and convenient converting functionality for any types of variables. |
|
gmeta
Package gmeta provides embedded meta data feature for struct.
|
Package gmeta provides embedded meta data feature for struct. |
|
gmode
Package gmode provides release mode management for project.
|
Package gmode provides release mode management for project. |
|
gpage
Package gpage provides useful paging functionality for web pages.
|
Package gpage provides useful paging functionality for web pages. |
|
grand
Package grand provides high performance random bytes/number/string generation functionality.
|
Package grand provides high performance random bytes/number/string generation functionality. |
|
gtag
Package gtag providing tag content storing for struct.
|
Package gtag providing tag content storing for struct. |
|
gutil
Package gutil provides utility functions.
|
Package gutil provides utility functions. |
|
gvalid
Package gvalid implements powerful and useful data/form validation functionality.
|
Package gvalid implements powerful and useful data/form validation functionality. |
|
gvalid/internal/builtin
Package builtin implements built-in validation rules.
|
Package builtin implements built-in validation rules. |
Click to show internal directories.
Click to hide internal directories.