专栏首页后台全栈之路腾讯 Tars-Go 服务获取自定义模版(配置)值
原创

腾讯 Tars-Go 服务获取自定义模版(配置)值

Tars 模版是什么?

腾讯 Tars 框架中,有两种可以称之为 “配置” 的地方:其中一个是可以自定义的,在 Tars 管理页面中称为 “服务配置”。在这里,可以按照开发者喜欢的格式上传文件,并且支持配置的热更新。

而另一个地方,则是本文要讲的。这个在 Tars 中称为 “模版”。模版可以在 Tars 管理平台顶部的 “运维管理” 进去后,再进入 “模版管理” 可以看到。

查看下面那些已有的模版可以看到,一般而言,模版是用于对整个服务的参数进行配置,其配置项更加偏向运维,而不是偏业务。

Tars 模版的内容

TarsGo 服务一般使用 tars.default 模板。查看这个模板的内容,可以看到如下:

<tars>
    <application>
        enableset=${enableset}		#是否启用SET分组
        setdivision=${setdivision}	#SET分组的全名.(mtt.s.1)
        <client>
            locator =${locator}		#地址
            sync-invoke-timeout = 3000	#同步调用超时时间,缺省3s(毫秒)
            async-invoke-timeout =5000	#异步超时时间,缺省5s(毫秒)
            refresh-endpoint-interval = 60000	#重新获取服务列表时间间隔(毫秒)
            stat = tars.tarsstat.StatObj		#模块间调用服务[可选]
            property = tars.tarsproperty.PropertyObj	#属性上报服务[可选]
            report-interval = 60000	#上报间隔时间,默认60s(毫秒)
            sample-rate = 100000	#stat采样比1:n 例如sample-rate为1000时 采样比为千分之一
            max-sample-count = 50	#1分钟内stat最大采样条数
            asyncthread = ${asyncthread}	#网络异步回调线程个数
            modulename = ${modulename}	#模块名称
        </client>
        <server>
            app      = ${app}	#应用名称
            server  = ${server}	#服务名称
            localip  = ${localip}	#本地ip
            local  = ${local}		#本地管理套接字[可选]
            basepath = ${basepath}	#服务的数据目录,可执行文件,配置文件等
            datapath = ${datapath}
            logpath  = ${logpath}	#日志路径
            logsize = 10M		#日志大小
            lognum = 10			#日志数量
            config  = tars.tarsconfig.ConfigObj	#配置中心的地址[可选]
            notify  = tars.tarsnotify.NotifyObj	#信息中心的地址[可选]
            log = tars.tarslog.LogObj			#远程LogServer[可选]
            deactivating-timeout = 3000			#关闭服务时等待时间
            logLevel=DEBUG						#滚动日志等级默认值
        </server>          
    </application>
</tars>

上面这些就是 Tars 平台中固定配置的一些参数。在 TarsGo 中,我们可以以如下参数来读取:

import (
	"github.com/TarsCloud/TarsGo/tars"
)

func main() {
    cfg := tars.GetServerConfig()			// 1
	server := cfg.App + "." + cfg.Server	// 2
    
    ...
}

说明如下:

  1. 获取 <server> 下的配置总项,也就是对应着配置的 “域” 为 "tars/application/server"
  2. 获取 <server> 下的 appserver

但是上面代码的 appserver 都是预定义值,如果我们额外添加了一个键值对,那么用这个方法就没法读到了。

自定义模版配置

这里需要提一下如何自定义模版配置。我们点击 Tars 管理平台的 “服务管理”,再点击具体的服务,比如这里我拿之前的例子中用到的 GoWebServer 为例,点击具体服务,然后在 “服务管理” tab 中,在指定的服务点 “编辑”:

在谈出来的对话框中,拉到最下方,在 “私有模板” 中可以配置自己的值。如果配置了与默认模版相同的 key,则 tars 会将值替换为这里所配置的私有模板值。可以看到在图中我覆盖修改了远程日志的服务器。


获取自定义的模板配置值

TarsGo 获取模版的原理

这里其实我们只要看一下 TarsGo 的代码,从 GetServerConfig() 函数(文件是 config.go)往里看。函数调用了 Init(),而这个函数又调用了 initConfig() 函数(文件是 application.go)。该函数的逻辑很清晰,就是利用 github.com/TarsCloud/TarsGo/tars/util/conf 包来解析模版文件的内容。

