Skip to content

Commit

Permalink
space to %20 for md link
Browse files Browse the repository at this point in the history
  • Loading branch information
gqcn committed Oct 31, 2024
1 parent ba8f09a commit f7489d6
Show file tree
Hide file tree
Showing 56 changed files with 65 additions and 65 deletions.
2 changes: 1 addition & 1 deletion docs/WEB服务开发/开始使用.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ func main() {

## HTTPS支持

`Server` 支持 `HTTPS` 服务,并且也同时支持单进程提供 `HTTP&HTTPS` 服务,HTTPS的详细介绍请参考 [HTTPS&TLS](高级特性/HTTPS & TLS.md) 章节。
`Server` 支持 `HTTPS` 服务,并且也同时支持单进程提供 `HTTP&HTTPS` 服务,HTTPS的详细介绍请参考 [HTTPS&TLS](高级特性/HTTPS%20&%20TLS.md) 章节。

## 更多功能特性

Expand Down
4 changes: 2 additions & 2 deletions docs/常见问题-FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ func main() {
| `v` | `valid` | 数据校验标签。 | [Struct校验-基本使用](核心组件/数据校验/数据校验-参数类型/数据校验-Struct校验/Struct校验-基本使用.md) |
| `p` | `param` | 自定义请求参数匹配。 | [请求输入-对象处理](WEB服务开发/请求输入/请求输入-对象处理.md) |
| `d` | `default` | 请求参数默认值绑定。 | [请求输入-默认值绑定](WEB服务开发/请求输入/请求输入-默认值绑定.md) |
| `orm` | `orm` | ORM标签,用于指定表名、关联关系。 | [数据规范-gen dao](开发工具/代码生成-gen/数据规范-gen dao.md)<br />[模型关联-静态关联-With特性](核心组件/数据库ORM/ORM链式操作/ORM链式操作-模型关联/模型关联-静态关联-With特性.md) |
| `orm` | `orm` | ORM标签,用于指定表名、关联关系。 | [数据规范-gen dao](开发工具/代码生成-gen/数据规范-gen%20dao.md)<br />[模型关联-静态关联-With特性](核心组件/数据库ORM/ORM链式操作/ORM链式操作-模型关联/模型关联-静态关联-With特性.md) |
| `dc` | `description` | 通用结构体属性描述,ORM和接口都用到。属于框架默认的属性描述标签。 | |

其他:
Expand Down Expand Up @@ -166,7 +166,7 @@ export GOPROXY=https://goproxy.cn

具体请看:

- [Go Module](其他资料/准备工作/Go Module.md)
- [Go Module](其他资料/准备工作/Go%20Module.md)
- [https://goproxy.cn](https://goproxy.cn)

### 2、 `Linux` 下安装 `gf` 提示命令不存在 `command not found`
Expand Down
2 changes: 1 addition & 1 deletion docs/微服务开发/工程管理.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ hide_title: true

### 生成数据表结构

我们可以通过 `gf gen pbentity / make pbentity` 命令自动根据数据库中的数据表结构生成对应的 `protobuf` 协议文件。命令介绍请参考章节: [数据表PB-gen pbentity](../开发工具/代码生成-gen/数据表PB-gen pbentity.md)
我们可以通过 `gf gen pbentity / make pbentity` 命令自动根据数据库中的数据表结构生成对应的 `protobuf` 协议文件。命令介绍请参考章节: [数据表PB-gen pbentity](../开发工具/代码生成-gen/数据表PB-gen%20pbentity.md)

### 编译 `proto` 协议文件

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,10 @@ hide_title: true

## 参考资料

- [https://github.com/prometheus/client\_golang](https://github.com/prometheus/client_golang "https://github.com/prometheus/client_golang")
- [https://github.com/prometheus/client\_golang](https://github.com/prometheus/client_golang%20"https://github.com/prometheus/client_golang")

- [https://github.com/open-telemetry/opentelemetry-go-contrib](https://github.com/open-telemetry/opentelemetry-go-contrib "https://github.com/open-telemetry/opentelemetry-go-contrib")
- [https://github.com/open-telemetry/opentelemetry-go-contrib](https://github.com/open-telemetry/opentelemetry-go-contrib%20"https://github.com/open-telemetry/opentelemetry-go-contrib")

- [https://opentelemetry.io/docs/specs/otel/metrics/api/](https://opentelemetry.io/docs/specs/otel/metrics/api/ "https://opentelemetry.io/docs/specs/otel/metrics/api/")
- [https://opentelemetry.io/docs/specs/otel/metrics/api/](https://opentelemetry.io/docs/specs/otel/metrics/api/%20"https://opentelemetry.io/docs/specs/otel/metrics/api/")

- [https://opentelemetry.io/docs/specs/otel/metrics/data-model](https://opentelemetry.io/docs/specs/otel/metrics/data-model "https://opentelemetry.io/docs/specs/otel/metrics/data-model")
- [https://opentelemetry.io/docs/specs/otel/metrics/data-model](https://opentelemetry.io/docs/specs/otel/metrics/data-model%20"https://opentelemetry.io/docs/specs/otel/metrics/data-model")
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ hide_title: true

经过一系列的项目实践,我们发现 `ScanList` 虽然从运行时业务逻辑的角度来维护了模型关联关系,但是这种关联关系维护也不如期望的简便。因此,我们继续改进推出了可以通过模型简单维护关联关系的 `With` 模型关联特性,当然,这种特性仍然致力于提升整体框架的易用性和维护性,可以把 `With` 特性看做 `ScanList` 与模型关联关系维护的一种结合和改进。

本特性需要感谢 [aries](https://goframe.org/display/~sunmoon "") 提供的宝贵建议。
本特性需要感谢 [aries](https://goframe.org/display/~sunmoon%20"") 提供的宝贵建议。

`With` 特性从 `goframe v1.15.7` 版本开始提供,目前属于实验性特性。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -747,7 +747,7 @@ func Example_Rule_Array() {
### `enums`

- 格式: `enums`
- 说明:校验提交的参数是否在字段类型的枚举值中。该规则需要结合 `gf gen enums` 命令一起使用,详情请参考: [枚举维护-gen enums](../../开发工具/代码生成-gen/枚举维护-gen enums.md)
- 说明:校验提交的参数是否在字段类型的枚举值中。该规则需要结合 `gf gen enums` 命令一起使用,详情请参考: [枚举维护-gen enums](../../开发工具/代码生成-gen/枚举维护-gen%20enums.md)



Expand Down
2 changes: 1 addition & 1 deletion docs/框架设计/Golang枚举值管理.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ const (

如果只是项目内部使用枚举值比较简单,定义完了内部使用即可,但涉及到跨服务之间调用,或者前后端协作时,效率就比较低了。当服务需要给外部调用者展示接口能力时,往往需要生成 `API` 接口文档(或者接口定义文件,例如 `proto`),往往也需要根据接口文档(文件)生成调用的客户端 `SDK`

如果是接口定义文件,例如 `proto`,往往可以直接查看源码来解决这个问题,问题不大。我们这里主要讨论的是接口文档维护枚举值的问题,特别是前后端协作时通过 `OpenAPI` 标准协议来维护枚举值的问题。这里我们提供了专门的工具来维护这些枚举值,具体请参考章节: [枚举维护-gen enums](../开发工具/代码生成-gen/枚举维护-gen enums.md)
如果是接口定义文件,例如 `proto`,往往可以直接查看源码来解决这个问题,问题不大。我们这里主要讨论的是接口文档维护枚举值的问题,特别是前后端协作时通过 `OpenAPI` 标准协议来维护枚举值的问题。这里我们提供了专门的工具来维护这些枚举值,具体请参考章节: [枚举维护-gen enums](../开发工具/代码生成-gen/枚举维护-gen%20enums.md)
Original file line number Diff line number Diff line change
Expand Up @@ -124,19 +124,19 @@ hide_title: true

用于生成 `DAO/Entity/DO` 代码文件。

更多介绍请参考文档: [数据规范-gen dao](../../开发工具/代码生成-gen/数据规范-gen dao.md)
更多介绍请参考文档: [数据规范-gen dao](../../开发工具/代码生成-gen/数据规范-gen%20dao.md)

#### 4) `make service`

用于解析 `logic` 目录并自动生成内调用接口。该指令在 `Goland IDE` 下往往使用自动化的 `Watcher` 文件变动来自动生成,具体请参考官方文档。

更多介绍请参考文档: [模块规范-gen service](../../开发工具/代码生成-gen/模块规范-gen service.md)
更多介绍请参考文档: [模块规范-gen service](../../开发工具/代码生成-gen/模块规范-gen%20service.md)

#### 5) `make enums`

用于解析指定代码目录(默认为 `api` 目录)并自动生成 `enums` 加载代码。

更多介绍请参考文档: [枚举维护-gen enums](../../开发工具/代码生成-gen/枚举维护-gen enums.md)
更多介绍请参考文档: [枚举维护-gen enums](../../开发工具/代码生成-gen/枚举维护-gen%20enums.md)

#### 6)更多指令

Expand Down
2 changes: 1 addition & 1 deletion docs/组件列表/数据管理/Redis客户端-gredis.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ sidebar_position: 1
hide_title: true
---

`Redis` 的功能由 `gredis` 模块实现,具体请参考 [NoSQL Redis](../NoSQL Redis/NoSQL Redis.md) 章节。
`Redis` 的功能由 `gredis` 模块实现,具体请参考 [NoSQL Redis](../NoSQL%20Redis/NoSQL%20Redis.md) 章节。
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ func main() {

## HTTPS支持

`Server` 支持 `HTTPS` 服务,并且也同时支持单进程提供 `HTTP&HTTPS` 服务,HTTPS的详细介绍请参考 [HTTPS&TLS](高级特性/HTTPS & TLS.md) 章节。
`Server` 支持 `HTTPS` 服务,并且也同时支持单进程提供 `HTTP&HTTPS` 服务,HTTPS的详细介绍请参考 [HTTPS&TLS](高级特性/HTTPS%20&%20TLS.md) 章节。

## 更多功能特性

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ hide_title: true
4. `GetRequest*`: 获取客户端提交的参数,不区分提交方式。
5. `Get*Struct`: 将指定类型的请求参数绑定到指定的 `struct` 对象上,注意给定的参数为对象指针。绝大部分场景中往往使用 `Parse` 方法将请求数据转换为请求对象,具体详见后续章节。
6. `GetBody/GetBodyString`: 获取客户端提交的原始数据,该数据是客户端写入到 `body` 中的原始数据,与 `HTTP Method` 无关,例如客户端提交 `JSON/XML` 数据格式时可以通过该方法获取原始的提交数据。
7. `GetJson`: 自动将原始请求信息解析为 `gjson.Json` 对象指针返回, `gjson.Json` 对象具体在 [gjson (数据动态编解码)](../../模块列表/编码解码/gjson -数据动态编解码/gjson -数据动态编解码.md) 章节中介绍。
7. `GetJson`: 自动将原始请求信息解析为 `gjson.Json` 对象指针返回, `gjson.Json` 对象具体在 [gjson (数据动态编解码)](../../模块列表/编码解码/gjson%20-数据动态编解码/gjson%20-数据动态编解码.md) 章节中介绍。
8. `Exit*`: 用于请求流程退出控制,详见本章后续说明;

## 提交方式
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ PLATFORMS
| `extra` | 否 | | 额外自定义的编译参数,会直接传递给 `go build` 命令 | |
| `varmap` | 否 | | 自定义的内置变量键值对 | ```<br />[gfcli]<br /> [gfcli.build]<br /> name = "gf"<br /> arch = "all"<br /> system = "all"<br /> mod = "none"<br /> cgo = 0<br /> [gfcli.build.varmap]<br /> k1 = "v1"<br /> k2 = "v2"<br />``` |
编译时的内置变量可以在运行时通过 `gbuild` 包 [gbuild (构建信息获取)](../模块列表/系统相关/gbuild -构建信息获取.md) 获取。
编译时的内置变量可以在运行时通过 `gbuild` 包 [gbuild (构建信息获取)](../模块列表/系统相关/gbuild%20-构建信息获取.md) 获取。
使用示例:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ hide_title: true

`gen model` 命令生成的 `model` 采用包管理方式维护数据表操作及数据结构定义,一张数据表一个包。

未来不再推荐这种方式,而是推荐使用 `dao` 的使用方式,具体请参考 [gen dao(重点)](gen dao-重点.md) 命令及 DAO-基本痛点及改进。
未来不再推荐这种方式,而是推荐使用 `dao` 的使用方式,具体请参考 [gen dao(重点)](gen%20dao-重点.md) 命令及 DAO-基本痛点及改进。

`gen` 命令用以自动化从数据库直接生成采用了 `Active Record` 设计模式的模型文件。该命令将会根据数据表名生成对应的目录,该目录名称即数据表包名。目录下自动生成3个文件:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Nick-Name Nick_Name match

接口文档: [https://godoc.org/github.com/gogf/gf/database/gdb](https://godoc.org/github.com/gogf/gf/database/gdb)

由于方法比较简单,这里便不再举例说明。需要注意的是两个方法 `Record.Map``Result.List`,这两个方法也是使用比较频繁的方法,用以将 `ORM` 查询结果信息转换为可做展示的数据类型。由于结果集字段值底层为 `[]byte` 类型,虽然使用了新的 `Value` 类型做了封装,并且也提供了数十种常见的类型转换方法(具体请阅读 [gvar (通用变量)](../../模块列表/数据结构/gvar -通用变量.md) 章节),但是大多数时候需要直接将结果 `Result` 或者 `Record` 直接作为 `json` 或者 `xml` 数据结构返回,就需要做转换才行。
由于方法比较简单,这里便不再举例说明。需要注意的是两个方法 `Record.Map``Result.List`,这两个方法也是使用比较频繁的方法,用以将 `ORM` 查询结果信息转换为可做展示的数据类型。由于结果集字段值底层为 `[]byte` 类型,虽然使用了新的 `Value` 类型做了封装,并且也提供了数十种常见的类型转换方法(具体请阅读 [gvar (通用变量)](../../模块列表/数据结构/gvar%20-通用变量.md) 章节),但是大多数时候需要直接将结果 `Result` 或者 `Record` 直接作为 `json` 或者 `xml` 数据结构返回,就需要做转换才行。

使用示例:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ hide_title: true

经过一系列的项目实践,我们发现 `ScanList` 虽然从运行时业务逻辑的角度来维护了模型关联关系,但是这种关联关系维护也不如期望的简便。因此,我们继续改进推出了可以通过模型简单维护关联关系的 `With` 模型关联特性,当然,这种特性仍然致力于提升整体框架的易用性和维护性,可以把 `With` 特性看做 `ScanList` 与模型关联关系维护的一种结合和改进。

本特性需要感谢 [aries](https://goframe.org/display/~sunmoon "") 提供的宝贵建议。
本特性需要感谢 [aries](https://goframe.org/display/~sunmoon%20"") 提供的宝贵建议。

`With` 特性从 `goframe v1.15.7` 版本开始提供,目前属于实验性特性。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ hide_title: true

## 日志文件

默认情况下,日志文件名称以当前时间日期命名,格式为 `YYYY-MM-DD.log`,我们可以使用 `SetFile` 方法来设置文件名称的格式,并且文件名称格式支持 [gtime (时间管理模块)](../../模块列表/系统相关/gtime -时间管理模块/gtime -时间管理模块.md) 时间格式 。简单示例:
默认情况下,日志文件名称以当前时间日期命名,格式为 `YYYY-MM-DD.log`,我们可以使用 `SetFile` 方法来设置文件名称的格式,并且文件名称格式支持 [gtime (时间管理模块)](../../模块列表/系统相关/gtime%20-时间管理模块/gtime%20-时间管理模块.md) 时间格式 。简单示例:

```go
package main
Expand Down
Loading

0 comments on commit f7489d6

Please sign in to comment.