description update

gogf · Nov 13, 2024 · 6756026 · 6756026
1 parent 34ce7cb
commit 6756026
Show file tree

Hide file tree

Showing 102 changed files with 102 additions and 102 deletions.
diff --git a/docs/docs/WEB服务开发/Cookie.md b/docs/docs/WEB服务开发/Cookie.md
@@ -4,7 +4,7 @@ title: 'Cookie'
 sidebar_position: 6
 hide_title: true
 keywords: [Cookie,GoFrame,GoFrame框架,ghttp,SessionId,接口文档,SetCookie,HTTP Server,Session,web开发]
-description: '如何在GoFrame框架中使用Cookie进行会话管理。通过ghttp.Request对象，开发者可以轻松获取、设置和删除Cookie。还讨论了SessionId的获取和设置，Cookie的过期时间处理，以及在控制器中继承和使用会话对象的简易方法。这些功能为Web开发者提供了强大的工具来管理用户会话，确保Web应用的灵活性和应变能力。'
+description: '在GoFrame框架中使用Cookie进行会话管理。通过ghttp.Request对象，开发者可以轻松获取、设置和删除Cookie。还讨论了SessionId的获取和设置，Cookie的过期时间处理，以及在控制器中继承和使用会话对象的简易方法。这些功能为Web开发者提供了强大的工具来管理用户会话，确保Web应用的灵活性和应变能力。'
 ---
 
 ## 基本介绍

diff --git a/docs/docs/WEB服务开发/HTTPClient/HTTPClient-基本使用.md b/docs/docs/WEB服务开发/HTTPClient/HTTPClient-基本使用.md
@@ -4,7 +4,7 @@ title: 'HTTPClient-基本使用'
 sidebar_position: 0
 hide_title: true
 keywords: [HTTP,GoFrame,GoFrame框架,HTTP客户端,GET请求,POST请求,JSON数据,DELETE请求,ghttp客户端,网络请求]
-description: '如何使用GoFrame框架通过基本的HTTP客户端操作来发送GET、POST、DELETE请求，并处理返回值。本文还讨论了如何使用POST方法发送JSON数据、使用多参数、map类型参数进行请求。同时，提供了*Bytes、*Content和*Var方法的简要介绍，以帮助开发者更便捷地处理HTTP请求和响应内容。'
+description: '使用GoFrame框架通过基本的HTTP客户端操作来发送GET、POST、DELETE请求，并处理返回值。本文还讨论了如何使用POST方法发送JSON数据、使用多参数、map类型参数进行请求。同时，提供了*Bytes、*Content和*Var方法的简要介绍，以帮助开发者更便捷地处理HTTP请求和响应内容。'
 ---
 
 ## 基本使用

diff --git a/docs/docs/WEB服务开发/分页管理/分页管理-URL模板.md b/docs/docs/WEB服务开发/分页管理/分页管理-URL模板.md
@@ -4,7 +4,7 @@ title: '分页管理-URL模板'
 sidebar_position: 3
 hide_title: true
 keywords: [GoFrame,GoFrame框架,gpage,分页管理,URL模板,自定义URL,内置变量,页面渲染,代码示例,模板替换]
-description: '如何使用GoFrame框架的gpage进行分页管理，并通过自定义URL模板功能，使用内置变量替换页码内容来实现页面的动态渲染。文章提供了详细的代码示例，展示了通过设置UrlTemplate属性实现分页URL的个性化配置，为开发者提供了灵活高效的解决方案。'
+description: '使用GoFrame框架的gpage进行分页管理，并通过自定义URL模板功能，使用内置变量替换页码内容来实现页面的动态渲染。文章提供了详细的代码示例，展示了通过设置UrlTemplate属性实现分页URL的个性化配置，为开发者提供了灵活高效的解决方案。'
 ---
 
 `gpage` 支持自定义 `URL` 模板，在模板中可以使用 `{.page}` 内置变量替换页码的内容，我们来看一个简单的示例：

