Go语言GoFly框架快速新增接口/上手写代码

拿到一个新框架大家可能无从下手,因为你对框架设计思路、结构不了解,从而产生恐惧,所以我们框架是通过简单可视化界面安装,安装后即可看到效果,然后点击先点点看各个功能,看现有的功能是怎么写的,这个现成功能作为参考,最好再自己写新的功能,下面我们就带大家如何写新的功能。

通过开发文档的必看章节,我猜您已经在您电脑成功安装并成功运行项目了,通过“开发必看”文档,您已经对哦框架有所了解,现在我们教你如何开发新的功能,对应我们前后端分离框架来说,后端写的功能都是提供给各个前端调用的api接口,所以我们往后开发功能都称为新增“接口”。

新增一个模块

我们在app目录下新加一个模块,当你下载新的代码安装后,app目录下只有admin、business、common三个文件夹和controller.go一个文件,其中controller.go是主控制器可以引入app下模块和设置全局路由拦截及请求前处理。我们用增加wxapp(微信应用模块)举例子,开发步骤如下:

第1.新增一个目录

在app下新建一个名称为 wxapp 的目录,这名称就是这个模块的名称,接口请求就是从wxapp开始也就是域名+wxapp/,例如:https://goflys.cn/wxapp

第2.在目录下添加控制器

wxapp 的目录中新建controller.go一个文件,这个就是整个wxapp 模块的控制器,代码如下:

package wxapp/**
* 引入控制器
* 请把您使用包用 _ "gofly/app/wxapp/XX"导入您编写的包 自动生成路由
* 不是使用则注释掉*/
import ("gofly/utils/gf"
)// 路由中间件/路由钩子
func RouterHandler(c *gf.GinCtx, IsCtr bool) {if IsCtr { //在这里面处理拦截操作c.Next()}
}

新建好的控制器文件后,要不这个模块添加到app下的controller.go主控制中并且引入模块路由中间件(如果模块不需拦截则可以不引入),代码如下:

package controller/**
* app路由引入口《引入模块控制器》
*
* 请把您使用包用 _ "gofly/app/xx"导入您编写的包 自动生成路由
* 不需要使用的模块则注释掉 例如home模块暂时用不到就注释掉,这样不占用资源,使用是取消注释即可。
* 路由规则:包路径“business/article” + 包中结构体“Cate”转小写+方法名(首字母转小写_ "gofly/app/business"
* 有控制的模块请在RouterHandler添加模块的路由钩子*/
import ("gofly/app/admin""gofly/app/business"_ "gofly/app/common""gofly/app/wxapp" //新增的wxapp模块"gofly/utils/gf"
)// 路由中间件/路由钩子
func RouterHandler(c *gf.GinCtx) {business.RouterHandler(c, gf.IsModelPath(c.FullPath(), "business"))admin.RouterHandler(c, gf.IsModelPath(c.FullPath(), "admin"))wxapp.RouterHandler(c, gf.IsModelPath(c.FullPath(), "wxapp"))//新增的wxapp模块
}

第3.在wxapp目录下创建接口文件夹

我们在wxapp模块创建名称user的用户相关接口类,和用户相关的接口将在user目录下添加,比如user中常见的用户基本操作(登录,获取用户信息)、用户订单等,我们下面从用户操作和用户订单给大家举例。这个类名user也会生成路由路径,到这里路由为:/wxapp/user,加上域名则为:https://goflys.cn/wxapp/user。我们框架会自动根据目录层级生成接口请求路径,这样路由就不用你手动编写,且不会出现路由重复、命名更规则、可以根据请求的接口路径快速定位代码位置方便更新代码。

第4.在user目录下创建接口文件

我们创建index.go来写用户常见操作,创建order.go来写用户订单相关功能,我们通过index.go和order.go两个给大家讲解接口,index,go中比较特殊框架为了减少路由层级框架对index命名的文件,在生成路由是会忽略index这一级生成路由为:/wxapp/user/+接口名称。其他命名路由会添加文件名,例如order.go生成路由为:/wxapp/user/order/+接口名称。index常用在与类名意义相同的功能上,类型本例user类的用户登录、获取用户信息等是和User类名称对应的功能,所以我们把用户登录、获取用户信息等用户操作功能放到index.go中,这样生成路由基于没有index这一层。

创建接口文件后我们在把user类在wxapp模块控制器引入,就是在app/wxapp/controller.go中import一下user,引入类的代码如下:

package wxapp/**
* 引入控制器
* 请把您使用包用 _ "gofly/app/wxapp/XX"导入您编写的包 自动生成路由
* 不是使用则注释掉*/
import (_ "gofly/app/wxapp/user" //这个就是新引入的 user类"gofly/utils/gf"
)// 路由中间件/路由钩子
func RouterHandler(c *gf.GinCtx, IsCtr bool) {if IsCtr { //在这里面处理拦截操作c.Next()}
}

4.1 新增index.go文件:

示例我只写接口方法,接口业务这里就不详细展开,您自己根据业务编写,index.go示例代码如下:

package userimport "gofly/utils/gf"// 用户
type Index struct{}func init() {fpath := Index{}gf.Register(&fpath, fpath)
}// 获取用户信息
func (api *Index) GetInfo(c *gf.GinCtx) {user_id, _ := c.Get("userID") //当前用户IDuserdata, err := gf.Model("business_user").Fields("id,businessID,name,nickname,mobile,email,avatar,status,createtime").Where("id", user_id).Find()if err != nil {gf.Failed().SetMsg("查找用户数据!").Regin(c)} else {gf.Success().SetMsg("获取用户信息").SetData(userdata).Regin(c)}
}// 用户登录
func (api *Index) Login(c *gf.GinCtx) {//更具登录业务写登录功能gf.Success().SetMsg("用户登录").Regin(c)
}

到这里我们就看到终端看到GetInfo和Login两个接口注册到路由中了,您可以通过:域名(服务端地址)+/wxapp/user/getInfo请求接口了。例如下图,大家可能疑问为什么GetInfo会生成为GET请求、Login又会是POST请已经为何首字母变小写,这问题请去:接口开发规范 这一节了解。

3aefed12497540b98ec06efd74f1cb93.png

4.2 新增order.go文件:

在user目录下创建order.go文件,package包名是类目录名user个必须规范,order.go基本代码如下:

package userimport "gofly/utils/gf"// 用户订单
type Order struct{}func init() {fpath := Order{}gf.Register(&fpath, fpath)
}

其中代码的结构体type Order struct{} 的Order名称要和order.go文件名一致,并且把首字母变大写。init函数中fpath := Order{} 的Order就是是=结构体名称,每个文件要写成和文件名称一样。

下面在order中添加功能接口,我们就添加一个获取订单列表GetList、获取订单详情GetDetail和修改订单状态UpStatus(取消订单、确认订单)3个接口做演示。代码如下:

package userimport ("gofly/utils/gf""gofly/utils/tools/gmap"
)// 用户订单
type Order struct{}func init() {fpath := Order{}gf.Register(&fpath, fpath)
}// 获取订单列表
func (Order) GetList(c *gf.GinCtx) {pageNo := gf.Int(c.DefaultQuery("page", "1"))pageSize := gf.Int(c.DefaultQuery("pageSize", "10"))//搜索添条件param, _ := gf.RequestParam(c)whereMap := gmap.New()if gf.DbHaseField("business_ordermanage", "businessID") {whereMap.Set("businessID", c.GetHeader("Businessid"))}user, err := gf.ParseTokenGetInfo(c)if err != nil {gf.Failed().SetMsg("登录失效请重新登录!").SetCode(401).SetData(err).Regin(c)}whereMap.Set("uid", user.ID)if title, ok := param["title"]; ok && title != "" {whereMap.Set("title like ?", "%"+gf.String(title)+"%")}MDB := gf.Model("business_order").Where(whereMap)totalCount, _ := MDB.Clone().Count()list, err := MDB.Fields("id,uid,title,status,createtime,updatetime").Page(pageNo, pageSize).Order("id desc").Select()if err != nil {gf.Failed().SetMsg(err.Error()).Regin(c)} else {gf.Success().SetMsg("获取全部列表").SetData(gf.Map{"page":     pageNo,"pageSize": pageSize,"total":    totalCount,"items":    list}).Regin(c)}
}// 获取订单详情
func (Order) GetDetail(c *gf.GinCtx) {id := c.DefaultQuery("id", "")if id == "" {gf.Failed().SetMsg("请传参数订单id").Regin(c)} else {data, err := gf.Model("business_order").Where("id", id).Fields("id,uid,title,status,createtime,updatetime").Find()if err != nil {gf.Failed().SetMsg("获取内容失败").SetData(err).Regin(c)} else {gf.Success().SetMsg("获取订单详情").SetData(data).Regin(c)}}
}// 更新订单状态
func (Order) UpStatus(c *gf.GinCtx) {param, _ := gf.RequestParam(c)res, err := gf.Model("business_order").Where("id", param["id"]).Data(gf.Map{"status": param["status"]}).Update()if err != nil {gf.Failed().SetMsg("更新失败!").SetData(err).Regin(c)} else {msg := "更新成功!"if res == nil {msg = "暂无数据更新"}gf.Success().SetMsg(msg).SetData(res).Regin(c)}
}

我们会在终端看到GetList、GetDetail、UpStatus生成请求路由了,也就是可以调用这些接口,如下图:

a5a6d01683f4469e883ee0e2c76ae2ae.png

我们细心的朋友可能发现,func 的函数前有个括号index和order两个写法不一样,这样我们和大家说明一下,func (Order) GetList(c *gf.GinCtx) {}中(Order)可以写成func (api *Order) GetList(c *gf.GinCtx) {}这种。func (Order)和func (api *Order)两种在我们示例都可以正常运行,写成func (Order)可以减少点代码,如果您写的业务有连锁操作需求再func (api *Order)这样通api去操作结构体内的变量值等操作。所以用不到api是可以省略,当然你留着也没有影响。

到此您就学会了使用框架新增功能了,同样的需要再现有的admin和business模块新增类或者一个接口也是同样操作,您就自己举一反三自己动手试试,反复写几次让自己对框架有深入了解,千万别急躁慢慢来,要自己多去探索,形成自学习惯。

 

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

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

相关文章

云原生架构内涵_3.主要架构模式

云原生架构有非常多的架构模式,这里列举一些对应用收益更大的主要架构模式,如服务化架构模式、Mesh化架构模式、Serverless模式、存储计算分离模式、分布式事务模式、可观测架构、事件驱动架构等。 1.服务化架构模式 服务化架构是云时代构建云原生应用的…

【开源项目】Excel数据表自动生成工具v1.0版

一、介绍 Excel数据表自动生成工具是Go语言编写的一款小型工具软件,用于将特定的Excel表格内容导出为多种编程语言的代码或可以直接读取的数据内容。 开源Github地址:https://github.com/SkyCreator/goproj 二、版本v1.0功能概览 1.编程语言支持 目前…

2018 年山东省职业院校技能大赛高职组“信息安全管理与评估”赛项任务书

2018年山东省职业院校技能大赛高职组 “信息安全管理与评估”赛项任务书 赛项时间 8:30-13:00,共计4小时30分钟,含赛题发放、收卷时间。 赛项信息 竞赛阶段 任务阶段 竞赛任务 竞赛时间 分值 第一阶段 平台搭建与安全设备配置防护 …

基于MetaGPT构建LLM多智能体

前言 你好,我是GISer Liu,在上一篇文章中,我们用了两万多字详细拆解了单个Agent的组成,并通过Github Trending订阅智能体理解MetaGPT框架的订阅模块如何解决应用问题,但是对于复杂,并行的任务,单…

ABAP MD04增强排除MRP元素

场景 MD04跑出来很多MRP元素,用户想手工控制某些MRP元素不参与运算 分析 增强点还蛮好找的,控制MRP元素是否参与运算用下面的se19三代增强点就可以,打个断点看下MD04进的哪个增强点就行 旧版本的用这个:MD_CHANGE_MRP_DATA 新…

期货交易的雷区

一、做自己看不懂的行情做交易计划一样要做有把握的,倘若你在盘中找机会交易,做自己看不懂的行情,即便你做进去了,建仓时也不会那么肯定,自然而然持仓也不自信,有点盈利就想平仓,亏损又想扛单。…

[测试开发]如何让IDEA实时显示内存

🔥 交流讨论:欢迎加入我们一起学习! 🔥 资源分享:耗时200小时精选的「软件测试」资料包 🔥 教程推荐:火遍全网的《软件测试》教程 📢欢迎点赞 👍 收藏 ⭐留言 &#x1…

Apache Hive 安装与配置的详细教程

1. Hive简介 Hive是基于Hadoop的一个数据仓库工具,用来进行数据提取、转化、加载,这是一种可以存储、查询和分析存储在Hadoop中的大规模数据的机制。hive数据仓库工具能将结构化的数据文件映射为一张数据库表,并提供SQL查询功能,能…

一致性hash算法原理图和负载均衡原理-urlhash与least_conn案例

一. 一致性hash算法原理图 4台服务器计算hash值图解 减少一台服务3台服务器计算hash值图解 增加一台服务器5台服务器计算hash值图解 二. 负载均衡原理-urlhash与least_conn 2.1.urlhash案例 # urlhash upstream tomcats {hash $requ

[C#]winform部署官方yolov10目标检测的onnx模型

【框架地址】 https://github.com/THU-MIG/yolov10 【算法介绍】 今天为大家介绍的是 YOLOv10,这是由清华大学研究团队最新提出的,同样遵循 YOLO 系列设计原则,致力于打造实时端到端的高性能目标检测器。 方法 创新 双标签分配策略 众所…

源码部署ELK

目录 资源列表 基础环境 关闭防护墙 关闭内核安全机制 修改主机名 添加hosts映射 一、部署elasticsearch 修改limit限制 部署elasticsearch 修改配置文件 单节点 集群(3台节点集群为例) 启动 二、部署logstash 部署logstash 添加配置文件 启动 三、部署kiban…

0基础认识C语言(理论+实操 2)

小伙伴们大家好,今天也要撸起袖子加油干!万事开头难,越学到后面越轻松~ 话不多说,开始正题~ 前提回顾: 接上次博客,我们学到了转义字符,最后留下两个转义字符不知道大家有没有动手尝试了一遍&a…

Sourcetree安装教程及使用

1 Sourcetree介绍 Sourcetree是一款免费的Git图形化客户端,它由Atlassian开发,提供了跨平台的支持,可运行在Windows和Mac操作系统上。Sourcetree可以让开发者更方便地使用Git来管理代码,不需要在命令行中输入复杂的Git命令&#x…

Linux 驱动设备匹配过程

一、Linux 驱动-总线-设备模型 1、驱动分层 Linux内核需要兼容多个平台,不同平台的寄存器设计不同导致操作方法不同,故内核提出分层思想,抽象出与硬件无关的软件层作为核心层来管理下层驱动,各厂商根据自己的硬件编写驱动…

海尔智家牵手罗兰-加洛斯,看全球创牌再升级

晚春的巴黎西郊,古典建筑群与七叶树林荫交相掩映,坐落于此的罗兰加洛斯球场内座无虚席。 来自全球各地的数万观众,正与场外街道上的驻足者们一起,等待着全世界最美好的网球声响起…… 当地时间5月26日,全球四大职业网…

内存函数<C语言>

前言 前面两篇文章介绍了字符串函数,不过它们都只能用来处理字符串,C语言中也内置了一些内存函数来对不同类型的数据进行处理,本文将介绍:memcpy()使用以及模拟实现,memmove()使用以及模拟实现,memset()使用…

MS Excel: 高亮当前行列 - 保持原有格式不被改变

本文使用条件格式VBA的方法实现高亮当前行列,因为纯VBA似乎会清除原有的高亮格式。效果如下:本文图省事就使用同一种颜色了。 首先最重要的,【选中你期望高亮的单元格区域】,比如可以全选当前sheet的全部区域 然后点击【开始】-【…

WAF几种代理模式详解

WAF简介 WAF的具体作用就是检测web应用中特定的应用,针对web应用的漏洞进行安全防护,阻止如SQL注入,XSS,跨脚本网站攻击等 正向代理 WAF和客户端与网络资源服务器都建立连接,但是WAF 的工作口具有自己的 IP 地址&…

构造+模拟,CF1148C. Crazy Diamond

一、题目 1、题目描述 2、输入输出 2.1输入 2.2输出 3、原题链接 Problem - 1148C - Codeforces 二、解题报告 1、思路分析 题目提示O(5n)的解法了,事实上我们O(3n)就能解决,关键在于1,n的处理 我们读入数据a[],代表初始数组…

PYQT5点击Button执行多次问题解决方案(亲测)

PYQT5点击Button却执行多次问题 使用pyqt5时遇到问题,UI上按钮点击一次,对应的槽函数却执行了3遍 首先,确认函数名无冲突,UI button名无命名冲突,下图是简单的示例程序: 运行后,点击按钮&#…