解析模版条件的基本逻辑是:

  • 如果遇到一个 xml 属性,比如 <server>...</server>,那么这个属性下本身会被存储为一个 Go map[string]string 类型,下面保存以 key = value 格式存储的键值对信息

因此,我们就可以利用这个 util 包,来获取解析到的原始配置值了

获取模版配置值封装

为了便于使用,我基于 github.com/TarsCloud/TarsGo/tars/util/conf 封装了一个简易的包来读取自定义的模版,安装如下:

$ go get github.com/Andrew-M-C/tarsgo-tools/config

比如我自定义了以下私有模版:

<tars>
    <application>
        <server>
			      myStr=This is a string
            myInt=54321
            myLong=12345
            myErrorInt=abcde
        </server>
    </application>
</tars>

那么在服务启动时我就可以这样去读取:

import (
	"github.com/Andrew-M-C/tarsgo-tools/config"
)

func main() {
    tarsconf, err := config.NewConfig()
    if err != nil {
        fmt.Println("Failed to get config: " + err.Error())
    } else {
        myStr, exist := tarsconf.GetString("/tars/application/server", "myStr", "WHAT?")
        fmt.Printf("%t, myStr: %s\n", exist, myStr)

        myInt, exist := tarsconf.GetInt("/tars/application/server", "myInt")
        fmt.Printf("%t, myInt: %d\n", exist, myInt)
        
        myInt2, exist := tarsconf.GetInt("/tars/application/server", "myInt2", -2)
        fmt.Printf("%t, myInt2: %d\n", exist, myInt2)

        myLong, exist := tarsconf.GetLong("/tars/application/server", "myLong", -3)
        fmt.Printf("%t, myLong: %d\n", exist, myLong)
        
        myErrorInt, exist := tarsconf.GetInt("/tars/application/server", "myInt", -4)
        fmt.Printf("%t, myErrorInt: %d\n", exist, myErrorInt)
    }
    return
}

命令行输出:

true, myStr: This is a string
true, myInt: 54321
false, myInt2: -2
true, myLong: 12345
false, myErrorInt: -4

这就成功读到自定义的配置值啦。其中对于每一个 GetXxx() 函数,都可以传入三个参数:

  1. 第一个参数为 domain,也就是前文提到的 “域” 名
  2. 第二个参数为 key,指的是指定域下键值对的键名
  3. 第三个参数可选,可以不传;如果传递了第三个参数的话,那么当 existfalse 的时候,接口会将该值作为默认值,赋给返回值,开发者可以用来节省一些代码操作。

需要注意的是,其中 myErrorInt 的值尽管是存在的,但是由于无法解析为数字,因此 GetInt() 函数返回的 exist 结果为 false


本文章采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。

原作者: amc,欢迎转载,但请按上述协议注明出处。

原文链接:https://cloud.tencent.com/developer/article/1394093

原文标题:《腾讯 Tars-Go 服务获取自定义模版(配置)值》

发布日期:2019 年 2 月 21 日

发布平台:云+社区