diff --git a/docs/docs/WEB服务开发/请求输入/请求输入-请求校验.md b/docs/docs/WEB服务开发/请求输入/请求输入-请求校验.md
@@ -4,7 +4,7 @@ title: '请求输入-请求校验'
 sidebar_position: 2
 hide_title: true
 keywords: [GoFrame,请求校验,GoFrame框架,gvalid,Struct校验,路由注册,请求参数,错误处理,注册请求,数据校验]
-description: '如何在GoFrame框架中通过v标签为结构体属性实现请求的输入校验。在示例中，我们讲解了如何使用gvalid模块进行校验，如何设置和解析注册请求的数据结构，以及在出现校验错误时如何处理，并展示了如何通过curl测试接口响应的数据和错误信息。此外，我们提供了不同版本的使用建议，以提高用户体验和代码的易用性。'
+description: '在GoFrame框架中通过v标签为结构体属性实现请求的输入校验。在示例中，我们讲解了如何使用gvalid模块进行校验，如何设置和解析注册请求的数据结构，以及在出现校验错误时如何处理，并展示了如何通过curl测试接口响应的数据和错误信息。此外，我们提供了不同版本的使用建议，以提高用户体验和代码的易用性。'
 ---
 
 `Request` 对象支持非常完美的请求校验能力，通过给结构体属性绑定 `v` 标签即可。由于底层校验功能通过 `gvalid` 模块实现，

diff --git a/docs/docs/WEB服务开发/请求输入/请求输入-默认值绑定.md b/docs/docs/WEB服务开发/请求输入/请求输入-默认值绑定.md
@@ -4,7 +4,7 @@ title: '请求输入-默认值绑定'
 sidebar_position: 4
 hide_title: true
 keywords: [GoFrame,GoFrame框架,请求输入,默认值绑定,struct tag,参数对象,分页,服务端,中间件,ghttp]
-description: '如何在GoFrame框架中使用struct tag为请求输入对象的属性绑定默认值的功能。通过示例展示了如何定义参数对象并为其属性设置默认值，以及如何在服务端处理和验证请求参数。特别强调了在未提交参数时，默认值将生效，而在提交了参数（即使为空）的情况下，默认值将被忽略。同时提供了一些关于默认值参数绑定的注意事项建议。'
+description: '在GoFrame框架中使用struct tag为请求输入对象的属性绑定默认值的功能。通过示例展示了如何定义参数对象并为其属性设置默认值，以及如何在服务端处理和验证请求参数。特别强调了在未提交参数时，默认值将生效，而在提交了参数（即使为空）的情况下，默认值将被忽略。同时提供了一些关于默认值参数绑定的注意事项建议。'
 ---
 
 从 `v1.15` 版本开始， `Request` 请求对象支持通过 `struct tag` 的方式为输入对象的属性绑定默认值。默认值的 `struct tag` 名称为 `d`(也可以使用 `default`)。

diff --git a/docs/docs/WEB服务开发/高级特性/CORS跨域处理.md b/docs/docs/WEB服务开发/高级特性/CORS跨域处理.md
@@ -4,7 +4,7 @@ title: 'CORS跨域处理'
 sidebar_position: 4
 hide_title: true
 keywords: [CORS,跨域请求,GoFrame,中间件,AJAX,Origin,CORSOptions,跨域访问,GoFrame框架,WebSocket]
-description: '如何使用GoFrame框架处理CORS跨域请求，结合路由管理中间件设置跨域规则，允许WebSocket跨域访问。提供CORS对象及其配置参数，包含默认和限制Origin来源的设置。同时，通过示例展示了基本使用方法、授权跨域Origin和自定义检测的方法，以实现更灵活的跨域请求管理。'
+description: '使用GoFrame框架处理CORS跨域请求，结合路由管理中间件设置跨域规则，允许WebSocket跨域访问。提供CORS对象及其配置参数，包含默认和限制Origin来源的设置。同时，通过示例展示了基本使用方法、授权跨域Origin和自定义检测的方法，以实现更灵活的跨域请求管理。'
 ---
 
 允许接口跨域往往是需要结合 [路由管理-中间件/拦截器](../%E8%B7%AF%E7%94%B1%E7%AE%A1%E7%90%86/%E8%B7%AF%E7%94%B1%E7%AE%A1%E7%90%86-%E4%B8%AD%E9%97%B4%E4%BB%B6%E6%8B%A6%E6%88%AA%E5%99%A8/%E4%B8%AD%E9%97%B4%E4%BB%B6%E6%8B%A6%E6%88%AA%E5%99%A8-%E5%9F%BA%E6%9C%AC%E4%BB%8B%E7%BB%8D.md) 一起使用，来统一设置某些路由规则下的接口可以跨域访问。同时，针对允许 `WebSocket` 的跨域请求访问，也是通过该方式来实现。

