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 user

import "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") //当前用户ID
    userdata, 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 user

import "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 user

import (
    "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模块新增类或者一个接口也是同样操作,您就自己举一反三自己动手试试,反复写几次让自己对框架有深入了解,千万别急躁慢慢来,要自己多去探索,形成自学习惯。

 

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

linux Inodes满导致数据库宕机

项目经理反馈集群环境中有个节点无法使用了需要支援下,同时发过来截图说明磁盘还是有空的。 登录系统后直接发现问题 orcl2:/home/oracledb2> sqlplus / as sysdba SQL*Plus: Release 11.2.0.4.0 Production on Wed May 29 13:59:21 2024 Copyright (c) 1982,…

网络融合的力量:企业如何通过“一网多用”提升业务效率

随着企业业务的不断扩展,网络需求变得日益复杂。需要的是一种能够统一承载办公、生产、销售和运营等多业务需求的网络架构。这种“一网多用”的架构,不仅简化了网络部署和管理,还提升了效率并降低了成本。 “一网多用”架构的实际应用&#x…

模拟集成电路(5)----单级放大器(共栅级)

模拟集成电路(5)----单级放大器(共栅级) 有一些场合需要一些小的输入电阻(电流放大器) 大信号分析 − W h e n V i n ≥ V B − V T H ∙ M 1 i s o f f , V o u t V D D − F o r L o w e r V i n I d 1 2 μ n C o x W L ( V…

RestTemplet 自定义消息转换器总结

在RestTemplet 请求中,请求发送一个 HTTP 请求时,RestTemplet 会根据请求中的内容类型(Content-Type)选择合适的 HttpMessageConverter 来处理请求体的数据。同样地,当服务器返回一个 HTTP 响应时,RestTemp…

2024年QMT智能量化交易全解读:一文带你深入了解什么是QMT

随着科技的飞速发展和金融市场的日益成熟,量化交易逐渐成为投资者关注的焦点。QMT(Quantitative Market Trading)智能量化交易系统,作为量化交易领域的重要工具,以其高效、精准、自动化的特点,受到越来越多…

3.Linux系统环境搭建

一、虚拟化机:指的是通过虚拟化技术将一台计算机分为多台逻辑计算机。注:虚拟机共用CPU和内存资源。 二、虚拟机用途: 1.搭建学习环境:例如在同一间实验室里,物理机Windows系统,虚拟机可以用Linux系统。 …

网络故障与排除

一、Router-ID冲突导致OSPF路由环路 路由器收到相同Router-ID的两台设备发送的LSA,所以查看路由表看到的OSPF缺省路由信息就会不断变动。而当C1的缺省路由从C2中学到,C2的缺省路由又从C1中学到时,就形成了路由环路,因此出现路由不…

3DEXPERIENCE DELMIA Role: RVN - Robotics Virtual Commissioning Analyst

Discipline: Robotics Role: RVN - Robotics Virtual Commissioning Analyst 通过准确地模拟连接到PLC程序的机器人、设备和传感器,在制造虚拟孪生上执行虚拟调试情景 为任何机器人角色的多周期情景创建传感器,生成和变换零件启用 PLC 程序的虚拟验证和…

最新Adaptive特征融合策略,涨点又高效,想发表论文可以参考

自适应特征融合是一种非常高效的数据处理方法,它比传统的特征更能适应不同的数据和任务需求,也因此拥有广泛的应用前景,是深度学习领域的研究热点。 这种方法通过动态选择和整合来自不同层次或尺度的特征信息,不仅显著提升了模型…

格式化字符串

自学python如何成为大佬(目录):https://blog.csdn.net/weixin_67859959/article/details/139049996?spm1001.2014.3001.5501 格式化字符串是指先制定一个模板,在这个模板中预留几个空位,然后再根据需要填上相应的内容。这些空位需要通过指定的符号标记…

opencv进阶 ——(七)图像处理之寸照换背景

寸照换背景,通常指的是将个人证件照片的背景色更换为另一种颜色,如白色、蓝色或红色等,以满足不同用途的要求。例如,护照照片通常要求白色背景,而身份证照片可能需要蓝色背景。这个过程通常涉及到图像处理技术&#xf…

人脸识别——探索戴口罩对人脸识别算法的影响

1. 概述 人脸识别是一种机器学习技术,广泛应用于各种领域,包括出入境管制、电子设备安全登录、社区监控、学校考勤管理、工作场所考勤管理和刑事调查。然而,当 COVID-19 引发全球大流行时,戴口罩就成了日常生活中的必需品。广泛使…

源码部署ELK

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

2024 五月份国内外CTF 散装re 部分wp

cr3CTF warmup 附件拖入ida main函数无法反汇编,仔细看,有花指令,jnz实际上必定跳转。有非常多处,可以写脚本patch程序去掉花指令,只要匹配指令,再获取跳转地址,nop掉中间的代码就行。但…

Paddle使用问题No module named ‘paddle.fluid’

这是Paddle版本的问题,从飞桨框架 2.5 版本开始,已经废弃了 paddle.fluid 。 ​解决方案:修改paddle版本 pip install paddlepaddle2.4.0

【微机原理及接口技术】可编程计数器/定时器8253

【微机原理及接口技术】可编程计数器/定时器8253 文章目录 【微机原理及接口技术】可编程计数器/定时器8253前言一、8253的内部结构和引脚二、8253的工作方式三、8253的编程总结 前言 本篇文章就8253芯片展开,详细介绍8253的内部结构和引脚,8253的工作方…

sqlserver查询(三)——group by 与 having的使用

目录 10. group by(分组) 11. having(对分组后的信息过滤) 可能从这里开始,执行顺序越来越显得重要了!!! 10. group by(分组) 这个查询相比前面会有一些困难; 格式:group by 字段的集合; 功…

正邦科技(day2)

自动校准 问题:电量不准都可以直接去校准 校准方式:可程式变频电压 问题分析:他是通过软件去自动自动校准的,flash 清空的时候有缓存没有清空,或者互感器没有读取到问题 互感器:电流互感器的作用包括电流测…

景源畅信:抖音小店如何开橱窗?

在当今数字化时代,社交媒体平台不仅仅是人们交流和分享生活的工具,更成为了商家们展示和销售产品的重要场所。抖音作为一款流行的短视频社交应用,其内置的电商功能——抖音小店,为众多商家和个人提供了便捷的在线销售途径。其中&a…

Spring-注解

Spring 注解分类 Spring 注解驱动模型 Spring 元注解 Documented Retention() Target() // 可以继承相关的属性 Inherited Repeatable()Spirng 模式注解 ComponentScan 原理 ClassPathScanningCandidateComponentProvider#findCandidateComponents public Set<BeanDefin…