TarsGo 开源项目教程
1. 项目的目录结构及介绍
TarsGo 项目的目录结构如下:
TarsGo/
├── app
│ ├── demo
│ │ ├── demo.go
│ │ ├── demo_imp.go
│ │ └── tars-protocol
│ │ └── Demo
│ │ ├── Demo.tars
│ │ └── Demo_IF.go
│ └── tars-protocol
│ └── tars
│ ├── tars.tars
│ └── tars_IF.go
├── build
│ └── makefile
├── client
│ └── client.go
├── config.conf
├── go.mod
├── go.sum
├── main.go
├── makefile
└── README.md
目录结构介绍
app/
: 包含应用程序的代码。demo/
: 示例应用程序的代码。demo.go
: 示例应用程序的主文件。demo_imp.go
: 示例应用程序的实现文件。tars-protocol/Demo/
: 示例应用程序的协议文件。Demo.tars
: 协议定义文件。Demo_IF.go
: 生成的协议接口文件。
tars-protocol/tars/
: Tars 框架的基础协议文件。tars.tars
: 基础协议定义文件。tars_IF.go
: 生成的基础协议接口文件。
build/
: 包含构建相关的文件。makefile
: 构建脚本。
client/
: 客户端示例代码。client.go
: 客户端主文件。
config.conf
: 配置文件。go.mod
和go.sum
: Go 模块文件。main.go
: 项目启动文件。makefile
: 项目构建脚本。README.md
: 项目说明文档。
2. 项目的启动文件介绍
项目的启动文件是 main.go
。这个文件负责启动 TarsGo 服务。以下是 main.go
的主要内容:
package main
import (
"github.com/TarsCloud/TarsGo/tars"
"app/demo"
)
func main() {
imp := new(demo.DemoImp)
app := new(demo.Demo)
cfg := tars.GetServerConfig()
app.AddServant(imp, cfg.App+"."+cfg.Server+".DemoObj")
tars.Run()
}
启动文件介绍
main
函数:项目的入口点。imp
:服务实现对象。app
:服务对象。cfg
:获取服务器配置。app.AddServant
:添加服务实现到服务对象。tars.Run
:启动 Tars 服务。
3. 项目的配置文件介绍
项目的配置文件是 config.conf
。这个文件包含了 TarsGo 服务的配置信息。以下是 config.conf
的主要内容:
<tars>
<application>
# 应用名称
app=TestApp
# 服务名称
server=HelloServer
# 服务端口
local=tcp -h 127.0.0.1 -p 18600 -t 3000
# 日志级别
logLevel=DEBUG
</application>
</tars>
配置文件介绍
<tars>
:Tars 配置的根节点。<application>
:应用配置节点。app
:应用名称。server
:服务名称。local
:服务监听的地址和端口。logLevel
:日志级别。
以上是 TarsGo 开源项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用 TarsGo 项目。