gf/README_ZH.MD

114 lines
4.2 KiB
Plaintext
Raw Normal View History

2018-12-17 19:41:08 +08:00
# GoFrame
[![Go Doc](https://godoc.org/github.com/gogf/gf?status.svg)](https://godoc.org/github.com/gogf/gf)
2021-02-07 15:34:36 +08:00
[![Build Status](https://travis-ci.com/gogf/gf.svg?branch=master)](https://travis-ci.org/gogf/gf)
2019-06-22 22:06:39 +08:00
[![Go Report](https://goreportcard.com/badge/github.com/gogf/gf?v=1)](https://goreportcard.com/report/github.com/gogf/gf)
2019-03-08 21:07:18 +08:00
[![Code Coverage](https://codecov.io/gh/gogf/gf/branch/master/graph/badge.svg)](https://codecov.io/gh/gogf/gf/branch/master)
2019-04-07 22:03:04 +08:00
[![Production Ready](https://img.shields.io/badge/production-ready-blue.svg)](https://github.com/gogf/gf)
[![License](https://img.shields.io/github/license/gogf/gf.svg?style=flat)](https://github.com/gogf/gf)
2018-12-17 20:44:38 +08:00
2019-08-30 22:15:54 +08:00
[English](README.MD) | 简体中文
2019-05-18 14:55:15 +08:00
2021-03-08 23:27:48 +08:00
`GoFrame`是一款模块化、高性能、企业级的Go基础开发框架。
2018-11-30 20:37:28 +08:00
2020-04-29 19:33:14 +08:00
> 如果您初识`Go`语言,您可以将`GoFrame`类似于`PHP`中的`Laravel`, `Java`中的`SpringBoot`或者`Python`中的`Django`。
2018-12-27 13:27:04 +08:00
# 特点
* 模块化、松耦合设计;
* 模块丰富、开箱即用;
* 简便易用、易于维护;
2020-02-22 15:36:31 +08:00
* 高代码质量、高单元测试覆盖率;
* 社区活跃,大牛谦逊低调脾气好;
2018-12-27 13:27:04 +08:00
* 详尽的开发文档及示例;
* 完善的本地中文化支持;
* 设计为团队及企业使用;
2020-02-15 12:00:20 +08:00
# 地址
- **主库**https://github.com/gogf/gf
- **码云**https://gitee.com/johng/gf
2018-12-27 13:27:04 +08:00
2018-11-30 20:37:28 +08:00
# 安装
```html
2019-12-04 18:48:13 +08:00
go get -u -v github.com/gogf/gf
2018-11-30 20:37:28 +08:00
```
2019-08-30 22:15:54 +08:00
推荐使用 `go.mod`:
2018-12-22 21:50:47 +08:00
```
require github.com/gogf/gf latest
2018-12-22 21:50:47 +08:00
```
2019-02-02 17:55:22 +08:00
2018-11-30 20:37:28 +08:00
# 限制
```shell
2020-04-23 21:06:42 +08:00
golang版本 >= 1.11
2018-11-30 20:37:28 +08:00
```
2020-07-12 10:25:15 +08:00
# 架构
<div align=center>
2021-02-07 15:34:36 +08:00
<img src="https://goframe.org/download/attachments/1114119/arch.png"/>
2020-07-12 10:25:15 +08:00
</div>
2020-05-17 15:11:07 +08:00
# 模块
2020-05-17 15:16:13 +08:00
1. **核心模块**
2020-05-17 15:11:07 +08:00
`GoFrame`提供了一些基础的、常用的模块,简单、易用和轻量级,并保持极少的外部依赖,这些模块由`gf`主仓库细致维护。
2020-05-17 15:16:13 +08:00
1. **社区模块**
2020-05-17 15:11:07 +08:00
2020-06-04 17:29:16 +08:00
社区模块主要由社区贡献并维护,大部分也是由`gf`主仓库的贡献者提供及维护,存放于`gogf`空间下,与`gf`主仓库处于同一级别。有的社区模块是从`gf`主仓库中剥离出来单独维护的模块,这些模块并不是特别常用,或者对外部依赖较重。
2020-05-17 15:11:07 +08:00
2020-04-23 17:23:57 +08:00
# 性能
2020-12-30 16:42:50 +08:00
大家较为感兴趣的`Web`组件性能测试请参考第三方性能测试评估https://github.com/the-benchmarker/web-frameworks
2018-12-27 13:27:04 +08:00
2018-11-30 20:37:28 +08:00
# 文档
2020-04-03 09:32:04 +08:00
开发文档https://goframe.org
2019-01-23 17:33:51 +08:00
2020-04-03 09:32:04 +08:00
接口文档https://godoc.org/github.com/gogf/gf
2018-11-30 20:37:28 +08:00
2020-02-15 12:00:20 +08:00
# 帮助
- QQ交流群[116707870](//shang.qq.com/wpa/qunwpa?idkey=195f91eceeb5d7fa76009b7cd5a4641f70bf4897b7f5a520635eb26ff17adfe7)
- WX交流群微信添加`389961817`备注`GF`
- 主库ISSUEhttps://github.com/gogf/gf/issues
2020-06-03 10:59:01 +08:00
> 建议通过阅读`GoFrame`的源码以及API文档深度学习`GoFrame`,了解更多的精妙设计。
2020-02-15 12:00:20 +08:00
2018-12-27 09:57:54 +08:00
# 协议
2018-12-27 09:59:56 +08:00
`GF` 使用非常友好的 [MIT](LICENSE) 开源协议进行发布,永久`100%`开源免费。
2018-12-27 09:57:54 +08:00
2020-06-05 20:36:05 +08:00
# 用户
- [腾讯科技](https://www.tencent.com/)
- [中兴通讯](https://www.zte.com.cn/china/)
2020-07-18 09:40:39 +08:00
- [蚂蚁金服](https://www.antfin.com/)
- [医联科技](https://www.medlinker.com/)
2020-07-18 10:21:17 +08:00
- [库币科技](https://www.kucoin.io/)
2020-07-18 10:17:05 +08:00
- [乐有家](https://www.leyoujia.com/)
2020-08-03 18:58:43 +08:00
- [IGG](https://igg.com)
2020-08-13 18:59:13 +08:00
- [喜马拉雅](https://www.ximalaya.com)
- [作业帮](https://www.zybang.com/)
2020-07-18 09:40:39 +08:00
2021-02-07 15:34:36 +08:00
> 在这里只列举了部分知名的用户,如果您的企业或者产品正在使用`GoFrame`,欢迎到 [这里](https://goframe.org/pages/viewpage.action?pageId=1114415) 留言。
2020-06-05 20:36:05 +08:00
2020-01-18 22:21:37 +08:00
# 贡献
2020-01-18 22:35:07 +08:00
感谢所有参与`GoFrame`开发的贡献者。 [[贡献者列表](https://github.com/gogf/gf/graphs/contributors)].
2020-01-18 22:21:37 +08:00
<a href="https://github.com/gogf/gf/graphs/contributors"><img src="https://opencollective.com/goframe/contributors.svg?width=890&button=false" /></a>
2019-02-26 23:39:09 +08:00
# 捐赠
2021-02-07 15:34:36 +08:00
如果您喜欢`GF`,要不给开发者 [来杯咖啡](https://goframe.org/pages/viewpage.action?pageId=1115633) 吧!
2019-05-18 14:55:15 +08:00
请在捐赠时备注您的`github`/`gitee`账号名称。
2020-02-22 15:36:31 +08:00
# 赞助
赞助支持`GF`框架的快速研发,如果您感兴趣,请联系 微信 `389961817` / 邮件 `john@goframe.org`。
2019-06-02 13:32:03 +08:00
# 感谢
2021-02-07 15:34:36 +08:00
<a href="https://www.jetbrains.com/?from=GoFrame"><img src="https://goframe.org/download/thumbnails/1114119/jetbrains.png" height="120" alt="JetBrains"/></a>
2021-02-07 10:31:59 +08:00
<a href="https://www.atlassian.com/?from=GoFrame"><img src="https://goframe.org/download/attachments/1114119/atlassian.jpg" height="120" alt="Atlassian"/></a>