go-zero框架基本配置和错误码封装

文章目录

  • 加载配置信息
    • 配置 env
    • 加载.env文件
    • 配置servicecontext
  • 查询数据
    • 生成model文件
    • 执行查询操作
  • 错误码封装
    • 配置拦截器
    • 错误码封装

接上一篇:《go-zero框架快速入门》

加载配置信息

配置 env

在项目根目录下新增 .env 文件,可以配置当前读取哪个环境的配置信息。内容如下:

# 基础环境配置
#开发环境 dev
#测试环境 test
#预发环境 pre
#生产环境 prod
GO_ENV=dev

新增gozero/etc/gozero-api-dev.yaml文件,配置数据库等相关信息:

Name: gozero-api
Host: 0.0.0.0
Port: 8888
MaxConns: 50
Timeout: 20000
Mysql:DataSource: root:123456@tcp(127.0.0.01:3306)/go-demo-2025?charset=utf8mb4&parseTime=True&loc=Local
cache_config: &cache_configHost: 127.0.0.1:6379Pass: ""Type: node
Cache:- <<: *cache_config

同时可以新增如下配置文件,具体要在当前项目中运行哪个配置文件,修改.env为对应的环境变量即可。

gozero/etc/gozero-api-test.yaml
gozero/etc/gozero-api-pre.yaml
gozero/etc/gozero-api-prod.yaml

加载.env文件

上面只是配置了不同的env,还需要有一个方法来加载当前设定的env。代码路径:gozero/internal/config/config.go

func GetConfigFile() string {// 加载 .env 文件if err := godotenv.Load(); err != nil {logx.Errorf("Error loading .env file: %v", err)}env := os.Getenv("GO_ENV")logx.Infof("env=: %s", env)if env == "" {env = "dev" // 默认开发环境}return filepath.Join("etc", fmt.Sprintf("gozero-api-%s.yaml", env))
}

同时,把数据库相关的信息加载到Config中:

type Config struct {rest.RestConfMysql struct {DataSource string}Cache cache.CacheConf
}

最后,在入口文件 gozero.go中加载配置项:

func main() {flag.Parse()var c config.Config//调用自定义的GetConfigFile方法,读取当前配置的env信息configFile := config.GetConfigFile()conf.MustLoad(configFile, &c)//....
}

配置servicecontext

在 Go-zero 中,servicecontext是服务上下文的依赖注入,所有的配置项和数据库连接、以及业务逻辑所需的模型实例,都被集中管理在 servicecontext 中。可以把它理解为一根长长的线,这根线上存储了整个项目所需的各类资源。如此一来,每个层只需依赖这个上下文,而不需要直接处理底层的配置和初始化逻辑。

这里,我们先简单的配置全局Config和数据库model以及日志等上下文信息。代码路径:gozero/internal/svc/servicecontext.go

