GOLANG进阶：Viper，Mysql，Swagger，Log

已于 2023-07-02 17:58:54 修改
阅读量701 收藏
点赞数
分类专栏： GOLANG 文章标签： golang 后端 文档资料 mysql javascript 数据库 单例模式
于 2023-07-01 18:57:13 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/masterphp/article/details/131493155
版权

GOLANG从浅入深必须学习的一些工具包

1.Viper：

        Viper 是一个完整的 Go 应用程序配置解决方案，优势就在于开发项目中你不必去操心配置文件的格式而是让你腾出手来专注于项目的开发。其特性如下：

        支持 JSON/TOML/YAML/HCL/envfile/Java properties 等多种格式的配置文件
        可以设置监听配置文件的修改，修改时自动加载新的配置
        从环境变量、命令行选项和io.Reader，远程K/V中读取配置
        从远程配置系统中读取和监听修改，如 etcd/Consul
        代码逻辑中显示设置键值

        简单通俗的来说就是配置文件，比如数据库的连接参数（用户名，密码，端口号，数据名等等），这些都可以用viper包来实现存储

        为什么使用viper包来存储固定参数：为的是方便管理，如果项目要移植或者修改参数，直接修改配置文件就可以了，保证代码的健壮

  2. Mysql

        操作数数据库包，基础用法可以参考博主的另外一篇我文章，此处就不再赘述了     

引入包：

go get -u github.com/spf13/viper

怎么使用？实际上存储的数据是存储在一个yml格式的文件中(以数据库连接参数为例子)

1.创建一个文件夹：config

2.创建一个yml文件并写入数据：两种写法，可以自由选择（注意点：yml文件数据冒号后面一定要有空格，要不然没有效果）

//全量配置（不用写入yml文件）

mysql:
  dsn: root:root@tcp(127.0.0.1:3306)/gochect?charset=utf8&parseTime=True&loc=Local

//非全量配置（不用写入yml文件）
    
mysql:
    username: root
    password: root
    address: 127.0.0.1
    port: 3306
    dataname: gochect

3.引入包文件，开始读取包文件配置的数据：

SetConfigName   ： 设置yml文件配置名
AddConfigPath      ： 设置配置文件所在文件夹的名字
ReadInConfig    ： 获取文件是否存在（用于判断是否设置错误）
viper.Get       ： 获取单层文件（第一层）
viper.GetString ： 获取多层文件（第二层乃至下级更多的层级）

实例代码：

package utils

import (
    "fmt"
    "github.com/spf13/viper"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

//定义变量

var DB *gorm.DB

func InitConfig ()  {
    viper.SetConfigName("app")
    viper.AddConfigPath("config")
    err :=viper.ReadInConfig()
    if err != nil{
        fmt.Println("参数读取错误")
    }
    fmt.Println("数据库配置参数",viper.Get("mysql"))
    fmt.Println("数据库配置参数1",viper.GetString("mysql.dsn"))
}

//此处特殊提醒一下：DB现在是提前定义的变量，该处切不使用 := 去初始化数据，这样就会一直实例化，导致会创建一个新的sqlDb变量,新的sqlDb会把全局变量sqlDb覆盖掉，最终会报错的

func IniMysql()  {
    DB, _ = gorm.Open(mysql.Open(viper.GetString("mysql.dsn")))
}

3.Swagger

        相关的工具集会根据 OpenAPI 规范去生成各式各类的与接口相关联的内容，常见的流程是编写注解 =》调用生成库-》生成标准描述文件 =》生成/导入到对应的 Swagger 工具。

        简单来说就是前后端调试的时候的API文档，该文档可以由Swag通过配置项直接生成

1.引包

GOLANG版本1.17以下：go get -u github.com/swaggo/swag/cmd/swag

GOLANG版本1.17以上：go install github.com/swaggo/swag/cmd/swag@latest

2.初始化

运行命令：swag init

结果（生成docs文件夹）：

查看是否安装成功命令：swag -v

3.引入相关包

go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files

4.配置：

注意点：生成的docs包一定要引入（gochect是项目名称，在mod initi 初始化项目的时候设置的）

package route

import (
    "github.com/gin-gonic/gin"
    swaggerfiles "github.com/swaggo/files"
    ginSwagger "github.com/swaggo/gin-swagger"
    "gochect/docs"
    "gochect/service"
)

func Route() *gin.Engine{
    r := gin.Default()
    //设置路径
    docs.SwaggerInfo.BasePath =""
    r.GET("/index",service.GetIndex)
    //引入swag
    r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))

    return r
}

