Files
EasyGoAdmin_GoFrame_AntdVue/api/v1/common.go
T
2026-10-20 19:07:36 +08:00

114 lines
5.2 KiB
Go

// +======================================================================
// | EasyGoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
// +----------------------------------------------------------------------
// | Copyright (c) 2019-2026 半城风雨团队 版权所有
// +----------------------------------------------------------------------
// | 开源协议: Apache-2.0
// | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
// +----------------------------------------------------------------------
// | 官方网站: https://www.easygoadmin.vip
// +----------------------------------------------------------------------
// | 研发团队: 小蚂蚁云团队 荣誉出品
// +======================================================================
// | 版权和免责声明:
// | 一、知识产权声明
// | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
// | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
// | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
// | 二、使用限制与禁止条款
// | 您理解并同意,禁止将本产品用于以下任何行为:
// | 1. 任何违反中华人民共和国法律法规的用途;
// | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
// | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
// | 三、责任豁免
// | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
// | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
// | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
// | 四、违约与法律责任
// | 如发现任何违反本声明的行为,本团队有权:
// | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
// | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
// | 3. 保留进一步采取刑事控告等法律措施的权利。
// | 五、许可范围说明
// | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
// | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
// | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
// | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
// | 成的一切经济损失及商誉损害。
// | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
// | 许可协议》附件为准。
// +======================================================================
package v1
// ============================== 公共基础模块 ==============================
// PageReq 分页公共参数
// 对应前端分页契约:pageNo/pageSize
type PageReq struct {
PageNo int `json:"pageNo" dc:"页码,从1开始,默认1"` // 页码,从1开始
PageSize int `json:"pageSize" dc:"每页条数,默认10,最大500"` // 每页条数
}
// GetPageNo 获取页码
// 页码小于等于0时返回默认值1
func (p *PageReq) GetPageNo() int {
if p.PageNo <= 0 {
return 1
}
return p.PageNo
}
// GetPageSize 获取每页条数
// 每页条数小于等于0时返回默认值10,超过500时按500截断
func (p *PageReq) GetPageSize() int {
if p.PageSize <= 0 {
return 10
}
if p.PageSize > 500 {
return 500
}
return p.PageSize
}
// Offset 计算SQL LIMIT偏移量
// 偏移量 = (页码 - 1) × 每页条数
func (p *PageReq) Offset() int {
return (p.GetPageNo() - 1) * p.GetPageSize()
}
// IdsReq 批量删除入参
// 通用批量操作请求体,携带待操作的ID列表
type IdsReq struct {
Ids []int64 `json:"ids" v:"required#请选择要操作的记录" dc:"ID列表"` // ID列表
}
// IdRes 通用返回ID结构
// 各模块新增等接口共用的返回结果
type IdRes struct {
Id int64 `json:"id"` // 主键ID
}
// PageData 统一分页壳
// 对应前端分页契约:records/total/size/current/pages
type PageData[T any] struct {
Records []T `json:"records"` // 当前页记录列表
Total int `json:"total"` // 总记录数
Size int `json:"size"` // 请求的每页条数
Current int `json:"current"` // 请求页码
Pages int `json:"pages"` // 总页数
}
// NewPageData 构造分页壳
// records 为空时输出空数组而非 null,pages 按总记录数与每页条数计算得出
func NewPageData[T any](pageNo, pageSize, total int, records []T) *PageData[T] {
if records == nil {
records = []T{}
}
pages := 0
if pageSize > 0 {
pages = (total + pageSize - 1) / pageSize
}
return &PageData[T]{Records: records, Total: total, Size: pageSize, Current: pageNo, Pages: pages}
}