diff --git a/docs/docs/WEB服务开发/高级特性/WebSocket服务.md b/docs/docs/WEB服务开发/高级特性/WebSocket服务.md
@@ -4,7 +4,7 @@ title: 'WebSocket服务'
 sidebar_position: 7
 hide_title: true
 keywords: [WebSocket,GoFrame,WebSocket服务,GoFrame框架,WebSocket开发,WebSocket客户端,HTTPS支持,WebSocket安全,WebSocket连接,GoFrame示例]
-description: '如何使用GoFrame框架开发WebSocket服务，包括HTML5客户端、WebSocket服务端、HTTPS支持和安全校验等内容。通过示例代码，展示了WebSocket的连接与信息传递机制，并详细说明了服务端与客户端之间的通信流程和数据处理方法，让读者能够快速上手并实现功能齐全的WebSocket服务。'
+description: '使用GoFrame框架开发WebSocket服务，包括HTML5客户端、WebSocket服务端、HTTPS支持和安全校验等内容。通过示例代码，展示了WebSocket的连接与信息传递机制，并详细说明了服务端与客户端之间的通信流程和数据处理方法，让读者能够快速上手并实现功能齐全的WebSocket服务。'
 ---
 
 使用 `goframe` 框架进行 `websocket` 开发相当简单。我们以下通过实现一个简单的 `echo服务器` 来演示 `goframe` 框架的 `websocket` 的使用（客户端使用HTML5实现）。

diff --git a/docs/docs/WEB服务开发/高级特性/服务日志管理.md b/docs/docs/WEB服务开发/高级特性/服务日志管理.md
@@ -4,7 +4,7 @@ title: '服务日志管理'
 sidebar_position: 1
 hide_title: true
 keywords: [GoFrame,Server日志管理,access log,error log,日志配置,日志格式,错误日志,请求日志,自定义日志处理,glog]
-description: '如何使用GoFrame框架进行服务日志管理，包括access log和error log的配置与使用。详细解释了日志配置对象及属性，如Logger、LogPath、ErrorStack等，并提供了详细的日志格式说明和自定义日志处理方法。同时，还涉及如何通过配置文件和代码方法进行日志设置，以及日志格式和错误日志的记录方式和示例。'
+description: '使用GoFrame框架进行服务日志管理，包括access log和error log的配置与使用。详细解释了日志配置对象及属性，如Logger、LogPath、ErrorStack等，并提供了详细的日志格式说明和自定义日志处理方法。同时，还涉及如何通过配置文件和代码方法进行日志设置，以及日志格式和错误日志的记录方式和示例。'
 ---
 
 `GoFrame` 框架提供了完善的 `Server` 日志管理功能，包括 `access log` 以及 `error log`，推荐使用配置文件的方式统一配置管理。

diff --git a/docs/docs/开发工具/代码生成-gen/数据表PB-gen pbentity.md b/docs/docs/开发工具/代码生成-gen/数据表PB-gen pbentity.md
@@ -4,7 +4,7 @@ title: '数据表PB-gen pbentity'
 sidebar_position: 5
 hide_title: true
 keywords: [GoFrame,Golang实体对象,proto数据结构,GRPC服务,数据库配置,GF命令行工具,数据表生成,entity文件生成,pbentity,命名格式]