原创声明,本文系作者授权云+社区发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 腾讯 Tars-Go 服务 Hello World——从 HTTP 开始

    Tars 框架最新的版本已经把内部的 Taf-Go 开源为 Tars-Go。作为与时俱进的程序员,当然要尝鲜啦。

    amc
  • 腾讯 Tars Web 管理端用户体系对接

    这段时间一直在基于 Tars 作开发。最近的文章也多是针对 Tars 的一些学习笔记。前面我们搭建了 Tars 基础框架,打开了 Tars web 管理界面进行...

    amc
  • TarsGo 服务获取自定义模版(配置)值

    之前的文章中我们介绍了如何使用TarsGo创建HTTP服务和TARS RPC服务,本篇文章中,我们将介绍如何在TarsGo服务中获得自定义模板的配置值。

    TARS基金会
  • 腾讯 Tars-Go 服务 Hello World——RPC 通信

    上一篇文章介绍了如何创建安装 TarsGo,同时也阐述了如何开始一个 Tars-Go HTTP 服务。本文就要开始 Tars-Go 的主力业务了:基于 Tars...

    amc
  • 解读|TARS开源项目发布Go语言版本

    导语:近日,Tars 开源项目在上海发布并开源了 Go 语言版本,其性能与 C++ 版本相当,比 gRPC 的性能高 5 倍。  ——编者 Tars 是腾讯...

    腾讯开源
  • 年度 | TARS开源里程碑回顾

    最近在开源中国举办的开源年终盛典上,开源项目TARS 获得了年度最佳原创开源软件奖。 ? 谈到微服务,人们往往会提起Spring Cloud和Service ...

    腾讯开源
  • 腾讯 Tars 基础框架手动搭建——填掉官方 Guide 的坑

    腾讯 Tars 是腾讯内部使用的 TAF(Tencent Application Framework)的对外开源版,去掉了许多冗杂多余的部分。该框架集开发、运维...

    amc
  • TarsGo新版本发布,支持protobuf,zipkin和自定义插件

    Tars是腾讯从2008年到今天一直在使用的后台逻辑层的统一应用框架,目前支持C++,Java,PHP,Nodejs,Golang语言。该框架为用户提供了涉及到...

    腾讯开源
  • TarsGo新版本发布,支持protobuf,zipkin和自定义插件

    Tars是腾讯从2008年到今天一直在使用的后台逻辑层的统一应用框架,目前支持C++、Java、PHP、Nodejs、Golang语言。该框架为用户提供了涉及到...

    TARS小助手
  • TarsGo支持Protocol Buffer

    Tars是腾讯从2008年到今天一直在使用的后台逻辑层的统一应用框架TAF(Total Application Framework),目前支持C++,Java,...

    陈明杰
  • 腾讯微服务开源项目再摘信通院OSCAR开源大奖

    10月16日,由中国信息通信研究院主办、云计算标准和开源推进委员会承办的2020开源产业大会正式开幕,腾讯微服务开源项目再摘信通院OSCAR开源大奖。 202...

    腾讯开源
  • GIAC 2020 全球互联网架构大会演讲实录:基于TarsGo的微服务技术架构实践

    2020年8月14日-15日,GIAC 2020 全球互联网架构大会于上周五正式在深圳开幕。 GIAC(GLOBAL INTERNET ARCHITECTU...

    腾讯技术工程官方号
  • 抢鲜 | 腾讯 Go语言开发框架 TARS-GO 即将发布!

    ? 腾讯拥有海量的用户基础,产品迭代速度飞快,在高并发的场景下,如何高效构建高可用的服务,是一个非常大的挑战。我们需要一个统一的框架,而Tars是腾讯从200...

    腾讯开源
  • 腾讯 Node.js 非侵入开发框架 Tars.js 2.0 正式发布

    腾讯开源
  • 开源代码TarsGo-v1.0.0源码分析之transport

    版权声明:本文为作者原创,如需转载请通知本人,并标明出处和作者。擅自转...

    月牙寂道长
  • TarsPHP 新版本发布,支持 Protobuf 协议

    TARS是腾讯从2008年到今天一直在使用的微服务开发框架,2018年成为Linux基金会开源项目目前支持PHP、C++、Java、Nodejs与Go语言。该框...

    TARS基金会
  • 腾讯荣获唯一OSCAR尖峰开源企业奖

    7月3日,由中国信息通信研究院主办的2019云计算开源产业大会在北京举办。腾讯开源独揽尖峰开源企业奖、尖峰开源技术创新奖(自主研发项目)、尖峰开源技术创新奖(...

    腾讯开源
  • 腾讯开源斩获5项大奖,1项独家认证

    7月3日,由中国信息通信研究院主办的2019云计算开源产业大会在北京举办。腾讯开源独揽尖峰开源企业奖、尖峰开源技术创新奖(自主研发项目)、尖峰开源技术创新奖(...

    腾讯云TStack
  • 腾讯开源再获OSCAR 5项大奖,全国首家可信开源治理认证自发开源企业

    ? 7月3日,由中国信息通信研究院主办的2019云计算开源产业大会在北京举办。腾讯开源独揽尖峰开源企业奖、尖峰开源技术创新奖(自主研发项目)、尖峰开源技术创新...

    腾讯技术工程官方号

扫码关注云+社区

领取腾讯云代金券