type ServiceContext struct {Config config.ConfigModel  *query.Query
}func NewServiceContext(c config.Config) *ServiceContext {newLogger := logger.New(log.New(os.Stdout, "\r\n", log.LstdFlags), // io writerlogger.Config{SlowThreshold: 10 * time.Second, // 慢SQL阈值,默认10秒钟LogLevel:      logger.Silent,    // 日志级别 Silent:静默级别,Error:错误级别,Warn:警告级别,Info:信息级别Colorful:      true,             // 是否彩色打印},)db, _ := gorm.Open(mysql.Open(c.Mysql.DataSource), &gorm.Config{Logger: newLogger,NamingStrategy: schema.NamingStrategy{TablePrefix: "", // 表名前缀SingularTable: true, // 使用单数表名,启用该选项,会区分 user 和 users 表为两个不同的数据表},})return &ServiceContext{Config: c,Model:  query.Use(db),}
}

查询数据

生成model文件

GEN 自动生成 GORM 模型结构体文件及使用示例,新增gozero/script/gorm_generate_db_struct.go 文件:

package mainimport ("github.com/zeromicro/go-zero/core/conf""go-demo-2025/gozero/internal/config""gorm.io/driver/mysql""gorm.io/gorm""gorm.io/gorm/schema""strings""gorm.io/gen"
)// GEN 自动生成 GORM 模型结构体文件及使用示例
// 安装: go get -u gorm.io/gen@v0.3.16
// 更多参考: https://gorm.io/zh_CN/gen | https://gorm.io/gen/database_to_structs.html
// 更多参考: https://segmentfault.com/a/1190000042502370
func main() {// 初始化go-zero的配置var c config.ConfigconfigFile := config.GetConfigFile() //调用自定义的GetConfigFile方法,读取当前配置的env信息conf.MustLoad(configFile, &c)// 连接数据库db, _ := gorm.Open(mysql.Open(c.Mysql.DataSource), &gorm.Config{NamingStrategy: schema.NamingStrategy{TablePrefix:   "",   // 表名前缀SingularTable: true, // 使用单数表名,启用该选项,会区分 user 和 users 表为两个不同的数据表},})// 生成实例g := gen.NewGenerator(gen.Config{// 生成的model文件的路径OutPath: "./internal/model/dao/query",// WithDefaultQuery 生成默认查询结构体(作为全局变量使用), 即`Q`结构体和其字段(各表模型)// WithoutContext 生成没有context调用限制的代码供查询// WithQueryInterface 生成interface形式的查询代码(可导出), 如`Where()`方法返回的就是一个可导出的接口类型Mode: gen.WithDefaultQuery | gen.WithQueryInterface,// 表字段可为 null 值时, 对应结体字段使用指针类型//FieldNullable: true, // generate pointer when field is nullable// 表字段默认值与模型结构体字段零值不一致的字段, 在插入数据时需要赋值该字段值为零值的, 结构体字段须是指针类型才能成功, 即`FieldCoverable:true`配置下生成的结构体字段.// 因为在插入时遇到字段为零值的会被GORM赋予默认值. 如字段`age`表默认值为10, 即使你显式设置为0最后也会被GORM设为10提交.// 如果该字段没有上面提到的插入时赋零值的特殊需要, 则字段为非指针类型使用起来会比较方便.FieldCoverable: false, // generate pointer when field has default value, to fix problem zero value cannot be assign: https://gorm.io/docs/create.html#Default-Values// 模型结构体字段的数字类型的符号表示是否与表字段的一致, `false`指示都用有符号类型FieldSignable: false, // detect integer field's unsigned type, adjust generated data type// 生成 gorm 标签的字段索引属性FieldWithIndexTag: false, // generate with gorm index tag// 生成 gorm 标签的字段类型属性FieldWithTypeTag: true, // generate with gorm column type tag})// 设置目标 dbg.UseDB(db)// 自定义字段的数据类型// 统一数字类型为int64,兼容protobufdataMap := map[string]func(columnType gorm.ColumnType) (dataType string){"tinyint":   func(columnType gorm.ColumnType) (dataType string) { return "int64" },"smallint":  func(columnType gorm.ColumnType) (dataType string) { return "int64" },"mediumint": func(columnType gorm.ColumnType) (dataType string) { return "int64" },"bigint":    func(columnType gorm.ColumnType) (dataType string) { return "int64" },"int":       func(columnType gorm.ColumnType) (dataType string) { return "int64" },}// 要先于`ApplyBasic`执行g.WithDataTypeMap(dataMap)//=================== 生成全部数据表的model ===================//// 自定义模型结体字段的标签// 将特定字段名的 json 标签加上`string`属性,即 MarshalJSON 时该字段由数字类型转成字符串类型jsonField := gen.FieldJSONTagWithNS(func(columnName string) (tagContent string) {//toStringField := `balance, `toStringField := ``if strings.Contains(toStringField, columnName) {return columnName + ",string"}return columnName})// 将非默认字段名的字段定义为自动时间戳和软删除字段;// 自动时间戳默认字段名为:`updated_at`、`created_at, 表字段数据类型为: INT 或 DATETIME// 软删除默认字段名为:`deleted_at`, 表字段数据类型为: DATETIME//autoUpdateTimeField := gen.FieldGORMTag("update_time", "column:update_time;type:int unsigned;autoUpdateTime")//autoCreateTimeField := gen.FieldGORMTag("create_time", "column:create_time;type:int unsigned;autoCreateTime")// 模型自定义选项组//fieldOpts := []gen.ModelOpt{jsonField, autoCreateTimeField, autoUpdateTimeField}fieldOpts := []gen.ModelOpt{jsonField}// 创建模型的结构体,生成文件在 model 目录; 先创建的结果会被后面创建的覆盖// 创建全部模型文件, 并覆盖前面创建的同名模型allModel := g.GenerateAllTable(fieldOpts...)// 创建模型的方法,生成文件在 query 目录; 先创建结果不会被后创建的覆盖g.ApplyBasic(allModel...)//=================== 生成指定数据表的model ===================////有时候其他小伙伴改动了某个表,不能随着当前版本上线,就需要指定部分数据表/*g.ApplyBasic(g.GenerateModel("ms_base_user"),g.GenerateModel("ms_user_depart"),g.GenerateModel("ms_sys_dict"),)*/g.Execute()
}

然后运行次文件:go run gorm_generate_db_struct.go ,会在 ./internal/model/dao 目录下生成如下的model文件:

image-20250106182912099

执行查询操作

gozero/internal/logic/admin/userdetaillogic.go 文件中编写查询model层数据的代码:

func (l *UserDetailLogic) UserDetail(req *types.UserDetailRequest) (resp *types.UserDetailResponse, err error) {//根据ID查询用户表信息,返回用户详情信息userModel := l.svcCtx.Model.Useruser, err := userModel.WithContext(l.ctx).Debug().Where(userModel.ID.Eq(int64(req.Id))).First()if err != nil {logx.Error("根据ID查询用户表信息失败:" + err.Error())return nil, err}//成功返回return &types.UserDetailResponse{Code: 200,Msg:  "获取用户详情成功",Data: types.UserDetailData{Id:   int32(user.ID),Name: user.Name,},}, nil
}

然后,在postman中使用POST请求调用一下看看:

image-20250106184200899

错误码封装

配置拦截器

上面我们通过直接在logic层写死了返回码:200 和 message:获取用户详情成功,如果出现异常,则不会返回json结构:

image-20250106185549280下一步,来配置一下go-zero中的拦截器(SetErrorHandler)。

在入口文件 gozero.go 中,添加如下代码:

// 使用拦截器
httpx.SetErrorHandler(func(err error) (int, any) {switch e := err.(type) {case *utils.MyError:return http.StatusOK, utils.Fail(e)default:return http.StatusOK, utils.ErrorResponse(constants.CodeServerError.Code, err.Error())}
})

另外新增gozero/internal/utils/response.go 文件:

package utils// 自定义错误结构体
type MyError struct {Code    int64  `json:"code"`Message string `json:"message"`
}// 实现 Error() 方法
func (e *MyError) Error() string {return e.Message
}// 创建自定义错误
func NewMyError(code int64, msg string) *MyError {return &MyError{Code:    code,Message: msg,}
}type Response struct {Code    int64       `json:"code"`Message string      `json:"message"`Data    interface{} `json:"result"`
}func SuccessResponse(data interface{}) *Response {return &Response{Code:    200000,Message: "请求成功",Data:    data,}
}
func ErrorResponse(code int64, msg string) *Response {return &Response{Code:    code,Message: msg,Data:    nil,}
}func Fail(err *MyError) *Response {return &Response{Code:    err.Code,Message: err.Message,Data:    nil,}
}

再次运行:

image-20250107155254244

错误码封装

接下来封装一个统一的错误码配置信息。新增gozero/internal/constants/errorCode.go:

package constantsvar (//系统基本错误码CodeSuccess     = utils.NewMyError(200000, "请求成功")CodeServerError = utils.NewMyError(500000, "服务器异常")CodeParamsEmpty = utils.NewMyError(400000, "参数为空")CodeParamsError = utils.NewMyError(400001, "参数错误")CodeUnknown     = utils.NewMyError(400100, "未知错误")
)

gozero/internal/logic/admin/userdetaillogic.go中添加一个自定义的判断条件:

func (l *UserDetailLogic) UserDetail(req *types.UserDetailRequest) (resp *types.UserDetailResponse, err error) {//校验参数,假设这里要求Id必须大于0if req.Id <= 0 {return nil, constants.CodeParamsError}
}

再次运行:

image-20250106193239807

注意:上面定义的MyError 结构体一定要实现 Error()方法,否则,就不能算是一个error类型!

image-20250106194824946

接下来,我们把成功返回部分也优化一下,把原有的logic的成功返回部分改为统一封装的*Response类型。

修改:gozero/internal/logic/admin/userdetaillogic.go

func (l *UserDetailLogic) UserDetail(req *types.UserDetailRequest) (resp *utils.Response, err error) {//前置判断条件和查询数据...//成功返回return utils.SuccessResponse(types.UserDetailData{Id:   int32(user.ID),Name: user.Name,}), nil
}

源代码:https://gitee.com/rxbook/go-demo-2025

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/6255.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

考研机试:买房子

描述 某程序员开始工作&#xff0c;年薪 N万&#xff0c;他希望在中关村公馆买一套 60平米的房子&#xff0c;现在价格是 200 万&#xff0c;假设房子价格以每年百分之 K 增长&#xff0c;并且该程序员未来年薪不变&#xff0c;且不吃不喝&#xff0c;不用交税&#xff0c;每年…

Ansible fetch模块详解:轻松从远程主机抓取文件

在自动化运维的过程中&#xff0c;我们经常需要从远程主机下载文件到本地&#xff0c;以便进行分析或备份。Ansible的fetch模块正是为了满足这一需求而设计的&#xff0c;它可以帮助我们轻松地从远程主机获取文件&#xff0c;并将其保存到本地指定的位置。在这篇文章中&#xf…

前端开发中的模拟后端与MVVM架构实践[特殊字符][特殊字符][特殊字符]

平时&#xff0c;后端可能不能及时给接口给前端进行数据调用和读取。这时候&#xff0c;前端想到进行模拟后端接口。本文将介绍如何通过vite-plugin-mock插件模拟后端接口&#xff0c;并探讨MVVM架构在前端开发中的应用。此外&#xff0c;我们还将讨论Vue2与Vue3的区别&#xf…

JAVA毕业设计210—基于Java+Springboot+vue3的中国历史文化街区管理系统(源代码+数据库)

毕设所有选题&#xff1a; https://blog.csdn.net/2303_76227485/article/details/131104075 基于JavaSpringbootvue3的中国历史文化街区管理系统(源代码数据库)210 一、系统介绍 本项目前后端分离(可以改为ssm版本)&#xff0c;分为用户、工作人员、管理员三种角色 1、用户…

docker的前世今生

docker来自哪里&#xff1f; 从我们运维部署的历史来看&#xff0c;宿主机从最初的物理机到虚拟机&#xff0c;再到docker&#xff0c;一步步演进到现在。技术演进其实是为了解决当前技术的痛点&#xff0c;那我们来看看有哪些痛点以及如何克服痛点的。 物理机 一般来说&…

电脑办公技巧之如何在 Word 文档中添加文字或图片水印

Microsoft Word是全球最广泛使用的文字处理软件之一&#xff0c;它为用户提供了丰富的编辑功能来美化和保护文档。其中&#xff0c;“水印”是一种特别有用的功能&#xff0c;它可以用于标识文档状态&#xff08;如“草稿”或“机密”&#xff09;、公司标志或是版权信息等。本…

【机器学习案列】探索各因素对睡眠时间影响的回归分析

&#x1f9d1; 博主简介&#xff1a;曾任某智慧城市类企业算法总监&#xff0c;目前在美国市场的物流公司从事高级算法工程师一职&#xff0c;深耕人工智能领域&#xff0c;精通python数据挖掘、可视化、机器学习等&#xff0c;发表过AI相关的专利并多次在AI类比赛中获奖。CSDN…

2024年度总结

迟来的2024年度总结&#xff0c;本文主要包括创作经历的回顾、个人成长与突破、以及职业与生活的平衡。 文章目录 1、 创作经历回顾2、 成长回顾3、 职业与生活的平衡4、 展望未来 1、 创作经历回顾 从高中开始就喜欢给别人解答疑问&#xff0c;大学学习模电、数电时&#xff…

vim在命令模式下的查找功能

/ab 从上往下 n 下一个 N 上一个 示例&#xff1a; 在命令模式下直接点击键盘上的/就可以进行查找&#xff0c;比如我要查找a&#xff0c;输入a后再回车&#xff0c;就可以检索出文件中所有和a有关的内容。 ?ab 从下往上 N 下一个 n 上一个 示例&#xff1a;和上图相同…

机器学习-使用梯度下降最小化均方误差

前面有一篇文章《机器学习-常用的三种梯度下降法》&#xff0c;这篇文章中对于均方误差的求偏导是错误的&#xff0c;为了澄清这个问题&#xff0c;我再写一篇文章来纠正一下&#xff0c;避免误导大家。 一、批量梯度下降法 我们用 批量梯度下降法 来求解一个简单的 线性回归…

基于quartz,刷新定时器的cron表达式

文章目录 前言基于quartz&#xff0c;刷新定时器的cron表达式1. 先看一下测试效果2. 实现代码 前言 如果您觉得有用的话&#xff0c;记得给博主点个赞&#xff0c;评论&#xff0c;收藏一键三连啊&#xff0c;写作不易啊^ _ ^。   而且听说点赞的人每天的运气都不会太差&…

LabVIEW智能胎压监测

汽车行车安全是社会关注焦点&#xff0c;轮胎压力异常易引发交通事故&#xff0c;开发胎压监测系统可保障行车安全、降低事故发生率。 系统组成与特点 &#xff08;一&#xff09;硬件组成 BMP - 280 气体压力传感器&#xff1a;高精度、稳定性好、能耗低&#xff0c;适合车载…

C语言教程——文件处理(1)

目录 前言 二、什么是文件 2.1文件的概念 2.2程序文件 2.3数据文件 2.4文件名 2.5二进制文件和文本文件 三、文件操作 3.1文件指针 3.2文件的打开与关闭 四、文件的顺序读写 4.1fgetc 4.2fputc 4.3fputs 4.4fgets 总结 前言 我们知道电脑上有许许多多的文件&a…

【橘子ES】Kibana的分析能力Analytics简易分析

一、kibana是啥&#xff0c;能干嘛 我们经常会用es来实现一些关于检索&#xff0c;关于分析的业务。但是es本身并没有UI,我们只能通过调用api来完成一些能力。而kibana就是他的一个外置UI&#xff0c;你完全可以这么理解。 当我们进入kibana的主页的时候你可以看到这样的布局。…

c#的tabControl控件实现自定义标签颜色

最近项目需要自定义tabControl控件颜色&#xff0c;而默认这个控件是不支持自定义标签颜色的&#xff0c;于是想办法实现了这个功能&#xff0c;效果如下图所示&#xff1a; 直接上代码&#xff1a; using System; using System.Collections.Generic; using System.ComponentM…

从零到一:Spring Boot 与 RocketMQ 的完美集成指南

1.Rocket的概念与原理 RocketMQ 是一款由阿里巴巴开源的分布式消息中间件&#xff0c;最初用于支持阿里巴巴的海量业务。它基于发布-订阅模型&#xff0c;具备高吞吐、低延迟、高可用和强一致性的特点&#xff0c;适用于消息队列、大规模数据流处理等场景。以下是对 RocketMQ …

Odoo免费开源ERP最佳业务实践:生产管理

文 / 开源智造&#xff08;OSCG&#xff09; Odoo亚太金牌服务 概述 Odoo是全球排名第一的免费开源ERP系统&#xff0c;以其强大的功能和模块化设计著称&#xff0c;适用于各种规模及类型的企业。Odoo集成了生产、采购、销售、库存、财务、人力资源、市场营销、电子商务等多个…

1.CSS的三大特性

css有三个非常重要的三个特性&#xff1a;层叠性、继承性、优先级 1.1 层叠性 想通选择器给设置想听的样式&#xff0c;此时一个样式就会覆盖&#xff08;层叠&#xff09;另一个冲突的样式。层叠性主要是解决样式冲突的问题。 <!DOCTYPE html> <html lang"en&…

【2024年华为OD机试】(A卷,200分)- 优雅子数组 (JavaScriptJava PythonC/C++)

一、问题描述 题目描述 如果一个数组中出现次数最多的元素出现大于等于 k 次&#xff0c;被称为 k-优雅数组&#xff0c;k 也可以被称为优雅阈值。 例如&#xff1a; 数组 [1, 2, 3, 1, 2, 3, 1] 是一个 3-优雅数组&#xff0c;因为元素 1 出现次数大于等于 3 次。数组 [1,…

电子应用设计方案102:智能家庭AI鱼缸系统设计

智能家庭 AI 鱼缸系统设计 一、引言 智能家庭 AI 鱼缸系统旨在为鱼类提供一个健康、舒适的生活环境&#xff0c;同时为用户提供便捷的管理和观赏体验。 二、系统概述 1. 系统目标 - 自动维持水质稳定&#xff0c;包括水温、酸碱度、硬度和溶氧量等关键指标。 - 智能投食&…