-description: '如何使用GoFrame框架的命令行工具gf来根据数据库表生成proto数据结构文件pbentity。包括命令使用方法、选项配置及其说明，以及与gen dao模块中生成的entity文件的区别。适用于HTTP和GRPC服务的数据实体结构生成，支持多种数据库的生成规则配置。'
+description: '使用GoFrame框架的命令行工具gf来根据数据库表生成proto数据结构文件pbentity。包括命令使用方法、选项配置及其说明，以及与gen dao模块中生成的entity文件的区别。适用于HTTP和GRPC服务的数据实体结构生成，支持多种数据库的生成规则配置。'
 ---
 :::tip
 该功能特性从 `v2.4` 版本开始提供。

diff --git a/docs/docs/微服务开发/服务配置管理.md b/docs/docs/微服务开发/服务配置管理.md
@@ -4,7 +4,7 @@ title: '服务配置管理'
 sidebar_position: 7
 hide_title: true
 keywords: [GoFrame,配置管理,微服务,Polaris,Apollo,Nacos,Consul,Kubernetes,容器编排,配置中心]
-description: '如何在GoFrame框架中使用配置管理组件，通过解耦化设计，支持多种第三方配置中心如Polaris、Apollo、Nacos、Consul等。通过详细代码展示了如何初始化和启用Polaris配置客户端，并提供了使用示例和错误处理方式。'
+description: '在GoFrame框架中使用配置管理组件，通过解耦化设计，支持多种第三方配置中心如Polaris、Apollo、Nacos、Consul等。通过详细代码展示了如何初始化和启用Polaris配置客户端，并提供了使用示例和错误处理方式。'
 ---
 
 ## 基本介绍

diff --git a/docs/docs/服务可观测性/服务监控告警/监控告警-基本使用.md b/docs/docs/服务可观测性/服务监控告警/监控告警-基本使用.md
@@ -4,7 +4,7 @@ title: '监控告警-基本使用'
 sidebar_position: 1
 hide_title: true
 keywords: [GoFrame,监控指标,otelmetric,OpenTelemetry,指标管理,Counter,MetricOption,gmetric,数据读取,指标实现]
-description: '如何在GoFrame框架中使用gmetric组件进行监控指标的开发。通过引入otelmetric组件，可以利用OpenTelemetry实现框架的监控指标接口。文章详细描述了指标管理对象的创建、各种监控指标对象的使用及初始化方法，并通过代码示例展示了如何读取和操作指标数据。'
+description: '在GoFrame框架中使用gmetric组件进行监控指标的开发。通过引入otelmetric组件，可以利用OpenTelemetry实现框架的监控指标接口。文章详细描述了指标管理对象的创建、各种监控指标对象的使用及初始化方法，并通过代码示例展示了如何读取和操作指标数据。'
 ---
 
 ## 基本介绍

diff --git a/docs/docs/服务可观测性/服务监控告警/监控告警-指标属性.md b/docs/docs/服务可观测性/服务监控告警/监控告警-指标属性.md
@@ -4,7 +4,7 @@ title: '监控告警-指标属性'
 sidebar_position: 4
 hide_title: true
 keywords: [监控告警,指标属性,GoFrame,常量属性,变量属性,全局属性,OpenTelemetry,Prometheus,Meter,指标注入]
-description: '如何在GoFrame框架中的监控告警组件中使用指标属性进行过滤、汇总和统计。提供了常量属性、变量属性和全局属性三种属性注入方式，并通过具体示例演示了如何在不同场景下应用这些属性。结合OpenTelemetry和Prometheus，展示了如何定义和应用指标属性，以实现灵活高效的数据监控和分析。'
+description: '在GoFrame框架中的监控告警组件中使用指标属性进行过滤、汇总和统计。提供了常量属性、变量属性和全局属性三种属性注入方式，并通过具体示例演示了如何在不同场景下应用这些属性。结合OpenTelemetry和Prometheus，展示了如何定义和应用指标属性，以实现灵活高效的数据监控和分析。'
 ---
 
 指标属性用于在更上层的指标使用中进行过滤、汇总、统计等高纬度操作。在 `GoFrame` 框架的监控告警组件中，提供了3种属性注入方式： **常量属性**、 **变量属性** 和 **全局属性**。