5.运行golang文件，查看是否成功

6.覆盖写入

入口文件配置示例：

//    @title            测试用例
//    @version        1.0
//    @description    测试用例

方法文件配置：

//    @Summary    首页
//    @Tags        首页
//    @Success    200    {string} Helloworld
//    @Router        /index [get]

        到此为止Swag就已经成功了，那么应该有读者会问了，Swag的配置属性有哪些？下面就给介绍一下

通用API信息

注释说明示例
title必填 应用程序的名称。// @title Swagger Example API
version必填 提供应用程序API的版本。// @version 1.0
description应用程序的简短描述。// @description This is a sample server celler server.
tag.name标签的名称。// @tag.name This is the name of the tag
tag.description标签的描述。// @tag.description Cool Description
tag.docs.url标签的外部文档的URL。// @tag.docs.url 
tag.docs.description标签的外部文档说明。// @tag.docs.description Best example documentation
termsOfServiceAPI的服务条款。// @termsOfService 
contact.name公开的API的联系信息。// @contact.name API Support
contact.url联系信息的URL。 必须采用网址格式。// @contact.url 
contact.email联系人/组织的电子邮件地址。 必须采用电子邮件地址的格式。// @contact.email 
license.name必填 用于API的许可证名称。// @license.name Apache 2.0
license.url用于API的许可证的URL。 必须采用网址格式。// @license.url 
host运行API的主机（主机名或IP地址）。// @host localhost:8080
BasePath运行API的基本路径。// @BasePath /api/v1
acceptAPI 可以使用的 MIME 类型列表。 请注意，Accept 仅影响具有请求正文的操作，例如 POST、PUT 和 PATCH。 值必须如“”中所述。// @accept json
produceAPI可以生成的MIME类型的列表。值必须如“Mime类型”中所述。// @produce json
query.collection.format请求URI query里数组参数的默认格式：csv，multi，pipes，tsv，ssv。 如果未设置，则默认为csv。// @query.collection.format multi
schemes用空格分隔的请求的传输协议。// @schemes http https
externalDocs.descriptionDescription of the external document.// @externalDocs.description OpenAPI
externalDocs.urlURL of the external document.// @externalDocs.url 
x-name扩展的键必须以x-开头，并且只能使用json值// @x-example-key {"key": "value"}

使用Markdown描述

如果文档中的短字符串不足以完整表达，或者需要展示图片，代码示例等类似的内容，则可能需要使用Markdown描述。要使用Markdown描述，请使用一下注释。

注释说明示例
title必填 应用程序的名称。// @title Swagger Example API
version必填 提供应用程序API的版本。// @version 1.0
description.markdown应用程序的简短描述。 从api.md文件中解析。 这是@description的替代用法。// @description.markdown No value needed, this parses the description from api.md
tag.name标签的名称。// @tag.name This is the name of the tag
tag.description.markdown标签说明，这是tag.description的替代用法。 该描述将从名为tagname.md的文件中读取。// @tag.description.markdown

API操作

注释描述
description操作行为的详细说明。
description.markdown应用程序的简短描述。该描述将从名为endpointname.md的文件中读取。
id用于标识操作的唯一字符串。在所有API操作中必须唯一。
tags每个API操作的标签列表，以逗号分隔。
summary该操作的简短摘要。
acceptAPI 可以使用的 MIME 类型列表。 请注意，Accept 仅影响具有请求正文的操作，例如 POST、PUT 和 PATCH。 值必须如“Mime类型”中所述。
produceAPI可以生成的MIME类型的列表。值必须如“Mime类型”中所述。
param用空格分隔的参数。param name,param type,data type,is mandatory?,comment attribute(optional)
security每个API操作的安全性。
success以空格分隔的成功响应。return code,{param type},data type,comment
failure以空格分隔的故障响应。return code,{param type},data type,comment
response与success、failure作用相同
header以空格分隔的头字段。 return code,{param type},data type,comment
router以空格分隔的路径定义。 path,[httpMethod]
x-name扩展字段必须以x-开头，并且只能使用json值。

Mime类型

AliasMIME Type
jsonapplication/json
xmltext/xml
plaintext/plain
htmltext/html
mpfdmultipart/form-data
x-www-form-urlencodedapplication/x-www-form-urlencoded
json-apiapplication/vnd.api+json
json-streamapplication/x-json-stream
octet-streamapplication/octet-stream
pngimage/png
jpegimage/jpeg
gifimage/gif

3.Log日志

引入包文件：go get gorm.io/gorm/logger

