# GoFrame > GoFrame 是 Go 语言的模块化应用开发框架。本文件是自包含文档集的入口，文档链接指向本项目内的 Markdown 文件。版本与运行要求见[框架概览](guide/overview.md)。 GoFrame 既可以作为完整项目框架使用，也可以按需引入独立组件。核心模块位于 `github.com/gogf/gf/v2`，数据库驱动、注册中心、Redis 适配器等扩展位于 `contrib` 子模块，按需单独引入。本文件只做导航，事实性内容以链接页面为准。需要单文件版本时读取 `llms-full.txt`。 ## 从这里开始 - [框架概览](guide/overview.md) - [源码结构](guide/source-map.md) - [AI 开发约定](guide/ai-conventions.md) 推荐阅读顺序：框架概览，快速开始，核心组件，WEB 服务开发，数据库 ORM，组件列表。需要生成代码时先读 AI 开发约定。 ## 快速开始 - [下载与使用](quick/install.md) - [Hello World](quick/hello-world.md) - [获取请求参数](quick/request-input.md) - [请求数据结构](quick/request-struct.md) - [使用规范路由](quick/strict-router.md) - [中间件初试用](quick/middleware.md) - [统一返回结构](quick/common-response.md) - [生成接口文档](quick/api-doc.md) - [What's Next](quick/quick-next.md) ### 项目脚手架 - [基本介绍](quick/scaffold-index.md) - [项目启动](quick/scaffold-boost.md) - [What's Next](quick/scaffold-next.md) #### 接口开发 - [接口开发](quick/scaffold-api.md) - [Step1 - 设计数据表](quick/scaffold-api-sql.md) - [Step2 - 生成/dao/do/entity](quick/scaffold-api-gen-dao.md) - [Step3 - 编写api接口定义](quick/scaffold-api-definition.md) - [Step4 - 生成controller代码](quick/scaffold-api-controller.md) - [Step5 - 完成接口逻辑实现](quick/scaffold-api-implements.md) - [Step6 - 配置与路由](quick/scaffold-api-config-and-route.md) - [Step7 - 启动与测试](quick/scaffold-api-run-and-test.md) ## 核心组件 - [对象管理](docs/core/g.md) - [调试模式](docs/core/debugging.md) ### 命令管理 - [命令管理](docs/core/gcmd.md) - [命令管理-基本概念](docs/core/gcmd-intro.md) - [命令管理-基础方法](docs/core/gcmd-funcs.md) - [命令管理-Parser解析](docs/core/gcmd-parser.md) - [命令管理-命令行对象](docs/core/gcmd-command.md) - [命令管理-结构化参数](docs/core/gcmd-struct.md) - [命令管理-终端交互](docs/core/gcmd-scan.md) - [命令管理-链路跟踪](docs/core/gcmd-tracing.md) ### 配置管理 - [配置管理](docs/core/gcfg.md) - [配置管理-配置对象](docs/core/gcfg-cfg.md) - [配置管理-文件配置](docs/core/gcfg-file.md) - [配置管理-常用方法](docs/core/gcfg-funcs.md) - [配置管理-YAML格式](docs/core/gcfg-yaml.md) - [配置管理-TOML格式](docs/core/gcfg-toml.md) - [配置管理-配置监听回调](docs/core/gcfg-watcher.md) - [配置管理-Loader加载器](docs/core/gcfg-loader.md) #### 接口化设计 - [配置管理-接口化设计](docs/core/gcfg-interface.md) - [配置管理-AdapterFile](docs/core/gcfg-interface-adapter-file.md) - [配置管理-AdapterContent](docs/core/gcfg-interface-adapter-content.md) ### 日志组件 - [日志组件](docs/core/glog.md) - [日志组件-配置管理](docs/core/glog-config.md) - [日志组件-日志级别](docs/core/glog-level.md) - [日志组件-文件目录](docs/core/glog-file-folder.md) - [日志组件-链式操作](docs/core/glog-chaining.md) - [日志组件-颜色打印](docs/core/glog-color.md) - [日志组件-Context](docs/core/glog-context.md) - [日志组件-Handler](docs/core/glog-handler.md) - [日志组件-JSON格式](docs/core/glog-json.md) - [日志组件-异步输出](docs/core/glog-async.md) - [日志组件-堆栈打印](docs/core/glog-stack.md) - [日志组件-调试信息](docs/core/glog-debug.md) - [日志组件-Writer接口](docs/core/glog-writer.md) - [日志组件-Flags特性](docs/core/glog-flags.md) - [日志组件-Rotate特性](docs/core/glog-rotate.md) - [日志组件-常见问题](docs/core/glog-faq.md) ### 错误处理 - [错误处理](docs/core/gerror.md) - [错误处理-常用方法](docs/core/gerror-funcs.md) - [错误处理-堆栈特性](docs/core/gerror-stack.md) - [错误处理-错误比较](docs/core/gerror-comparison.md) - [错误处理-国际化支持](docs/core/gerror-i18n.md) - [错误处理-其他特性](docs/core/gerror-other.md) - [错误处理-最佳实践](docs/core/gerror-practice.md) - [错误处理-性能测试](docs/core/gerror-benchmark.md) #### 错误码特性 - [错误处理-错误码特性](docs/core/gerror-code.md) - [错误处理-错误码接口](docs/core/gerror-code-interface.md) - [错误处理-错误码使用](docs/core/gerror-code-example.md) - [错误处理-错误码扩展](docs/core/gerror-code-extension.md) - [错误处理-错误码实现](docs/core/gerror-code-custom.md) - [错误处理-内置错误码](docs/core/gerror-code-builtin.md) ### 数据校验 - [数据校验](docs/core/gvalid.md) - [数据校验-校验规则](docs/core/gvalid-rules.md) - [数据校验-校验对象](docs/core/gvalid-validator.md) - [数据校验-校验结果](docs/core/gvalid-result-handling.md) - [数据校验-可选校验](docs/core/gvalid-optional-rule.md) - [数据校验-递归校验](docs/core/gvalid-recursive-validating.md) - [数据校验-自定义错误](docs/core/gvalid-custom-validating-message.md) - [数据校验-方法介绍](docs/core/gvalid-funcs.md) - [数据校验-常见问题](docs/core/gvalid-faq.md) #### 参数类型 - [数据校验-单数据校验](docs/core/gvalid-parameter-type-basic.md) - [Map校验-基本使用](docs/core/gvalid-parameter-type-map-example.md) - [Map校验-校验顺序性](docs/core/gvalid-parameter-type-map-sequence.md) - [Struct校验-基本使用](docs/core/gvalid-parameter-type-struct-example.md) - [Struct校验-Assoc关联](docs/core/gvalid-parameter-type-struct-assoc.md) #### 自定义规则 - [数据校验-自定义规则](docs/core/gvalid-custom-rules.md) - [自定义规则-规则注册](docs/core/gvalid-custom-rules-register.md) - [自定义规则-完整数据校验](docs/core/gvalid-custom-rules-handle-input-parameters.md) ### 类型转换 - [类型转换](docs/core/gconv.md) - [类型转换-基本类型](docs/core/gconv-basic.md) - [类型转换-Map转换](docs/core/gconv-map.md) - [类型转换-Struct转换](docs/core/gconv-struct.md) - [类型转换-Structs转换](docs/core/gconv-structs.md) - [类型转换-Scan转换](docs/core/gconv-scan.md) - [类型转换-Converter](docs/core/gconv-converter.md) - [类型转换-自定义类型转换](docs/core/gconv-register-converter-func.md) - [类型转换-UnmarshalValue](docs/core/gconv-unmarshal-value.md) - [类型转换-性能测试](docs/core/gconv-benchmark.md) ### 缓存管理 - [缓存管理](docs/core/gcache.md) - [缓存管理-接口设计](docs/core/gcache-interface.md) - [缓存管理-内存缓存](docs/core/gcache-memory.md) - [缓存管理-Redis缓存](docs/core/gcache-redis.md) - [缓存管理-方法介绍](docs/core/gcache-funcs.md) ### 模板引擎 - [模板引擎](docs/core/gview.md) - [模板引擎-模板配置](docs/core/gview-config.md) - [模板引擎-模板标签](docs/core/gview-tags.md) - [模板引擎-模板变量](docs/core/gview-variable.md) - [模板引擎-模板布局](docs/core/gview-layout.md) - [模板引擎-XSS处理](docs/core/gview-xss.md) - [模板引擎-其他使用](docs/core/gview-more.md) #### 模板函数 - [模板函数-基础函数](docs/core/gview-funcs-index.md) - [模板函数-内置函数](docs/core/gview-funcs-builtin.md) - [模板函数-自定义函数](docs/core/gview-funcs-custom.md) ### 数据库ORM - [数据库ORM](docs/core/gdb.md) - [ORM方法操作(原生)](docs/core/gdb-funcs.md) - [ORM时区处理](docs/core/gdb-timezone.md) - [ORM模型生成](docs/core/gdb-model-generating.md) - [ORM上下文变量](docs/core/gdb-context.md) - [ORM常见问题](docs/core/gdb-faq.md) #### ORM使用配置 - [ORM使用配置-配置文件](docs/core/gdb-config-file.md) - [ORM使用配置-配置方法](docs/core/gdb-config-funcs.md) - [ORM使用配置-常见问题](docs/core/gdb-config-faq.md) #### ORM链式操作 - [ORM链式操作](docs/core/gdb-chaining.md) - [ORM链式操作-模型创建](docs/core/gdb-chaining-model.md) - [ORM链式操作-写入保存](docs/core/gdb-chaining-insert-save.md) - [ORM链式操作-更新删除](docs/core/gdb-chaining-update-delete.md) - [ORM链式操作-对象输入](docs/core/gdb-chaining-object-parameter.md) - [ORM链式操作-字段过滤](docs/core/gdb-chaining-fields-filtering.md) - [ORM链式操作-字段获取](docs/core/gdb-chaining-fields-retrieving.md) - [ORM链式操作-事务处理](docs/core/gdb-chaining-transaction.md) - [ORM链式操作-主从切换](docs/core/gdb-chaining-master-slave.md) - [ORM链式操作-查询缓存](docs/core/gdb-chaining-query-cache.md) - [ORM链式操作-数据库切换](docs/core/gdb-chaining-schema.md) - [ORM链式操作-Hook特性](docs/core/gdb-chaining-hook.md) - [ORM链式操作-Handler特性](docs/core/gdb-chaining-handler.md) - [ORM链式操作-悲观锁 & 乐观锁](docs/core/gdb-chaining-locks.md) - [ORM查询-Where条件](docs/core/gdb-chaining-query-where.md) - [ORM查询-常用查询方法](docs/core/gdb-chaining-query-all-one-array-value-count.md) - [ORM查询-AllAndCount](docs/core/gdb-chaining-query-all-and-count.md) - [ORM查询-Exist](docs/core/gdb-chaining-query-exist.md) - [ORM查询-Scan](docs/core/gdb-chaining-query-scan.md) - [ORM查询-ScanAndCount](docs/core/gdb-chaining-query-scan-and-count.md) - [ORM查询-Join查询](docs/core/gdb-chaining-query-join.md) - [ORM查询-分组排序过滤](docs/core/gdb-chaining-query-group-order-having.md) - [ORM查询-Union/UnionAll](docs/core/gdb-chaining-query-union.md) - [ORM查询-子查询特性](docs/core/gdb-chaining-query-sub-query.md) - [ORM查询-常用操作示例](docs/core/gdb-chaining-query-example.md) - [模型关联-动态关联-ScanList](docs/core/gdb-chaining-relation-scan-list.md) - [模型关联-静态关联-With特性](docs/core/gdb-chaining-relation-with.md) - [ORM链式操作-时间维护](docs/core/gdb-chaining-soft-time.md) - [时间维护-基本使用](docs/core/gdb-chaining-soft-time-example.md) - [时间维护-整型字段](docs/core/gdb-chaining-soft-time-numeric-fields.md) - [时间维护-布尔字段](docs/core/gdb-chaining-soft-time-bool-fields.md) - [时间维护-SoftTimeOption](docs/core/gdb-chaining-soft-time-option.md) #### ORM事务处理 - [ORM事务处理](docs/core/gdb-transaction.md) - [ORM事务处理-常规操作](docs/core/gdb-transaction-basic.md) - [ORM事务处理-闭包操作](docs/core/gdb-transaction-closure.md) - [ORM事务处理-嵌套事务](docs/core/gdb-transaction-nested.md) - [ORM事务处理-事务传播](docs/core/gdb-transaction-propagation.md) - [ORM事务处理-隔离级别](docs/core/gdb-transaction-isolation-level.md) - [ORM事务处理-只读模式](docs/core/gdb-transaction-readonly.md) #### ORM结果处理 - [ORM结果处理-结果类型](docs/core/gdb-result-types.md) - [ORM结果处理-为空判断](docs/core/gdb-result-empty-check.md) - [ORM结果处理-空数组结构返回](docs/core/gdb-result-empty-array.md) #### ORM分库分表 - [ORM分库分表](docs/core/gdb-sharding.md) - [ORM分库分表-分表特性](docs/core/gdb-sharding-table.md) - [ORM分库分表-分库特性](docs/core/gdb-sharding-schema.md) #### ORM高级特性 - [ORM高级特性-RawSQL](docs/core/gdb-senior-raw-sql.md) - [ORM高级特性-SQL捕获](docs/core/gdb-senior-catch-sql.md) - [ORM高级特性-调试模式](docs/core/gdb-senior-debugging.md) - [ORM高级特性-日志输出](docs/core/gdb-senior-logging.md) - [ORM高级特性-字段映射](docs/core/gdb-senior-fields-mapping.md) - [ORM高级特性-空跑特性](docs/core/gdb-senior-dry-run.md) - [ORM高级特性-类型识别](docs/core/gdb-senior-type-recognization.md) - [ORM高级特性-类型转换](docs/core/gdb-senior-type-converting.md) - [ORM高级特性-连接池状态](docs/core/gdb-senior-connection-pool.md) - [ORM高级特性-内嵌结构支持](docs/core/gdb-senior-nested-struct-support.md) - [ORM高级特性-自定义类型转换](docs/core/gdb-senior-custom-type-converting.md) #### ORM接口开发 - [ORM接口开发](docs/core/gdb-interface.md) - [ORM接口开发-回调处理](docs/core/gdb-interface-callback.md) - [ORM接口开发-驱动开发](docs/core/gdb-interface-driver.md) #### ORM最佳实践 - [ORM最佳实践](docs/core/gdb-practice.md) - [利用指针属性和do对象实现灵活的修改接口](docs/core/gdb-practice-using-pointer-and-do-for-update-api.md) - [复杂类型尽量使用json存储，便于Scan到对象时自动化转换，避免自定义解析](docs/core/gdb-practice-using-json-for-complicated-field.md) - [查询时避免返回对象初始化及sql.ErrNoRows判断](docs/core/gdb-practice-avoid-object-initialization-and-sql-errnorows-error.md) ### I18N国际化 - [I18N国际化](docs/core/gi18n.md) - [I18N国际化-配置管理](docs/core/gi18n-config.md) - [I18N国际化-使用介绍](docs/core/gi18n-example.md) ### 资源管理 - [资源管理](docs/core/gres.md) - [资源管理-工具打包](docs/core/gres-pack-using-cli.md) - [资源管理-方法打包](docs/core/gres-pack-using-funcs.md) - [资源管理-方法介绍](docs/core/gres-funcs.md) - [资源管理-使用示例](docs/core/gres-example.md) - [资源管理-最佳实践](docs/core/gres-practice.md) ## WEB 服务开发 - [开始使用](docs/web/start.md) - [Cookie](docs/web/cookie.md) - [异常处理](docs/web/panic-handling.md) - [性能测试](docs/web/performance.md) - [常见问题](docs/web/faq.md) ### 路由管理 - [路由管理](docs/web/router.md) - [路由管理-路由规则](docs/web/router-pattern.md) #### 路由注册 - [路由管理-路由注册](docs/web/router-registering.md) - [路由注册-函数注册](docs/web/router-registering-callback.md) - [路由注册-对象注册](docs/web/router-registering-struct.md) - [路由注册-分组路由](docs/web/router-registering-group.md) - [路由注册-规范路由](docs/web/router-registering-strict-router.md) - [规范路由-基本示例](docs/web/router-registering-strict-router-example.md) - [规范路由-如何使用](docs/web/router-registering-strict-router-usage.md) - [规范路由-常见问题](docs/web/router-registering-strict-router-faq.md) #### 中间件/拦截器 - [路由管理-中间件/拦截器](docs/web/router-middleware.md) - [中间件/拦截器-基本介绍](docs/web/router-middleware-intro.md) - [中间件/拦截器-使用示例](docs/web/router-middleware-example.md) - [中间件/拦截器-常见问题](docs/web/router-middleware-faq.md) ### 接口文档 - [接口文档](docs/web/api-document.md) - [接口文档-OpenAPIv3](docs/web/api-document-openapiv3.md) - [接口文档-扩展Response](docs/web/api-document-extendable-response.md) - [接口文档-自定义UI](docs/web/api-document-swagger-ui.md) ### 请求输入 - [请求输入](docs/web/request.md) - [请求输入-参数处理](docs/web/request-parameters.md) - [请求输入-对象处理](docs/web/request-struct-converting.md) - [请求输入-请求校验](docs/web/request-validation.md) - [请求输入-JSON/XML](docs/web/request-json-xml-parameter.md) - [请求输入-默认值绑定](docs/web/request-default-value.md) - [请求输入-自定义参数](docs/web/request-custom-parameters.md) - [请求输入-Context](docs/web/request-context.md) - [请求输入-文件上传](docs/web/request-file-uploading.md) ### 数据返回 - [数据返回](docs/web/response.md) - [数据返回-缓冲控制](docs/web/response-buffering.md) - [数据返回-JSON/XML](docs/web/response-json-xml.md) - [数据返回-Redirect](docs/web/response-redirect.md) - [数据返回-Exit控制](docs/web/response-exit-exitall-exithook.md) - [数据返回-文件下载](docs/web/response-file-downloading.md) - [数据返回-模板解析](docs/web/response-template.md) - [数据返回-Stream返回](docs/web/response-stream.md) ### 服务配置 - [服务配置](docs/web/server-config.md) - [服务配置-配置文件](docs/web/server-config-file.md) - [服务配置-配置文件模板](docs/web/server-config-file-template.md) - [服务配置-配置方法](docs/web/server-config-funcs.md) ### Session - [Session](docs/web/session.md) - [Session-File](docs/web/session-file.md) - [Session-Memory](docs/web/session-memory.md) - [Session-Redis-KeyValue](docs/web/session-redis-key-value.md) - [Session-Redis-HashTable](docs/web/session-redis-hash-table.md) - [Session-Storage接口开发](docs/web/session-storage.md) - [Session-RegenerateId](docs/web/session-regenerate-id.md) ### HTTPClient - [HTTPClient](docs/web/http-client.md) - [HTTPClient-基本使用](docs/web/http-client-example.md) - [HTTPClient-文件上传](docs/web/http-client-file-uploading.md) - [HTTPClient-自定义Cookie](docs/web/http-client-cookie.md) - [HTTPClient-自定义Header](docs/web/http-client-header.md) - [HTTPClient-自定义ContentType](docs/web/http-client-content-type.md) - [HTTPClient-自定义Transport](docs/web/http-client-transport.md) - [HTTPClient-请求信息打印](docs/web/http-client-raw-request-response.md) - [HTTPClient-代理Proxy设置](docs/web/http-client-proxy.md) - [HTTPClient-拦截器/中间件](docs/web/http-client-middleware.md) - [HTTPClient-常见问题](docs/web/http-client-faq.md) - [HTTPClient-监控指标](docs/web/http-client-metrics.md) ### 分页管理 - [分页管理](docs/web/paging.md) - [分页管理-动态分页](docs/web/paging-dynamic.md) - [分页管理-静态分页](docs/web/paging-static.md) - [分页管理-Ajax分页](docs/web/paging-ajax.md) - [分页管理-URL模板](docs/web/paging-template.md) - [分页管理-自定义分页](docs/web/paging-customization.md) ### 高级特性 - [静态文件服务](docs/web/senior-static-server.md) - [服务日志管理](docs/web/senior-logging.md) - [HTTPS & TLS](docs/web/senior-https.md) - [平滑重启特性](docs/web/senior-hot-reload.md) - [CORS跨域处理](docs/web/senior-cors.md) - [CSRF防御设置](docs/web/senior-csrf.md) - [HOOK事件回调](docs/web/senior-hook.md) - [WebSocket服务](docs/web/senior-websocket.md) - [自定义状态码处理](docs/web/senior-status-handler.md) - [PProf服务性能分析](docs/web/senior-pprof.md) - [SameSite设置](docs/web/senior-same-site.md) - [HTTPServer-监控指标](docs/web/senior-server-metrics.md) ## 微服务开发 - [微服务开发](docs/micro-service.md) - [环境准备](docs/micro-service/prepare-environment.md) - [工程管理](docs/micro-service/structure.md) - [脚手架模块](docs/micro-service/scaffold.md) - [服务端配置](docs/micro-service/config.md) - [拦截器组件](docs/micro-service/interceptor.md) - [服务注册发现](docs/micro-service/registry-discovery.md) - [服务负载均衡](docs/micro-service/load-balance.md) - [服务配置管理](docs/micro-service/config-service.md) ## 服务可观测性 - [服务可观测性](docs/obs.md) ### 服务链路跟踪 - [服务链路跟踪](docs/obs/tracing.md) - [链路跟踪-背景知识](docs/obs/tracing-intro.md) - [链路跟踪-准备工作](docs/obs/tracing-prepare.md) - [链路跟踪-基本示例](docs/obs/tracing-example.md) - [链路跟踪-GRPC示例](docs/obs/tracing-grpc-example.md) #### 链路跟踪-HTTP示例 - [链路跟踪-HTTP示例](docs/obs/tracing-http-example.md) - [链路跟踪-HTTP示例-Baggage](docs/obs/tracing-http-example-baggage.md) - [链路跟踪-HTTP示例-数据操作](docs/obs/tracing-http-example-with-database.md) - [链路跟踪-TraceID注入和获取](docs/obs/tracing-practice-inject-traceid.md) ### 服务监控告警 - [服务监控告警](docs/obs/metrics.md) - [监控告警-基本介绍](docs/obs/metrics-intro.md) - [监控告警-基本使用](docs/obs/metrics-example.md) - [监控告警-同步指标](docs/obs/metrics-sync.md) - [监控告警-异步指标](docs/obs/metrics-async.md) - [监控告警-指标属性](docs/obs/metrics-attributes.md) - [监控告警-内置指标](docs/obs/metrics-builtin.md) - [监控告警-组件指标](docs/obs/metrics-components.md) ## 组件列表 - [组件列表](docs/components.md) ### 数据结构 #### 字典类型-gmap - [字典类型-gmap](docs/components/container-gmap.md) - [字典类型-基本使用](docs/components/container-gmap-example.md) - [字典类型-性能测试](docs/components/container-gmap-benchmark.md) - [字典类型-方法介绍](docs/components/container-gmap-funcs.md) #### 数组类型-garray - [数组类型-garray](docs/components/container-garray.md) - [数组类型-基本使用](docs/components/container-garray-example.md) - [数组类型-方法介绍](docs/components/container-garray-funcs.md) #### 集合类型-gset - [集合类型-gset](docs/components/container-gset.md) - [集合类型-基本使用](docs/components/container-gset-example.md) - [集合类型-性能测试](docs/components/container-gset-benchmark.md) - [集合类型-方法介绍](docs/components/container-gset-funcs.md) #### 链表类型-glist - [链表类型-glist](docs/components/container-glist.md) - [链表类型-基本使用](docs/components/container-glist-example.md) - [链表类型-性能测试](docs/components/container-glist-benchmark.md) #### 泛型类型-gvar - [泛型类型-gvar](docs/components/container-gvar.md) - [泛型类型-基本使用](docs/components/container-gvar-example.md) - [泛型类型-方法介绍](docs/components/container-gvar-funcs.md) - [泛型类型-注意事项](docs/components/container-gvar-notice.md) #### 安全类型-gtype - [安全类型-gtype](docs/components/container-gtype.md) - [安全类型-基本使用](docs/components/container-gtype-example.md) - [安全类型-性能测试](docs/components/container-gtype-benchmark.md) #### 队列类型-gqueue - [队列类型-gqueue](docs/components/container-gqueue.md) - [队列类型-基本使用](docs/components/container-gqueue-example.md) - [队列类型-性能测试](docs/components/container-gqueue-benchmark.md) #### 树形类型-gtree - [树形类型-gtree](docs/components/container-gtree.md) - [树形类型-基本使用](docs/components/container-gtree-example.md) - [树形类型-方法介绍](docs/components/container-gtree-funcs.md) #### 对象复用-gpool - [对象复用-gpool](docs/components/container-gpool.md) - [对象复用-基本使用](docs/components/container-gpool-example.md) #### 并发安全环-gring - [并发安全环-gring](docs/components/container-gring.md) - [并发安全环-基本使用](docs/components/container-gring-example.md) - [并发安全环-方法介绍](docs/components/container-gring-funcs.md) ### 系统相关 - [内存锁-gmlock](docs/components/os-gmlock.md) - [互斥锁-gmutex](docs/components/os-gmutex.md) - [上下文-gctx](docs/components/os-gctx.md) - [日志管理-glog](docs/components/os-glog.md) - [缓存管理-gcache](docs/components/os-gcache.md) - [文件管理-gfile](docs/components/os-gfile.md) - [资源管理-gres](docs/components/os-gres.md) - [配置管理-gcfg](docs/components/os-gcfg.md) - [环境变量-genv](docs/components/os-genv.md) - [模板引擎-gview](docs/components/os-gview.md) - [协程管理-grpool](docs/components/os-grpool.md) - [构建信息-gbuild](docs/components/os-gbuild.md) - [对象信息-gstructs](docs/components/os-gstructs.md) #### 定时器-gtimer - [定时器-gtimer](docs/components/os-gtimer.md) - [定时器-基本使用](docs/components/os-gtimer-example.md) - [定时器-性能测试](docs/components/os-gtimer-benchmark.md) #### 时间管理-gtime - [时间管理-gtime](docs/components/os-gtime.md) - [时间管理-时间格式](docs/components/os-gtime-format.md) - [时间管理-时间对象](docs/components/os-gtime-time.md) - [时间管理-工具方法](docs/components/os-gtime-common-funcs.md) - [时间管理-时区设置](docs/components/os-gtime-timezone.md) - [时间管理-方法介绍](docs/components/os-gtime-funcs.md) #### 定时任务-gcron - [定时任务-gcron](docs/components/os-gcron.md) - [定时任务-表达式](docs/components/os-gcron-pattern.md) - [定时任务-基本使用](docs/components/os-gcron-example.md) - [定时任务-日志管理](docs/components/os-gcron-logging.md) - [定时任务-gcron与gtimer](docs/components/os-gcron-differ-with-gtimer.md) #### 文件监控-gfsnotify - [文件监控-gfsnotify](docs/components/os-gfsnotify.md) - [文件监控-添加监控](docs/components/os-gfsnotify-add.md) - [文件监控-移除监控](docs/components/os-gfsnotify-remove.md) - [文件监控-系统参数](docs/components/os-gfsnotify-system-variables.md) #### 进程管理-gproc - [进程管理-gproc](docs/components/os-gproc.md) - [进程管理-基本使用](docs/components/os-gproc-example.md) - [进程管理-进程通信](docs/components/os-gproc-communication-between-processes.md) - [进程管理-信号监听](docs/components/os-gproc-signal.md) - [进程管理-链路跟踪](docs/components/os-gproc-tracing.md) ### 文本处理 - [字符串处理-gstr](docs/components/text-gstr.md) #### 正则表达式-gregex - [正则表达式-gregex](docs/components/text-gregex.md) - [正则表达式-基本使用](docs/components/text-gregex-example.md) - [正则表达式-方法介绍](docs/components/text-gregex-funcs.md) ### 编码解码 - [二进制编解码-gbinary](docs/components/encoding-gbinary.md) - [BASE64编解码-gbase64](docs/components/encoding-gbase64.md) - [经典哈希函数-ghash](docs/components/encoding-ghash.md) - [HTML编解码-ghtml](docs/components/encoding-ghtml.md) - [URL编解码-gurl](docs/components/encoding-gurl.md) - [XML编解码-gxml](docs/components/encoding-gxml.md) - [INI编解码-gini](docs/components/encoding-gini.md) - [YAML编解码-gyaml](docs/components/encoding-gyaml.md) - [TOML编解码-gtoml](docs/components/encoding-gtoml.md) - [字符集转换-gcharset](docs/components/encoding-gcharset.md) - [压缩/解压-gcompress](docs/components/encoding-gcompress.md) #### 通用编解码-gjson - [通用编解码-gjson](docs/components/encoding-gjson.md) - [通用编解码-对象创建](docs/components/encoding-gjson-creation.md) - [通用编解码-层级访问](docs/components/encoding-gjson-nested-visiting.md) - [通用编解码-Struct转换](docs/components/encoding-gjson-struct-converting.md) - [通用编解码-动态创建修改](docs/components/encoding-gjson-dynamic-creating-and-editing.md) - [通用编解码-数据格式转换](docs/components/encoding-gjson-format-converting.md) - [通用编解码-方法介绍](docs/components/encoding-gjson-funcs.md) - [通用编解码-FAQ](docs/components/encoding-gjson-faq.md) ### 数据管理 - [数据库ORM-gdb](docs/components/database-gdb.md) - [Redis客户端-gredis](docs/components/database-gredis.md) ### 网络组件 #### TCP组件 - [TCP组件](docs/components/network-gtcp.md) - [TCP组件-工具方法](docs/components/network-gtcp-funcs.md) - [TCP组件-TLS加密](docs/components/network-gtcp-tls.md) - [TCP组件-连接池特性](docs/components/network-gtcp-connection-pool.md) - [TCP组件-连接对象](docs/components/network-gtcp-conn.md) - [连接对象-消息包处理](docs/components/network-gtcp-conn-package.md) - [连接对象-通信开发进阶](docs/components/network-gtcp-conn-senior.md) #### UDP组件 - [UDP组件](docs/components/network-gudp.md) - [UDP组件-连接对象](docs/components/network-gudp-conn.md) - [UDP组件-工具方法](docs/components/network-gudp-funcs.md) ### 加密解密 - [AES算法-gaes](docs/components/crypto-gaes.md) - [CRC32算法-gcrc32](docs/components/crypto-gcrc32.md) - [DES算法-gdes](docs/components/crypto-gdes.md) - [MD5算法-gmd5](docs/components/crypto-gmd5.md) - [RSA算法-grsa](docs/components/crypto-grsa.md) - [SHA1算法-gsha1](docs/components/crypto-gsha1.md) - [SHA256算法-gsha256](docs/components/crypto-gsha256.md) ### 实用工具 - [随机数-grand](docs/components/util-grand.md) - [唯一数-guid](docs/components/util-guid.md) - [元数据-gmeta](docs/components/util-gmeta.md) - [类型转换-gconv](docs/components/util-gconv.md) - [数据校验-gvalid](docs/components/util-gvalid.md) - [分页管理-gpage](docs/components/util-gpage.md) - [工具方法-gutil](docs/components/util-gutil.md) ### 单元测试 - [单元测试-gtest](docs/components/test-gtest.md) ### 错误管理 - [错误处理-gerror](docs/components/error-gerror.md) - [错误码接口-gcode](docs/components/error-gcode.md) ### 功能调试 - [调试功能-gdebug](docs/components/debug-gdebug.md) ### NoSQL Redis - [NoSQL Redis](docs/components/contrib-nosql-redis.md) - [Redis-配置管理](docs/components/contrib-nosql-redis-config.md) - [Redis-使用示例](docs/components/contrib-nosql-redis-example.md) - [Redis-命令交互](docs/components/contrib-nosql-redis-do-and-serialization.md) - [Redis-高级特性](docs/components/contrib-nosql-redis-conn.md) - [Redis-接口化设计](docs/components/contrib-nosql-redis-interface.md) ## 框架设计 - [框架设计](docs/design.md) - [模块化设计](docs/design/modular.md) - [统一框架设计](docs/design/unified.md) - [全链路跟踪设计](docs/design/tracing.md) - [全错误堆栈设计](docs/design/error-stack.md) - [接口化与泛型设计](docs/design/interface-generic.md) - [隐式与显式初始化](docs/design/initialization.md) - [Golang枚举值管理](docs/design/enums.md) - [Context共享变量](docs/design/context-variable.md) ### 工程开发设计 - [工程开发设计](docs/design/project.md) - [代码分层设计](docs/design/project-layer.md) - [工程目录设计](docs/design/project-structure.md) - [结构化编程设计](docs/design/project-struct-parameter.md) - [数据模型与业务模型](docs/design/project-models.md) - [微服务大仓管理模式](docs/design/project-mono-repo.md) #### DAO封装设计 - [DAO-组件痛点及改进](docs/design/project-dao-pain.md) - [DAO-工程痛点及改进](docs/design/project-dao-improvement.md) ## 开发工具 - [开发工具](docs/cli.md) - [工具安装-install](docs/cli/install.md) - [版本查看-version](docs/cli/version.md) - [框架升级-up](docs/cli/up.md) - [项目创建-init](docs/cli/init.md) - [交叉编译-build](docs/cli/build.md) - [自动编译-run](docs/cli/run.md) - [资源打包-pack](docs/cli/pack.md) - [镜像编译-docker](docs/cli/docker.md) - [兼容修复-fix](docs/cli/fix.md) - [工具帮助-help](docs/cli/help.md) ### 代码生成-gen - [代码生成-gen](docs/cli/gen.md) - [接口规范-gen ctrl](docs/cli/gen-ctrl.md) - [数据规范-gen dao](docs/cli/gen-dao.md) - [模块规范-gen service](docs/cli/gen-service.md) - [枚举维护-gen enums](docs/cli/gen-enums.md) - [协议编译-gen pb](docs/cli/gen-pb.md) - [数据表PB-gen pbentity](docs/cli/gen-pbentity.md) ## 项目部署 - [独立部署](docs/deploy/standalone.md) - [代理部署](docs/deploy/proxy.md) - [容器部署](docs/deploy/container.md) ## AI 辅助开发 - [AI Vibe Coding](ai/vibe-coding.md) - [GoFrame Skills](ai/goframe-skills.md) ## 示例项目 ### gRPC - [gRPC](examples/grpc.md) - [基础示例](examples/grpc/basic.md) - [服务发现](examples/grpc/resolver.md) - [负载均衡](examples/grpc/balancer.md) - [上下文示例](examples/grpc/ctx.md) - [原生 gRPC 示例](examples/grpc/rawgrpc.md) ### NoSQL - [NoSQL](examples/nosql.md) - [Redis](examples/nosql/redis.md) - [MongoDB](examples/nosql/mongodb.md) ### 数据库 - [加密密码数据库连接](examples/database/encoded-pass.md) ### HTTP Server - [HTTP Server](examples/httpserver.md) - [JWT认证](examples/httpserver/jwt.md) - [反向代理](examples/httpserver/proxy.md) - [访问限流](examples/httpserver/rate-limit.md) - [文件上传](examples/httpserver/upload-file.md) - [WebSocket](examples/httpserver/websocket.md) - [JSON数组响应](examples/httpserver/response-json-array.md) - [基本认证](examples/httpserver/basic-auth.md) - [GoFrame MCP HTTP 示例](examples/httpserver/mcp-http.md) - [GoFrame MCP SSE 示例](examples/httpserver/mcp-sse.md) - [Server-Sent Events(SSE)](examples/httpserver/sse.md) - [Swagger认证](examples/httpserver/swagger-auth.md) ### 配置管理 - [配置管理](examples/config.md) - [Apollo](examples/config/apollo.md) - [Consul](examples/config/consul.md) - [Nacos](examples/config/nacos.md) - [Polaris](examples/config/polaris.md) - [Kubernetes ConfigMap](examples/config/kubecm.md) ### 注册发现 - [注册发现](examples/registry.md) - [Consul](examples/registry/consul.md) - [Etcd](examples/registry/etcd.md) - [File](examples/registry/file.md) - [Nacos](examples/registry/nacos.md) - [Polaris](examples/registry/polaris.md) ### 负载均衡 - [负载均衡](examples/balancer.md) - [HTTP负载均衡](examples/balancer/http.md) - [使用Polaris实现负载均衡](examples/balancer/polaris.md) ### 可观测性 - [可观测性](examples/observability.md) #### 指标收集 - [指标收集](examples/observability/metric.md) - [基础用法](examples/observability/metric/basic.md) - [回调处理](examples/observability/metric/callback.md) - [动态属性](examples/observability/metric/dynamic_attributes.md) - [全局属性](examples/observability/metric/global_attributes.md) - [HTTP客户端](examples/observability/metric/http_client.md) - [HTTP服务器](examples/observability/metric/http_server.md) - [指标计量器属性](examples/observability/metric/meter_attributes.md) - [Prometheus集成](examples/observability/metric/prometheus.md) #### 链路跟踪 - [链路跟踪](examples/observability/trace.md) - [gRPC带数据库](examples/observability/trace/grpc-with-db.md) - [HTTP服务](examples/observability/trace/http.md) - [HTTP带数据库](examples/observability/trace/http-with-db.md) - [进程内服务 (HTTP导出器)](examples/observability/trace/inprocess.md) - [进程内服务 (gRPC导出器)](examples/observability/trace/inprocess-grpc.md) - [多进程示例](examples/observability/trace/processes.md) - [OpenTelemetry示例](examples/observability/trace/otlp.md) - [OpenTelemetry Provider](examples/observability/trace/provider.md) ### 工程实践 - [依赖注入](examples/practices/injection.md) - [MVC开发实例](docs/practices/mvc-demo-chat.md) - [快速开发示例](docs/practices/quick-demo.md) - [gRPC项目示例](examples/practices/user-grpc-service.md) - [HTTP项目示例](examples/practices/user-http-service.md) ## 其他资料 - [如何从v1愉快升级到v2](docs/other/happy-upgrading-from-v1-to-v2.md) - [格式化打印占位符](docs/other/printing-format.md) - [附录：系统信号列表](docs/other/system-signals.md) ### 准备开发环境 - [环境安装](docs/install-go/index.md) - [Go Module](docs/install-go/go-module.md) - [开发环境配置](docs/install-go/config-env.md) - [私有依赖管理](docs/install-go/private-go-module.md) ## 常见问题与排查 - [常见问题(FAQ)](docs/faq.md) ## 外部资源 - [官方网站](https://goframe.org) - [英文站点](https://goframe.org/en) - [源码仓库](https://github.com/gogf/gf) - [Go 包文档](https://pkg.go.dev/github.com/gogf/gf/v2) - [GoFrame Skills 仓库](https://github.com/gogf/skills) - [文档源码仓库](https://github.com/gogf/gf-site)