diff --git a/docs/docs/核心组件/I18N国际化/I18N国际化-使用介绍.md b/docs/docs/核心组件/I18N国际化/I18N国际化-使用介绍.md
@@ -4,7 +4,7 @@ title: 'I18N国际化-使用介绍'
 sidebar_position: 1
 hide_title: true
 keywords: [GoFrame,i18n,国际化,多语言,上下文,模板转译,context,T方法,独立对象,SetLanguage]
-description: '如何在GoFrame框架中使用i18n国际化功能，包括对象创建、语言设置、常用方法以及与视图引擎的集成。详细描述了通过单例和独立对象管理语言转译的方式，使用SetLanguage和WithLanguage方法进行语言设定，并通过T和Tf方法实现关键字和模板内容的转译。文章还展示了通过上下文设置和视图引擎进行国际化操作的示例。'
+description: '在GoFrame框架中使用i18n国际化功能，包括对象创建、语言设置、常用方法以及与视图引擎的集成。详细描述了通过单例和独立对象管理语言转译的方式，使用SetLanguage和WithLanguage方法进行语言设定，并通过T和Tf方法实现关键字和模板内容的转译。文章还展示了通过上下文设置和视图引擎进行国际化操作的示例。'
 ---
 
 ## 对象创建

diff --git a/docs/docs/核心组件/命令管理/命令管理-命令行对象.md b/docs/docs/核心组件/命令管理/命令管理-命令行对象.md
@@ -4,7 +4,7 @@ title: '命令管理-命令行对象'
 sidebar_position: 3
 hide_title: true
 keywords: [GoFrame,命令行管理,gcmd,Command对象,回调方法,Parser解析,启动命令,层级命令,子命令,帮助信息]
-description: '如何使用GoFrame框架中的gcmd库管理命令行对象和命令，涵盖了Command对象的定义、回调方法的使用以及命令的层级管理。同时，提供了在GoFrame框架下启动HTTP和gRPC服务的命令行实现示例，展示了如何为命令增加子命令，并自动生成帮助信息。'
+description: '使用GoFrame框架中的gcmd库管理命令行对象和命令，涵盖了Command对象的定义、回调方法的使用以及命令的层级管理。同时，提供了在GoFrame框架下启动HTTP和gRPC服务的命令行实现示例，展示了如何为命令增加子命令，并自动生成帮助信息。'
 ---
 
 ## 基本介绍

diff --git a/docs/docs/核心组件/命令管理/命令管理-结构化参数.md b/docs/docs/核心组件/命令管理/命令管理-结构化参数.md
@@ -4,7 +4,7 @@ title: '命令管理-结构化参数'
 sidebar_position: 4
 hide_title: true
 keywords: [GoFrame,GoFrame框架,命令行管理,结构化参数,自动数据转换,参数校验,命令行工具,数据类型转换,配置读取,框架开发]
-description: '如何通过GoFrame框架实现命令行管理的结构化参数处理。通过对象化管理父级及子级命令，定义规范化的输入参数对象，实现命令行的自动数据转换及校验功能。通过GoFrame的框架开发工具，用户可以轻松管理多个命令行项目，支持从配置中读取数据，提升项目的开发效率和稳定性。'
+description: '通过GoFrame框架实现命令行管理的结构化参数处理。通过对象化管理父级及子级命令，定义规范化的输入参数对象，实现命令行的自动数据转换及校验功能。通过GoFrame的框架开发工具，用户可以轻松管理多个命令行项目，支持从配置中读取数据，提升项目的开发效率和稳定性。'
 ---
 
 ## 命令行管理痛点

diff --git a/docs/docs/核心组件/数据库ORM/ORM事务处理/ORM事务处理-嵌套事务.md b/docs/docs/核心组件/数据库ORM/ORM事务处理/ORM事务处理-嵌套事务.md
@@ -4,7 +4,7 @@ title: 'ORM事务处理-嵌套事务'
 sidebar_position: 2
 hide_title: true
 keywords: [GoFrame,GoFrame框架,ORM,嵌套事务,事务处理,数据库,SQL,事务保存点,回滚,闭包]