直接上代码：

func IniMysql()  {
    newLogger := logger.New(
        //自定义日志模板，打印sql语句
        log.New(os.Stdout,"/r/n",log.LstdFlags),
        logger.Config{
            SlowThreshold: time.Second,//慢sql阈值
            LogLevel: logger.Info,//log日志的级别
            Colorful: true,//颜色
        },
    )
    DB, _ = gorm.Open(mysql.Open(viper.GetString("mysql.dsn")),&gorm.Config{Logger:newLogger})
}

​​​​​​​

 

masterphp
关注
专栏目录
golang学习笔记（进阶篇）
lcynone的博客
01-13 878
Golang学习笔记_进阶篇
Golang简单入门教程——函数进阶篇
TechFlow的博客
06-15 398
本文始发于个人公众号：TechFlow，原创不易，求个关注 今天是golang专题的第八篇，我们来聊聊golang当中的函数。 我们在之前的时候已经介绍过了函数的基本用法，知道了怎么样设计或者是定义一个函数，以及怎么样调用一个函数，还了解了defer的用法。今天这篇文章我们来继续深入这个话题，来看看golang当中关于函数的一些进阶的用法。 返回error 前文当中我们曾经提到过，在golang当中并没有try catch捕获异常的机制。在其他语言当中异常只有一种，可以通过try catch语句进行捕
go 使用viper包读取toml和yml配置文件
秋叶原的黑猫的博客
04-28 3178
什么是viper包？ Viper是适用于Go应用程序的完整配置解决方案。它被设计用于在应用程序中工作，并且可以处理所有类型的配置需求和格式。有了viper包，不用再费尽心思去寻找不同格式的配置文件对应的操作库，轻松读取配置信息。目前viper包支持JSON、TOML、YAML、HCL、envfile和Java properties等格式。 viper非常的容易上手。 读取toml文件 test.toml [database] server = "192.168.1.1" ports = [ 8001, 80
Viper学习与使用
程序媛平平无奇的一天
09-20 909
Viper 是 Go 中非常强大的配置管理库，提供了读取文件、环境变量、命令行参数、远程配置等多种方式。通过与其他库如。
Golang进阶
RNGWGzZs的博客
01-26 1959
因此，在程序执行的过程中，总会存在执行状态的切换(用户到内核，内核到用户)。但是，golang中的协程完完全全解决了这个问题。大多数编程语言，在如何实现并发的问题上，采用的都是基于线程和内存同步访问控制。我们在linux处着重讲了，实现进程间的本质，就是让每个进程(线程)可看到同一份公共资源。此时，只需要在该函数前加上go，这两个执行流就不会处在所谓的"阻塞"状态，而是各管各的。并行的是追是针对多核CPU，它指的是多个核心同时执行多个任务的能力。并发的实质是针对单核CPU，它的交替调度不同任务的能力。
Golang进阶学习
qq_56517253的博客
08-01 888
Golang进阶学习，包如何使用，如何自定义错误，常用工具数组、切片，Go语言如何面向对象编程
golang高级进阶（一）：进程、线程、并发、并行、goroutine协程
genziisme的专栏
04-21 5774
目录 一、关于进程和线程 1. 进程（Process） 2. 线程 二、关于并发和并行 1. 并发 2. 并行 3. 通俗讲 三、goroutine协程以及主线程 1. 主线程 2. 协程 3. 多协程和多线程 四、go关键词实操 1. 顺序执行 2. 加入go 3. 加入时间 4. 主线程执行快的情况 5. sync.WaitGroup解决不等待 6. 多协程并发并行执行 五、设置golang运行时占用的cpu核数量（不是很重要） 重点：这一篇全是干货，一定要多
golang-swaggerui-example:Golang的SwaggerUI生成示例
05-14
golang-swaggerui-example Golang-swaggerui-example是一个示例存储库，用于在您的Golang项目中使用SwaggerUI设置API文档。 详细说明可在。 API互动 可以通过访问localhost：8080 / swaggerui /访问SwaggerUI，有关...
mswagger:使用golang生成swagger 2.0 json文件
05-17
生成swagger 2.0 json文件。 使用swagger-ui修复某些字段类型的映射。 用法 在main.go中发表评论 // @Version 1.0.0 // @Title Backend API // @Description API usually works as expected. But sometimes its ...
Golang: Gin Swagger 配置
Allan_shore_ma的博客
03-04 886
Gin Swagger 配置     swagger是一套基于OpenAPI规范构建的开源工具，使用RestApi。swagger-ui 呈现出来的是一份可交互式的API文档，可以直接在文档页面尝试API的调用。     gin-swagger 是基于注释生成 API 文档，项目地址:https://github.com/swaggo/swag。
golang swagger
qq_36020617的博客
10-22 1659
我看网上很多关于golang gin整合swagger的教程，但都写的比较模糊，所以我自己整理了一个golang引入swagger的教程，希望能帮到大家。
golang进阶(八)——隐藏技能go:linkname
热门推荐
独自登高楼 望断天涯路
12-18 1万+
什么是go:linkname指令的格式如下：//go:linkname hello github.com/lastsweetop/testlinkname/hello.hellofuncgo:linkname引导编译器将当前(私有)方法或者变量在编译时链接到指定的位置的方法或者变量，第一个参数表示当前方法或变量，第二个参数表示目标方法或变量，因为这关指令会破坏系统和包的模块化，因此在使用时必须导入u
Go语言进阶
HY1273383167的博客
01-01 990
Go语言进阶
go语言进阶
bobi的博客
02-16 414
包的目录结构： src目录是专门用来存放go源码文件，每个文件夹都对应一个package 同一目录下所有go文件都属于一个包 import时从go安装目录GOPROOT和GOPATH开始索引 import时 绝对路径：根据src的下一级目录开始 import时 相对路径：main.go所在的路径，以"."开始 import时使用.操作 import ( . "fmt...
Go语言进阶教程
Weirdo的博客
06-12 1048
Go语言，又称Golang，自诞生以来便凭借其简洁、高效和强大的并发支持能力，迅速在云计算、网络编程、分布式系统等领域崭露头角。对于已经掌握了Go语言基础语法的开发者来说，进阶学习Go语言的更多特性和最佳实践是进一步提升自己技能的关键。虽然Go语言提供了垃圾回收机制来自动管理内存，但在编写高性能应用时，了解如何手动优化内存使用和避免不必要的内存分配仍然是很重要的。虽然Go语言本身没有内置的设计模式支持，但我们可以借鉴其他语言中的设计模式来实现更好的代码结构和可维护性。接口是Go语言中实现多态的关键。
Golang 学习进阶资料整理
努力打工
01-03 296
基础 Go语言中文文档（官方文档） Iris中文文档（goWEB框架） Go入门视频 （密码:zd5x） 进阶 Golang的反射（nil!=nil）
Golang 进阶3—— 协程&管道
最新发布
weixin_41835324的博客
10-06 1110
在任务切换回来的时候，恢复先前保存的寄存器上下文和栈，这样就保证该线程能够最大限度处于就绪态，即随时都可以被CPU执行的状态，相当于我们在用户级别将自己的IO操作最大限度隐藏起来，从而可以迷惑操作系统，让其看到：该线程好像是一直在计算，IO比较少，从而会更多的将cpu的执行权限分配给我们线程。线程是CPU控制的，而协程是程序自身控制的，属于程序级别的切换，操作系统完全感知不到，从而更加轻量级。自身线程安全，不需要加锁，channel本身就是线程安全的,多个协程操作同一个管道时候，不会发生资源争抢问题。
golang mysql
oToyix的博客
07-28 443
func sql.Open(driverName string, dataSourceName string) (*sql.DB, error) func (*sql.DB).Prepare(query string) (*sql.Stmt, error)//使用DB.Prepare预编译并使用参数化查询，对预编译的SQL语句进行缓存，省去了每次解析优化该SQL语句的过程 func (*sql.Stmt).Query(args ...any) (*sql.Rows, error) func (*sql
leetcode分类-learning-golang::memo:Go学习之路
06-30
Golang 知识清单 基础 变量 常量 类型 函数 包 数组 切片 指针 结构 方法 接口 协程 信道 缓冲区 选择 互斥锁 延迟 错误 异常 恢复 text image compress container crypto encoding unicode io net sync bytes os ...
【golang简明入门进阶指南01】golang基础变量、函数、条件控制
kouryoushine的博客
03-24 718
说明 本文目的：学习golang 必须掌握的基本语法和概念 前置条件：搭建号golang环境并输出helloworld 一、变量和常量 这部分要分清golang语言的优势特性 1.1 变量声明 名称在前，类型在后，重点突出 变量声明既有初值，不存在null 一旦声明必须使用，编译器决定 可以不声明类型，编译器做类型推断 var和: 等同，后者更短，短就是好 注 := 只能在函数内使用，不能声明全局变量 详细声明方法请参考代码（建议逐行演练一遍） package main import "fmt"
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值