-description: '如何使用GoFrame框架中的ORM功能来处理嵌套事务的问题。文章详细讲解了嵌套事务的基本原理、方法以及日志信息，同时给出了常规操作和闭包操作的示例，并指出可能出现的问题。最后提供了嵌套事务在工程中的参考示例，帮助开发者理解在实际项目中如何应用。'
+description: '使用GoFrame框架中的ORM功能来处理嵌套事务的问题。文章详细讲解了嵌套事务的基本原理、方法以及日志信息，同时给出了常规操作和闭包操作的示例，并指出可能出现的问题。最后提供了嵌套事务在工程中的参考示例，帮助开发者理解在实际项目中如何应用。'
 ---
 
 从 `GoFrame ORM` 支持数据库嵌套事务，嵌套事务在业务项目中用得比较多，特别是业务模块之间的相互调用，保证各个业务模块的数据库操作都处于一个事务中，其原理是通过传递的 `context` 上下文来隐式传递和关联同一个事务对象。需要注意的是，数据库服务往往并不支持嵌套事务，而是依靠 `ORM` 组件层通过 `Transaction Save Point` 特性实现的。同样的，我们推荐使用 `Transaction` 闭包方法来实现嵌套事务操作。为了保证文档的完整性，因此我们这里仍然从最基本的事务操作方法开始来介绍嵌套事务操作。

diff --git a/docs/docs/核心组件/数据库ORM/ORM接口开发/ORM接口开发-回调处理.md b/docs/docs/核心组件/数据库ORM/ORM接口开发/ORM接口开发-回调处理.md
@@ -4,7 +4,7 @@ title: 'ORM接口开发-回调处理'
 sidebar_position: 0
 hide_title: true
 keywords: [GoFrame,ORM接口,SQL语句,自定义回调,日志记录,鉴权操作,数据库驱动,MySQL驱动,gdb接口,框架覆盖]
-description: '如何在使用GoFrame框架进行ORM接口开发时，通过自定义回调处理来对SQL语句进行日志记录或鉴权。通过实现并覆盖DoQuery、DoExec等接口方法，开发者可以注入自定义逻辑到默认实现中。示例中展示了如何自定义MySQL驱动以记录执行的SQL语句，并配置gdb以使用该驱动。'
+description: '在使用GoFrame框架进行ORM接口开发时，通过自定义回调处理来对SQL语句进行日志记录或鉴权。通过实现并覆盖DoQuery、DoExec等接口方法，开发者可以注入自定义逻辑到默认实现中。示例中展示了如何自定义MySQL驱动以记录执行的SQL语句，并配置gdb以使用该驱动。'
 ---
 
 ## 基本介绍

diff --git a/docs/docs/核心组件/数据库ORM/ORM时区处理.md b/docs/docs/核心组件/数据库ORM/ORM时区处理.md
@@ -4,7 +4,7 @@ title: 'ORM时区处理'
 sidebar_position: 5
 hide_title: true
 keywords: [GoFrame框架,ORM时区处理,MySQL时区,time.Time,数据库驱动,时区转换,loc参数,时区设置,配置文件,time.Parse]
-description: '如何在GoFrame框架中处理ORM操作中的时区问题，特别是使用MySQL数据库时的时区转换。我们讲解了如何通过设置loc参数来控制time.Time对象在提交到数据库时的时区处理，并提供了相关代码示例和配置建议，帮助开发者在处理数据库操作时更好地管理时区。'
+description: '在GoFrame框架中处理ORM操作中的时区问题，特别是使用MySQL数据库时的时区转换。我们讲解了如何通过设置loc参数来控制time.Time对象在提交到数据库时的时区处理，并提供了相关代码示例和配置建议，帮助开发者在处理数据库操作时更好地管理时区。'
 ---
 
 ## 基本介绍