Compare commits

..

14 Commits

Author SHA1 Message Date
22ea09f0c1 fix(contrib/drivers/pgsql): Fixed table field call issue in primary key acquisition logic (#4546)
`pgsql driver`中`getPrimaryKeys`未使用现有缓存,导致每次`insert`都会重新查询表字段
2026-05-18 20:36:38 +00:00
4080452ead fix(contrib/drivers/pgsql): Fixed table field call issue in primary key acquisition logic (#4546)
`pgsql driver`中`getPrimaryKeys`未使用现有缓存,导致每次`insert`都会重新查询表字段
2025-12-08 16:27:17 +08:00
67a8a28a18 Update contrib/drivers/pgsql/pgsql_do_insert.go
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-08 15:01:01 +08:00
d8fa0a7922 Update contrib/drivers/pgsql/pgsql_do_insert.go
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-08 15:00:52 +08:00
b7cd39a8b8 up 2025-12-08 14:56:21 +08:00
01cd4a3384 up 2025-12-08 14:55:19 +08:00
111f8b3264 Update contrib/drivers/pgsql/pgsql_z_unit_upsert_test.go
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-08 14:54:48 +08:00
ba44475765 Update contrib/drivers/pgsql/pgsql_do_insert.go
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-08 14:54:26 +08:00
99536c8bef up 2025-12-08 14:37:35 +08:00
91e3f1eab1 Merge branch 'master' of github.com:gogf/gf into feat/gdb-pgsql-replace 2025-12-08 11:40:45 +08:00
ffe65d9d4a merge master 2025-12-04 20:41:28 +08:00
8723999afc up 2025-12-04 20:33:08 +08:00
0d122d6fee up 2025-12-04 17:33:57 +08:00
63c2bb7c86 feat(contrib/drivers/dm): add Replace/InsertIgnore support for dm 2025-12-04 17:29:39 +08:00
297 changed files with 2068 additions and 21365 deletions

View File

@ -1,336 +0,0 @@
# GoFrame 项目指导说明
## 项目概述
GoFrame (GF) 是一个模块化、高性能、企业级的 Golang 基础开发框架。
## 目录结构说明
### 主包
```shell
gf
├── container // 容器相关包
│ ├── garray // 数组容器
│ ├── glist // 链表容器
│ ├── gmap // Map容器
│ ├── gpool // 对象池
│ ├── gqueue // 队列
│ ├── gring // 环形缓冲区
│ ├── gset // 集合
│ ├── gtree // 树结构
│ ├── gtype // 并发安全类型
│ └── gvar // 动态变量
├── crypto // 加密相关
│ ├── gaes // AES加密
│ ├── gcrc32 // CRC32校验
│ ├── gdes // DES加密
│ ├── gmd5 // MD5哈希
│ └── gsha1 // SHA1哈希
├── database // 数据库相关
│ ├── gdb // 数据库ORM
│ └── gredis // Redis客户端
├── debug // 调试工具
│ └── gdebug // 调试辅助
├── encoding // 编码相关
│ ├── gbase64 // Base64编码
│ ├── gbinary // 二进制编码
│ ├── gcharset // 字符集转换
│ ├── gcompress // 压缩解压
│ ├── ghash // 哈希算法
│ ├── ghtml // HTML处理
│ ├── gini // INI解析
│ ├── gjson // JSON处理
│ ├── gproperties // Properties解析
│ ├── gtoml // TOML解析
│ ├── gurl // URL处理
│ ├── gxml // XML处理
│ └── gyaml // YAML处理
├── errors // 错误处理
│ ├── gcode // 错误码
│ └── gerror // 错误处理
├── frame // 框架核心
│ ├── g // 全局对象
│ └── gins // 依赖注入
├── i18n // 国际化
│ └── gi18n // 国际化支持
├── net // 网络相关
│ ├── gclient // HTTP客户端
│ ├── ghttp // HTTP服务端
│ ├── gipv4 // IPv4工具
│ ├── gipv6 // IPv6工具
│ ├── goai // AI工具
│ ├── gsel // 服务发现
│ ├── gsvc // 服务治理
│ ├── gtcp // TCP工具
│ ├── gtrace // 链路追踪
│ └── gudp // UDP工具
├── os // 系统相关
│ ├── gbuild // 构建工具
│ ├── gcache // 缓存管理
│ ├── gcfg // 配置管理
│ ├── gcmd // 命令行解析
│ ├── gcron // 定时任务
│ ├── gctx // 上下文管理
│ ├── genv // 环境变量
│ ├── gfile // 文件操作
│ ├── gfpool // 文件池
│ ├── gfsnotify // 文件监控
│ ├── glog // 日志管理
│ ├── gmetric // 指标监控
│ ├── gmlock // 内存锁
│ ├── gmutex // 互斥锁
│ ├── gproc // 进程管理
│ ├── gres // 资源管理
│ ├── grpool // 协程池
│ ├── gsession // 会话管理
│ ├── gspath // 路径处理
│ ├── gstructs // 结构体工具
│ ├── gtime // 时间处理
│ ├── gtimer // 定时器
│ └── gview // 视图渲染
├── test // 测试工具
│ └── gtest // 测试框架
├── text // 文本处理
│ ├── gregex // 正则表达式
│ └── gstr // 字符串工具
└── util // 工具类
├── gconv // 类型转换
├── gmeta // 元数据处理
├── gmode // 运行模式
├── gpage // 分页工具
├── grand // 随机数
├── gtag // 标签处理
├── guid // UUID生成
├── gutil // 通用工具
└── gvalid // 数据校验
```
### cmd 命令行工具
```shell
cmd
├── gf // GF CLI主程序
│ ├── gfcmd // CLI命令入口
│ │ ├── build // 项目构建 (cmd_build.go)
│ │ ├── run // 热编译运行 (cmd_run.go)
│ │ ├── init // 项目脚手架 (cmd_init.go)
│ │ ├── gen // 代码生成入口 (cmd_gen.go)
│ │ ├── docker // 容器化操作 (cmd_docker.go)
│ │ ├── install // 依赖管理 (cmd_install.go)
│ │ ├── fix // 代码修复 (cmd_fix.go)
│ │ ├── update // 框架升级 (cmd_up.go)
│ │ ├── env // 环境变量管理 (cmd_env.go)
│ │ ├── pack // 二进制打包 (cmd_pack.go)
│ │ └── doc // 文档生成 (cmd_doc.go)
│ ├── internal/cmd/ // 命令实现核心
│ │ ├── cmd_build.go // 构建命令:交叉编译支持/构建参数配置
│ │ ├── cmd_doc.go // 文档命令Swagger/API文档自动化生成
│ │ ├── cmd_docker.go // Docker命令镜像构建/推送/多阶段编译
│ │ ├── cmd_env.go // 环境管理:变量查看/设置/环境切换
│ │ ├── cmd_fix.go // 代码修复:自动修复常见语法问题
│ │ ├── cmd_gen.go // 代码生成:统一入口路由
│ │ ├── cmd_gen_ctrl.go // MVC控制器RESTful接口生成
│ │ ├── cmd_gen_dao.go // DAO层数据库表映射生成
│ │ ├── cmd_gen_enums.go // 枚举代码:自动生成枚举类型和方法
│ │ ├── cmd_gen_pb.go // Protobuf协议文件编译生成
│ │ ├── cmd_gen_pbentity.go // Protobuf实体数据库表到proto转换
│ │ ├── cmd_gen_service.go // 微服务接口GRPC服务代码生成
│ │ ├── cmd_init.go // 项目初始化:模块化脚手架生成
│ │ ├── cmd_install.go // 依赖管理自动分析并安装go依赖
│ │ ├── cmd_pack.go // 打包发布:支持二进制/Docker/zip多种格式
│ │ ├── cmd_run.go // 运行管理:热编译/配置重载/进程监控
│ │ ├── cmd_tpl.go // 模板管理:自定义代码模板系统
│ │ ├── cmd_up.go // 框架升级:版本检测与自动更新
│ │ ├── cmd_version.go // 版本管理CLI/Golang/框架版本信息
│ │ ├── cmd_z_init_test.go // 初始化测试:脚手架生成验证
│ │ └── cmd_z_unit_*_test.go // 单元测试:各命令功能验证
│ ├── internal/cmd/gen/ // 代码生成模板
│ │ ├── tpl_field.go // 字段级模板(列映射/类型转换)
│ │ ├── tpl_table.go // 表级模板(CRUD操作/关系映射)
│ │ ├── tpl_test.go // 测试用例模板
│ │ ├── tpl_ctrl.go // 控制器模板(RESTful方法)
│ │ ├── tpl_service.go // 服务层模板(业务逻辑)
│ │ └── tpl_pbentity.go // Protobuf实体模板
│ ├── test/ // 测试相关
│ │ ├── cmd_z_unit_build_test.go // 构建命令单元测试
│ │ ├── cmd_z_unit_gen_dao_test.go // DAO生成测试
│ │ └── testdata/ // 测试用例数据
│ ├── internal // 内部实现
│ ├── test // 测试代码
│ ├── go.mod // 模块文件
│ ├── go.sum // 依赖校验
│ ├── go.work // 工作区配置
│ ├── LICENSE // 许可证
│ ├── main.go // 主入口
│ ├── Makefile // 构建配置
│ └── README.MD // 说明文档
```
### contrib 组件库
```shell
contrib
├── config // 配置中心支持
│ ├── apollo // Apollo配置中心
│ ├── consul // Consul配置中心
│ ├── kubecm // Kubernetes ConfigMap支持
│ ├── nacos // Nacos配置中心
│ └── polaris // Polaris配置中心
├── drivers // 数据库驱动
│ ├── clickhouse // ClickHouse驱动
│ ├── dm // 达梦数据库驱动
│ ├── mssql // SQL Server驱动
│ ├── mysql // MySQL驱动
│ ├── oracle // Oracle驱动
│ ├── pgsql // PostgreSQL驱动
│ ├── sqlite // SQLite驱动
│ └── sqlitecgo // SQLite CGO驱动
├── metric // 指标监控
│ └── otelmetric // OpenTelemetry指标支持
├── nosql // NoSQL支持
│ └── redis // Redis支持
├── registry // 服务注册发现
│ ├── consul // Consul支持
│ ├── etcd // Etcd支持
│ ├── file // 文件注册中心
│ ├── nacos // Nacos支持
│ ├── polaris // Polaris支持
│ └── zookeeper // Zookeeper支持
├── rpc // RPC支持
│ └── grpcx // gRPC扩展支持
├── sdk // SDK支持
│ └── httpclient // HTTP客户端SDK
└── trace // 链路追踪
├── otlpgrpc // OpenTelemetry gRPC支持
└── otlphttp // OpenTelemetry HTTP支持
```
### examples 示例库
```shell
examples
├── balancer // 负载均衡示例
│ ├── http // HTTP负载均衡
│ └── polaris // Polaris负载均衡
├── config // 配置中心示例
│ ├── apollo // Apollo配置中心
│ ├── consul // Consul配置中心
│ ├── kubecm // Kubernetes ConfigMap
│ ├── nacos // Nacos配置中心
│ └── polaris // Polaris配置中心
├── converter // 类型转换示例
│ ├── alias-type-convert // 别名类型转换
│ ├── alias-type-scan // 别名类型扫描
│ ├── struct-convert // 结构体转换
│ └── struct-scan // 结构体扫描
├── database // 数据库示例
│ └── mysql // MySQL数据库
├── httpserver // HTTP服务示例
│ ├── default-value // 默认值处理
│ ├── proxy // 代理服务
│ ├── rate // 限流控制
│ ├── response-with-json // JSON响应
│ ├── serve-file // 文件服务
│ ├── swagger // Swagger文档
│ ├── upload-file // 文件上传
│ └── swagger-set-template // Swagger模板
├── metric // 指标监控示例
│ ├── basic // 基础指标
│ ├── callback // 回调指标
│ ├── dynamic-attributes // 动态属性
│ ├── global-attributes // 全局属性
│ ├── http-client // HTTP客户端指标
│ ├── http-server // HTTP服务端指标
│ ├── meter-attributes // 计量器属性
│ └── prometheus // Prometheus集成
├── nosql // NoSQL示例
│ └── redis // Redis操作
├── os // 系统操作示例
│ ├── cron // 定时任务
│ └── log // 日志管理
├── pack // 打包示例
│ ├── hack // 打包工具
│ ├── manifest // 清单文件
│ ├── packed // 打包结果
│ └── resource // 资源文件
├── registry // 服务注册发现示例
│ ├── consul // Consul注册中心
│ ├── etcd // Etcd注册中心
│ ├── file // 文件注册中心
│ ├── nacos // Nacos注册中心
│ └── polaris // Polaris注册中心
├── rpc // RPC示例
│ └── grpcx // gRPC扩展
├── tcp // TCP示例
│ └── server // TCP服务
└── trace // 链路追踪示例
├── grpc-with-db // gRPC+数据库
├── http // HTTP链路
├── http-with-db // HTTP+数据库
├── inprocess // 进程内追踪
├── inprocess-grpc // 进程内gRPC
├── otlp // OpenTelemetry
├── processes // 进程管理
└── provider // 追踪提供者
```
## 编码规范
1. 命名规范
- 包名使用小写
- 结构体、接口名使用大驼峰
- 方法名使用大驼峰
- 变量名使用小驼峰
2. 代码格式
- 使用`gofmt`标准格式化
- 遵循 Go 官方代码规范
- 每个包都应有详细的文档注释
3. 错误处理
- 使用`gerror`包进行错误处理
- 错误信息应该清晰明确
4. 测试规范
- 所有公开接口需要单元测试
- 测试文件命名为`xxx_test.go`
- 基准测试命名为`BenchmarkXxx`
5. 依赖管理
- 使用`go mod`进行依赖管理
- golang 的版本根据 go.mod 文件中的 go 版本进行管理
## 项目特定指南
1. 模块开发
- 遵循模块化设计原则
- 使用依赖注入模式
- 保持向后兼容性
2. 文档编写
- 使用英文编写代码注释
- 中英文文档同步更新
- 示例代码需要可运行
3. 性能考虑
- 注意内存分配
- 避免不必要的类型转换
- 合理使用缓存机制
## 代码生成建议
生成代码时请遵循以下原则:
- 符合 Go 语言惯用法
- 保持代码简洁清晰
- 注重性能和可维护性
- 添加必要的注释说明

View File

@ -198,17 +198,6 @@ jobs:
ports:
- 5236:5236
# openGauss server
# docker run --privileged=true -e GS_PASSWORD=UTpass@1234 -p 9950:5432 opengauss/opengauss:7.0.0-RC1.B023
gaussdb:
image: opengauss/opengauss:7.0.0-RC1.B023
env:
GS_PASSWORD: UTpass@1234
TZ: Asia/Shanghai
ports:
- 9950:5432
zookeeper:
image: zookeeper:3.8
ports:

View File

@ -1,785 +0,0 @@
#!/usr/bin/env bash
#
# GoFrame Docker Services Manager
# For managing Docker services used in local development and testing
#
set -e
# Container name prefix
PREFIX="goframe"
# Color definitions
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
CYAN='\033[0;36m'
NC='\033[0m' # No Color
# Service definitions
declare -A SERVICES
declare -A SERVICE_PORTS
declare -A SERVICE_ENVS
declare -A SERVICE_OPTS
# Basic services
SERVICES["etcd"]="bitnamilegacy/etcd:3.4.24"
SERVICE_PORTS["etcd"]="2379:2379"
SERVICE_ENVS["etcd"]="-e ALLOW_NONE_AUTHENTICATION=yes"
SERVICES["redis"]="redis:7.0"
SERVICE_PORTS["redis"]="6379:6379"
SERVICE_OPTS["redis"]="--health-cmd 'redis-cli ping' --health-interval 10s --health-timeout 5s --health-retries 5"
SERVICES["mysql"]="mysql:5.7"
SERVICE_PORTS["mysql"]="3306:3306"
SERVICE_ENVS["mysql"]="-e MYSQL_DATABASE=test -e MYSQL_ROOT_PASSWORD=12345678"
SERVICES["mariadb"]="mariadb:11.4"
SERVICE_PORTS["mariadb"]="3307:3306"
SERVICE_ENVS["mariadb"]="-e MARIADB_DATABASE=test -e MARIADB_ROOT_PASSWORD=12345678"
SERVICES["postgres"]="postgres:17-alpine"
SERVICE_PORTS["postgres"]="5432:5432"
SERVICE_ENVS["postgres"]="-e POSTGRES_PASSWORD=12345678 -e POSTGRES_USER=postgres -e POSTGRES_DB=test -e TZ=Asia/Shanghai"
SERVICE_OPTS["postgres"]="--health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5"
SERVICES["mssql"]="mcr.microsoft.com/mssql/server:2022-latest"
SERVICE_PORTS["mssql"]="1433:1433"
SERVICE_ENVS["mssql"]="-e TZ=Asia/Shanghai -e ACCEPT_EULA=Y -e MSSQL_SA_PASSWORD=LoremIpsum86"
SERVICES["clickhouse"]="clickhouse/clickhouse-server:24.11.1.2557-alpine"
SERVICE_PORTS["clickhouse"]="9000:9000 -p 8123:8123 -p 9001:9001"
SERVICES["polaris"]="polarismesh/polaris-standalone:v1.17.2"
SERVICE_PORTS["polaris"]="8090:8090 -p 8091:8091 -p 8093:8093 -p 9090:9090 -p 9091:9091"
SERVICES["oracle"]="loads/oracle-xe-11g-r2:11.2.0"
SERVICE_PORTS["oracle"]="1521:1521"
SERVICE_ENVS["oracle"]="-e ORACLE_ALLOW_REMOTE=true -e ORACLE_SID=XE -e ORACLE_DB_USER_NAME=system -e ORACLE_DB_PASSWORD=oracle"
SERVICES["dm"]="loads/dm:v8.1.2.128_ent_x86_64_ctm_pack4"
SERVICE_PORTS["dm"]="5236:5236"
SERVICES["gaussdb"]="opengauss/opengauss:7.0.0-RC1.B023"
SERVICE_PORTS["gaussdb"]="9950:5432"
SERVICE_ENVS["gaussdb"]="-e GS_PASSWORD=UTpass@1234 -e TZ=Asia/Shanghai"
SERVICE_OPTS["gaussdb"]="--privileged=true"
SERVICES["zookeeper"]="zookeeper:3.8"
SERVICE_PORTS["zookeeper"]="2181:2181"
# Service groups
GROUP_DB="mysql mariadb postgres mssql oracle dm gaussdb clickhouse"
GROUP_CACHE="redis etcd"
GROUP_REGISTRY="polaris zookeeper"
GROUP_ALL="etcd redis mysql mariadb postgres mssql clickhouse polaris oracle dm gaussdb zookeeper"
# Working directories
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$(dirname "$SCRIPT_DIR")"
WORKFLOW_DIR="$PROJECT_ROOT/.github/workflows"
# Print colored messages
print_info() {
echo -e "${BLUE}[INFO]${NC} $1"
}
print_success() {
echo -e "${GREEN}[OK]${NC} $1"
}
print_warning() {
echo -e "${YELLOW}[WARN]${NC} $1"
}
print_error() {
echo -e "${RED}[ERROR]${NC} $1"
}
# Check if Docker is available
check_docker() {
if ! command -v docker &> /dev/null; then
print_error "Docker is not installed or not in PATH"
exit 1
fi
if ! docker info &> /dev/null; then
print_error "Docker service is not running"
exit 1
fi
}
# Get container name
get_container_name() {
echo "${PREFIX}-$1"
}
# Start a single service
start_service() {
local service=$1
local container_name=$(get_container_name "$service")
local image="${SERVICES[$service]}"
local ports="${SERVICE_PORTS[$service]}"
local envs="${SERVICE_ENVS[$service]}"
local opts="${SERVICE_OPTS[$service]}"
if [ -z "$image" ]; then
print_error "Unknown service: $service"
return 1
fi
# Check if container already exists
if docker ps -a --format '{{.Names}}' | grep -q "^${container_name}$"; then
if docker ps --format '{{.Names}}' | grep -q "^${container_name}$"; then
print_warning "$service is already running"
return 0
else
print_info "Starting existing container $service..."
docker start "$container_name" > /dev/null
print_success "$service started"
return 0
fi
fi
print_info "Starting $service..."
# Build docker run command
local cmd="docker run -d --name $container_name"
# Add port mappings
for port in $ports; do
cmd="$cmd -p $port"
done
# Add environment variables
if [ -n "$envs" ]; then
cmd="$cmd $envs"
fi
# Add other options
if [ -n "$opts" ]; then
cmd="$cmd $opts"
fi
cmd="$cmd $image"
if eval "$cmd" > /dev/null 2>&1; then
print_success "$service started (container: $container_name)"
else
print_error "Failed to start $service"
return 1
fi
}
# Stop a single service
stop_service() {
local service=$1
local container_name=$(get_container_name "$service")
if docker ps --format '{{.Names}}' | grep -q "^${container_name}$"; then
print_info "Stopping $service..."
docker stop "$container_name" > /dev/null
print_success "$service stopped"
else
print_warning "$service is not running"
fi
}
# Remove a single service
remove_service() {
local service=$1
local container_name=$(get_container_name "$service")
if docker ps -a --format '{{.Names}}' | grep -q "^${container_name}$"; then
print_info "Removing $service..."
docker rm -f "$container_name" > /dev/null
print_success "$service removed"
else
print_warning "$service container does not exist"
fi
}
# View service logs
logs_service() {
local service=$1
local container_name=$(get_container_name "$service")
local lines=${2:-100}
if docker ps -a --format '{{.Names}}' | grep -q "^${container_name}$"; then
docker logs --tail "$lines" -f "$container_name"
else
print_error "$service container does not exist"
return 1
fi
}
# Start docker-compose service
start_compose_service() {
local service=$1
local compose_file=""
case $service in
apollo)
compose_file="$WORKFLOW_DIR/apollo/docker-compose.yml"
;;
nacos)
compose_file="$WORKFLOW_DIR/nacos/docker-compose.yml"
;;
redis-cluster)
compose_file="$WORKFLOW_DIR/redis/docker-compose.yml"
;;
consul)
compose_file="$WORKFLOW_DIR/consul/docker-compose.yml"
;;
*)
print_error "Unknown compose service: $service"
return 1
;;
esac
if [ -f "$compose_file" ]; then
print_info "Starting $service (docker-compose)..."
docker compose -f "$compose_file" up -d
print_success "$service started"
else
print_error "Compose file does not exist: $compose_file"
return 1
fi
}
# Stop docker-compose service
stop_compose_service() {
local service=$1
local compose_file=""
case $service in
apollo)
compose_file="$WORKFLOW_DIR/apollo/docker-compose.yml"
;;
nacos)
compose_file="$WORKFLOW_DIR/nacos/docker-compose.yml"
;;
redis-cluster)
compose_file="$WORKFLOW_DIR/redis/docker-compose.yml"
;;
consul)
compose_file="$WORKFLOW_DIR/consul/docker-compose.yml"
;;
*)
print_error "Unknown compose service: $service"
return 1
;;
esac
if [ -f "$compose_file" ]; then
print_info "Stopping $service (docker-compose)..."
docker compose -f "$compose_file" down
print_success "$service stopped"
else
print_error "Compose file does not exist: $compose_file"
return 1
fi
}
# Show service status
show_status() {
echo ""
echo -e "${CYAN}========== GoFrame Docker Services Status ==========${NC}"
echo ""
printf "%-15s %-12s %-30s %s\n" "SERVICE" "STATUS" "CONTAINER" "PORTS"
echo "--------------------------------------------------------------------------------"
for service in $GROUP_ALL; do
local container_name=$(get_container_name "$service")
local status="stopped"
local ports="-"
if docker ps --format '{{.Names}}' 2>/dev/null | grep -q "^${container_name}$"; then
status="${GREEN}running${NC}"
ports=$(docker port "$container_name" 2>/dev/null | tr '\n' ' ' || echo "-")
elif docker ps -a --format '{{.Names}}' 2>/dev/null | grep -q "^${container_name}$"; then
status="${YELLOW}stopped${NC}"
else
status="${RED}not created${NC}"
fi
printf "%-15s %-22b %-30s %s\n" "$service" "$status" "$container_name" "$ports"
done
echo ""
echo -e "${CYAN}========== Compose Services ==========${NC}"
echo ""
for compose_svc in apollo nacos redis-cluster consul; do
local running=0
case $compose_svc in
apollo)
running=$(docker ps --filter "name=apollo" --format '{{.Names}}' 2>/dev/null | wc -l)
;;
nacos)
running=$(docker ps --filter "name=nacos" --format '{{.Names}}' 2>/dev/null | wc -l)
;;
redis-cluster)
running=$(docker ps --filter "name=redis-" --format '{{.Names}}' 2>/dev/null | wc -l)
;;
consul)
running=$(docker ps --filter "name=consul" --format '{{.Names}}' 2>/dev/null | wc -l)
;;
esac
if [ "$running" -gt 0 ]; then
printf "%-15s ${GREEN}running${NC} (%d containers)\n" "$compose_svc" "$running"
else
printf "%-15s ${RED}stopped${NC}\n" "$compose_svc"
fi
done
echo ""
}
# Show service information
show_service_info() {
echo ""
echo -e "${CYAN}========== Available Services ==========${NC}"
echo ""
echo -e "${YELLOW}Basic Services (standalone containers):${NC}"
echo ""
printf "%-15s %-50s %s\n" "SERVICE" "IMAGE" "PORTS"
echo "--------------------------------------------------------------------------------"
for service in $GROUP_ALL; do
printf "%-15s %-50s %s\n" "$service" "${SERVICES[$service]}" "${SERVICE_PORTS[$service]}"
done
echo ""
echo -e "${YELLOW}Compose Services (multi-container):${NC}"
echo " apollo - Apollo Config Center (8080, 8070, 8060, 13306)"
echo " nacos - Nacos Registry (8848, 9848, 9555)"
echo " redis-cluster - Redis Primary-Replica + Sentinel Cluster (6380-6382, 26379-26381)"
echo " consul - Consul Service Discovery (8500, 8600)"
echo ""
echo -e "${YELLOW}Service Groups:${NC}"
echo " db - Databases: $GROUP_DB"
echo " cache - Cache: $GROUP_CACHE"
echo " registry - Registry: $GROUP_REGISTRY"
echo " all - All basic services"
echo ""
}
# Show help
show_help() {
echo ""
echo -e "${CYAN}GoFrame Docker Services Manager${NC}"
echo ""
echo "Usage: $0 <command> [service|group] [options]"
echo ""
echo "Commands:"
echo " start <service|group> Start service or service group"
echo " stop <service|group> Stop service or service group"
echo " restart <service|group> Restart service or service group"
echo " remove <service|group> Remove service container"
echo " logs <service> [lines] View service logs (default 100 lines)"
echo " status Show all service status"
echo " info Show available service information"
echo " clean Remove all goframe containers"
echo " pull [service] Pull images"
echo ""
echo "Services:"
echo " Basic: etcd, redis, mysql, mariadb, postgres, mssql,"
echo " clickhouse, polaris, oracle, dm, gaussdb, zookeeper"
echo " Compose: apollo, nacos, redis-cluster, consul"
echo ""
echo "Service Groups:"
echo " db - All database services"
echo " cache - Cache services (redis, etcd)"
echo " registry - Registry services (polaris, zookeeper)"
echo " all - All basic services"
echo ""
echo "Examples:"
echo " $0 start mysql # Start MySQL"
echo " $0 start db # Start all databases"
echo " $0 start all # Start all basic services"
echo " $0 start apollo # Start Apollo (compose)"
echo " $0 stop all # Stop all basic services"
echo " $0 logs mysql 50 # View last 50 lines of MySQL logs"
echo " $0 status # View service status"
echo ""
}
# Parse service groups
parse_services() {
local input=$1
case $input in
db)
echo "$GROUP_DB"
;;
cache)
echo "$GROUP_CACHE"
;;
registry)
echo "$GROUP_REGISTRY"
;;
all)
echo "$GROUP_ALL"
;;
*)
echo "$input"
;;
esac
}
# Check if it's a compose service
is_compose_service() {
local service=$1
case $service in
apollo|nacos|redis-cluster|consul)
return 0
;;
*)
return 1
;;
esac
}
# Pull images
pull_images() {
local services=$1
if [ -z "$services" ]; then
services="$GROUP_ALL"
fi
for service in $services; do
if [ -n "${SERVICES[$service]}" ]; then
print_info "Pulling image: ${SERVICES[$service]}"
docker pull "${SERVICES[$service]}"
fi
done
}
# Clean all goframe containers
clean_all() {
print_info "Removing all $PREFIX containers..."
local containers=$(docker ps -a --filter "name=$PREFIX" --format '{{.Names}}')
if [ -n "$containers" ]; then
for container in $containers; do
docker rm -f "$container" > /dev/null
print_success "Removed: $container"
done
else
print_info "No $PREFIX containers found"
fi
}
# Get service status mark
get_service_status_mark() {
local service=$1
local container_name=$(get_container_name "$service")
if docker ps --format '{{.Names}}' 2>/dev/null | grep -q "^${container_name}$"; then
echo -e "${GREEN}*${NC}"
else
echo " "
fi
}
# Get compose service status mark
get_compose_status_mark() {
local service=$1
local running=0
case $service in
apollo)
running=$(docker ps --filter "name=apollo" --format '{{.Names}}' 2>/dev/null | wc -l)
;;
nacos)
running=$(docker ps --filter "name=nacos" --format '{{.Names}}' 2>/dev/null | wc -l)
;;
redis-cluster)
running=$(docker ps --filter "name=redis-" --format '{{.Names}}' 2>/dev/null | wc -l)
;;
consul)
running=$(docker ps --filter "name=consul" --format '{{.Names}}' 2>/dev/null | wc -l)
;;
esac
if [ "$running" -gt 0 ]; then
echo -e "${GREEN}*${NC}"
else
echo " "
fi
}
# Service selection menu
select_service_menu() {
local action=$1
local action_name=$2
echo ""
echo -e "${CYAN}========== Select Service to ${action_name} ==========${NC}"
# Show running status for stop/restart/logs operations
if [[ "$action" == "stop" || "$action" == "restart" || "$action" == "logs" ]]; then
echo -e " (${GREEN}*${NC} indicates running)"
fi
echo ""
echo -e "${YELLOW}Basic Services:${NC}"
printf " %b1) etcd %b2) redis %b3) mysql\n" \
"$(get_service_status_mark etcd)" "$(get_service_status_mark redis)" "$(get_service_status_mark mysql)"
printf " %b4) mariadb %b5) postgres %b6) mssql\n" \
"$(get_service_status_mark mariadb)" "$(get_service_status_mark postgres)" "$(get_service_status_mark mssql)"
printf " %b7) clickhouse %b8) polaris %b9) oracle\n" \
"$(get_service_status_mark clickhouse)" "$(get_service_status_mark polaris)" "$(get_service_status_mark oracle)"
printf " %b10) dm %b11) gaussdb %b12) zookeeper\n" \
"$(get_service_status_mark dm)" "$(get_service_status_mark gaussdb)" "$(get_service_status_mark zookeeper)"
echo ""
echo -e "${YELLOW}Compose Services:${NC}"
printf " %b13) apollo %b14) nacos %b15) redis-cluster\n" \
"$(get_compose_status_mark apollo)" "$(get_compose_status_mark nacos)" "$(get_compose_status_mark redis-cluster)"
printf " %b16) consul\n" "$(get_compose_status_mark consul)"
echo ""
echo -e "${YELLOW}Service Groups:${NC}"
echo " 17) db (all databases) 18) cache (cache services)"
echo " 19) registry (registry services) 20) all (all basic services)"
echo ""
echo " 0) Back to main menu"
echo ""
read -p "Select [0-20]: " svc_choice
local svc=""
case $svc_choice in
1) svc="etcd" ;;
2) svc="redis" ;;
3) svc="mysql" ;;
4) svc="mariadb" ;;
5) svc="postgres" ;;
6) svc="mssql" ;;
7) svc="clickhouse" ;;
8) svc="polaris" ;;
9) svc="oracle" ;;
10) svc="dm" ;;
11) svc="gaussdb" ;;
12) svc="zookeeper" ;;
13) svc="apollo" ;;
14) svc="nacos" ;;
15) svc="redis-cluster" ;;
16) svc="consul" ;;
17) svc="db" ;;
18) svc="cache" ;;
19) svc="registry" ;;
20) svc="all" ;;
0) return ;;
*)
print_error "Invalid selection"
return
;;
esac
case $action in
start)
if is_compose_service "$svc"; then
start_compose_service "$svc"
else
for s in $(parse_services "$svc"); do
start_service "$s"
done
fi
;;
stop)
if is_compose_service "$svc"; then
stop_compose_service "$svc"
else
for s in $(parse_services "$svc"); do
stop_service "$s"
done
fi
;;
restart)
if is_compose_service "$svc"; then
stop_compose_service "$svc"
start_compose_service "$svc"
else
for s in $(parse_services "$svc"); do
stop_service "$s"
start_service "$s"
done
fi
;;
remove)
for s in $(parse_services "$svc"); do
remove_service "$s"
done
;;
logs)
if is_compose_service "$svc"; then
print_error "For Compose services, please use 'docker compose logs'"
else
read -p "Number of lines (default 100): " lines
lines=${lines:-100}
logs_service "$svc" "$lines"
fi
;;
pull)
pull_images "$(parse_services "$svc")"
;;
esac
}
# Interactive menu
interactive_menu() {
while true; do
echo ""
echo -e "${CYAN}========== GoFrame Docker Services Manager ==========${NC}"
echo ""
echo " 1) Start Service"
echo " 2) Stop Service"
echo " 3) Restart Service"
echo " 4) Remove Service"
echo " 5) View Logs"
echo " 6) View Status"
echo " 7) Service Info"
echo " 8) Clean All Containers"
echo " 9) Pull Images"
echo " 0) Exit"
echo ""
read -p "Select operation [0-9]: " choice
case $choice in
1)
select_service_menu "start" "Start"
;;
2)
select_service_menu "stop" "Stop"
;;
3)
select_service_menu "restart" "Restart"
;;
4)
select_service_menu "remove" "Remove"
;;
5)
select_service_menu "logs" "View Logs"
;;
6)
show_status
;;
7)
show_service_info
;;
8)
read -p "Confirm removing all goframe containers? [y/N]: " confirm
if [[ "$confirm" =~ ^[Yy]$ ]]; then
clean_all
fi
;;
9)
select_service_menu "pull" "Pull Images"
;;
0)
echo "Goodbye!"
exit 0
;;
*)
print_error "Invalid selection"
;;
esac
done
}
# Main function
main() {
check_docker
if [ $# -eq 0 ]; then
interactive_menu
exit 0
fi
local command=$1
local target=$2
local extra=$3
case $command in
start)
if [ -z "$target" ]; then
print_error "Please specify service name or service group"
exit 1
fi
if is_compose_service "$target"; then
start_compose_service "$target"
else
for service in $(parse_services "$target"); do
start_service "$service"
done
fi
;;
stop)
if [ -z "$target" ]; then
print_error "Please specify service name or service group"
exit 1
fi
if is_compose_service "$target"; then
stop_compose_service "$target"
else
for service in $(parse_services "$target"); do
stop_service "$service"
done
fi
;;
restart)
if [ -z "$target" ]; then
print_error "Please specify service name or service group"
exit 1
fi
if is_compose_service "$target"; then
stop_compose_service "$target"
start_compose_service "$target"
else
for service in $(parse_services "$target"); do
stop_service "$service"
start_service "$service"
done
fi
;;
remove|rm)
if [ -z "$target" ]; then
print_error "Please specify service name or service group"
exit 1
fi
for service in $(parse_services "$target"); do
remove_service "$service"
done
;;
logs)
if [ -z "$target" ]; then
print_error "Please specify service name"
exit 1
fi
logs_service "$target" "${extra:-100}"
;;
status|ps)
show_status
;;
info|list)
show_service_info
;;
clean)
clean_all
;;
pull)
pull_images "$target"
;;
help|--help|-h)
show_help
;;
*)
print_error "Unknown command: $command"
show_help
exit 1
;;
esac
}
main "$@"

3
.gitmodules vendored
View File

@ -0,0 +1,3 @@
[submodule "examples"]
path = examples
url = git@github.com:gogf/examples.git

View File

@ -6,7 +6,6 @@ tidy:
./.make_tidy.sh
# execute "golangci-lint" to check code style
# go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@latest
.PHONY: lint
lint:
golangci-lint run -c .golangci.yml
@ -76,13 +75,3 @@ subsync: subup
git push origin; \
fi; \
cd ..;
# manage docker services for local development
# usage: make docker or make docker cmd=start svc=mysql
.PHONY: docker
docker:
@if [ -z "$(cmd)" ]; then \
./.github/workflows/scripts/docker-services.sh; \
else \
./.github/workflows/scripts/docker-services.sh $(cmd) $(svc) $(extra); \
fi

View File

@ -24,12 +24,6 @@ English | [简体中文](README.zh_CN.MD)
A powerful framework for faster, easier, and more efficient project development.
## Installation
```bash
go get -u github.com/gogf/gf/v2
```
## Documentation
- Official Site: [https://goframe.org](https://goframe.org)
@ -38,14 +32,13 @@ go get -u github.com/gogf/gf/v2
- Mirror Site: [Github Pages](https://pages.goframe.org)
- Mirror Site: [Offline Docs](https://github.com/gogf/goframe.org-pdf?tab=readme-ov-file#%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC)
- GoDoc API: [https://pkg.go.dev/github.com/gogf/gf/v2](https://pkg.go.dev/github.com/gogf/gf/v2)
- Doc Source: [https://github.com/gogf/gf-site](https://github.com/gogf/gf-site)
## Contributors
💖 [Thanks to all the contributors who made GoFrame possible](https://github.com/gogf/gf/graphs/contributors) 💖
<a href="https://github.com/gogf/gf/graphs/contributors">
<img src="https://goframe.org/img/contributors.svg?version=v2.9.8" alt="goframe contributors"/>
<img src="https://goframe.org/img/contributors.svg?version=v2.9.6" alt="goframe contributors"/>
</a>
## License

View File

@ -24,12 +24,6 @@
一个强大的框架,为了更快、更轻松、更高效的项目开发。
## 安装
```bash
go get -u github.com/gogf/gf/v2
```
## 文档
- 官方网站: [https://goframe.org](https://goframe.org)
@ -37,8 +31,7 @@ go get -u github.com/gogf/gf/v2
- 国内镜像: [https://goframe.org.cn](https://goframe.org.cn)
- 镜像网站: [Github Pages](https://pages.goframe.org)
- 镜像网站: [离线文档](https://github.com/gogf/goframe.org-pdf?tab=readme-ov-file#%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC)
- Go包文档: [https://pkg.go.dev/github.com/gogf/gf/v2](https://pkg.go.dev/github.com/gogf/gf/v2)
- 文档源码: [https://github.com/gogf/gf-site](https://github.com/gogf/gf-site)
- GoDoc API: [https://pkg.go.dev/github.com/gogf/gf/v2](https://pkg.go.dev/github.com/gogf/gf/v2)
## 贡献者

View File

@ -3,13 +3,13 @@ module github.com/gogf/gf/cmd/gf/v2
go 1.23.0
require (
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.9.8
github.com/gogf/gf/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.9.6
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.9.6
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.9.6
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.9.6
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.9.6
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.9.6
github.com/gogf/gf/v2 v2.9.6
github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f
github.com/olekukonko/tablewriter v1.1.0
github.com/schollz/progressbar/v3 v3.15.0

View File

@ -46,20 +46,20 @@ github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiU
github.com/go-sql-driver/mysql v1.4.0/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w=
github.com/go-sql-driver/mysql v1.7.1 h1:lUIinVbN1DY0xBg0eMOzmmtGoHwWBbvnWubQUrtU8EI=
github.com/go-sql-driver/mysql v1.7.1/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.9.8 h1:L72OB2HPuZSHtJ2ipBzI+62rGGDRdwYjequ1v+zctpg=
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.9.8/go.mod h1:D0UySg70Bd264F5AScYmz1Hl8vjzlUJ7YvqBJc5OFbo=
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.9.8 h1:DT5zHfo9/VkbJ+TF7kUasvv4dbU5uctoj+JGbrzgdYE=
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.9.8/go.mod h1:cDd91Zd8LxFF+xxOflRRqw0WTTCpAJ0nf0KKRA+nvTE=
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.9.8 h1:XZ4Ya/50xpjf81+4genr33iJXR2dxJmqYKxGyXlLRqA=
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.9.8/go.mod h1:wtm2NJb/L3CbDOmyUc7TsOpWHTCMakg1QRG7B/oKrRs=
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.9.8 h1:ZrqABJsUnhNDz8VAem1XXONBTywl6r+GHQH05i+4W1g=
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.9.8/go.mod h1:YTFyeVk2Rgu/JMUhFxkjYzWaBc+yZ6wAvY54XVZoNko=
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.9.8 h1:Dc227FD1uf9nNBPFEjMEgIoAJbAgeYeNrOrjviDgPzY=
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.9.8/go.mod h1:o3EpB4Ti3+x/axzRMJg2k7TrLiWZiSTxP0v64LBkk5k=
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.9.8 h1:LHEhzsBfIo8xHvOUuLDQW1q7Qix1vnBabH/iivCRghs=
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.9.8/go.mod h1:SX6dRONaJGafzCoMIrn8CkRM4fIvtmJRt/aYclUHy3Q=
github.com/gogf/gf/v2 v2.9.8 h1:El0HwksTzeRk0DQV4Lh7S9DbsIwKInhHSHGcH7qJumM=
github.com/gogf/gf/v2 v2.9.8/go.mod h1:Svl1N+E8G/QshU2DUbh/3J/AJauqCgUnxHurXWR4Qx0=
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.9.6 h1:rJzRmA5TGWMeKDebdDosYODoUrMUHqfA5pWO1MBC5b0=
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.9.6/go.mod h1:u+bUsuftf8qpKpPZPdOFhzh3F5KQzo6Wqa9JFTCLFqg=
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.9.6 h1:3QTlIbSdrVYvRMNUF6nckspA6Eh5Uy2NqwB3/auxIwk=
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.9.6/go.mod h1:oMteYgkWImPpUVe1aqPKtZ8jX1dG3v60lS7IA87MwFQ=
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.9.6 h1:BY1ThxMo0bTx2P18PuCe57ARmjHuEithSdob/CbH/rw=
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.9.6/go.mod h1:v/jKO9JJdLctlPlnUSnnG0SNSEpElM51Qx3KoI5crkU=
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.9.6 h1:12+sWI/hm1D4KxG+1FMZpfoU3PwtSLJ9KbLNa20roLg=
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.9.6/go.mod h1:gjjhgxqjafnORK0F4Fa5W8TJlassw7svKy7RFj5GKss=
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.9.6 h1:LG/bTOJEpyNu6+IdREqFyi6J8LdZIeceeyxhuyV58LQ=
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.9.6/go.mod h1:Ekd5IgUGyBlbfqKD/69hkIL9vHF6F4V2FeEP3h/pH08=
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.9.6 h1:3QZvWIlz3dLjNELQU+5ZZZWuzEx9gsRFLU+qIKVUG6M=
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.9.6/go.mod h1:7EEAe8UYI5dLeuwCWN3HgC62OhjIYbkynaoavw1U/k4=
github.com/gogf/gf/v2 v2.9.6 h1:fQ6uPtS1Ra8qY+OuzPPZTlgksJ4eOXmTZ1/a2l3Idog=
github.com/gogf/gf/v2 v2.9.6/go.mod h1:Svl1N+E8G/QshU2DUbh/3J/AJauqCgUnxHurXWR4Qx0=
github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f h1:7xfXR/BhG3JDqO1s45n65Oyx9t4E/UqDOXep6jXdLCM=
github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f/go.mod h1:HnYoio6S7VaFJdryKcD/r9HgX+4QzYfr00XiXUo/xz0=
github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=

View File

@ -14,9 +14,5 @@ replace (
github.com/gogf/gf/contrib/drivers/oracle/v2 => ../../contrib/drivers/oracle
github.com/gogf/gf/contrib/drivers/pgsql/v2 => ../../contrib/drivers/pgsql
github.com/gogf/gf/contrib/drivers/sqlite/v2 => ../../contrib/drivers/sqlite
github.com/gogf/gf/contrib/drivers/mariadb/v2 => ../../contrib/drivers/mariadb
github.com/gogf/gf/contrib/drivers/tidb/v2 => ../../contrib/drivers/tidb
github.com/gogf/gf/contrib/drivers/oceanbase/v2 => ../../contrib/drivers/oceanbase
github.com/gogf/gf/contrib/drivers/gaussdb/v2 => ../../contrib/drivers/gaussdb
github.com/gogf/gf/v2 => ../../
)

View File

@ -23,7 +23,6 @@ type cGen struct {
cGenPb
cGenPbEntity
cGenService
cGenTpl
}
const (

View File

@ -1,13 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package cmd
import "github.com/gogf/gf/cmd/gf/v2/internal/cmd/gen/tpl"
type (
cGenTpl = tpl.CGenTpl
)

View File

@ -7,11 +7,9 @@
package cmd
import (
"bufio"
"context"
"fmt"
"os"
"strconv"
"strings"
"github.com/gogf/gf/v2/frame/g"
@ -22,7 +20,6 @@ import (
"github.com/gogf/gf/v2/text/gstr"
"github.com/gogf/gf/v2/util/gtag"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/geninit"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/allyes"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/utils"
@ -47,13 +44,6 @@ const (
gf init my-project
gf init my-mono-repo -m
gf init my-mono-repo -a
gf init my-project -u
gf init my-project -g "github.com/myorg/myproject"
gf init -r github.com/gogf/template-single my-project
gf init -r github.com/gogf/examples/httpserver/jwt my-jwt
gf init -r github.com/gogf/gf/cmd/gf/v2@v2.9.7 mygf
gf init -r github.com/gogf/gf/cmd/gf/v2 mygf -s
gf init -i
`
cInitNameBrief = `
name for the project. It will create a folder with NAME in current directory.
@ -65,16 +55,6 @@ The NAME will also be the module name for the project.
cInitGitignore = ".gitignore"
)
// defaultTemplates is the list of predefined templates for interactive selection
var defaultTemplates = []struct {
Name string
Repo string
Desc string
}{
{"template-single", "github.com/gogf/template-single", "Single project template"},
{"template-mono", "github.com/gogf/template-mono", "Mono-repo project template"},
}
func init() {
gtag.Sets(g.MapStrStr{
`cInitBrief`: cInitBrief,
@ -84,86 +64,17 @@ func init() {
}
type cInitInput struct {
g.Meta `name:"init"`
Name string `name:"NAME" arg:"true" brief:"{cInitNameBrief}"`
Mono bool `name:"mono" short:"m" brief:"initialize a mono-repo instead a single-repo" orphan:"true"`
MonoApp bool `name:"monoApp" short:"a" brief:"initialize a mono-repo-app instead a single-repo" orphan:"true"`
Update bool `name:"update" short:"u" brief:"update to the latest goframe version" orphan:"true"`
Module string `name:"module" short:"g" brief:"custom go module"`
Repo string `name:"repo" short:"r" brief:"remote repository URL for template download"`
SelectVer bool `name:"select" short:"s" brief:"enable interactive version selection for remote template" orphan:"true"`
Interactive bool `name:"interactive" short:"i" brief:"enable interactive mode to select template" orphan:"true"`
g.Meta `name:"init"`
Name string `name:"NAME" arg:"true" v:"required" brief:"{cInitNameBrief}"`
Mono bool `name:"mono" short:"m" brief:"initialize a mono-repo instead a single-repo" orphan:"true"`
MonoApp bool `name:"monoApp" short:"a" brief:"initialize a mono-repo-app instead a single-repo" orphan:"true"`
Update bool `name:"update" short:"u" brief:"update to the latest goframe version" orphan:"true"`
Module string `name:"module" short:"g" brief:"custom go module"`
}
type cInitOutput struct{}
func (c cInit) Index(ctx context.Context, in cInitInput) (out *cInitOutput, err error) {
// Check if using remote template mode
if in.Repo != "" || in.Interactive {
return c.initFromRemote(ctx, in)
}
// If no name provided and no remote mode, enter interactive mode
if in.Name == "" {
return c.initInteractive(ctx, in)
}
// Default: use built-in template
return c.initFromBuiltin(ctx, in)
}
// initFromRemote initializes project from remote repository
func (c cInit) initFromRemote(ctx context.Context, in cInitInput) (out *cInitOutput, err error) {
repo := in.Repo
name := in.Name
// If interactive mode and no repo specified, let user select
if in.Interactive && repo == "" {
var modPath string
var upgradeDeps bool
repo, name, modPath, upgradeDeps, err = interactiveSelectTemplate()
if err != nil {
return nil, err
}
if modPath != "" {
in.Module = modPath
}
if upgradeDeps {
in.Update = true
}
}
if repo == "" {
return nil, fmt.Errorf("repository URL is required for remote template mode")
}
// Default name to repo basename if empty
if name == "" {
name = gfile.Basename(repo)
mlog.Printf("Using repository basename as project name: %s", name)
}
mlog.Print("initializing from remote template...")
opts := &geninit.ProcessOptions{
SelectVersion: in.SelectVer,
ModulePath: in.Module,
UpgradeDeps: in.Update,
}
if err = geninit.Process(ctx, repo, name, opts); err != nil {
return nil, err
}
mlog.Print("initialization done!")
if name != "" && name != "." {
mlog.Printf(`you can now run "cd %s && gf run main.go" to start your journey, enjoy!`, name)
}
return
}
// initFromBuiltin initializes project from built-in template
func (c cInit) initFromBuiltin(ctx context.Context, in cInitInput) (out *cInitOutput, err error) {
var overwrote = false
if !gfile.IsEmpty(in.Name) && !allyes.Check() {
s := gcmd.Scanf(`the folder "%s" is not empty, files might be overwrote, continue? [y/n]: `, in.Name)
@ -238,9 +149,6 @@ func (c cInit) initFromBuiltin(ctx context.Context, in cInitInput) (out *cInitOu
return
}
// Format the generated Go files.
utils.GoFmt(in.Name)
// Update the GoFrame version.
if in.Update {
mlog.Print("update goframe...")
@ -272,170 +180,3 @@ func (c cInit) initFromBuiltin(ctx context.Context, in cInitInput) (out *cInitOu
}
return
}
// initInteractive enters interactive mode when no arguments provided
func (c cInit) initInteractive(ctx context.Context, in cInitInput) (out *cInitOutput, err error) {
reader := bufio.NewReader(os.Stdin)
// Ask user which mode to use
fmt.Println("\nPlease select initialization mode:")
fmt.Println(strings.Repeat("-", 50))
fmt.Println(" [1] Built-in template (default)")
fmt.Println(" [2] Remote template")
fmt.Println(strings.Repeat("-", 50))
fmt.Print("Select mode [1-2] (default: 1): ")
input, err := reader.ReadString('\n')
if err != nil {
mlog.Fatalf("failed to read input: %v", err)
return
}
input = strings.TrimSpace(input)
if input == "2" {
in.Interactive = true
return c.initFromRemote(ctx, in)
}
// Built-in template mode
fmt.Println("\nPlease select project type:")
fmt.Println(strings.Repeat("-", 50))
fmt.Println(" [1] Single project (default)")
fmt.Println(" [2] Mono-repo project")
fmt.Println(" [3] Mono-repo app")
fmt.Println(strings.Repeat("-", 50))
fmt.Print("Select type [1-3] (default: 1): ")
input, err = reader.ReadString('\n')
if err != nil {
mlog.Fatalf("failed to read input: %v", err)
return
}
input = strings.TrimSpace(input)
switch input {
case "2":
in.Mono = true
case "3":
in.MonoApp = true
}
// Get project name
for {
fmt.Print("Enter project name: ")
input, err = reader.ReadString('\n')
if err != nil {
mlog.Fatalf("failed to read input: %v", err)
return
}
in.Name = strings.TrimSpace(input)
if in.Name != "" {
break
}
fmt.Println("Project name cannot be empty")
}
// Get module path (optional)
fmt.Printf("Enter Go module path (leave empty to use \"%s\"): ", in.Name)
input, err = reader.ReadString('\n')
if err != nil {
mlog.Fatalf("failed to read input: %v", err)
return
}
in.Module = strings.TrimSpace(input)
// Ask about update
fmt.Print("Update to latest GoFrame version? [y/N]: ")
input, err = reader.ReadString('\n')
if err != nil {
mlog.Fatalf("failed to read input: %v", err)
return
}
input = strings.TrimSpace(strings.ToLower(input))
in.Update = input == "y" || input == "yes"
fmt.Println()
return c.initFromBuiltin(ctx, in)
}
// interactiveSelectTemplate prompts user to select a template interactively
func interactiveSelectTemplate() (repo, name, modPath string, upgradeDeps bool, err error) {
reader := bufio.NewReader(os.Stdin)
// 1. Select template
fmt.Println("\nPlease select a project template:")
fmt.Println(strings.Repeat("-", 50))
for i, t := range defaultTemplates {
fmt.Printf(" [%d] %s - %s\n", i+1, t.Name, t.Desc)
}
fmt.Printf(" [%d] Custom repository URL\n", len(defaultTemplates)+1)
fmt.Println(strings.Repeat("-", 50))
for {
fmt.Printf("Select template [1-%d]: ", len(defaultTemplates)+1)
input, err := reader.ReadString('\n')
if err != nil {
return "", "", "", false, fmt.Errorf("failed to read template selection: %w", err)
}
input = strings.TrimSpace(input)
idx, e := strconv.Atoi(input)
if e != nil || idx < 1 || idx > len(defaultTemplates)+1 {
fmt.Printf("Invalid selection, please enter a number between 1-%d\n", len(defaultTemplates)+1)
continue
}
if idx <= len(defaultTemplates) {
repo = defaultTemplates[idx-1].Repo
fmt.Printf("Selected: %s\n\n", repo)
} else {
// Custom URL
fmt.Print("Enter repository URL: ")
input, err = reader.ReadString('\n')
if err != nil {
return "", "", "", false, fmt.Errorf("failed to read repository URL: %w", err)
}
repo = strings.TrimSpace(input)
if repo == "" {
fmt.Println("Repository URL cannot be empty")
continue
}
}
break
}
// 2. Enter project name
for {
fmt.Print("Enter project name: ")
input, err := reader.ReadString('\n')
if err != nil {
return "", "", "", false, fmt.Errorf("failed to read project name: %w", err)
}
name = strings.TrimSpace(input)
if name == "" {
fmt.Println("Project name cannot be empty")
continue
}
break
}
// 3. Enter module path (optional)
fmt.Printf("Enter Go module path (leave empty to use \"%s\"): ", name)
input, err := reader.ReadString('\n')
if err != nil {
return "", "", "", false, fmt.Errorf("failed to read module path: %w", err)
}
modPath = strings.TrimSpace(input)
// 4. Ask about upgrade
fmt.Print("Upgrade dependencies to latest (go get -u)? [y/N]: ")
input, err = reader.ReadString('\n')
if err != nil {
return "", "", "", false, fmt.Errorf("failed to read upgrade confirmation: %w", err)
}
input = strings.TrimSpace(strings.ToLower(input))
upgradeDeps = input == "y" || input == "yes"
fmt.Println()
return repo, name, modPath, upgradeDeps, nil
}

View File

@ -33,18 +33,12 @@ type cRun struct {
g.Meta `name:"run" usage:"{cRunUsage}" brief:"{cRunBrief}" eg:"{cRunEg}" dc:"{cRunDc}"`
}
type watchPath struct {
Path string
Recursive bool
}
type cRunApp struct {
File string // Go run file name.
Path string // Directory storing built binary.
Options string // Extra "go run" options.
Args string // Custom arguments.
WatchPaths []string // Watch paths for live reload.
IgnorePatterns []string // Custom ignore patterns.
File string // Go run file name.
Path string // Directory storing built binary.
Options string // Extra "go run" options.
Args string // Custom arguments.
WatchPaths []string // Watch paths for live reload.
}
const (
@ -54,47 +48,43 @@ const (
gf run main.go
gf run main.go --args "server -p 8080"
gf run main.go -mod=vendor
gf run main.go -w internal,api
gf run main.go -i ".git,node_modules"
gf run main.go -w "manifest/config/*.yaml"
`
cRunDc = `
The "run" command is used for running go codes with hot-compiled-like feature,
which compiles and runs the go codes asynchronously when codes change.
`
cRunFileBrief = `building file path.`
cRunPathBrief = `output directory path for built binary file. it's "./" in default`
cRunExtraBrief = `the same options as "go run"/"go build" except some options as follows defined`
cRunArgsBrief = `custom arguments for your process`
cRunWatchPathsBrief = `watch additional paths for live reload, separated by ",". i.e. "internal,api"`
cRunIgnorePatternBrief = `custom ignore patterns for watch, separated by ",". i.e. ".git,node_modules". default patterns: node_modules, vendor, .*, _*. Glob syntax: "*" matches any chars, "?" matches single char, "[abc]" matches char class. Note: patterns match directory names only, not paths`
cRunFileBrief = `building file path.`
cRunPathBrief = `output directory path for built binary file. it's "./" in default`
cRunExtraBrief = `the same options as "go run"/"go build" except some options as follows defined`
cRunArgsBrief = `custom arguments for your process`
cRunWatchPathsBrief = `watch additional paths for live reload, separated by ",". i.e. "manifest/config/*.yaml"`
)
var process *gproc.Process
func init() {
gtag.Sets(g.MapStrStr{
`cRunUsage`: cRunUsage,
`cRunBrief`: cRunBrief,
`cRunEg`: cRunEg,
`cRunDc`: cRunDc,
`cRunFileBrief`: cRunFileBrief,
`cRunPathBrief`: cRunPathBrief,
`cRunExtraBrief`: cRunExtraBrief,
`cRunArgsBrief`: cRunArgsBrief,
`cRunWatchPathsBrief`: cRunWatchPathsBrief,
`cRunIgnorePatternBrief`: cRunIgnorePatternBrief,
`cRunUsage`: cRunUsage,
`cRunBrief`: cRunBrief,
`cRunEg`: cRunEg,
`cRunDc`: cRunDc,
`cRunFileBrief`: cRunFileBrief,
`cRunPathBrief`: cRunPathBrief,
`cRunExtraBrief`: cRunExtraBrief,
`cRunArgsBrief`: cRunArgsBrief,
`cRunWatchPathsBrief`: cRunWatchPathsBrief,
})
}
type (
cRunInput struct {
g.Meta `name:"run" config:"gfcli.run"`
File string `name:"FILE" arg:"true" brief:"{cRunFileBrief}" v:"required"`
Path string `name:"path" short:"p" brief:"{cRunPathBrief}" d:"./"`
Extra string `name:"extra" short:"e" brief:"{cRunExtraBrief}"`
Args string `name:"args" short:"a" brief:"{cRunArgsBrief}"`
WatchPaths []string `name:"watchPaths" short:"w" brief:"{cRunWatchPathsBrief}"`
IgnorePatterns []string `name:"ignorePatterns" short:"i" brief:"{cRunIgnorePatternBrief}"`
g.Meta `name:"run" config:"gfcli.run"`
File string `name:"FILE" arg:"true" brief:"{cRunFileBrief}" v:"required"`
Path string `name:"path" short:"p" brief:"{cRunPathBrief}" d:"./"`
Extra string `name:"extra" short:"e" brief:"{cRunExtraBrief}"`
Args string `name:"args" short:"a" brief:"{cRunArgsBrief}"`
WatchPaths []string `name:"watchPaths" short:"w" brief:"{cRunWatchPathsBrief}"`
}
cRunOutput struct{}
)
@ -111,25 +101,17 @@ func (c cRun) Index(ctx context.Context, in cRunInput) (out *cRunOutput, err err
mlog.Fatalf(`command "go" not found in your environment, please install golang first to proceed this command`)
}
// Parse comma-separated values in WatchPaths
if len(in.WatchPaths) > 0 {
in.WatchPaths = parseCommaSeparatedArgs(in.WatchPaths)
if len(in.WatchPaths) == 1 {
in.WatchPaths = strings.Split(in.WatchPaths[0], ",")
mlog.Printf("watchPaths: %v", in.WatchPaths)
}
// Parse comma-separated values in IgnorePatterns
if len(in.IgnorePatterns) > 0 {
in.IgnorePatterns = parseCommaSeparatedArgs(in.IgnorePatterns)
mlog.Printf("ignorePatterns: %v", in.IgnorePatterns)
}
app := &cRunApp{
File: in.File,
Path: filepath.FromSlash(in.Path),
Options: in.Extra,
Args: in.Args,
WatchPaths: in.WatchPaths,
IgnorePatterns: in.IgnorePatterns,
File: in.File,
Path: filepath.FromSlash(in.Path),
Options: in.Extra,
Args: in.Args,
WatchPaths: in.WatchPaths,
}
dirty := gtype.NewBool()
@ -139,7 +121,6 @@ func (c cRun) Index(ctx context.Context, in cRunInput) (out *cRunOutput, err err
return
}
// Check if the file extension is 'go'.
if gfile.ExtName(event.Path) != "go" {
return
}
@ -157,11 +138,15 @@ func (c cRun) Index(ctx context.Context, in cRunInput) (out *cRunOutput, err err
})
}
// Get directories to watch (recursive or non-recursive monitoring).
watchPaths := app.getWatchPaths()
for _, wp := range watchPaths {
option := gfsnotify.WatchOption{NoRecursive: !wp.Recursive}
_, err = gfsnotify.Add(wp.Path, callbackFunc, option)
if len(app.WatchPaths) > 0 {
for _, path := range app.WatchPaths {
_, err = gfsnotify.Add(gfile.RealPath(path), callbackFunc)
if err != nil {
mlog.Fatal(err)
}
}
} else {
_, err = gfsnotify.Add(gfile.RealPath("."), callbackFunc)
if err != nil {
mlog.Fatal(err)
}
@ -264,181 +249,35 @@ func (app *cRunApp) End(ctx context.Context, sig os.Signal, outputPath string) {
}
func (app *cRunApp) genOutputPath() (outputPath string) {
var renamePath string
outputPath = gfile.Join(app.Path, gfile.Name(app.File))
if runtime.GOOS == "windows" {
outputPath += ".exe"
if gfile.Exists(outputPath) {
renamePath := outputPath + "~"
renamePath = outputPath + "~"
if err := gfile.Rename(outputPath, renamePath); err != nil {
mlog.Print(err)
}
// Clean up the renamed old binary file
defer func() {
if gfile.Exists(renamePath) {
_ = gfile.Remove(renamePath)
}
}()
}
}
return filepath.FromSlash(outputPath)
}
// getWatchPaths uses DFS to find the minimal set of directories to watch.
// Rule: if a directory and all its descendants have no ignored subdirectories, watch it;
// otherwise, recurse into valid children and watch the current directory non-recursively.
func (app *cRunApp) getWatchPaths() []watchPath {
roots := []string{"."}
if len(app.WatchPaths) > 0 {
roots = app.WatchPaths
}
// Use custom ignore patterns if provided, otherwise use default.
ignorePatterns := defaultIgnorePatterns
if len(app.IgnorePatterns) > 0 {
ignorePatterns = app.IgnorePatterns
}
var watchPaths []watchPath
for _, root := range roots {
absRoot := gfile.RealPath(root)
if absRoot == "" {
mlog.Printf("watch path '%s' not found, skipping", root)
func matchWatchPaths(watchPaths []string, eventPath string) bool {
for _, path := range watchPaths {
absPath, err := filepath.Abs(path)
if err != nil {
mlog.Printf("match watchPath '%s' error: %s", path, err.Error())
continue
}
if isIgnoredDirName(absRoot, ignorePatterns) {
matched, err := filepath.Match(absPath, eventPath)
if err != nil {
mlog.Printf("match watchPath '%s' error: %s", path, err.Error())
continue
}
app.collectWatchPaths(absRoot, ignorePatterns, &watchPaths)
}
if len(watchPaths) == 0 {
mlog.Printf("no directories to watch, using current directory")
if absCur := gfile.RealPath("."); absCur != "" {
return []watchPath{{Path: absCur, Recursive: true}}
}
return []watchPath{{Path: ".", Recursive: true}}
}
mlog.Printf("watching %d paths", len(watchPaths))
for _, wp := range watchPaths {
recursiveStr := "recursive"
if !wp.Recursive {
recursiveStr = "non-recursive"
}
mlog.Debugf(" - %s (%s)", wp.Path, recursiveStr)
}
return watchPaths
}
// collectWatchPaths performs a DFS traversal to collect the minimal set of directories to watch.
// Returns true if the directory or any of its descendants contains ignored directories.
// Rule: if a directory has no ignored descendants at any depth, watch it recursively;
// otherwise, watch it non-recursively and recurse into valid children.
func (app *cRunApp) collectWatchPaths(dir string, ignorePatterns []string, watchPaths *[]watchPath) bool {
entries, err := gfile.ScanDir(dir, "*", false)
if err != nil {
mlog.Printf("scan directory '%s' error: %s", dir, err.Error())
// If we can't scan the directory, add it to watch list as fallback
*watchPaths = append(*watchPaths, watchPath{Path: dir, Recursive: true})
return false
}
// First pass: identify valid subdirectories and check for directly ignored children
var validSubDirs []string
hasIgnoredChild := false
for _, entry := range entries {
if !gfile.IsDir(entry) {
continue
}
if isIgnoredDirName(entry, ignorePatterns) {
hasIgnoredChild = true
} else {
validSubDirs = append(validSubDirs, entry)
}
}
// If already has ignored child, we know this dir needs non-recursive watch
if hasIgnoredChild {
*watchPaths = append(*watchPaths, watchPath{Path: dir, Recursive: false})
for _, subDir := range validSubDirs {
app.collectWatchPaths(subDir, ignorePatterns, watchPaths)
}
return true
}
// No ignored children, but need to check descendants recursively
// Collect results from all subdirectories first
subResults := make([]bool, len(validSubDirs))
subWatchPaths := make([][]watchPath, len(validSubDirs))
hasIgnoredDescendant := false
for i, subDir := range validSubDirs {
var subPaths []watchPath
subResults[i] = app.collectWatchPaths(subDir, ignorePatterns, &subPaths)
subWatchPaths[i] = subPaths
if subResults[i] {
hasIgnoredDescendant = true
}
}
if !hasIgnoredDescendant {
// No ignored descendants at any depth, watch this directory recursively
*watchPaths = append(*watchPaths, watchPath{Path: dir, Recursive: true})
return false
}
// Has ignored descendants, watch current directory non-recursively
// and add all collected subdirectory watch paths
*watchPaths = append(*watchPaths, watchPath{Path: dir, Recursive: false})
for _, subPaths := range subWatchPaths {
*watchPaths = append(*watchPaths, subPaths...)
}
return true
}
// defaultIgnorePatterns contains glob patterns for directory names that should be ignored when watching.
// These directories typically contain third-party code or non-source files.
// Supported glob syntax (filepath.Match):
// - "*" matches any sequence of non-separator characters
// - "?" matches any single non-separator character
// - "[abc]" matches any character in the bracket
// - "[a-z]" matches any character in the range
// - "[^abc]" or "[!abc]" matches any character not in the bracket
//
// Note: patterns match directory base names only, not full paths (no "/" or path separators allowed).
var defaultIgnorePatterns = []string{
"node_modules",
"vendor",
".*", // All hidden directories (covers .git, .svn, .hg, .idea, .vscode, etc.)
"_*", // Directories starting with underscore
}
// isIgnoredDirName checks if a directory name matches any ignored pattern.
// It accepts either a full path or just the directory name, but only matches against the base name.
// Note: patterns should not contain "/" as they only match directory names, not paths.
func isIgnoredDirName(name string, ignorePatterns []string) bool {
baseName := gfile.Basename(name)
for _, pattern := range ignorePatterns {
if matched, _ := filepath.Match(pattern, baseName); matched {
if matched {
return true
}
}
return false
}
// parseCommaSeparatedArgs parses command line arguments that may contain comma-separated values.
// It handles both single argument with commas (e.g., "a,b,c") and multiple arguments.
func parseCommaSeparatedArgs(args []string) []string {
var result []string
for _, arg := range args {
parts := strings.Split(arg, ",")
for _, part := range parts {
trimmed := strings.TrimSpace(part)
if trimmed != "" {
result = append(result, trimmed)
}
}
}
return result
}

View File

@ -22,7 +22,7 @@ func Test_Gen_Ctrl_Default(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
var (
path = gfile.Temp(guid.S())
apiFolder = gtest.DataPath("genctrl", "default", "api")
apiFolder = gtest.DataPath("genctrl", "api")
in = genctrl.CGenCtrlInput{
SrcFolder: apiFolder,
DstFolder: path,
@ -39,7 +39,7 @@ func Test_Gen_Ctrl_Default(t *testing.T) {
err = gfile.Mkdir(path)
t.AssertNil(err)
defer gfile.RemoveAll(path)
defer gfile.Remove(path)
_, err = genctrl.CGenCtrl{}.Ctrl(ctx, in)
t.AssertNil(err)
@ -49,7 +49,7 @@ func Test_Gen_Ctrl_Default(t *testing.T) {
genApi = apiFolder + filepath.FromSlash("/article/article.go")
genApiExpect = apiFolder + filepath.FromSlash("/article/article_expect.go")
)
defer gfile.RemoveAll(genApi)
defer gfile.Remove(genApi)
t.Assert(gfile.GetContents(genApi), gfile.GetContents(genApiExpect))
// files
@ -67,7 +67,7 @@ func Test_Gen_Ctrl_Default(t *testing.T) {
})
// content
testPath := gtest.DataPath("genctrl", "default", "controller")
testPath := gtest.DataPath("genctrl", "controller")
expectFiles := []string{
testPath + filepath.FromSlash("/article/article.go"),
testPath + filepath.FromSlash("/article/article_new.go"),
@ -84,104 +84,6 @@ func Test_Gen_Ctrl_Default(t *testing.T) {
})
}
func Test_Gen_Ctrl_Default_Multi(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
var (
path = gfile.Temp(guid.S())
apiFolder = gtest.DataPath("genctrl", "multi", "api")
in = genctrl.CGenCtrlInput{
SrcFolder: apiFolder,
DstFolder: path,
WatchFile: "",
SdkPath: "",
SdkStdVersion: false,
SdkNoV1: false,
Clear: false,
Merge: false,
}
)
err := gutil.FillStructWithDefault(&in)
t.AssertNil(err)
err = gfile.Mkdir(path)
t.AssertNil(err)
defer gfile.RemoveAll(path)
_, err = genctrl.CGenCtrl{}.Ctrl(ctx, in)
t.AssertNil(err)
// apiInterface file
var (
genApiSlice = []string{
apiFolder + filepath.FromSlash("/admin/article/article.go"),
apiFolder + filepath.FromSlash("/admin/user/user.go"),
apiFolder + filepath.FromSlash("/app/user/user.go"),
apiFolder + filepath.FromSlash("/app/user/user_ext/user_ext.go"),
}
genApiSliceExpect = []string{
apiFolder + filepath.FromSlash("/admin/article/article_expect.go"),
apiFolder + filepath.FromSlash("/admin/user/user_expect.go"),
apiFolder + filepath.FromSlash("/app/user/user_expect.go"),
apiFolder + filepath.FromSlash("/app/user/user_ext/user_ext_expect.go"),
}
)
for i := range genApiSlice {
t.Assert(gfile.GetContents(genApiSlice[i]), gfile.GetContents(genApiSliceExpect[i]))
gfile.RemoveAll(genApiSlice[i])
}
// files
files, err := gfile.ScanDir(path, "*.go", true)
t.AssertNil(err)
t.Assert(files, []string{
path + filepath.FromSlash("/admin/article/article.go"),
path + filepath.FromSlash("/admin/article/article_new.go"),
path + filepath.FromSlash("/admin/article/article_v1_create.go"),
path + filepath.FromSlash("/admin/user/user.go"),
path + filepath.FromSlash("/admin/user/user_new.go"),
path + filepath.FromSlash("/admin/user/user_v1_create.go"),
path + filepath.FromSlash("/app/user/user.go"),
path + filepath.FromSlash("/app/user/user_ext/user_ext.go"),
path + filepath.FromSlash("/app/user/user_ext/user_ext_new.go"),
path + filepath.FromSlash("/app/user/user_ext/user_ext_v1_create.go"),
path + filepath.FromSlash("/app/user/user_ext/user_ext_v1_update.go"),
path + filepath.FromSlash("/app/user/user_new.go"),
path + filepath.FromSlash("/app/user/user_v1_create.go"),
path + filepath.FromSlash("/app/user/user_v1_update.go"),
})
// content
testPath := gtest.DataPath("genctrl", "multi", "controller")
expectFiles := []string{
testPath + filepath.FromSlash("/admin/article/article.go"),
testPath + filepath.FromSlash("/admin/article/article_new.go"),
testPath + filepath.FromSlash("/admin/article/article_v1_create.go"),
testPath + filepath.FromSlash("/admin/user/user.go"),
testPath + filepath.FromSlash("/admin/user/user_new.go"),
testPath + filepath.FromSlash("/admin/user/user_v1_create.go"),
testPath + filepath.FromSlash("/app/user/user.go"),
testPath + filepath.FromSlash("/app/user/user_ext/user_ext.go"),
testPath + filepath.FromSlash("/app/user/user_ext/user_ext_new.go"),
testPath + filepath.FromSlash("/app/user/user_ext/user_ext_v1_create.go"),
testPath + filepath.FromSlash("/app/user/user_ext/user_ext_v1_update.go"),
testPath + filepath.FromSlash("/app/user/user_new.go"),
testPath + filepath.FromSlash("/app/user/user_v1_create.go"),
testPath + filepath.FromSlash("/app/user/user_v1_update.go"),
}
for i := range files {
t.Assert(gfile.GetContents(files[i]), gfile.GetContents(expectFiles[i]))
}
})
}
func expectFilesContent(t *gtest.T, paths []string, expectPaths []string) {
for i, expectFile := range expectPaths {
val := gfile.GetContents(paths[i])
@ -196,8 +98,8 @@ func Test_Gen_Ctrl_UseMerge_AddNewFile(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
var (
ctrlPath = gfile.Temp(guid.S())
// ctrlPath = gtest.DataPath("issue", "3460", "controller")
apiFolder = gtest.DataPath("genctrl", "merge", "add_new_file", "api")
//ctrlPath = gtest.DataPath("issue", "3460", "controller")
apiFolder = gtest.DataPath("genctrl-merge", "add_new_file", "api")
in = genctrl.CGenCtrlInput{
SrcFolder: apiFolder,
DstFolder: ctrlPath,
@ -216,7 +118,7 @@ type DictTypeAddRes struct {
err := gfile.Mkdir(ctrlPath)
t.AssertNil(err)
defer gfile.RemoveAll(ctrlPath)
defer gfile.Remove(ctrlPath)
_, err = genctrl.CGenCtrl{}.Ctrl(ctx, in)
t.AssertNil(err)
@ -225,7 +127,7 @@ type DictTypeAddRes struct {
genApi = filepath.Join(apiFolder, "/dict/dict.go")
genApiExpect = filepath.Join(apiFolder, "/dict/dict_expect.go")
)
defer gfile.RemoveAll(genApi)
defer gfile.Remove(genApi)
t.Assert(gfile.GetContents(genApi), gfile.GetContents(genApiExpect))
genCtrlFiles, err := gfile.ScanDir(ctrlPath, "*.go", true)
@ -236,7 +138,7 @@ type DictTypeAddRes struct {
filepath.Join(ctrlPath, "/dict/dict_v1_dict_type.go"),
})
expectCtrlPath := gtest.DataPath("genctrl", "merge", "add_new_file", "controller")
expectCtrlPath := gtest.DataPath("genctrl-merge", "add_new_file", "controller")
expectFiles := []string{
filepath.Join(expectCtrlPath, "/dict/dict.go"),
filepath.Join(expectCtrlPath, "/dict/dict_new.go"),
@ -250,7 +152,7 @@ type DictTypeAddRes struct {
newApiFilePath := filepath.Join(apiFolder, "/dict/v1/test_new.go")
err = gfile.PutContents(newApiFilePath, testNewApiFile)
t.AssertNil(err)
defer gfile.RemoveAll(newApiFilePath)
defer gfile.Remove(newApiFilePath)
// Then execute the command
_, err = genctrl.CGenCtrl{}.Ctrl(ctx, in)
@ -277,8 +179,8 @@ func Test_Gen_Ctrl_UseMerge_AddNewCtrl(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
var (
ctrlPath = gfile.Temp(guid.S())
// ctrlPath = gtest.DataPath("issue", "3460", "controller")
apiFolder = gtest.DataPath("genctrl", "merge", "add_new_ctrl", "api")
//ctrlPath = gtest.DataPath("issue", "3460", "controller")
apiFolder = gtest.DataPath("genctrl-merge", "add_new_ctrl", "api")
in = genctrl.CGenCtrlInput{
SrcFolder: apiFolder,
DstFolder: ctrlPath,
@ -288,7 +190,7 @@ func Test_Gen_Ctrl_UseMerge_AddNewCtrl(t *testing.T) {
err := gfile.Mkdir(ctrlPath)
t.AssertNil(err)
defer gfile.RemoveAll(ctrlPath)
defer gfile.Remove(ctrlPath)
_, err = genctrl.CGenCtrl{}.Ctrl(ctx, in)
t.AssertNil(err)
@ -297,7 +199,7 @@ func Test_Gen_Ctrl_UseMerge_AddNewCtrl(t *testing.T) {
genApi = filepath.Join(apiFolder, "/dict/dict.go")
genApiExpect = filepath.Join(apiFolder, "/dict/dict_expect.go")
)
defer gfile.RemoveAll(genApi)
defer gfile.Remove(genApi)
t.Assert(gfile.GetContents(genApi), gfile.GetContents(genApiExpect))
genCtrlFiles, err := gfile.ScanDir(ctrlPath, "*.go", true)
@ -308,7 +210,7 @@ func Test_Gen_Ctrl_UseMerge_AddNewCtrl(t *testing.T) {
filepath.Join(ctrlPath, "/dict/dict_v1_dict_type.go"),
})
expectCtrlPath := gtest.DataPath("genctrl", "merge", "add_new_ctrl", "controller")
expectCtrlPath := gtest.DataPath("genctrl-merge", "add_new_ctrl", "controller")
expectFiles := []string{
filepath.Join(expectCtrlPath, "/dict/dict.go"),
filepath.Join(expectCtrlPath, "/dict/dict_new.go"),
@ -334,7 +236,7 @@ type DictTypeAddRes struct {
err = gfile.PutContentsAppend(dictModuleFileName, testNewApiFile)
t.AssertNil(err)
// ==================================
//==================================
// Then execute the command
_, err = genctrl.CGenCtrl{}.Ctrl(ctx, in)
t.AssertNil(err)
@ -360,7 +262,7 @@ func Test_Gen_Ctrl_UseMerge_Issue3460(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
var (
ctrlPath = gfile.Temp(guid.S())
// ctrlPath = gtest.DataPath("issue", "3460", "controller")
//ctrlPath = gtest.DataPath("issue", "3460", "controller")
apiFolder = gtest.DataPath("issue", "3460", "api")
in = genctrl.CGenCtrlInput{
SrcFolder: apiFolder,
@ -376,7 +278,7 @@ func Test_Gen_Ctrl_UseMerge_Issue3460(t *testing.T) {
err := gfile.Mkdir(ctrlPath)
t.AssertNil(err)
defer gfile.RemoveAll(ctrlPath)
defer gfile.Remove(ctrlPath)
_, err = genctrl.CGenCtrl{}.Ctrl(ctx, in)
t.AssertNil(err)

View File

@ -1,336 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package cmd
import (
"os"
"path/filepath"
"strings"
"testing"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/v2/test/gtest"
)
func Test_cRunApp_getWatchPaths_Basic(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
app := &cRunApp{
WatchPaths: []string{"."},
}
watchPaths := app.getWatchPaths()
t.AssertGT(len(watchPaths), 0)
for _, v := range watchPaths {
t.Log(v)
}
})
}
func Test_cRunApp_getWatchPaths_EmptyWatchPaths(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
app := &cRunApp{
WatchPaths: []string{},
}
watchPaths := app.getWatchPaths()
// Should default to current directory "."
t.AssertGT(len(watchPaths), 0)
})
}
func Test_cRunApp_getWatchPaths_CustomIgnorePattern(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
app := &cRunApp{
WatchPaths: []string{"testdata"},
IgnorePatterns: []string{"2572"},
}
watchPaths := app.getWatchPaths()
// Ensure the "2572" directory is not watched directly.
for _, wp := range watchPaths {
t.Log("watch path:", wp)
t.Assert(strings.HasSuffix(wp.Path, "2572"), false)
}
t.AssertGT(len(watchPaths), 0)
})
}
func Test_cRunApp_getWatchPaths_WithIgnoredDirectories(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
// Create a temporary directory structure for testing
tempDir := gfile.Temp("gf_run_test")
defer gfile.Remove(tempDir)
// Create directory structure:
// tempDir/
// ├── src/
// │ ├── api/
// │ └── internal/
// ├── vendor/ <-- ignored
// └── node_modules/ <-- ignored
gfile.Mkdir(filepath.Join(tempDir, "src", "api"))
gfile.Mkdir(filepath.Join(tempDir, "src", "internal"))
gfile.Mkdir(filepath.Join(tempDir, "vendor"))
gfile.Mkdir(filepath.Join(tempDir, "node_modules"))
app := &cRunApp{
WatchPaths: []string{tempDir},
}
watchPaths := app.getWatchPaths()
// Should watch tempDir non-recursively (to catch top-level files) and src recursively
t.Assert(len(watchPaths), 2)
// First path is tempDir (non-recursive)
t.Assert(watchPaths[0].Path, tempDir)
t.Assert(watchPaths[0].Recursive, false)
// Second path is src (recursive, since it has no ignored descendants)
t.Assert(watchPaths[1].Path, filepath.Join(tempDir, "src"))
t.Assert(watchPaths[1].Recursive, true)
})
}
func Test_cRunApp_getWatchPaths_NoIgnoredDirectories(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
// Create a temporary directory structure without ignored directories
tempDir := gfile.Temp("gf_run_test_no_ignore")
defer gfile.Remove(tempDir)
// Create directory structure without ignored patterns:
// tempDir/
// ├── src/
// │ ├── api/
// │ └── internal/
gfile.Mkdir(filepath.Join(tempDir, "src", "api"))
gfile.Mkdir(filepath.Join(tempDir, "src", "internal"))
app := &cRunApp{
WatchPaths: []string{tempDir},
}
watchPaths := app.getWatchPaths()
// Should watch the root directory recursively since no ignored directories exist
t.Assert(len(watchPaths), 1)
t.Assert(watchPaths[0].Path, tempDir)
t.Assert(watchPaths[0].Recursive, true)
})
}
func Test_cRunApp_getWatchPaths_CustomIgnorePatterns(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
// Create a temporary directory structure
tempDir := gfile.Temp("gf_run_test_custom_ignore")
defer gfile.Remove(tempDir)
// Create directory structure:
// tempDir/
// ├── src/
// │ ├── api/
// │ └── internal/
// ├── build/ <-- ignored
// └── dist/ <-- ignored
gfile.Mkdir(filepath.Join(tempDir, "src", "api"))
gfile.Mkdir(filepath.Join(tempDir, "src", "internal"))
gfile.Mkdir(filepath.Join(tempDir, "build"))
gfile.Mkdir(filepath.Join(tempDir, "dist"))
app := &cRunApp{
WatchPaths: []string{tempDir},
IgnorePatterns: []string{"build", "dist"},
}
watchPaths := app.getWatchPaths()
// Should watch tempDir non-recursively and src recursively
t.Assert(len(watchPaths), 2)
t.Assert(watchPaths[0].Path, tempDir)
t.Assert(watchPaths[0].Recursive, false)
t.Assert(watchPaths[1].Path, filepath.Join(tempDir, "src"))
t.Assert(watchPaths[1].Recursive, true)
})
}
func Test_cRunApp_getWatchPaths_DeepNestedStructure(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
// Create a deep nested directory structure
tempDir := gfile.Temp("gf_run_test_deep")
defer gfile.Remove(tempDir)
// Create deep directory structure:
// tempDir/
// ├── a/
// │ ├── b/
// │ │ └── c/
// │ └── vendor/ <-- ignored
// └── d/
gfile.Mkdir(filepath.Join(tempDir, "a", "b", "c"))
gfile.Mkdir(filepath.Join(tempDir, "a", "vendor"))
gfile.Mkdir(filepath.Join(tempDir, "d"))
app := &cRunApp{
WatchPaths: []string{tempDir},
}
watchPaths := app.getWatchPaths()
// Should watch individual valid directories due to ignored vendor directory
t.AssertGT(len(watchPaths), 0)
// Verify that vendor directory is not in watch list
for _, wp := range watchPaths {
t.Assert(strings.Contains(wp.Path, "vendor"), false)
}
})
}
func Test_cRunApp_getWatchPaths_MultipleRoots(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
// Create multiple temporary directories
tempDir1 := gfile.Temp("gf_run_test_multi1")
tempDir2 := gfile.Temp("gf_run_test_multi2")
defer gfile.Remove(tempDir1)
defer gfile.Remove(tempDir2)
gfile.Mkdir(filepath.Join(tempDir1, "src"))
gfile.Mkdir(filepath.Join(tempDir2, "api"))
app := &cRunApp{
WatchPaths: []string{tempDir1, tempDir2},
}
watchPaths := app.getWatchPaths()
// Should watch both root directories recursively
t.Assert(len(watchPaths), 2)
// Both directories should be in the watch list
foundDir1, foundDir2 := false, false
for _, wp := range watchPaths {
if wp.Path == tempDir1 {
foundDir1 = true
t.Assert(wp.Recursive, true)
}
if wp.Path == tempDir2 {
foundDir2 = true
t.Assert(wp.Recursive, true)
}
}
t.Assert(foundDir1, true)
t.Assert(foundDir2, true)
})
}
func Test_cRunApp_getWatchPaths_NonExistentDirectory(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
app := &cRunApp{
WatchPaths: []string{"/non/existent/path"},
}
watchPaths := app.getWatchPaths()
// Should fall back to current directory when no valid paths found
t.AssertGT(len(watchPaths), 0)
// Should contain current directory
currentDir, _ := os.Getwd()
foundCurrentDir := false
for _, wp := range watchPaths {
if wp.Path == currentDir {
foundCurrentDir = true
break
}
}
t.Assert(foundCurrentDir, true)
})
}
func Test_isIgnoredDirName(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
// Test default ignore patterns
t.Assert(isIgnoredDirName("node_modules", defaultIgnorePatterns), true)
t.Assert(isIgnoredDirName("vendor", defaultIgnorePatterns), true)
t.Assert(isIgnoredDirName(".git", defaultIgnorePatterns), true)
t.Assert(isIgnoredDirName("_private", defaultIgnorePatterns), true)
t.Assert(isIgnoredDirName("src", defaultIgnorePatterns), false)
t.Assert(isIgnoredDirName("api", defaultIgnorePatterns), false)
// Test custom ignore patterns
customPatterns := []string{"build", "dist", "*.tmp"}
t.Assert(isIgnoredDirName("build", customPatterns), true)
t.Assert(isIgnoredDirName("dist", customPatterns), true)
t.Assert(isIgnoredDirName("test.tmp", customPatterns), true)
t.Assert(isIgnoredDirName("src", customPatterns), false)
})
}
func Test_cRunApp_getWatchPaths_DeeplyNestedIgnore(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
// Create a temporary directory structure with deeply nested ignored directory
tempDir := gfile.Temp("gf_run_test_deeply_nested")
defer gfile.Remove(tempDir)
// Create directory structure:
// tempDir/
// ├── a/
// │ ├── b/
// │ │ ├── c/
// │ │ │ └── vendor/ <-- deeply nested ignored (4 levels)
// │ │ └── d/
// │ └── e/
// └── f/
gfile.Mkdir(filepath.Join(tempDir, "a", "b", "c", "vendor"))
gfile.Mkdir(filepath.Join(tempDir, "a", "b", "d"))
gfile.Mkdir(filepath.Join(tempDir, "a", "e"))
gfile.Mkdir(filepath.Join(tempDir, "f"))
app := &cRunApp{
WatchPaths: []string{tempDir},
}
watchPaths := app.getWatchPaths()
// Expected watch paths:
// 1. tempDir (non-recursive) - has ignored descendant
// 2. a (non-recursive) - has ignored descendant in b/c/vendor
// 3. b (non-recursive) - has ignored descendant in c/vendor
// 4. c (non-recursive) - has ignored child vendor
// 5. d (recursive) - no ignored descendants
// 6. e (recursive) - no ignored descendants
// 7. f (recursive) - no ignored descendants
t.AssertGT(len(watchPaths), 0)
// Verify vendor is not in watch paths
for _, wp := range watchPaths {
t.Assert(strings.Contains(wp.Path, "vendor"), false)
}
// Find specific paths and verify their recursive flags
foundF := false
for _, wp := range watchPaths {
if wp.Path == filepath.Join(tempDir, "f") {
foundF = true
t.Assert(wp.Recursive, true) // f should be recursive (no ignored descendants)
}
}
t.Assert(foundF, true)
})
}
func Test_cRunApp_getWatchPaths_EmptyDirectory(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
// Create an empty temporary directory
tempDir := gfile.Temp("gf_run_test_empty")
defer gfile.Remove(tempDir)
gfile.Mkdir(tempDir)
app := &cRunApp{
WatchPaths: []string{tempDir},
}
watchPaths := app.getWatchPaths()
// Empty directory should be watched recursively (no ignored descendants)
t.Assert(len(watchPaths), 1)
t.Assert(watchPaths[0].Path, tempDir)
t.Assert(watchPaths[0].Recursive, true)
})
}

View File

@ -1,308 +0,0 @@
# 标签配置使用指南
## 功能概述
`gf gen tpl` 现在支持灵活的标签配置,可以选择性地为生成的结构体字段添加 `omitempty` 或其他自定义标签。
## 配置选项一览
| 选项 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `jsonOmitempty` | bool | false | 为所有字段添加 omitempty |
| `jsonOmitemptyAuto` | bool | false | 仅为可空字段自动添加 omitempty |
| `withOrmTag` | bool | true | 是否添加 orm 标签 |
| `descriptionTag` | bool | false | 是否添加 description 标签 |
| `noJsonTag` | bool | false | 是否禁用 JSON 标签 |
| `fieldMapping.tags` | map | - | 字段级自定义标签 |
## 配置方式
### 1. 全局开关 - `jsonOmitempty`
为所有字段的 JSON 标签添加 `omitempty`:
```yaml
gfcli:
gen:
tpl:
jsonOmitempty: true
```
**生成结果:**
```go
type User struct {
ID int `json:"id,omitempty" orm:"id" description:"用户ID"`
Name string `json:"name,omitempty" orm:"name" description:"用户名"`
Email string `json:"email,omitempty" orm:"email" description:"邮箱"`
}
```
---
### 2. 智能判断 - `jsonOmitemptyAuto` (推荐)
仅为可空字段自动添加 `omitempty`:
```yaml
gfcli:
gen:
tpl:
jsonOmitemptyAuto: true
```
**假设数据库表结构:**
```sql
CREATE TABLE user (
id INT NOT NULL,
name VARCHAR(50) NOT NULL,
email VARCHAR(100) NULL, -- 可空字段
age INT NULL -- 可空字段
);
```
**生成结果:**
```go
type User struct {
ID int `json:"id" orm:"id" description:"用户ID"`
Name string `json:"name" orm:"name" description:"用户名"`
Email string `json:"email,omitempty" orm:"email" description:"邮箱"` // 自动添加
Age int `json:"age,omitempty" orm:"age" description:"年龄"` // 自动添加
}
```
---
### 3. ORM 标签控制 - `withOrmTag`
控制是否添加 orm 标签 (默认启用):
```yaml
gfcli:
gen:
tpl:
withOrmTag: false # 不生成 orm 标签
```
**生成结果:**
```go
type User struct {
ID int `json:"id" description:"用户ID"` // 没有 orm 标签
Name string `json:"name" description:"用户名"` // 没有 orm 标签
Email string `json:"email" description:"邮箱"` // 没有 orm 标签
}
```
---
### 4. 字段级精确控制 - `fieldMapping`
针对特定字段自定义标签 (优先级最高):
```yaml
gfcli:
gen:
tpl:
fieldMapping:
user.password:
type: string
tags:
json: "-" # 不序列化
user.email:
type: string
tags:
json: "email,omitempty"
validate: "required,email"
binding: "required"
user.status:
type: int
tags:
json: "status,omitempty"
validate: "oneof=0 1 2"
example: "1"
```
**生成结果:**
```go
type User struct {
Password string `json:"-" orm:"password" description:"密码"`
Email string `binding:"required" json:"email,omitempty" validate:"required,email" description:"邮箱"`
Status int `example:"1" json:"status,omitempty" validate:"oneof=0 1 2" description:"状态"`
}
```
---
## 常见标签示例
### validate 标签 (gin validator)
```yaml
fieldMapping:
user.email:
tags:
validate: "required,email"
user.age:
tags:
validate: "gte=0,lte=150"
user.password:
tags:
validate: "required,min=8,max=32"
```
### binding 标签 (gin binding)
```yaml
fieldMapping:
user.name:
tags:
binding: "required"
user.email:
tags:
binding: "required,email"
```
### swagger 文档标签
```yaml
fieldMapping:
user.id:
tags:
example: "1"
description: "用户唯一标识"
user.status:
tags:
example: "1"
enums: "0,1,2"
```
### 多个自定义标签组合
```yaml
fieldMapping:
user.email:
type: string
tags:
json: "email,omitempty"
validate: "required,email"
binding: "required"
example: "user@example.com"
description: "用户邮箱地址"
```
---
## 配置优先级
标签配置的优先级从高到低:
1. **fieldMapping.tags** - 字段级自定义标签 (优先级最高)
2. **jsonOmitempty** - 全局 omitempty 开关
3. **jsonOmitemptyAuto** - 智能判断可空字段
4. **默认行为** - 不添加 omitempty
---
## 完整配置示例
```yaml
gfcli:
gen:
tpl:
link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
path: "./output"
tplPath: "./templates"
jsonCase: "CamelLower"
importPrefix: "github.com/example/project"
# 全局配置
jsonOmitemptyAuto: true # 可空字段自动添加 omitempty
withOrmTag: true # 添加 orm 标签 (默认)
descriptionTag: true # 添加 description 标签
# 类型映射
typeMapping:
decimal:
type: decimal.Decimal
import: github.com/shopspring/decimal
# 字段级配置
fieldMapping:
user.password:
type: string
tags:
json: "-"
user.email:
type: string
tags:
json: "email,omitempty"
validate: "required,email"
binding: "required"
order.total_amount:
type: decimal.Decimal
import: github.com/shopspring/decimal
tags:
json: "totalAmount,omitempty"
validate: "gt=0"
```
---
## 命令行使用
```bash
# 使用配置文件
gf gen tpl
# 命令行参数
gf gen tpl -tp ./templates -p ./output -ja -wo
# -ja: jsonOmitemptyAuto
# -wo: withOrmTag
# 组合使用
gf gen tpl -l "mysql:root:pass@tcp(127.0.0.1:3306)/db" -tp ./tpl -ja -c -wo
```
---
## 模板中使用
如果你需要在自定义模板中使用标签功能:
```go
// entity.tpl
type {{.table.NameCaseCamel}} struct { {{range $i,$v := .table.Fields}}
{{$v.NameCaseCamel}} {{$v.LocalType}} {{$v.BuildTags $.tagInput}} // {{$v.Comment}}{{end}}
}
```
或者分别使用单个标签方法:
```go
type {{.table.NameCaseCamel}} struct { {{range $i,$v := .table.Fields}}
{{$v.NameCaseCamel}} {{$v.LocalType}} `json:"{{$v.JsonTag $.tagInput.JsonOmitempty $.tagInput.JsonOmitemptyAuto}}" orm:"{{$v.OrmTag}}"` // {{$v.Comment}}{{end}}
}
```
---
## 注意事项
1. **字段名格式**: `fieldMapping` 中的 key 格式为 `表名.字段名`,使用数据库中的实际字段名 (非驼峰)
2. **标签顺序**: 自定义标签会按字母顺序排列,确保生成结果一致
3. **特殊字符**: 如果标签值包含双引号,会自动转义
4. **DO 文件**: DO 文件 (model/do) 只保留 description 标签,不包含 JSON/ORM 标签
5. **兼容性**: 与现有的 `typeMapping``fieldMapping` 完全兼容
6. **默认值**: `withOrmTag` 默认为 `true`,如果不需要 orm 标签,需要显式设置为 `false`

View File

@ -1,106 +0,0 @@
# 代码生成器设计文档
## 功能概述
基于数据库表结构通过自定义模板生成Go代码的工具。
## 功能设计
生成流程:
1. 读取数据库表结构
2. 解析出表结构信息,包括表名、表注释、字段列表
3. 根据规则裁切表数据,生成模板数据
4. 根据模板生成代码
## 命令参数设计
```shell
$ gf gen tpl -h
USAGE
gf gen tpl [OPTION]
OPTION
-p, --path directory path for generated files
-l, --link database configuration, the same as the ORM configuration of GoFrame
-t, --tables generate templates only for given tables, multiple table names separated with ','
-x, --tablesEx generate templates excluding given tables, multiple table names separated with ','
-g, --group specifying the configuration group name of database for generated ORM instance,
it's not necessary and the default value is "default"
-f, --prefix add prefix for all table of specified link/database tables
-r, --removePrefix remove specified prefix of the table, multiple prefix separated with ','
-rf, --removeFieldPrefix remove specified prefix of the field, multiple prefix separated with ','
-j, --jsonCase generated json tag case for model struct, cases are as follows:
| Case | Example |
|---------------- |--------------------|
| Camel | AnyKindOfString |
| CamelLower | anyKindOfString | default
| Snake | any_kind_of_string |
| SnakeScreaming | ANY_KIND_OF_STRING |
| SnakeFirstUpper | rgb_code_md5 |
| Kebab | any-kind-of-string |
| KebabScreaming | ANY-KIND-OF-STRING |
-i, --importPrefix custom import prefix for generated go files
-t1, --tplPath template file path for custom template
-s, --stdTime use time.Time from stdlib instead of gtime.Time for generated time/date fields of tables
-w, --withTime add created time for auto produced go files
-n, --gJsonSupport use gJsonSupport to use *gjson.Json instead of string for generated json fields of
tables
-v, --overwrite overwrite all template files
-c, --descriptionTag add comment to description tag for each field
-k, --noJsonTag no json tag will be added for each field
-m, --noModelComment no model comment will be added for each field
-a, --clear delete all generated template files that do not exist in database
-y, --typeMapping custom local type mapping for generated struct attributes relevant to fields of table
-fm, --fieldMapping custom local type mapping for generated struct attributes relevant to specific fields of
table
-h, --help more information about this command
EXAMPLE
gf gen tpl
gf gen tpl -l "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
gf gen tpl -p ./template -g user-center -t user,user_detail,user_login
gf gen tpl -r user_
CONFIGURATION SUPPORT
Options are also supported by configuration file.
It's suggested using configuration file instead of command line arguments making producing.
The configuration node name is "gfcli.gen.tpl", which also supports multiple databases, for example(config.yaml):
gfcli:
gen:
tpl:
- link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
tables: "order,products"
jsonCase: "CamelLower"
- link: "mysql:root:12345678@tcp(127.0.0.1:3306)/primary"
path: "./my-app"
prefix: "primary_"
tables: "user, userDetail"
typeMapping:
decimal:
type: decimal.Decimal
import: github.com/shopspring/decimal
numeric:
type: string
fieldMapping:
table_name.field_name:
type: decimal.Decimal
import: github.com/shopspring/decimal
```
## 表结构信息
### 表信息
1. 表名
2. 表注释
3. 字段列表
### 字段信息
1. 字段名
2. 类型
3. 对应的 go 类型
4. 是否主键
5. 是否唯一键
6. 备注
7. 默认值
8. 是否自增

View File

@ -1,82 +0,0 @@
# gf gen tpl 标签配置示例
gfcli:
gen:
tpl:
# 数据库连接
link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
# 输出路径
path: "./output"
# 模板路径
tplPath: "./testdata"
# JSON 命名规则
jsonCase: "CamelLower"
# 导入路径前缀
importPrefix: "github.com/example/project"
# ===== 标签配置选项 =====
# 方式1: 全局为所有字段添加 omitempty
jsonOmitempty: false
# 方式2: 自动为可空字段添加 omitempty (推荐)
jsonOmitemptyAuto: true
# 是否添加 orm 标签 (默认: true)
withOrmTag: true
# 是否添加 description 标签
descriptionTag: true
# 是否禁用 JSON 标签
noJsonTag: false
# ===== 类型映射 =====
typeMapping:
decimal:
type: decimal.Decimal
import: github.com/shopspring/decimal
numeric:
type: string
# ===== 字段级配置 (最灵活) =====
fieldMapping:
# 表名.字段名 格式
user.password:
type: string
tags:
json: "-" # 不序列化密码字段
user.email:
type: string
tags:
json: "email,omitempty"
validate: "required,email"
binding: "required"
user.age:
type: int
tags:
json: "age"
validate: "gte=0,lte=150"
user.status:
type: int
tags:
json: "status,omitempty"
validate: "oneof=0 1 2"
example: "1"
# 自定义类型示例
order.total_amount:
type: decimal.Decimal
import: github.com/shopspring/decimal
tags:
json: "totalAmount,omitempty"
validate: "gt=0"

View File

@ -1,27 +0,0 @@
// =================================================================================
// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
// =================================================================================
package dao
import (
"{{.table.PackageName}}/internal"
)
// internal{{.table.NameCaseCamel}}Dao is internal type for wrapping internal DAO implements.
type internal{{.table.NameCaseCamel}}Dao = *internal.{{.table.NameCaseCamel}}Dao
// {{.table.NameCaseCamelLower}}Dao is the data access object for table {{.table.Name}}.
// You can define custom methods on it to extend its functionality as you wish.
type {{.table.NameCaseCamelLower}}Dao struct {
internal{{.table.NameCaseCamel}}Dao
}
var (
// {{.table.NameCaseCamel}} is globally public accessible object for table {{.table.Name}} operations.
{{.table.NameCaseCamel}} = {{.table.NameCaseCamelLower}}Dao{
internal.New{{.table.NameCaseCamel}}Dao(),
}
)
// Fill with you ideas below.

View File

@ -1,69 +0,0 @@
package internal
import (
"context"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/frame/g"
)
// {{.table.NameCaseCamel}}Dao is the data access object for table {{.table.Name}}.
type {{.table.NameCaseCamel}}Dao struct {
table string // table is the underlying table name of the DAO.
group string // group is the database configuration group name of current DAO.
columns {{.table.NameCaseCamel}}Columns // columns contains all the column names of Table for convenient usage.
}
// {{.table.NameCaseCamel}}Columns defines and stores column names for table {{.table.Name}}.
type {{.table.NameCaseCamel}}Columns struct { {{range $i,$v := .table.Fields}}
{{$v.NameCaseCamel}} string // {{$v.Comment}}{{end}}
}
// {{.table.NameCaseCamelLower}}Columns holds the columns for table {{.table.Name}}.
var {{.table.NameCaseCamelLower}}Columns = {{.table.NameCaseCamel}}Columns{ {{range $i,$v := .table.Fields}}
{{$v.NameCaseCamel}}: "{{$v.NameJsonCase}}",{{end}}
}
// New{{.table.NameCaseCamel}}Dao creates and returns a new DAO object for table data access.
func New{{.table.NameCaseCamel}}Dao() *{{.table.NameCaseCamel}}Dao {
return &{{.table.NameCaseCamel}}Dao{
group: "test",
table: "{{.table.Name}}",
columns: {{.table.NameCaseCamelLower}}Columns,
}
}
// DB retrieves and returns the underlying raw database management object of current DAO.
func (dao *{{.table.NameCaseCamel}}Dao) DB() gdb.DB {
return g.DB(dao.group)
}
// Table returns the table name of current dao.
func (dao *{{.table.NameCaseCamel}}Dao) Table() string {
return dao.table
}
// Columns returns all column names of current dao.
func (dao *{{.table.NameCaseCamel}}Dao) Columns() {{.table.NameCaseCamel}}Columns {
return dao.columns
}
// Group returns the configuration group name of database of current dao.
func (dao *{{.table.NameCaseCamel}}Dao) Group() string {
return dao.group
}
// Ctx creates and returns the Model for current DAO, It automatically sets the context for current operation.
func (dao *{{.table.NameCaseCamel}}Dao) Ctx(ctx context.Context) *gdb.Model {
return dao.DB().Model(dao.table).Safe().Ctx(ctx)
}
// Transaction wraps the transaction logic using function f.
// It rollbacks the transaction and returns the error from function f if it returns non-nil error.
// It commits the transaction and returns nil if function f returns nil.
//
// Note that, you should not Commit or Rollback the transaction in function f
// as it is automatically handled by this function.
func (dao *{{.table.NameCaseCamel}}Dao) Transaction(ctx context.Context, f func(ctx context.Context, tx gdb.TX) error) (err error) {
return dao.Ctx(ctx).Transaction(ctx, f)
}

View File

@ -1,16 +0,0 @@
// =================================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
// =================================================================================
package do
import (
"github.com/gogf/gf/v2/frame/g"{{if .table.Imports}}{{range $k,$v := .table.Imports}}
"{{$k}}"{{end}}{{end}}
)
// {{.table.NameCaseCamel}} is the golang structure of table {{.table.Name}} for DAO operations like Where/Data.
type {{.table.NameCaseCamel}} struct {
g.Meta `orm:"table:{{.table.Name}}, do:true"`{{range $i,$v := .table.Fields}}
{{$v.NameCaseCamel}} interface{} // {{$v.Comment}}{{end}}
}

View File

@ -1,14 +0,0 @@
// =================================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
// =================================================================================
package entity
{{if .table.Imports}}
import ({{range $k,$v := .table.Imports}}
"{{$k}}"{{end}}
)
{{end}}
// {{.table.NameCaseCamel}} is the golang structure for table {{.table.Name}}.
type {{.table.NameCaseCamel}} struct { {{range $i,$v := .table.Fields}}
{{$v.NameCaseCamel}} {{$v.LocalType}} {{$v.BuildTags $.tagInput}} // {{$v.Comment}}{{end}}
}

View File

@ -1,400 +0,0 @@
package tpl
import (
"context"
"fmt"
"path/filepath"
"strings"
_ "github.com/gogf/gf/contrib/drivers/clickhouse/v2"
_ "github.com/gogf/gf/contrib/drivers/mssql/v2"
_ "github.com/gogf/gf/contrib/drivers/mysql/v2"
_ "github.com/gogf/gf/contrib/drivers/oracle/v2"
_ "github.com/gogf/gf/contrib/drivers/pgsql/v2"
_ "github.com/gogf/gf/contrib/drivers/sqlite/v2"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/v2/os/gtime"
"github.com/gogf/gf/v2/os/gview"
"github.com/gogf/gf/v2/util/gtag"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/utils"
)
const (
CGenTplConfig = `gfcli.gen.tpl`
CGenTplUsage = `gf gen tpl [OPTION]`
CGenTplBrief = `automatically generate template files`
CGenTplEg = `
gf gen tpl
gf gen tpl -l "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
gf gen tpl -p ./model -g user-center -t user,user_detail,user_login
gf gen tpl -r user_
`
CGenTplAd = `
CONFIGURATION SUPPORT
Options are also supported by configuration file.
It's suggested using configuration file instead of command line arguments making producing.
The configuration node name is "gfcli.gen.dao", which also supports multiple databases, for example(config.yaml):
gfcli:
gen:
dao:
- link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
tables: "order,products"
jsonCase: "CamelLower"
- link: "mysql:root:12345678@tcp(127.0.0.1:3306)/primary"
path: "./my-app"
prefix: "primary_"
tables: "user, userDetail"
typeMapping:
decimal:
type: decimal.Decimal
import: github.com/shopspring/decimal
numeric:
type: string
fieldMapping:
table_name.field_name:
type: decimal.Decimal
import: github.com/shopspring/decimal
tags:
json: "field_name,omitempty"
validate: "required"
`
CGenTplBriefPath = `directory path for generated files`
CGenTplBriefLink = `database configuration, the same as the ORM configuration of GoFrame`
CGenTplBriefTables = `generate models only for given tables, multiple table names separated with ','`
CGenTplBriefTablesEx = `generate models excluding given tables, multiple table names separated with ','`
CGenTplBriefPrefix = `add prefix for all table of specified link/database tables`
CGenTplBriefRemovePrefix = `remove specified prefix of the table, multiple prefix separated with ','`
CGenTplBriefRemoveFieldPrefix = `remove specified prefix of the field, multiple prefix separated with ','`
CGenTplBriefStdTime = `use time.Time from stdlib instead of gtime.Time for generated time/date fields of tables`
CGenTplBriefWithTime = `add created time for auto produced go files`
CGenTplBriefGJsonSupport = `use gJsonSupport to use *gjson.Json instead of string for generated json fields of tables`
CGenTplBriefImportPrefix = `custom import prefix for generated go files`
CGenTplBriefDaoPath = `directory path for storing generated dao files under path`
CGenTplBriefDoPath = `directory path for storing generated do files under path`
CGenTplBriefEntityPath = `directory path for storing generated entity files under path`
CGenTplBriefOverwriteDao = `overwrite all dao files both inside/outside internal folder`
CGenTplBriefModelFile = `custom file name for storing generated model content`
CGenTplBriefModelFileForDao = `custom file name generating model for DAO operations like Where/Data. It's empty in default`
CGenTplBriefDescriptionTag = `add comment to description tag for each field`
CGenTplBriefNoJsonTag = `no json tag will be added for each field`
CGenTplBriefNoModelComment = `no model comment will be added for each field`
CGenTplBriefClear = `delete all generated go files that do not exist in database`
CGenTplBriefTypeMapping = `custom local type mapping for generated struct attributes relevant to fields of table`
CGenTplBriefFieldMapping = `custom local type mapping for generated struct attributes relevant to specific fields of table`
CGenTplBriefGroup = `
specifying the configuration group name of database for generated ORM instance,
it's not necessary and the default value is "default"
`
CGenTplBriefJsonCase = `
generated json tag case for model struct, cases are as follows:
| Case | Example |
|---------------- |--------------------|
| Camel | AnyKindOfString |
| CamelLower | anyKindOfString | default
| Snake | any_kind_of_string |
| SnakeScreaming | ANY_KIND_OF_STRING |
| SnakeFirstUpper | rgb_code_md5 |
| Kebab | any-kind-of-string |
| KebabScreaming | ANY-KIND-OF-STRING |
`
CGenTplBriefTplDaoIndexPath = `template file path for dao index file`
CGenTplBriefTplDaoInternalPath = `template file path for dao internal file`
CGenTplBriefTplDaoDoPathPath = `template file path for dao do file`
CGenTplBriefTplDaoEntityPath = `template file path for dao entity file`
CGenTplBriefJsonOmitempty = `add omitempty to all json tags`
CGenTplBriefJsonOmitemptyAuto = `automatically add omitempty to json tags for nullable fields`
CGenTplBriefWithOrmTag = `add orm tag for entity fields`
)
func init() {
gtag.Sets(g.MapStrStr{
`CGenTplConfig`: CGenTplConfig,
`CGenTplUsage`: CGenTplUsage,
`CGenTplBrief`: CGenTplBrief,
`CGenTplEg`: CGenTplEg,
`CGenTplAd`: CGenTplAd,
`CGenTplBriefPath`: CGenTplBriefPath,
`CGenTplBriefLink`: CGenTplBriefLink,
`CGenTplBriefTables`: CGenTplBriefTables,
`CGenTplBriefTablesEx`: CGenTplBriefTablesEx,
`CGenTplBriefPrefix`: CGenTplBriefPrefix,
`CGenTplBriefRemovePrefix`: CGenTplBriefRemovePrefix,
`CGenTplBriefRemoveFieldPrefix`: CGenTplBriefRemoveFieldPrefix,
`CGenTplBriefStdTime`: CGenTplBriefStdTime,
`CGenTplBriefWithTime`: CGenTplBriefWithTime,
`CGenTplBriefDaoPath`: CGenTplBriefDaoPath,
`CGenTplBriefDoPath`: CGenTplBriefDoPath,
`CGenTplBriefEntityPath`: CGenTplBriefEntityPath,
`CGenTplBriefGJsonSupport`: CGenTplBriefGJsonSupport,
`CGenTplBriefImportPrefix`: CGenTplBriefImportPrefix,
`CGenTplBriefOverwriteDao`: CGenTplBriefOverwriteDao,
`CGenTplBriefModelFile`: CGenTplBriefModelFile,
`CGenTplBriefModelFileForDao`: CGenTplBriefModelFileForDao,
`CGenTplBriefDescriptionTag`: CGenTplBriefDescriptionTag,
`CGenTplBriefNoJsonTag`: CGenTplBriefNoJsonTag,
`CGenTplBriefNoModelComment`: CGenTplBriefNoModelComment,
`CGenTplBriefClear`: CGenTplBriefClear,
`CGenTplBriefTypeMapping`: CGenTplBriefTypeMapping,
`CGenTplBriefFieldMapping`: CGenTplBriefFieldMapping,
`CGenTplBriefGroup`: CGenTplBriefGroup,
`CGenTplBriefJsonCase`: CGenTplBriefJsonCase,
`CGenTplBriefTplDaoIndexPath`: CGenTplBriefTplDaoIndexPath,
`CGenTplBriefTplDaoInternalPath`: CGenTplBriefTplDaoInternalPath,
`CGenTplBriefTplDaoDoPathPath`: CGenTplBriefTplDaoDoPathPath,
`CGenTplBriefTplDaoEntityPath`: CGenTplBriefTplDaoEntityPath,
`CGenTplBriefJsonOmitempty`: CGenTplBriefJsonOmitempty,
`CGenTplBriefJsonOmitemptyAuto`: CGenTplBriefJsonOmitemptyAuto,
`CGenTplBriefWithOrmTag`: CGenTplBriefWithOrmTag,
})
}
type (
CGenTpl struct{}
CGenTplInput struct {
g.Meta `name:"tpl" config:"{CGenTplConfig}" usage:"{CGenTplUsage}" brief:"{CGenTplBrief}" eg:"{CGenTplEg}" ad:"{CGenTplAd}"`
Path string `name:"path" short:"p" brief:"{CGenTplBriefPath}" d:"./output"`
TplPath string `name:"tplPath" short:"tp" brief:"模板目录路径"`
Link string `name:"link" short:"l" brief:"{CGenTplBriefLink}"`
Tables string `name:"tables" short:"t" brief:"{CGenTplBriefTables}"`
TablesEx string `name:"tablesEx" short:"x" brief:"{CGenTplBriefTablesEx}"`
Group string `name:"group" short:"g" brief:"{CGenTplBriefGroup}" d:"default"`
Prefix string `name:"prefix" short:"f" brief:"{CGenTplBriefPrefix}"`
RemovePrefix string `name:"removePrefix" short:"r" brief:"{CGenTplBriefRemovePrefix}"`
RemoveFieldPrefix string `name:"removeFieldPrefix" short:"rf" brief:"{CGenTplBriefRemoveFieldPrefix}"`
JsonCase string `name:"jsonCase" short:"j" brief:"{CGenTplBriefJsonCase}" d:"CamelLower"`
ImportPrefix string `name:"importPrefix" short:"i" brief:"{CGenTplBriefImportPrefix}"`
// 新增过滤参数
TableNamePattern string `name:"tableNamePattern" short:"tn" brief:"表名匹配模式,支持通配符"`
// DaoPath string `name:"daoPath" short:"d" brief:"{CGenTplBriefDaoPath}" d:"dao"`
// DoPath string `name:"doPath" short:"o" brief:"{CGenTplBriefDoPath}" d:"model/do"`
// EntityPath string `name:"entityPath" short:"e" brief:"{CGenTplBriefEntityPath}" d:"model/entity"`
// TplDaoIndexPath string `name:"tplDaoIndexPath" short:"t1" brief:"{CGenTplBriefTplDaoIndexPath}"`
// TplDaoInternalPath string `name:"tplDaoInternalPath" short:"t2" brief:"{CGenTplBriefTplDaoInternalPath}"`
// TplDaoDoPath string `name:"tplDaoDoPath" short:"t3" brief:"{CGenTplBriefTplDaoDoPathPath}"`
// TplDaoEntityPath string `name:"tplDaoEntityPath" short:"t4" brief:"{CGenTplBriefTplDaoEntityPath}"`
StdTime bool `name:"stdTime" short:"s" brief:"{CGenTplBriefStdTime}" orphan:"true"`
WithTime bool `name:"withTime" short:"w" brief:"{CGenTplBriefWithTime}" orphan:"true"`
GJsonSupport bool `name:"gJsonSupport" short:"n" brief:"{CGenTplBriefGJsonSupport}" orphan:"true"`
OverwriteDao bool `name:"overwriteDao" short:"v" brief:"{CGenTplBriefOverwriteDao}" orphan:"true"`
DescriptionTag bool `name:"descriptionTag" short:"c" brief:"{CGenTplBriefDescriptionTag}" orphan:"true"`
NoJsonTag bool `name:"noJsonTag" short:"k" brief:"{CGenTplBriefNoJsonTag}" orphan:"true"`
NoModelComment bool `name:"noModelComment" short:"m" brief:"{CGenTplBriefNoModelComment}" orphan:"true"`
Clear bool `name:"clear" short:"a" brief:"{CGenTplBriefClear}" orphan:"true"`
JsonOmitempty bool `name:"jsonOmitempty" short:"jo" brief:"{CGenTplBriefJsonOmitempty}" orphan:"true"`
JsonOmitemptyAuto bool `name:"jsonOmitemptyAuto" short:"ja" brief:"{CGenTplBriefJsonOmitemptyAuto}" orphan:"true"`
WithOrmTag bool `name:"withOrmTag" short:"wo" brief:"{CGenTplBriefWithOrmTag}" orphan:"false" d:"false"`
TypeMapping map[string]CustomAttributeType `name:"typeMapping" short:"y" brief:"{CGenTplBriefTypeMapping}" orphan:"true"`
FieldMapping map[string]CustomAttributeType `name:"fieldMapping" short:"fm" brief:"{CGenTplBriefFieldMapping}" orphan:"true"`
}
CGenTplOutput struct{}
CustomAttributeType struct {
Type string `brief:"custom attribute type name"`
Import string `brief:"custom import for this type"`
Tags map[string]string `brief:"custom tags for this field, e.g. json, validate, binding"`
}
)
var (
defaultTypeMapping = map[string]CustomAttributeType{
"decimal": {
Type: "float64",
},
"money": {
Type: "float64",
},
"numeric": {
Type: "float64",
},
"smallmoney": {
Type: "float64",
},
}
)
type (
DBFieldTypeName = string
)
// TplObj description
type TplObj struct {
ctx context.Context
in CGenTplInput
db gdb.DB
TplPathAbs string
}
// NewTpl description
//
// createTime: 2025-01-25 16:36:43
func NewTpl(ctx context.Context, in CGenTplInput) (*TplObj, error) {
db, err := in.GetDB()
if err != nil {
return nil, err
}
return &TplObj{
ctx: ctx,
in: in,
db: db,
TplPathAbs: gfile.Abs(in.TplPath),
}, nil
}
func (t *TplObj) ShowParams() {
mlog.Debug("tplPath:", t.in.TplPath)
mlog.Debug("output:", t.in.Path)
}
func (t *TplObj) Format() {
utils.GoFmt(t.in.Path)
}
// GetTplFileList description
//
// createTime: 2025-01-25 16:43:06
func (t *TplObj) GetTplFileList() ([]string, error) {
tplList, err := gfile.ScanDirFile(t.TplPathAbs, "*.tpl", true)
if err != nil {
return nil, err
}
return tplList, nil
}
func (c CGenTpl) Tpl(ctx context.Context, in CGenTplInput) (out *CGenTplOutput, err error) {
if in.TplPath == "" {
return nil, gerror.New("tplPath is required")
}
// Merge default typeMapping to input typeMapping
if in.TypeMapping == nil {
in.TypeMapping = defaultTypeMapping
} else {
for key, typeMapping := range defaultTypeMapping {
if _, ok := in.TypeMapping[key]; !ok {
in.TypeMapping[key] = typeMapping
}
}
}
// Clear old files
if in.Clear {
if err := gfile.Remove(in.Path); err != nil {
return nil, gerror.Wrapf(err, "clear output path failed")
}
}
// Create output directory
if !gfile.Exists(in.Path) {
if err := gfile.Mkdir(in.Path); err != nil {
return nil, gerror.Wrapf(err, "create output directory failed")
}
}
tplObj, err := NewTpl(ctx, in)
if err != nil {
return nil, err
}
tplList, err := tplObj.GetTplFileList()
if err != nil {
panic(err)
}
fmt.Println(tplList)
fmt.Printf("%#v\n", Table{})
fmt.Printf("%#v\n", TableField{})
tables, err := tplObj.GetTables()
if err != nil {
return nil, err
}
view := gview.New()
for _, table := range tables {
// Create tag input for this table
tagInput := TagBuildInput{
NoJsonTag: in.NoJsonTag,
JsonOmitempty: in.JsonOmitempty,
JsonOmitemptyAuto: in.JsonOmitemptyAuto,
WithOrmTag: in.WithOrmTag,
DescriptionTag: in.DescriptionTag,
}
tplData := g.Map{
"table": table,
"tables": tables,
"tagInput": tagInput,
}
fmt.Println(table.FieldsJsonStr(in.JsonCase))
for _, tpl := range tplList {
mlog.Print("generating template file:", tpl)
// 相对路径
relativePath := strings.TrimPrefix(gfile.Dir(tpl), tplObj.TplPathAbs)
mlog.Print("relativePath:", relativePath)
table.PackageName = filepath.ToSlash(filepath.Join(in.ImportPrefix, relativePath))
filePath := filepath.Join(relativePath, table.FileName())
mlog.Print("generating table filePath:", filePath)
res, err := view.Parse(ctx, tpl, tplData)
if err != nil {
mlog.Fatal(err)
}
fmt.Println(len(res), err)
err = tplObj.SaveFile(ctx, filePath, res)
if err != nil {
panic(err)
}
}
}
// Format generated files
tplObj.Format()
mlog.Print("template files generated successfully!")
return &CGenTplOutput{}, nil
}
// SaveFile description
//
// createTime: 2025-01-25 17:05:25
func (t *TplObj) SaveFile(ctx context.Context, path, content string) error {
mlog.Print("saving file:", path)
path = filepath.Join(t.in.Path, path)
mlog.Print("saving file:", path)
path = filepath.FromSlash(path)
mlog.Print("saving file:", path)
if err := gfile.PutContents(path, content); err != nil {
return err
}
return nil
}
// GetDB description
//
// createTime: 2025-01-24 16:58:46
func (in CGenTplInput) GetDB() (db gdb.DB, err error) {
// It uses user passed database configuration.
if in.Link != "" {
var tempGroup = gtime.TimestampNanoStr()
gdb.AddConfigNode(tempGroup, gdb.ConfigNode{
Link: in.Link,
})
if db, err = gdb.Instance(tempGroup); err != nil {
mlog.Fatalf(`database initialization failed: %+v`, err)
}
} else {
db = g.DB(in.Group)
}
if db == nil {
mlog.Fatal(`database initialization failed, may be invalid database configuration`)
}
return
}

View File

@ -1,256 +0,0 @@
package tpl
import (
"context"
"fmt"
"sort"
"strings"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/text/gregex"
"github.com/gogf/gf/v2/text/gstr"
)
// TableField description
type TableField struct {
gdb.TableField
LocalType string
JsonCase string
CustomTags map[string]string // 自定义标签
}
type TableFields []*TableField
// Len returns the length of TableFields slice
func (s TableFields) Len() int { return len(s) }
// Swap swaps the elements with indexes i and j
func (s TableFields) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
// Less reports whether the element with index i should sort before the element with index j
func (s TableFields) Less(i, j int) bool {
return strings.Compare(s[i].Name, s[j].Name) < 0
}
// Input description
type Input struct {
StdTime bool
GJsonSupport bool
TypeMapping map[string]CustomAttributeType
FieldMapping map[string]CustomAttributeType
}
// GetLocalTypeName description
//
// createTime: 2023-10-25 15:43:06
//
// author: hailaz
func (field *TableField) GetLocalTypeName(ctx context.Context, db gdb.DB, in Input) (appendImport string) {
var (
err error
localTypeName gdb.LocalType
localTypeNameStr string
)
if in.TypeMapping != nil && len(in.TypeMapping) > 0 {
var (
tryTypeName string
)
tryTypeMatch, _ := gregex.MatchString(`(.+?)\((.+)\)`, field.Type)
if len(tryTypeMatch) == 3 {
tryTypeName = gstr.Trim(tryTypeMatch[1])
} else {
tryTypeName = gstr.Split(field.Type, " ")[0]
}
if tryTypeName != "" {
if typeMapping, ok := in.TypeMapping[strings.ToLower(tryTypeName)]; ok {
localTypeNameStr = typeMapping.Type
appendImport = typeMapping.Import
}
}
}
if localTypeNameStr == "" {
localTypeName, err = db.CheckLocalTypeForField(ctx, field.Type, nil)
if err != nil {
panic(err)
}
localTypeNameStr = string(localTypeName)
switch localTypeName {
case gdb.LocalTypeDate, gdb.LocalTypeDatetime:
if in.StdTime {
localTypeNameStr = "time.Time"
} else {
localTypeNameStr = "*gtime.Time"
appendImport = "github.com/gogf/gf/v2/os/gtime"
}
case gdb.LocalTypeInt64Bytes:
localTypeNameStr = "int64"
case gdb.LocalTypeUint64Bytes:
localTypeNameStr = "uint64"
// Special type handle.
case gdb.LocalTypeJson, gdb.LocalTypeJsonb:
if in.GJsonSupport {
localTypeNameStr = "*gjson.Json"
appendImport = "github.com/gogf/gf/v2/encoding/gjson"
} else {
localTypeNameStr = "string"
}
}
}
// Check field-specific mapping (overrides type mapping)
if len(in.FieldMapping) > 0 {
fieldKey := field.Name
if typeMapping, ok := in.FieldMapping[fieldKey]; ok {
localTypeNameStr = typeMapping.Type
if typeMapping.Import != "" {
appendImport = typeMapping.Import
}
}
}
field.LocalType = localTypeNameStr
return
}
// NameJsonCase description
//
// createTime: 2025-01-25 15:27:01
func (f *TableField) NameJsonCase() string {
return gstr.CaseConvert(f.Name, gstr.CaseTypeMatch(f.JsonCase))
}
// NameCaseConvert 字段名转换
func (f *TableField) NameCaseConvert(caseName string) string {
return gstr.CaseConvert(f.Name, gstr.CaseTypeMatch(caseName))
}
// NameCaseCamel returns the field name in camel case format
func (f *TableField) NameCaseCamel() string {
return gstr.CaseCamel(f.Name)
}
// NameCaseCamelLower returns the field name in lower camel case format
func (f *TableField) NameCaseCamelLower() string {
return gstr.CaseCamelLower(f.Name)
}
// NameCaseSnake returns the field name in snake case format
func (f *TableField) NameCaseSnake() string {
return gstr.CaseSnake(f.Name)
}
// NameCaseKebabScreaming returns the field name in screaming kebab case format
func (f *TableField) NameCaseKebabScreaming() string {
return gstr.CaseKebabScreaming(f.Name)
}
// IsNullable returns whether the field is nullable
func (f *TableField) IsNullable() bool {
return f.Null
}
// JsonTag generates json tag for the field
func (f *TableField) JsonTag(omitempty bool, omitemptyAuto bool) string {
if f.CustomTags != nil {
if jsonTag, ok := f.CustomTags["json"]; ok {
return jsonTag
}
}
name := f.NameJsonCase()
if omitempty || (omitemptyAuto && f.IsNullable()) {
return name + ",omitempty"
}
return name
}
// OrmTag generates orm tag for the field
func (f *TableField) OrmTag() string {
if f.CustomTags != nil {
if ormTag, ok := f.CustomTags["orm"]; ok {
return ormTag
}
}
return f.Name
}
// DescriptionTag generates description tag for the field
func (f *TableField) DescriptionTag() string {
if f.CustomTags != nil {
if descTag, ok := f.CustomTags["description"]; ok {
return descTag
}
}
// 转义双引号
comment := strings.ReplaceAll(f.Comment, `"`, `\"`)
return comment
}
// CustomTag returns custom tag value by name
func (f *TableField) CustomTag(name string) string {
if f.CustomTags == nil {
return ""
}
return f.CustomTags[name]
}
// BuildTags builds all tags for the field
func (f *TableField) BuildTags(in TagBuildInput) string {
var tags []string
// JSON tag
if !in.NoJsonTag {
jsonValue := f.JsonTag(in.JsonOmitempty, in.JsonOmitemptyAuto)
tags = append(tags, fmt.Sprintf(`json:"%s"`, jsonValue))
}
// ORM tag
if in.WithOrmTag {
ormValue := f.OrmTag()
tags = append(tags, fmt.Sprintf(`orm:"%s"`, ormValue))
}
// Description tag
if in.DescriptionTag {
descValue := f.DescriptionTag()
tags = append(tags, fmt.Sprintf(`description:"%s"`, descValue))
}
// Custom tags from CustomTags map
if f.CustomTags != nil {
// 按字母顺序遍历,确保输出稳定
var keys []string
for k := range f.CustomTags {
// 跳过已处理的标准标签
if k == "json" || k == "orm" || k == "description" {
continue
}
keys = append(keys, k)
}
sort.Strings(keys)
for _, k := range keys {
v := f.CustomTags[k]
tags = append(tags, fmt.Sprintf(`%s:"%s"`, k, v))
}
}
if len(tags) == 0 {
return ""
}
return "`" + strings.Join(tags, " ") + "`"
}
// TagBuildInput for building tags
type TagBuildInput struct {
NoJsonTag bool
JsonOmitempty bool
JsonOmitemptyAuto bool
WithOrmTag bool
DescriptionTag bool
}

View File

@ -1,273 +0,0 @@
package tpl
import (
"context"
"encoding/json"
"fmt"
"regexp"
"sort"
"strings"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/text/gstr"
)
// Table description
type Table struct {
Name string // 表名
OutputName string // 输出表名,用于生成文件名
OutputNameCase string // 输出表名的命名规则
PackageName string
db gdb.DB
Fields TableFields
FieldsSource map[string]*gdb.TableField
Imports map[string]struct{}
}
type Tables []*Table
// NewTable description
//
// createTime: 2023-12-11 16:17:33
//
// author: hailaz
func NewTable(t *TplObj, tableName string) (*Table, error) {
fields, err := t.db.TableFields(t.ctx, tableName)
if err != nil {
return nil, err
}
table := Table{
Name: tableName,
OutputName: t.TableOutputName(tableName),
FieldsSource: fields,
db: t.db,
Imports: make(map[string]struct{}),
}
table.toTableFields(t.in)
return &table, nil
}
// Name description
//
// createTime: 2023-10-23 16:17:30
//
// author: hailaz
func (t *Table) Show() string {
return fmt.Sprintf("table name is %s", t.Name)
}
// NameCase description
func (t *Table) NameCase() string {
return gstr.CaseConvert(t.Name, gstr.CaseTypeMatch(t.OutputNameCase))
}
// NameCaseCamel description
func (t *Table) NameCaseCamel() string {
return gstr.CaseCamel(t.Name)
}
// NameCaseCamelLower description
func (t *Table) NameCaseCamelLower() string {
return gstr.CaseCamelLower(t.Name)
}
// NameCaseSnake description
func (t *Table) NameCaseSnake() string {
return gstr.CaseSnake(t.Name)
}
// NameCaseKebabScreaming description
func (t *Table) NameCaseKebabScreaming() string {
return gstr.CaseKebabScreaming(t.Name)
}
// FileName description
func (t *Table) FileName() string {
return gstr.CaseConvert(t.OutputName, gstr.CaseTypeMatch(t.OutputNameCase)) + ".go"
}
// toTableFields description
//
// createTime: 2023-10-23 17:22:40
//
// author: hailaz
func (t *Table) toTableFields(in CGenTplInput) {
if len(t.Fields) > 0 {
return
}
t.Fields = make(TableFields, len(t.FieldsSource))
for _, v := range t.FieldsSource {
field := &TableField{
TableField: *v,
JsonCase: in.JsonCase,
CustomTags: make(map[string]string),
}
// 设置字段类型
appendImport := field.GetLocalTypeName(context.Background(), t.db, Input{
TypeMapping: in.TypeMapping,
FieldMapping: in.FieldMapping,
StdTime: in.StdTime,
GJsonSupport: in.GJsonSupport,
})
if appendImport != "" {
t.Imports[appendImport] = struct{}{}
}
// 从 FieldMapping 中提取自定义标签
if in.FieldMapping != nil {
if fieldMapping, ok := in.FieldMapping[v.Name]; ok {
if fieldMapping.Tags != nil {
for tagName, tagValue := range fieldMapping.Tags {
field.CustomTags[tagName] = tagValue
}
}
}
}
t.Fields[v.Index] = field
}
}
// SortFields 字段排序
//
// createTime: 2023-10-23 17:18:22
//
// author: hailaz
func (t *Table) SortFields(isReverse bool) {
if isReverse {
sort.Sort(sort.Reverse(t.Fields))
} else {
sort.Sort(t.Fields)
}
}
// FieldsJsonStr 表字段json字符串
//
// createTime: 2023-10-23 17:29:39
//
// author: hailaz
func (t *Table) FieldsJsonStr(caseName string) string {
mapStr := make(map[string]interface{}, len(t.Fields))
for _, v := range t.Fields {
mapStr[v.NameCaseConvert(caseName)] = v.Default
}
b, err := json.MarshalIndent(mapStr, "", " ")
if err != nil {
return ""
}
return string(b)
}
// TagInput holds input for tag generation
type TagInput struct {
in CGenTplInput
}
// GetTagInput returns TagInput for template usage
func (t *Table) GetTagInput(in CGenTplInput) TagInput {
return TagInput{in: in}
}
// GetTables 获取数据库表结构信息
func (t *TplObj) GetTables() (Tables, error) {
nameList, err := t.db.Tables(t.ctx)
if err != nil {
return nil, err
}
// 过滤表名
nameList = filterTablesByName(nameList, t.in.TableNamePattern)
// 根据Tables参数过滤
nameList = filterTablesByInclude(nameList, t.in.Tables)
// 根据TablesEx参数过滤
nameList = filterTablesByExclude(nameList, t.in.TablesEx)
tables := make(Tables, 0, len(nameList))
for _, v := range nameList {
t, err := NewTable(t, v)
if err != nil {
continue
}
t.SortFields(true)
tables = append(tables, t)
}
return tables, nil
}
// TableOutputName description
//
// createTime: 2025-01-25 17:20:46
func (t *TplObj) TableOutputName(name string) string {
if t.in.Prefix != "" {
name = t.in.Prefix + name
}
if t.in.RemovePrefix != "" {
name = strings.TrimPrefix(name, t.in.RemovePrefix)
}
return name
}
// 新增过滤函数
func filterTablesByName(tables []string, pattern string) []string {
if pattern == "" {
return tables
}
var result []string
re, err := regexp.Compile(pattern)
if err != nil {
return tables
}
for _, table := range tables {
if re.MatchString(table) {
result = append(result, table)
}
}
return result
}
// 根据包含表名过滤
func filterTablesByInclude(tables []string, include string) []string {
if include == "" {
return tables
}
includeTables := strings.Split(include, ",")
result := make([]string, 0, len(includeTables))
for _, table := range tables {
for _, includeTable := range includeTables {
if table == includeTable {
result = append(result, table)
break
}
}
}
return result
}
// 根据排除表名过滤
func filterTablesByExclude(tables []string, exclude string) []string {
if exclude == "" {
return tables
}
excludeTables := strings.Split(exclude, ",")
result := make([]string, 0, len(tables))
for _, table := range tables {
exclude := false
for _, excludeTable := range excludeTables {
if table == excludeTable {
exclude = true
break
}
}
if !exclude {
result = append(result, table)
}
}
return result
}

View File

@ -1,25 +0,0 @@
package tpl_test
import (
"context"
"fmt"
"testing"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/gen/tpl"
)
func TestTpl(t *testing.T) {
c := tpl.CGenTpl{}
t.Log(c)
out, err := c.Tpl(context.Background(), tpl.CGenTplInput{
Path: "./output",
TplPath: "./testdata",
Link: fmt.Sprintf("mysql:root:%s@tcp(127.0.0.1:3306)/focus?loc=Local&parseTime=true", "root123"),
Tables: "gf_user",
ImportPrefix: "github.com/gogf/gf/cmd/gf/v2/internal/cmd/gen/tpl/output",
})
if err != nil {
t.Error(err)
}
t.Log(out)
}

View File

@ -89,11 +89,28 @@ func (c CGenCtrl) Ctrl(ctx context.Context, in CGenCtrlInput) (out *CGenCtrlOutp
if !gfile.Exists(in.SrcFolder) {
mlog.Fatalf(`source folder path "%s" does not exist`, in.SrcFolder)
}
err = c.generateByModules(in)
// retrieve all api modules.
apiModuleFolderPaths, err := gfile.ScanDir(in.SrcFolder, "*", false)
if err != nil {
return nil, err
}
for _, apiModuleFolderPath := range apiModuleFolderPaths {
if !gfile.IsDir(apiModuleFolderPath) {
continue
}
// generate go files by api module.
var (
module = gfile.Basename(apiModuleFolderPath)
dstModuleFolderPath = gfile.Join(in.DstFolder, module)
)
err = c.generateByModule(
apiModuleFolderPath, dstModuleFolderPath, in.SdkPath,
in.SdkStdVersion, in.SdkNoV1, in.Clear, in.Merge,
)
if err != nil {
return nil, err
}
}
mlog.Print(`done!`)
return
@ -146,56 +163,6 @@ func (c CGenCtrl) generateByWatchFile(watchFile, sdkPath string, sdkStdVersion,
)
}
// generateByModules recursively calls generateByModule for multi-level modules generation.
func (c CGenCtrl) generateByModules(in CGenCtrlInput) (err error) {
// read root folder, example: api/user or api/app
moduleFolderPaths, err := gfile.ScanDir(in.SrcFolder, "*", false)
if err != nil {
return err
}
for _, moduleFolder := range moduleFolderPaths {
if !gfile.IsDir(moduleFolder) {
continue
}
// read children folder, example: api/user/v1 or api/app/user
childrenFolderPaths, err := gfile.ScanDir(moduleFolder, "*", false)
if err != nil {
return err
}
for _, childrenFolderPath := range childrenFolderPaths {
if !gfile.IsDir(childrenFolderPath) {
continue
}
var (
inCopy = in
module = gfile.Basename(moduleFolder)
)
inCopy.SrcFolder = gfile.Join(in.SrcFolder, module)
inCopy.DstFolder = gfile.Join(in.DstFolder, module)
err = c.generateByModules(inCopy)
if err != nil {
return err
}
}
// generate go files by api module.
var (
module = gfile.Basename(moduleFolder)
dstModuleFolderPath = gfile.Join(in.DstFolder, module)
)
err = c.generateByModule(
moduleFolder, dstModuleFolderPath, in.SdkPath,
in.SdkStdVersion, in.SdkNoV1, in.Clear, in.Merge,
)
if err != nil {
return err
}
}
return
}
// parseApiModule parses certain api and generate associated go files by certain module, not all api modules.
func (c CGenCtrl) generateByModule(
apiModuleFolderPath, dstModuleFolderPath, sdkPath string,

View File

@ -8,9 +8,6 @@ package genctrl
import (
"fmt"
"go/ast"
"go/parser"
"go/token"
"path/filepath"
"strings"
@ -147,8 +144,8 @@ func (c *controllerGenerator) doGenerateCtrlItem(dstModuleFolderPath string, ite
"{MethodName}": item.MethodName,
"{MethodComment}": item.GetComment(),
})
// Use AST-based checking for more accurate method detection
if methodExists(methodFilePath, ctrlName, item.MethodName) {
if gstr.Contains(gfile.GetContents(methodFilePath), fmt.Sprintf(`func (c *%v) %v(`, ctrlName, item.MethodName)) {
return
}
if err = gfile.PutContentsAppend(methodFilePath, gstr.TrimLeft(content)); err != nil {
@ -173,6 +170,7 @@ func (c *controllerGenerator) doGenerateCtrlItem(dstModuleFolderPath string, ite
// use -merge
func (c *controllerGenerator) doGenerateCtrlMergeItem(dstModuleFolderPath string, apiItems []apiItem, doneApiSet *gset.StrSet) (err error) {
type controllerFileItem struct {
module string
version string
@ -195,23 +193,13 @@ func (c *controllerGenerator) doGenerateCtrlMergeItem(dstModuleFolderPath string
ctrlFileItemMap[api.FileName] = ctrlFileItem
}
ctrlName := fmt.Sprintf(`Controller%s`, gstr.UcFirst(api.Version))
ctrl := gstr.TrimLeft(gstr.ReplaceByMap(consts.TemplateGenCtrlControllerMethodFuncMerge, g.MapStrStr{
"{Module}": api.Module,
"{CtrlName}": ctrlName,
"{CtrlName}": fmt.Sprintf(`Controller%s`, gstr.UcFirst(api.Version)),
"{Version}": api.Version,
"{MethodName}": api.MethodName,
"{MethodComment}": api.GetComment(),
}))
ctrlFilePath := gfile.Join(dstModuleFolderPath, fmt.Sprintf(
`%s_%s_%s.go`, ctrlFileItem.module, ctrlFileItem.version, api.FileName,
))
// Use AST-based checking for more accurate method detection
if methodExists(ctrlFilePath, ctrlName, api.MethodName) {
return
}
ctrlFileItem.controllers.WriteString(ctrl)
doneApiSet.Add(api.String())
}
@ -241,41 +229,3 @@ func (c *controllerGenerator) doGenerateCtrlMergeItem(dstModuleFolderPath string
}
return
}
// methodExists checks if a method with the given receiver type and name exists in the file.
// It uses AST parsing to accurately detect method definitions regardless of formatting.
// This handles various code formatting styles including multi-line method signatures.
func methodExists(filePath, ctrlName, methodName string) bool {
fset := token.NewFileSet()
node, err := parser.ParseFile(fset, filePath, nil, parser.ParseComments)
if err != nil {
// If parsing fails (e.g., file doesn't exist or invalid syntax), return false
return false
}
for _, decl := range node.Decls {
funcDecl, ok := decl.(*ast.FuncDecl)
if !ok {
continue
}
// Check if it's a method (has receiver)
if funcDecl.Recv != nil && len(funcDecl.Recv.List) > 0 {
// Extract receiver type name
// Handle both *T and T patterns
recvType := ""
switch t := funcDecl.Recv.List[0].Type.(type) {
case *ast.StarExpr:
if ident, ok := t.X.(*ast.Ident); ok {
recvType = ident.Name
}
case *ast.Ident:
recvType = t.Name
}
// Check if both receiver type and method name match
if recvType == ctrlName && funcDecl.Name.Name == methodName {
return true
}
}
}
return false
}

View File

@ -104,10 +104,6 @@ var (
"smallmoney": {
Type: "float64",
},
"uuid": {
Type: "uuid.UUID",
Import: "github.com/google/uuid",
},
}
// tablewriter Options

View File

@ -98,6 +98,7 @@ func generateStructFieldDefinition(
err error
localTypeName gdb.LocalType
localTypeNameStr string
jsonTag = gstr.CaseConvert(field.Name, gstr.CaseTypeMatch(in.JsonCase))
)
if in.TypeMapping != nil && len(in.TypeMapping) > 0 {
@ -155,8 +156,6 @@ func generateStructFieldDefinition(
" #" + formatFieldName(newFiledName, FieldNameCaseCamel),
" #" + localTypeNameStr,
}
jsonTag := gstr.CaseConvert(newFiledName, gstr.CaseTypeMatch(in.JsonCase))
attrLines = append(attrLines, fmt.Sprintf(` #%sjson:"%s"`, tagKey, jsonTag))
// orm tag
if !in.IsDo {

View File

@ -1,269 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package geninit
import (
"context"
"path/filepath"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/v2/text/gstr"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
// ProcessOptions contains options for the Process function
type ProcessOptions struct {
SelectVersion bool // Enable interactive version selection
ModulePath string // Custom go.mod module path (e.g., github.com/xxx/xxx)
UpgradeDeps bool // Upgrade dependencies to latest (go get -u ./...)
}
// Process handles the template generation flow from remote repository
func Process(ctx context.Context, repo, name string, opts *ProcessOptions) error {
if opts == nil {
opts = &ProcessOptions{}
}
// 0. Check Go environment first
mlog.Print("Checking Go environment...")
goEnv, err := CheckGoEnv(ctx)
if err != nil {
mlog.Printf("Go environment check failed: %v", err)
return err
}
mlog.Printf("Go environment OK (version: %s)", goEnv.GOVERSION)
// Check if this is a git subdirectory URL
if IsSubdirRepo(repo) {
return processGitSubdir(ctx, repo, name, opts)
}
// Try Go module download first, fallback to git subdirectory if it fails
// This handles edge cases where the heuristic may be incorrect
err = processGoModule(ctx, repo, name, opts)
if err != nil {
mlog.Printf("Go module download failed, trying git subdirectory mode: %v", err)
mlog.Print("Note: If this is a git subdirectory, you can force git mode by using a full git URL")
// If Go module download fails, try git subdirectory as fallback
// This handles cases where the heuristic incorrectly classified a git subdir as Go module
if IsSubdirRepo(repo) {
mlog.Print("Falling back to git subdirectory download...")
return processGitSubdir(ctx, repo, name, opts)
}
}
return err
}
// processGoModule handles standard Go module download via go get
func processGoModule(ctx context.Context, repo, name string, opts *ProcessOptions) error {
// Extract module path (without version)
modulePath := repo
specifiedVersion := ""
if gstr.Contains(repo, "@") {
parts := gstr.Split(repo, "@")
modulePath = parts[0]
specifiedVersion = parts[1]
}
// Default name to repo basename if empty
if name == "" {
name = filepath.Base(modulePath)
}
// Determine the target module path for go.mod
targetModulePath := name
if opts.ModulePath != "" {
targetModulePath = opts.ModulePath
}
// 1. Determine version to use
var targetVersion string
if specifiedVersion != "" {
// User specified version, try to use it first
targetVersion = specifiedVersion
mlog.Printf("Using specified version: %s", targetVersion)
} else if opts.SelectVersion {
// Interactive version selection
mlog.Print("Fetching available versions...")
versionInfo, err := GetModuleVersions(ctx, modulePath)
if err != nil {
mlog.Printf("Failed to get versions: %v", err)
return err
}
targetVersion, err = SelectVersion(ctx, versionInfo.Versions, modulePath)
if err != nil {
mlog.Printf("Version selection failed: %v", err)
return err
}
} else {
// Default: use latest version
mlog.Print("Fetching latest version...")
latest, err := GetLatestVersion(ctx, modulePath)
if err != nil {
mlog.Printf("Failed to get latest version, will try @latest tag: %v", err)
targetVersion = "latest"
} else {
targetVersion = latest
mlog.Printf("Latest version: %s", targetVersion)
}
}
// 2. Download Template with determined version
repoWithVersion := modulePath + "@" + targetVersion
srcDir, err := downloadTemplate(ctx, repoWithVersion)
if err != nil {
// If specified version download failed, offer to select from available versions
if specifiedVersion != "" {
mlog.Printf("Failed to download specified version '%s': %v", specifiedVersion, err)
mlog.Print("Fetching available versions...")
versionInfo, verErr := GetModuleVersions(ctx, modulePath)
if verErr != nil {
mlog.Printf("Failed to get available versions: %v", verErr)
return err // Return original download error
}
if len(versionInfo.Versions) == 0 {
mlog.Print("No versions available for this module")
return err
}
// Let user select from available versions
selectedVersion, selErr := SelectVersion(ctx, versionInfo.Versions, modulePath)
if selErr != nil {
mlog.Printf("Version selection failed: %v", selErr)
return selErr
}
// Retry download with selected version
targetVersion = selectedVersion
repoWithVersion = modulePath + "@" + targetVersion
srcDir, err = downloadTemplate(ctx, repoWithVersion)
if err != nil {
mlog.Printf("Download failed: %v", err)
return err
}
} else {
mlog.Printf("Download failed: %v", err)
return err
}
}
mlog.Debugf("Template located at: %s", srcDir)
// 3. Generate Project
if err := generateProject(ctx, srcDir, name, modulePath, targetModulePath); err != nil {
mlog.Printf("Generation failed: %v", err)
return err
}
// 4. Handle dependencies
var projectDir string
if name == "." {
projectDir = gfile.Pwd()
} else {
projectDir = filepath.Join(gfile.Pwd(), name)
}
if opts.UpgradeDeps {
// Upgrade all dependencies to latest
if err := upgradeDependencies(ctx, projectDir); err != nil {
mlog.Printf("Failed to upgrade dependencies: %v", err)
}
} else {
// Default: just tidy dependencies
if err := tidyDependencies(ctx, projectDir); err != nil {
mlog.Printf("Failed to tidy dependencies: %v", err)
}
}
return nil
}
// processGitSubdir handles git subdirectory download via sparse checkout
func processGitSubdir(ctx context.Context, repo, name string, opts *ProcessOptions) error {
mlog.Print("Detected subdirectory URL, using git sparse checkout...")
// Check if git is available
gitVersion, err := CheckGitEnv(ctx)
if err != nil {
mlog.Printf("Git is required for subdirectory templates: %v", err)
return err
}
mlog.Printf("Git available (%s)", gitVersion)
// Download via git sparse checkout
srcDir, gitInfo, err := downloadGitSubdir(ctx, repo)
if err != nil {
mlog.Printf("Git download failed: %v", err)
return err
}
// Clean up temp directory after generation
// The temp dir is parent of parent of srcDir (tempDir/repo/subpath)
tempDir := filepath.Dir(filepath.Dir(srcDir))
if tempDir != "" && gfile.Exists(tempDir) && gstr.Contains(tempDir, "gf-init-git") {
defer func() {
if err := gfile.Remove(tempDir); err != nil {
mlog.Debugf("Failed to remove temp directory %s: %v", tempDir, err)
} else {
mlog.Debugf("Cleaned up temp directory: %s", tempDir)
}
}()
}
// Default name to subpath basename if empty
if name == "" {
name = filepath.Base(gitInfo.SubPath)
}
// Get original module name from go.mod (might be "main" or something else)
oldModule := GetModuleNameFromGoMod(srcDir)
if oldModule == "" {
// Fallback: construct from git info
oldModule = gitInfo.Host + "/" + gitInfo.Owner + "/" + gitInfo.Repo + "/" + gitInfo.SubPath
}
// Determine the target module path for go.mod
targetModulePath := name
if opts.ModulePath != "" {
targetModulePath = opts.ModulePath
}
mlog.Debugf("Template located at: %s", srcDir)
mlog.Debugf("Original module: %s", oldModule)
// Generate Project
if err := generateProject(ctx, srcDir, name, oldModule, targetModulePath); err != nil {
mlog.Printf("Generation failed: %v", err)
return err
}
// Handle dependencies
var projectDir string
if name == "." {
projectDir = gfile.Pwd()
} else {
projectDir = filepath.Join(gfile.Pwd(), name)
}
if opts.UpgradeDeps {
// Upgrade all dependencies to latest
if err := upgradeDependencies(ctx, projectDir); err != nil {
mlog.Printf("Failed to upgrade dependencies: %v", err)
}
} else {
// Default: just tidy dependencies
if err := tidyDependencies(ctx, projectDir); err != nil {
mlog.Printf("Failed to tidy dependencies: %v", err)
}
}
return nil
}

View File

@ -1,125 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package geninit
import (
"bytes"
"context"
"go/ast"
"go/parser"
"go/printer"
"go/token"
"os"
"path/filepath"
"strings"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
// ASTReplacer handles import path replacement using Go AST
type ASTReplacer struct {
oldModule string
newModule string
fset *token.FileSet
}
// NewASTReplacer creates a new AST-based import replacer
func NewASTReplacer(oldModule, newModule string) *ASTReplacer {
return &ASTReplacer{
oldModule: oldModule,
newModule: newModule,
fset: token.NewFileSet(),
}
}
// ReplaceInFile replaces import paths in a single Go file
func (r *ASTReplacer) ReplaceInFile(ctx context.Context, filePath string) error {
// Read file content
content := gfile.GetContents(filePath)
if content == "" {
return nil
}
// Parse the file
file, err := parser.ParseFile(r.fset, filePath, content, parser.ParseComments)
if err != nil {
mlog.Debugf("Failed to parse %s: %v", filePath, err)
return nil // Skip files that can't be parsed
}
// Track if any changes were made
changed := false
// Traverse and modify imports
ast.Inspect(file, func(n ast.Node) bool {
switch x := n.(type) {
case *ast.ImportSpec:
if x.Path != nil {
importPath := strings.Trim(x.Path.Value, `"`)
if strings.HasPrefix(importPath, r.oldModule) {
// Replace only the leading module prefix for clarity and correctness.
newPath := r.newModule + strings.TrimPrefix(importPath, r.oldModule)
x.Path.Value = `"` + newPath + `"`
changed = true
mlog.Debugf("Replaced import: %s -> %s in %s", importPath, newPath, filePath)
}
}
}
return true
})
if !changed {
return nil
}
// Write back to file without formatting.
// Formatting will be handled by formatGoFiles after all replacements are done.
var buf bytes.Buffer
if err := printer.Fprint(&buf, r.fset, file); err != nil {
return err
}
return gfile.PutContents(filePath, buf.String())
}
// ReplaceInDir replaces import paths in all Go files in a directory (recursively)
func (r *ASTReplacer) ReplaceInDir(ctx context.Context, dir string) error {
mlog.Printf("Replacing imports: %s -> %s", r.oldModule, r.newModule)
// Find all .go files
files, err := findGoFiles(dir)
if err != nil {
return err
}
for _, file := range files {
if err := r.ReplaceInFile(ctx, file); err != nil {
mlog.Printf("Failed to process %s: %v", file, err)
}
}
return nil
}
// findGoFiles recursively finds all .go files in a directory
func findGoFiles(dir string) ([]string, error) {
var files []string
err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if !info.IsDir() && strings.HasSuffix(path, ".go") {
files = append(files, path)
}
return nil
})
return files, err
}

View File

@ -1,111 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package geninit
import (
"context"
"encoding/json"
"fmt"
"os"
"os/exec"
"strings"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/v2/text/gstr"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
// downloadTemplate fetches the remote repository using go get
func downloadTemplate(ctx context.Context, repo string) (string, error) {
// 1. Create a temporary directory workspace
tempDir := gfile.Temp("gf-init-cli")
if tempDir == "" {
return "", fmt.Errorf("failed to create temporary directory")
}
if err := gfile.Mkdir(tempDir); err != nil {
return "", err
}
defer func() {
if err := gfile.Remove(tempDir); err != nil {
mlog.Debugf("Failed to remove temp directory %s: %v", tempDir, err)
}
}() // Clean up the temp workspace
mlog.Debugf("Using temp workspace: %s", tempDir)
// 2. Initialize a temp go module to perform go get
// We run commands inside the temp directory
if err := runCmd(ctx, tempDir, "go", "mod", "init", "temp"); err != nil {
return "", err
}
// 3. Run go get <repo>
// Try different version strategies: original -> @latest -> @master
moduleName := repo
if gstr.Contains(repo, "@") {
moduleName = gstr.Split(repo, "@")[0]
}
var downloadErrs []string
versionsToTry := []string{repo}
if !gstr.Contains(repo, "@") {
versionsToTry = append(versionsToTry, repo+"@latest", repo+"@master")
}
var successRepo string
for _, tryRepo := range versionsToTry {
mlog.Printf("Downloading template %s...", tryRepo)
if err := runCmd(ctx, tempDir, "go", "get", tryRepo); err == nil {
successRepo = tryRepo
break
} else {
downloadErrs = append(downloadErrs, fmt.Sprintf("%s: %v", tryRepo, err))
mlog.Debugf("Failed to download %s, trying next...", tryRepo)
}
}
if successRepo == "" {
errMsg := "all download attempts failed"
if len(downloadErrs) > 0 {
errMsg = strings.Join(downloadErrs, "; ")
}
return "", fmt.Errorf("failed to download repo %s: %s", repo, errMsg)
}
// 4. Find the local path using go list -m -json <repo>
listCmd := exec.CommandContext(ctx, "go", "list", "-m", "-json", moduleName)
listCmd.Dir = tempDir
output, err := listCmd.Output()
if err != nil {
if exitErr, ok := err.(*exec.ExitError); ok {
return "", fmt.Errorf("go list failed: %s", string(exitErr.Stderr))
}
return "", fmt.Errorf("failed to locate module path: %w", err)
}
var modInfo struct {
Dir string `json:"Dir"`
}
if err := json.Unmarshal(output, &modInfo); err != nil {
return "", fmt.Errorf("failed to parse go list output: %w", err)
}
if modInfo.Dir == "" {
return "", fmt.Errorf("module directory not found for %s", repo)
}
return modInfo.Dir, nil
}
func runCmd(ctx context.Context, dir string, name string, args ...string) error {
cmd := exec.CommandContext(ctx, name, args...)
cmd.Dir = dir
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
return cmd.Run()
}

View File

@ -1,90 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package geninit
import (
"context"
"encoding/json"
"fmt"
"os/exec"
"strings"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
// GoEnv represents Go environment variables
type GoEnv struct {
GOVERSION string `json:"GOVERSION"`
GOROOT string `json:"GOROOT"`
GOPATH string `json:"GOPATH"`
GOMODCACHE string `json:"GOMODCACHE"`
GOPROXY string `json:"GOPROXY"`
GO111MODULE string `json:"GO111MODULE"`
}
// CheckGoEnv verifies Go is installed and properly configured
func CheckGoEnv(ctx context.Context) (*GoEnv, error) {
// 1. Check if go binary exists
goPath, err := exec.LookPath("go")
if err != nil {
return nil, fmt.Errorf("go is not installed or not in PATH: %w", err)
}
mlog.Debugf("Found go binary at: %s", goPath)
// 2. Get go env as JSON
cmd := exec.CommandContext(ctx, "go", "env", "-json")
output, err := cmd.Output()
if err != nil {
if exitErr, ok := err.(*exec.ExitError); ok {
return nil, fmt.Errorf("go env failed: %s", string(exitErr.Stderr))
}
return nil, fmt.Errorf("failed to run go env: %w", err)
}
// 3. Parse JSON output
var env GoEnv
if err := json.Unmarshal(output, &env); err != nil {
return nil, fmt.Errorf("failed to parse go env output: %w", err)
}
// 4. Validate critical environment variables
if env.GOROOT == "" {
return nil, fmt.Errorf("GOROOT is not set")
}
if env.GOMODCACHE == "" && env.GOPATH == "" {
return nil, fmt.Errorf("neither GOMODCACHE nor GOPATH is set")
}
mlog.Debugf("Go Version: %s", env.GOVERSION)
mlog.Debugf("GOROOT: %s", env.GOROOT)
mlog.Debugf("GOMODCACHE: %s", env.GOMODCACHE)
mlog.Debugf("GOPROXY: %s", env.GOPROXY)
return &env, nil
}
// CheckGitEnv verifies Git is installed and returns its version
func CheckGitEnv(ctx context.Context) (string, error) {
// 1. Check if git binary exists
gitPath, err := exec.LookPath("git")
if err != nil {
return "", fmt.Errorf("git is not installed or not in PATH: %w", err)
}
mlog.Debugf("Found git binary at: %s", gitPath)
// 2. Get git version
cmd := exec.CommandContext(ctx, "git", "--version")
output, err := cmd.Output()
if err != nil {
return "", fmt.Errorf("failed to get git version: %w", err)
}
version := strings.TrimSpace(string(output))
mlog.Debugf("Git version: %s", version)
return version, nil
}

View File

@ -1,146 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package geninit
import (
"context"
"fmt"
"go/format"
"path/filepath"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/v2/text/gstr"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
// generateProject copies the template to the destination and performs cleanup
// oldModule: original module path from template
// newModule: target module path for go.mod (can be different from project name)
func generateProject(ctx context.Context, srcPath, name, oldModule, newModule string) error {
pwd := gfile.Pwd()
dstPath := filepath.Join(pwd, name)
if name == "." {
dstPath = pwd
}
if gfile.Exists(dstPath) && !gfile.IsEmpty(dstPath) {
return fmt.Errorf("target directory %s is not empty", dstPath)
}
mlog.Printf("Generating project in %s...", dstPath)
// 1. Copy files
if err := gfile.Copy(srcPath, dstPath); err != nil {
return err
}
// 2. Clean up .git directory
gitDir := filepath.Join(dstPath, ".git")
if gfile.Exists(gitDir) {
if err := gfile.Remove(gitDir); err != nil {
mlog.Debugf("Failed to remove .git directory: %v", err)
}
}
// 3. Clean up go.work and go.work.sum (workspace files should not be in generated project)
for _, workFile := range []string{"go.work", "go.work.sum"} {
workPath := filepath.Join(dstPath, workFile)
if gfile.Exists(workPath) {
if err := gfile.Remove(workPath); err != nil {
mlog.Printf("Failed to remove %s: %v", workFile, err)
} else {
mlog.Debugf("Removed %s", workFile)
}
}
}
// 4. Update go.mod module name
goModPath := filepath.Join(dstPath, "go.mod")
if gfile.Exists(goModPath) {
content := gfile.GetContents(goModPath)
lines := gstr.Split(content, "\n")
if len(lines) > 0 && gstr.HasPrefix(lines[0], "module ") {
lines[0] = "module " + newModule
newContent := gstr.Join(lines, "\n")
if err := gfile.PutContents(goModPath, newContent); err != nil {
mlog.Printf("Failed to update go.mod: %v", err)
}
}
}
// 5. Use AST to replace import paths in all Go files
if oldModule != "" && oldModule != newModule {
replacer := NewASTReplacer(oldModule, newModule)
if err := replacer.ReplaceInDir(ctx, dstPath); err != nil {
return fmt.Errorf("failed to replace imports: %w", err)
}
}
// 6. Format the generated Go files using go/format (not imports.Process)
// Note: We use formatGoFiles instead of utils.GoFmt because imports.Process
// may incorrectly "fix" local import paths by replacing them with cached module paths.
formatGoFiles(dstPath)
mlog.Print("Project generated successfully!")
return nil
}
// tidyDependencies runs go mod tidy in the project directory
func tidyDependencies(ctx context.Context, projectDir string) error {
mlog.Print("Tidying dependencies (go mod tidy)...")
if err := runCmd(ctx, projectDir, "go", "mod", "tidy"); err != nil {
return fmt.Errorf("go mod tidy failed: %w", err)
}
mlog.Print("Dependencies tidied successfully!")
return nil
}
// upgradeDependencies runs go get -u ./... to upgrade all dependencies to latest
func upgradeDependencies(ctx context.Context, projectDir string) error {
mlog.Print("Upgrading dependencies to latest (go get -u ./...)...")
if err := runCmd(ctx, projectDir, "go", "get", "-u", "./..."); err != nil {
return fmt.Errorf("go get -u failed: %w", err)
}
// Run tidy again after upgrade
if err := runCmd(ctx, projectDir, "go", "mod", "tidy"); err != nil {
return fmt.Errorf("go mod tidy after upgrade failed: %w", err)
}
mlog.Print("Dependencies upgraded successfully!")
return nil
}
// formatGoFiles formats all Go files in the directory using go/format.
// Unlike imports.Process, this only formats code without modifying imports,
// which prevents incorrect "fixing" of local import paths.
func formatGoFiles(dir string) {
files, err := findGoFiles(dir)
if err != nil {
mlog.Printf("Failed to find Go files for formatting: %v", err)
return
}
for _, file := range files {
content := gfile.GetContents(file)
if content == "" {
continue
}
formatted, err := format.Source([]byte(content))
if err != nil {
mlog.Debugf("Failed to format %s: %v", file, err)
continue
}
if string(formatted) != content {
if err := gfile.PutContents(file, string(formatted)); err != nil {
mlog.Debugf("Failed to write formatted file %s: %v", file, err)
}
}
}
}

View File

@ -1,241 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package geninit
import (
"context"
"fmt"
"path/filepath"
"strings"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/v2/text/gstr"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
// GitRepoInfo holds parsed git repository information
type GitRepoInfo struct {
Host string // e.g., github.com
Owner string // e.g., gogf
Repo string // e.g., examples
Branch string // e.g., main (default: main)
SubPath string // e.g., httpserver/jwt
CloneURL string // e.g., https://github.com/gogf/examples.git
}
// ParseGitURL parses a git URL and extracts repository info
// Supports formats:
// - github.com/owner/repo
// - github.com/owner/repo/subdir/path
// - github.com/owner/repo/tree/branch/subdir/path (from GitHub web URL)
func ParseGitURL(url string) (*GitRepoInfo, error) {
// Remove protocol prefix if present
url = strings.TrimPrefix(url, "https://")
url = strings.TrimPrefix(url, "http://")
url = strings.TrimSuffix(url, ".git")
// Remove version suffix like @v1.0.0
if idx := strings.Index(url, "@"); idx != -1 {
url = url[:idx]
}
parts := strings.Split(url, "/")
if len(parts) < 3 {
return nil, fmt.Errorf("invalid git URL: %s", url)
}
info := &GitRepoInfo{
Host: parts[0],
Owner: parts[1],
Repo: parts[2],
Branch: "main", // default branch
}
// Check for /tree/branch/ pattern (GitHub web URL)
if len(parts) > 4 && parts[3] == "tree" {
info.Branch = parts[4]
if len(parts) > 5 {
info.SubPath = strings.Join(parts[5:], "/")
}
} else if len(parts) > 3 {
// Direct subpath: github.com/owner/repo/subdir/path
info.SubPath = strings.Join(parts[3:], "/")
}
info.CloneURL = fmt.Sprintf("https://%s/%s/%s.git", info.Host, info.Owner, info.Repo)
return info, nil
}
// IsSubdirRepo checks if the URL points to a subdirectory of a repository
// Returns false for Go module paths (which may have /vN suffix or nested module paths)
// Note: This uses heuristics that may have false positives/negatives in edge cases
func IsSubdirRepo(url string) bool {
info, err := ParseGitURL(url)
if err != nil {
return false
}
if info.SubPath == "" {
return false
}
// Check if this looks like a Go module path rather than a git subdirectory
// Go modules can have nested paths like github.com/owner/repo/cmd/tool/v2
// We should try to resolve it as a Go module first
// If the URL can be resolved as a Go module, it's not a subdir repo
// We use a heuristic: check if the full path looks like a valid Go module
// by checking if it ends with /vN (major version) or contains common module patterns
// Remove version suffix for checking
cleanURL := url
if before, _, ok := strings.Cut(url, "@"); ok {
cleanURL = before
}
// Check if the path ends with /vN (Go module major version)
parts := strings.Split(cleanURL, "/")
if len(parts) > 0 {
lastPart := parts[len(parts)-1]
if len(lastPart) >= 2 && lastPart[0] == 'v' {
// Check if it's v2, v3, etc.
if _, err := fmt.Sscanf(lastPart, "v%d", new(int)); err == nil {
// This looks like a Go module with major version suffix
// It could be either a versioned module or a subdir ending in vN
// We'll treat it as a Go module and let go get handle it
mlog.Debugf("URL %s detected as Go module (ends with /vN)", url)
return false
}
}
}
// For GitHub URLs, check if the subpath could be a nested Go module
// Common patterns: cmd/*, internal/*, pkg/*, contrib/*
subPathParts := strings.Split(info.SubPath, "/")
if len(subPathParts) > 0 {
firstPart := subPathParts[0]
// These are common Go module nesting patterns
if firstPart == "cmd" || firstPart == "contrib" || firstPart == "tools" {
// This might be a nested Go module, not a simple subdirectory
// Let go get try first
mlog.Debugf("URL %s detected as Go module (starts with common pattern)", url)
return false
}
}
mlog.Debugf("URL %s detected as git subdirectory", url)
return true
}
// downloadGitSubdir downloads a subdirectory from a git repository using sparse checkout
func downloadGitSubdir(ctx context.Context, repoURL string) (string, *GitRepoInfo, error) {
info, err := ParseGitURL(repoURL)
if err != nil {
return "", nil, err
}
if info.SubPath == "" {
return "", nil, fmt.Errorf("not a subdirectory URL: %s", repoURL)
}
// Create temp directory for clone
tempDir := gfile.Temp("gf-init-git")
if tempDir == "" {
return "", nil, fmt.Errorf("failed to create temporary directory")
}
if err := gfile.Mkdir(tempDir); err != nil {
return "", nil, err
}
cloneDir := filepath.Join(tempDir, info.Repo)
mlog.Debugf("Using git temp workspace: %s", tempDir)
mlog.Printf("Cloning %s (sparse checkout: %s)...", info.CloneURL, info.SubPath)
// 1. Clone with no checkout, filter, and sparse
if err := runCmd(ctx, tempDir, "git", "clone", "--filter=blob:none", "--no-checkout", "--sparse", info.CloneURL); err != nil {
// Fallback: try without filter for older git versions
mlog.Debugf("Sparse clone failed, trying full clone...")
if err := gfile.Remove(cloneDir); err != nil {
mlog.Debugf("Failed to remove clone directory: %v", err)
}
if err := runCmd(ctx, tempDir, "git", "clone", "--no-checkout", info.CloneURL); err != nil {
if err := gfile.Remove(tempDir); err != nil {
mlog.Debugf("Failed to remove temp directory: %v", err)
}
return "", nil, fmt.Errorf("git clone failed: %w", err)
}
}
// 2. Set sparse-checkout to the subpath
if err := runCmd(ctx, cloneDir, "git", "sparse-checkout", "set", info.SubPath); err != nil {
// Fallback for older git: use sparse-checkout init + set
mlog.Debugf("sparse-checkout set failed, trying legacy method...")
if err := runCmd(ctx, cloneDir, "git", "sparse-checkout", "init", "--cone"); err != nil {
if err := gfile.Remove(tempDir); err != nil {
mlog.Debugf("Failed to remove temp directory: %v", err)
}
return "", nil, fmt.Errorf("git sparse-checkout init (legacy) failed: %w", err)
}
if err := runCmd(ctx, cloneDir, "git", "sparse-checkout", "set", info.SubPath); err != nil {
if err := gfile.Remove(tempDir); err != nil {
mlog.Debugf("Failed to remove temp directory: %v", err)
}
return "", nil, fmt.Errorf("git sparse-checkout set (legacy) failed: %w", err)
}
}
// 3. Checkout the branch
if err := runCmd(ctx, cloneDir, "git", "checkout", info.Branch); err != nil {
// Try master if main fails
if info.Branch == "main" {
mlog.Debugf("Branch 'main' not found, trying 'master'...")
info.Branch = "master"
if err := runCmd(ctx, cloneDir, "git", "checkout", "master"); err != nil {
if err := gfile.Remove(tempDir); err != nil {
mlog.Debugf("Failed to remove temp directory: %v", err)
}
return "", nil, fmt.Errorf("git checkout failed: %w", err)
}
} else {
if err := gfile.Remove(tempDir); err != nil {
mlog.Debugf("Failed to remove temp directory: %v", err)
}
return "", nil, fmt.Errorf("git checkout failed: %w", err)
}
}
// Return the path to the subdirectory
subDirPath := filepath.Join(cloneDir, info.SubPath)
if !gfile.Exists(subDirPath) {
if err := gfile.Remove(tempDir); err != nil {
mlog.Debugf("Failed to remove temp directory: %v", err)
}
return "", nil, fmt.Errorf("subdirectory not found: %s", info.SubPath)
}
mlog.Debugf("Subdirectory located at: %s", subDirPath)
return subDirPath, info, nil
}
// GetModuleNameFromGoMod reads module name from go.mod file
func GetModuleNameFromGoMod(dir string) string {
goModPath := filepath.Join(dir, "go.mod")
if !gfile.Exists(goModPath) {
return ""
}
content := gfile.GetContents(goModPath)
lines := gstr.Split(content, "\n")
for _, line := range lines {
line = strings.TrimSpace(line)
if after, ok := strings.CutPrefix(line, "module "); ok {
return strings.TrimSpace(after)
}
}
return ""
}

View File

@ -1,99 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package geninit
import (
"bufio"
"context"
"fmt"
"os"
"strconv"
"strings"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
// SelectVersion prompts user to select a version interactively
func SelectVersion(ctx context.Context, versions []string, modulePath string) (string, error) {
if len(versions) == 0 {
return "", fmt.Errorf("no versions available for selection")
}
if len(versions) == 1 {
mlog.Printf("Only one version available: %s", versions[0])
return versions[0], nil
}
// Display available versions
fmt.Printf("\nAvailable versions for %s:\n", modulePath)
fmt.Println(strings.Repeat("-", 40))
// Show versions with index (newest first)
maxDisplay := 20 // Limit display to avoid overwhelming output
displayCount := len(versions)
if displayCount > maxDisplay {
displayCount = maxDisplay
}
for i := 0; i < displayCount; i++ {
marker := ""
if i == 0 {
marker = " (latest)"
}
fmt.Printf(" [%2d] %s%s\n", i+1, versions[i], marker)
}
if len(versions) > maxDisplay {
fmt.Printf(" ... and %d more versions\n", len(versions)-maxDisplay)
}
fmt.Println(strings.Repeat("-", 40))
// Prompt for selection
reader := bufio.NewReader(os.Stdin)
for {
fmt.Printf("Select version [1-%d] or enter version string (default: 1 for latest): ", displayCount)
input, err := reader.ReadString('\n')
if err != nil {
return "", fmt.Errorf("failed to read input: %w", err)
}
input = strings.TrimSpace(input)
// Default to latest
if input == "" {
fmt.Printf("Selected: %s (latest)\n", versions[0])
return versions[0], nil
}
// Try parsing as number first
idx, err := strconv.Atoi(input)
if err == nil {
// Valid number - check if in range
if idx >= 1 && idx <= len(versions) {
// Allow selection from all versions, not just displayed ones
selected := versions[idx-1]
fmt.Printf("Selected: %s\n", selected)
return selected, nil
} else if idx < 1 || idx > displayCount {
fmt.Printf("Invalid selection. Please enter a number between 1 and %d, or type a version string.\n", displayCount)
continue
}
} else {
// Try matching the input as a version string (e.g., "v1.2.3")
for _, v := range versions {
if v == input || strings.Contains(v, input) {
fmt.Printf("Selected: %s\n", v)
return v, nil
}
}
fmt.Printf("Version '%s' not found. Please select by number or type a valid version string.\n", input)
continue
}
}
}

View File

@ -1,138 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package geninit
import (
"context"
"encoding/json"
"fmt"
"os/exec"
"sort"
"strings"
"golang.org/x/mod/semver"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
// VersionInfo contains module version information
type VersionInfo struct {
Module string `json:"module"`
Versions []string `json:"versions"`
Latest string `json:"latest"`
}
// GetModuleVersions fetches available versions for a Go module
func GetModuleVersions(ctx context.Context, modulePath string) (*VersionInfo, error) {
// Create a temporary directory for go list
tempDir := gfile.Temp("gf-init-version")
if tempDir == "" {
return nil, fmt.Errorf("failed to create temporary directory for go list")
}
if err := gfile.Mkdir(tempDir); err != nil {
return nil, err
}
defer func() {
if err := gfile.Remove(tempDir); err != nil {
mlog.Debugf("Failed to remove temp directory: %v", err)
}
}()
// Initialize a temp go module
if err := runCmd(ctx, tempDir, "go", "mod", "init", "temp"); err != nil {
return nil, fmt.Errorf("failed to init temp module: %w", err)
}
// Get versions using go list -m -versions
cmd := exec.CommandContext(ctx, "go", "list", "-m", "-versions", modulePath)
cmd.Dir = tempDir
output, err := cmd.Output()
if err != nil {
// Try with @latest to see if module exists
mlog.Debugf("go list -versions failed, trying @latest: %v", err)
return getLatestOnly(ctx, tempDir, modulePath)
}
// Parse output: "module/path v1.0.0 v1.1.0 v2.0.0"
parts := strings.Fields(strings.TrimSpace(string(output)))
if len(parts) < 1 {
return nil, fmt.Errorf("no version information found for %s", modulePath)
}
info := &VersionInfo{
Module: parts[0],
Versions: []string{},
}
if len(parts) > 1 {
info.Versions = parts[1:]
// Sort versions in descending order (newest first)
sort.Slice(info.Versions, func(i, j int) bool {
return semver.Compare(info.Versions[i], info.Versions[j]) > 0
})
info.Latest = info.Versions[0]
}
// If no tagged versions, try to get latest
if len(info.Versions) == 0 {
latestInfo, err := getLatestOnly(ctx, tempDir, modulePath)
if err != nil {
return nil, err
}
info.Latest = latestInfo.Latest
if latestInfo.Latest != "" {
info.Versions = []string{latestInfo.Latest}
}
}
return info, nil
}
// getLatestOnly gets only the latest version when go list -versions fails
func getLatestOnly(ctx context.Context, tempDir, modulePath string) (*VersionInfo, error) {
// Try go list -m modulePath@latest
cmd := exec.CommandContext(ctx, "go", "list", "-m", "-json", modulePath+"@latest")
cmd.Dir = tempDir
output, err := cmd.Output()
if err != nil {
// Try without @latest
cmd = exec.CommandContext(ctx, "go", "list", "-m", "-json", modulePath)
cmd.Dir = tempDir
output, err = cmd.Output()
if err != nil {
return nil, fmt.Errorf("failed to get module info for %s: %w", modulePath, err)
}
}
var modInfo struct {
Path string `json:"Path"`
Version string `json:"Version"`
}
if err := json.Unmarshal(output, &modInfo); err != nil {
return nil, fmt.Errorf("failed to parse module info: %w", err)
}
return &VersionInfo{
Module: modInfo.Path,
Versions: []string{modInfo.Version},
Latest: modInfo.Version,
}, nil
}
// GetLatestVersion returns the latest version of a module
func GetLatestVersion(ctx context.Context, modulePath string) (string, error) {
info, err := GetModuleVersions(ctx, modulePath)
if err != nil {
return "", err
}
if info.Latest == "" {
return "", fmt.Errorf("no version found for %s", modulePath)
}
return info.Latest, nil
}

View File

@ -4,7 +4,7 @@ go 1.23.0
toolchain go1.24.6
require github.com/gogf/gf/v2 v2.9.8
require github.com/gogf/gf/v2 v2.9.6
require (
go.opentelemetry.io/otel v1.38.0 // indirect

View File

@ -1,10 +1,13 @@
package testdata
import (
"fmt"
"testing"
"time"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
"github.com/gogf/gf/v2/test/gtest"
"github.com/gogf/gf/v2/util/guid"
)

View File

@ -7,7 +7,7 @@ package dict
import (
"context"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/merge/add_new_ctrl/api/dict/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl-merge/add_new_ctrl/api/dict/v1"
)
type IDictV1 interface {

View File

@ -7,7 +7,7 @@ package dict
import (
"context"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/merge/add_new_ctrl/api/dict/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl-merge/add_new_ctrl/api/dict/v1"
)
type IDictV1 interface {

View File

@ -5,7 +5,7 @@
package dict
import (
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/merge/add_new_ctrl/api/dict"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl-merge/add_new_ctrl/api/dict"
)
type ControllerV1 struct{}

View File

@ -6,7 +6,7 @@ import (
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/merge/add_new_ctrl/api/dict/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl-merge/add_new_ctrl/api/dict/v1"
)
func (c *ControllerV1) DictTypeAddPage(ctx context.Context, req *v1.DictTypeAddPageReq) (res *v1.DictTypeAddPageRes, err error) {

View File

@ -6,7 +6,7 @@ import (
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/merge/add_new_ctrl/api/dict/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl-merge/add_new_ctrl/api/dict/v1"
)
func (c *ControllerV1) DictTypeAddPage(ctx context.Context, req *v1.DictTypeAddPageReq) (res *v1.DictTypeAddPageRes, err error) {

View File

@ -7,7 +7,7 @@ package dict
import (
"context"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/merge/add_new_ctrl/api/dict/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl-merge/add_new_ctrl/api/dict/v1"
)
type IDictV1 interface {

View File

@ -7,7 +7,7 @@ package dict
import (
"context"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/merge/add_new_file/api/dict/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl-merge/add_new_file/api/dict/v1"
)
type IDictV1 interface {

View File

@ -5,7 +5,7 @@
package dict
import (
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/merge/add_new_file/api/dict"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl-merge/add_new_file/api/dict"
)
type ControllerV1 struct{}

View File

@ -6,7 +6,7 @@ import (
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/merge/add_new_file/api/dict/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl-merge/add_new_file/api/dict/v1"
)
func (c *ControllerV1) DictTypeAddPage(ctx context.Context, req *v1.DictTypeAddPageReq) (res *v1.DictTypeAddPageRes, err error) {

View File

@ -6,7 +6,7 @@ import (
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/merge/add_new_file/api/dict/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl-merge/add_new_file/api/dict/v1"
)
func (c *ControllerV1) DictTypeAdd(ctx context.Context, req *v1.DictTypeAddReq) (res *v1.DictTypeAddRes, err error) {

View File

@ -7,8 +7,8 @@ package article
import (
"context"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/default/api/article/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/default/api/article/v2"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v2"
)
type IArticleV1 interface {

View File

@ -5,7 +5,7 @@
package article
import (
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/default/api/article"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article"
)
type ControllerV1 struct{}

View File

@ -6,7 +6,7 @@ import (
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/default/api/article/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v1"
)
// Create add title.

View File

@ -6,7 +6,7 @@ import (
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/default/api/article/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v1"
)
func (c *ControllerV1) GetList(ctx context.Context, req *v1.GetListReq) (res *v1.GetListRes, err error) {

View File

@ -6,7 +6,7 @@ import (
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/default/api/article/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v1"
)
func (c *ControllerV1) GetOne(ctx context.Context, req *v1.GetOneReq) (res *v1.GetOneRes, err error) {

View File

@ -6,7 +6,7 @@ import (
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/default/api/article/v1"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v1"
)
func (c *ControllerV1) Update(ctx context.Context, req *v1.UpdateReq) (res *v1.UpdateRes, err error) {

View File

@ -6,7 +6,7 @@ import (
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/default/api/article/v2"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v2"
)
func (c *ControllerV2) Create(ctx context.Context, req *v2.CreateReq) (res *v2.CreateRes, err error) {

View File

@ -6,7 +6,7 @@ import (
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/default/api/article/v2"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v2"
)
func (c *ControllerV2) Update(ctx context.Context, req *v2.UpdateReq) (res *v2.UpdateRes, err error) {

View File

@ -1,15 +0,0 @@
// =================================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
// =================================================================================
package article
import (
"context"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/admin/article/v1"
)
type IArticleV1 interface {
Create(ctx context.Context, req *v1.CreateReq) (res *v1.CreateRes, err error)
}

View File

@ -1,19 +0,0 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package v1
import "github.com/gogf/gf/v2/frame/g"
type (
// CreateReq add title.
CreateReq struct {
g.Meta `path:"/article/create" method:"post" tags:"ArticleService"`
Title string `v:"required"`
}
CreateRes struct{}
)

View File

@ -1,15 +0,0 @@
// =================================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
// =================================================================================
package user
import (
"context"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/admin/user/v1"
)
type IUserV1 interface {
Create(ctx context.Context, req *v1.CreateReq) (res *v1.CreateRes, err error)
}

View File

@ -1,19 +0,0 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package v1
import "github.com/gogf/gf/v2/frame/g"
type (
// CreateReq add title.
CreateReq struct {
g.Meta `path:"/article/create" method:"post" tags:"ArticleService"`
Title string `v:"required"`
}
CreateRes struct{}
)

View File

@ -1,16 +0,0 @@
// =================================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
// =================================================================================
package user
import (
"context"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/app/user/v1"
)
type IUserV1 interface {
Create(ctx context.Context, req *v1.CreateReq) (res *v1.CreateRes, err error)
Update(ctx context.Context, req *v1.UpdateReq) (res *v1.UpdateRes, err error)
}

View File

@ -1,16 +0,0 @@
// =================================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
// =================================================================================
package user_ext
import (
"context"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/app/user/user_ext/v1"
)
type IUserExtV1 interface {
Create(ctx context.Context, req *v1.CreateReq) (res *v1.CreateRes, err error)
Update(ctx context.Context, req *v1.UpdateReq) (res *v1.UpdateRes, err error)
}

View File

@ -1,28 +0,0 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package v1
import "github.com/gogf/gf/v2/frame/g"
type (
// CreateReq add title.
CreateReq struct {
g.Meta `path:"/article/create" method:"post" tags:"ArticleService"`
Title string `v:"required"`
}
CreateRes struct{}
)
type (
UpdateReq struct {
g.Meta `path:"/article/update" method:"post" tags:"ArticleService"`
Title string `v:"required"`
}
UpdateRes struct{}
)

View File

@ -1,28 +0,0 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package v1
import "github.com/gogf/gf/v2/frame/g"
type (
// CreateReq add title.
CreateReq struct {
g.Meta `path:"/article/create" method:"post" tags:"ArticleService"`
Title string `v:"required"`
}
CreateRes struct{}
)
type (
UpdateReq struct {
g.Meta `path:"/article/update" method:"post" tags:"ArticleService"`
Title string `v:"required"`
}
UpdateRes struct{}
)

View File

@ -1,5 +0,0 @@
// =================================================================================
// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
// =================================================================================
package article

View File

@ -1,15 +0,0 @@
// =================================================================================
// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
// =================================================================================
package article
import (
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/admin/article"
)
type ControllerV1 struct{}
func NewV1() article.IArticleV1 {
return &ControllerV1{}
}

View File

@ -1,15 +0,0 @@
package article
import (
"context"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/admin/article/v1"
)
// Create add title.
func (c *ControllerV1) Create(ctx context.Context, req *v1.CreateReq) (res *v1.CreateRes, err error) {
return nil, gerror.NewCode(gcode.CodeNotImplemented)
}

View File

@ -1,5 +0,0 @@
// =================================================================================
// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
// =================================================================================
package user

View File

@ -1,15 +0,0 @@
// =================================================================================
// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
// =================================================================================
package user
import (
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/admin/user"
)
type ControllerV1 struct{}
func NewV1() user.IUserV1 {
return &ControllerV1{}
}

View File

@ -1,15 +0,0 @@
package user
import (
"context"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/admin/user/v1"
)
// Create add title.
func (c *ControllerV1) Create(ctx context.Context, req *v1.CreateReq) (res *v1.CreateRes, err error) {
return nil, gerror.NewCode(gcode.CodeNotImplemented)
}

View File

@ -1,5 +0,0 @@
// =================================================================================
// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
// =================================================================================
package user

View File

@ -1,5 +0,0 @@
// =================================================================================
// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
// =================================================================================
package user_ext

View File

@ -1,15 +0,0 @@
// =================================================================================
// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
// =================================================================================
package user_ext
import (
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/app/user/user_ext"
)
type ControllerV1 struct{}
func NewV1() user_ext.IUserExtV1 {
return &ControllerV1{}
}

View File

@ -1,15 +0,0 @@
package user_ext
import (
"context"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/app/user/user_ext/v1"
)
// Create add title.
func (c *ControllerV1) Create(ctx context.Context, req *v1.CreateReq) (res *v1.CreateRes, err error) {
return nil, gerror.NewCode(gcode.CodeNotImplemented)
}

View File

@ -1,14 +0,0 @@
package user_ext
import (
"context"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/app/user/user_ext/v1"
)
func (c *ControllerV1) Update(ctx context.Context, req *v1.UpdateReq) (res *v1.UpdateRes, err error) {
return nil, gerror.NewCode(gcode.CodeNotImplemented)
}

View File

@ -1,15 +0,0 @@
// =================================================================================
// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
// =================================================================================
package user
import (
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/app/user"
)
type ControllerV1 struct{}
func NewV1() user.IUserV1 {
return &ControllerV1{}
}

View File

@ -1,15 +0,0 @@
package user
import (
"context"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/app/user/v1"
)
// Create add title.
func (c *ControllerV1) Create(ctx context.Context, req *v1.CreateReq) (res *v1.CreateRes, err error) {
return nil, gerror.NewCode(gcode.CodeNotImplemented)
}

View File

@ -1,14 +0,0 @@
package user
import (
"context"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/multi/api/app/user/v1"
)
func (c *ControllerV1) Update(ctx context.Context, req *v1.UpdateReq) (res *v1.UpdateRes, err error) {
return nil, gerror.NewCode(gcode.CodeNotImplemented)
}

View File

@ -17,29 +17,19 @@ import (
"github.com/gogf/gf/v2/util/gconv"
)
// NilChecker is a function that checks whether the given value is nil.
type NilChecker[V any] func(V) bool
// KVMap wraps map type `map[K]V` and provides more map features.
type KVMap[K comparable, V any] struct {
mu rwmutex.RWMutex
data map[K]V
nilChecker NilChecker[V]
mu rwmutex.RWMutex
data map[K]V
}
// NewKVMap creates and returns an empty hash map.
// The parameter `safe` is used to specify whether to use the map in concurrent-safety mode, which is false by default.
// The parameter `safe` is used to specify whether to use the map in concurrent-safety mode,
// which is false by default.
func NewKVMap[K comparable, V any](safe ...bool) *KVMap[K, V] {
return NewKVMapFrom(make(map[K]V), safe...)
}
// NewKVMapWithChecker creates and returns an empty hash map with a custom nil checker.
// The parameter `checker` is a function used to determine if a value is nil.
// The parameter `safe` is used to specify whether to use the map in concurrent-safety mode, which is false by default.
func NewKVMapWithChecker[K comparable, V any](checker NilChecker[V], safe ...bool) *KVMap[K, V] {
return NewKVMapWithCheckerFrom(make(map[K]V), checker, safe...)
}
// NewKVMapFrom creates and returns a hash map from given map `data`.
// Note that, the param `data` map will be set as the underlying data map (no deep copy),
// there might be some concurrent-safe issues when changing the map outside.
@ -51,37 +41,6 @@ func NewKVMapFrom[K comparable, V any](data map[K]V, safe ...bool) *KVMap[K, V]
return m
}
// NewKVMapWithCheckerFrom creates and returns a hash map from given map `data` with a custom nil checker.
// Note that, the param `data` map will be set as the underlying data map (no deep copy),
// and there might be some concurrent-safe issues when changing the map outside.
// The parameter `checker` is a function used to determine if a value is nil.
// The parameter `safe` is used to specify whether to use the map in concurrent-safety mode, which is false by default.
func NewKVMapWithCheckerFrom[K comparable, V any](data map[K]V, checker NilChecker[V], safe ...bool) *KVMap[K, V] {
m := NewKVMapFrom[K, V](data, safe...)
m.RegisterNilChecker(checker)
return m
}
// RegisterNilChecker registers a custom nil checker function for the map values.
// This function is used to determine if a value should be considered as nil.
// The nil checker function takes a value of type V and returns a boolean indicating
// whether the value should be treated as nil.
func (m *KVMap[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
m.mu.Lock()
defer m.mu.Unlock()
m.nilChecker = nilChecker
}
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
func (m *KVMap[K, V]) isNil(v V) bool {
if m.nilChecker != nil {
return m.nilChecker(v)
}
return any(v) == nil
}
// Iterator iterates the hash map readonly with custom callback function `f`.
// If `f` returns true, then it continues iterating; or false to stop.
func (m *KVMap[K, V]) Iterator(f func(k K, v V) bool) {
@ -258,7 +217,8 @@ func (m *KVMap[K, V]) doSetWithLockCheck(key K, value V) (val V, ok bool) {
if v, ok := m.data[key]; ok {
return v, true
}
if !m.isNil(value) {
if any(value) != nil {
m.data[key] = value
}
return value, false
@ -295,7 +255,7 @@ func (m *KVMap[K, V]) GetOrSetFuncLock(key K, f func() V) V {
return v
}
value := f()
if !m.isNil(value) {
if any(value) != nil {
m.data[key] = value
}
return value

View File

@ -27,10 +27,9 @@ import (
//
// Reference: http://en.wikipedia.org/wiki/Associative_array
type ListKVMap[K comparable, V any] struct {
mu rwmutex.RWMutex
data map[K]*glist.TElement[*gListKVMapNode[K, V]]
list *glist.TList[*gListKVMapNode[K, V]]
nilChecker NilChecker[V]
mu rwmutex.RWMutex
data map[K]*glist.TElement[*gListKVMapNode[K, V]]
list *glist.TList[*gListKVMapNode[K, V]]
}
type gListKVMapNode[K comparable, V any] struct {
@ -50,16 +49,6 @@ func NewListKVMap[K comparable, V any](safe ...bool) *ListKVMap[K, V] {
}
}
// NewListKVMapWithChecker creates and returns a new ListKVMap instance with a custom nil checker.
// The parameter `checker` is a function used to determine if a value is nil.
// The parameter `safe` is used to specify whether using map in concurrent-safety,
// which is false by default.
func NewListKVMapWithChecker[K comparable, V any](checker NilChecker[V], safe ...bool) *ListKVMap[K, V] {
m := NewListKVMap[K, V](safe...)
m.RegisterNilChecker(checker)
return m
}
// NewListKVMapFrom returns a link map from given map `data`.
// Note that, the param `data` map will be copied to the underlying data structure,
// so changes to the original map will not affect the link map.
@ -69,38 +58,6 @@ func NewListKVMapFrom[K comparable, V any](data map[K]V, safe ...bool) *ListKVMa
return m
}
// NewListKVMapWithCheckerFrom returns a link map from given map `data` with a custom nil checker.
// Note that, the param `data` map will be copied to the underlying data structure,
// so changes to the original map will not affect the link map.
// The parameter `checker` is a function used to determine if a value is nil.
// The parameter `safe` is used to specify whether using map in concurrent-safety,
// which is false by default.
func NewListKVMapWithCheckerFrom[K comparable, V any](data map[K]V, nilChecker NilChecker[V], safe ...bool) *ListKVMap[K, V] {
m := NewListKVMapWithChecker[K, V](nilChecker, safe...)
m.Sets(data)
return m
}
// RegisterNilChecker registers a custom nil checker function for the map values.
// This function is used to determine if a value should be considered as nil.
// The nil checker function takes a value of type V and returns a boolean indicating
// whether the value should be treated as nil.
func (m *ListKVMap[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
m.mu.Lock()
defer m.mu.Unlock()
m.nilChecker = nilChecker
}
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
func (m *ListKVMap[K, V]) isNil(v V) bool {
if m.nilChecker != nil {
return m.nilChecker(v)
}
return any(v) == nil
}
// Iterator is alias of IteratorAsc.
func (m *ListKVMap[K, V]) Iterator(f func(key K, value V) bool) {
m.IteratorAsc(f)
@ -325,7 +282,7 @@ func (m *ListKVMap[K, V]) doSetWithLockCheckWithoutLock(key K, value V) V {
if e, ok := m.data[key]; ok {
return e.Value.value
}
if !m.isNil(value) {
if any(value) != nil {
m.data[key] = m.list.PushBack(&gListKVMapNode[K, V]{key, value})
}
return value
@ -370,7 +327,7 @@ func (m *ListKVMap[K, V]) GetOrSetFuncLock(key K, f func() V) V {
return e.Value.value
}
value := f()
if !m.isNil(value) {
if any(value) != nil {
m.data[key] = m.list.PushBack(&gListKVMapNode[K, V]{key, value})
}
return value
@ -413,7 +370,7 @@ func (m *ListKVMap[K, V]) SetIfNotExist(key K, value V) bool {
if _, ok := m.data[key]; ok {
return false
}
if !m.isNil(value) {
if any(value) != nil {
m.data[key] = m.list.PushBack(&gListKVMapNode[K, V]{key, value})
}
return true
@ -433,7 +390,7 @@ func (m *ListKVMap[K, V]) SetIfNotExistFunc(key K, f func() V) bool {
return false
}
value := f()
if !m.isNil(value) {
if any(value) != nil {
m.data[key] = m.list.PushBack(&gListKVMapNode[K, V]{key, value})
}
return true
@ -456,7 +413,7 @@ func (m *ListKVMap[K, V]) SetIfNotExistFuncLock(key K, f func() V) bool {
return false
}
value := f()
if !m.isNil(value) {
if any(value) != nil {
m.data[key] = m.list.PushBack(&gListKVMapNode[K, V]{key, value})
}
return true

View File

@ -1630,67 +1630,3 @@ func Test_KVMap_Flip_String(t *testing.T) {
t.Assert(m.Get("val2"), "key2")
})
}
// Test TypedNil with custom nil checker for pointers
func Test_KVMap_TypedNil(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Student struct {
Name string
Age int
}
m1 := gmap.NewKVMap[int, *Student](true)
for i := 0; i < 10; i++ {
m1.GetOrSetFuncLock(i, func() *Student {
if i%2 == 0 {
return &Student{}
}
return nil
})
}
t.Assert(m1.Size(), 10)
m2 := gmap.NewKVMap[int, *Student](true)
m2.RegisterNilChecker(func(student *Student) bool {
return student == nil
})
for i := 0; i < 10; i++ {
m2.GetOrSetFuncLock(i, func() *Student {
if i%2 == 0 {
return &Student{}
}
return nil
})
}
t.Assert(m2.Size(), 5)
})
}
func Test_NewKVMapWithChecker_TypedNil(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Student struct {
Name string
Age int
}
m1 := gmap.NewKVMap[int, *Student](true)
for i := 0; i < 10; i++ {
m1.GetOrSetFuncLock(i, func() *Student {
if i%2 == 0 {
return &Student{}
}
return nil
})
}
t.Assert(m1.Size(), 10)
m2 := gmap.NewKVMapWithChecker[int, *Student](func(student *Student) bool {
return student == nil
}, true)
for i := 0; i < 10; i++ {
m2.GetOrSetFuncLock(i, func() *Student {
if i%2 == 0 {
return &Student{}
}
return nil
})
}
t.Assert(m2.Size(), 5)
})
}

View File

@ -1341,67 +1341,3 @@ func Test_ListKVMap_UnmarshalValue_NilData(t *testing.T) {
t.Assert(m.Get("b"), "2")
})
}
// Test typed nil values
func Test_ListKVMap_TypedNil(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Student struct {
Name string
Age int
}
m1 := gmap.NewListKVMap[int, *Student](true)
for i := 0; i < 10; i++ {
m1.GetOrSetFuncLock(i, func() *Student {
if i%2 == 0 {
return &Student{}
}
return nil
})
}
t.Assert(m1.Size(), 10)
m2 := gmap.NewListKVMap[int, *Student](true)
m2.RegisterNilChecker(func(student *Student) bool {
return student == nil
})
for i := 0; i < 10; i++ {
m2.GetOrSetFuncLock(i, func() *Student {
if i%2 == 0 {
return &Student{}
}
return nil
})
}
t.Assert(m2.Size(), 5)
})
}
func Test_NewListKVMapWithChecker_TypedNil(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Student struct {
Name string
Age int
}
m1 := gmap.NewListKVMap[int, *Student](true)
for i := 0; i < 10; i++ {
m1.GetOrSetFuncLock(i, func() *Student {
if i%2 == 0 {
return &Student{}
}
return nil
})
}
t.Assert(m1.Size(), 10)
m2 := gmap.NewListKVMapWithChecker[int, *Student](func(student *Student) bool {
return student == nil
}, true)
for i := 0; i < 10; i++ {
m2.GetOrSetFuncLock(i, func() *Student {
if i%2 == 0 {
return &Student{}
}
return nil
})
}
t.Assert(m2.Size(), 5)
})
}

View File

@ -15,14 +15,10 @@ import (
"github.com/gogf/gf/v2/util/gconv"
)
// NilChecker is a function that checks whether the given value is nil.
type NilChecker[T any] func(T) bool
// TSet[T] is consisted of any items.
type TSet[T comparable] struct {
mu rwmutex.RWMutex
data map[T]struct{}
nilChecker NilChecker[T]
mu rwmutex.RWMutex
data map[T]struct{}
}
// NewTSet creates and returns a new set, which contains un-repeated items.
@ -34,15 +30,6 @@ func NewTSet[T comparable](safe ...bool) *TSet[T] {
}
}
// NewTSetWithChecker creates and returns a new set with a custom nil checker.
// The parameter `nilChecker` is a function used to determine if a value is nil.
// The parameter `safe` is used to specify whether using set in concurrent-safety mode.
func NewTSetWithChecker[T comparable](checker NilChecker[T], safe ...bool) *TSet[T] {
s := NewTSet[T](safe...)
s.RegisterNilChecker(checker)
return s
}
// NewTSetFrom returns a new set from `items`.
// `items` - A slice of type T.
func NewTSetFrom[T comparable](items []T, safe ...bool) *TSet[T] {
@ -56,36 +43,6 @@ func NewTSetFrom[T comparable](items []T, safe ...bool) *TSet[T] {
}
}
// NewTSetWithCheckerFrom returns a new set from `items` with a custom nil checker.
// The parameter `items` is a slice of elements to be added to the set.
// The parameter `checker` is a function used to determine if a value is nil.
// The parameter `safe` is used to specify whether using set in concurrent-safety mode.
func NewTSetWithCheckerFrom[T comparable](items []T, checker NilChecker[T], safe ...bool) *TSet[T] {
set := NewTSetWithChecker[T](checker, safe...)
set.Add(items...)
return set
}
// RegisterNilChecker registers a custom nil checker function for the set elements.
// This function is used to determine if an element should be considered as nil.
// The nil checker function takes an element of type T and returns a boolean indicating
// whether the element should be treated as nil.
func (set *TSet[T]) RegisterNilChecker(nilChecker NilChecker[T]) {
set.mu.Lock()
defer set.mu.Unlock()
set.nilChecker = nilChecker
}
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
func (set *TSet[T]) isNil(v T) bool {
if set.nilChecker != nil {
return set.nilChecker(v)
}
return any(v) == nil
}
// Iterator iterates the set readonly with given callback function `f`,
// if `f` returns true then continue iterating; or false to stop.
func (set *TSet[T]) Iterator(f func(v T) bool) {
@ -99,13 +56,13 @@ func (set *TSet[T]) Iterator(f func(v T) bool) {
// Add adds one or multiple items to the set.
func (set *TSet[T]) Add(items ...T) {
set.mu.Lock()
defer set.mu.Unlock()
if set.data == nil {
set.data = make(map[T]struct{})
}
for _, v := range items {
set.data[v] = struct{}{}
}
set.mu.Unlock()
}
// AddIfNotExist checks whether item exists in the set,
@ -114,7 +71,7 @@ func (set *TSet[T]) Add(items ...T) {
//
// Note that, if `item` is nil, it does nothing and returns false.
func (set *TSet[T]) AddIfNotExist(item T) bool {
if set.isNil(item) {
if any(item) == nil {
return false
}
if !set.Contains(item) {
@ -138,7 +95,7 @@ func (set *TSet[T]) AddIfNotExist(item T) bool {
// Note that, if `item` is nil, it does nothing and returns false. The function `f`
// is executed without writing lock.
func (set *TSet[T]) AddIfNotExistFunc(item T, f func() bool) bool {
if set.isNil(item) {
if any(item) == nil {
return false
}
if !set.Contains(item) {
@ -164,7 +121,7 @@ func (set *TSet[T]) AddIfNotExistFunc(item T, f func() bool) bool {
// Note that, if `item` is nil, it does nothing and returns false. The function `f`
// is executed within writing lock.
func (set *TSet[T]) AddIfNotExistFuncLock(item T, f func() bool) bool {
if set.isNil(item) {
if any(item) == nil {
return false
}
if !set.Contains(item) {

View File

@ -591,42 +591,3 @@ func TestTSet_RLockFunc(t *testing.T) {
t.Assert(sum, 6)
})
}
func Test_TSet_TypedNil(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Student struct {
Name string
Age int
}
set := gset.NewTSet[*Student](true)
var s *Student = nil
exist := set.AddIfNotExist(s)
t.Assert(exist, true)
set2 := gset.NewTSet[*Student](true)
set2.RegisterNilChecker(func(student *Student) bool {
return student == nil
})
exist2 := set2.AddIfNotExist(s)
t.Assert(exist2, false)
})
}
func Test_NewTSetWithChecker_TypedNil(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Student struct {
Name string
Age int
}
set := gset.NewTSet[*Student](true)
var s *Student = nil
exist := set.AddIfNotExist(s)
t.Assert(exist, true)
set2 := gset.NewTSetWithChecker[*Student](func(student *Student) bool {
return student == nil
}, true)
exist2 := set2.AddIfNotExist(s)
t.Assert(exist2, false)
})
}

View File

@ -18,15 +18,11 @@ import (
"github.com/gogf/gf/v2/util/gconv"
)
// NilChecker is a function that checks whether the given value is nil.
type NilChecker[V any] func(V) bool
// AVLKVTree holds elements of the AVL tree.
type AVLKVTree[K comparable, V any] struct {
mu rwmutex.RWMutex
comparator func(v1, v2 K) int
tree *avltree.Tree[K, V]
nilChecker NilChecker[V]
}
// AVLKVTreeNode is a single element within the tree.
@ -47,15 +43,6 @@ func NewAVLKVTree[K comparable, V any](comparator func(v1, v2 K) int, safe ...bo
}
}
// NewAVLKVTreeWithChecker instantiates an AVL tree with the custom key comparator and nil checker.
// The parameter `safe` is used to specify whether using tree in concurrent-safety, which is false in default.
// The parameter `checker` is used to specify whether the given value is nil.
func NewAVLKVTreeWithChecker[K comparable, V any](comparator func(v1, v2 K) int, checker NilChecker[V], safe ...bool) *AVLKVTree[K, V] {
t := NewAVLKVTree[K, V](comparator, safe...)
t.RegisterNilChecker(checker)
return t
}
// NewAVLKVTreeFrom instantiates an AVL tree with the custom key comparator and data map.
//
// The parameter `safe` is used to specify whether using tree in concurrent-safety, which is false in default.
@ -67,37 +54,6 @@ func NewAVLKVTreeFrom[K comparable, V any](comparator func(v1, v2 K) int, data m
return tree
}
// NewAVLKVTreeWithCheckerFrom instantiates an AVL tree with the custom key comparator, nil checker and data map.
// The parameter `safe` is used to specify whether using tree in concurrent-safety, which is false in default.
// The parameter `checker` is used to specify whether the given value is nil.
func NewAVLKVTreeWithCheckerFrom[K comparable, V any](comparator func(v1, v2 K) int, data map[K]V, checker NilChecker[V], safe ...bool) *AVLKVTree[K, V] {
tree := NewAVLKVTreeWithChecker[K, V](comparator, checker, safe...)
for k, v := range data {
tree.doSet(k, v)
}
return tree
}
// RegisterNilChecker registers a custom nil checker function for the map values.
// This function is used to determine if a value should be considered as nil.
// The nil checker function takes a value of type V and returns a boolean indicating
// whether the value should be treated as nil.
func (tree *AVLKVTree[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
tree.mu.Lock()
defer tree.mu.Unlock()
tree.nilChecker = nilChecker
}
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
func (tree *AVLKVTree[K, V]) isNil(value V) bool {
if tree.nilChecker != nil {
return tree.nilChecker(value)
}
return any(value) == nil
}
// Clone clones and returns a new tree from current tree.
func (tree *AVLKVTree[K, V]) Clone() *AVLKVTree[K, V] {
if tree == nil {
@ -562,7 +518,7 @@ func (tree *AVLKVTree[K, V]) Flip(comparator ...func(v1, v2 K) int) {
//
// It returns value with given `key`.
func (tree *AVLKVTree[K, V]) doSet(key K, value V) V {
if tree.isNil(value) {
if any(value) == nil {
return value
}
tree.tree.Put(key, value)

View File

@ -24,7 +24,6 @@ type BKVTree[K comparable, V any] struct {
comparator func(v1, v2 K) int
m int // order (maximum number of children)
tree *btree.Tree[K, V]
nilChecker NilChecker[V]
}
// BKVTreeEntry represents the key-value pair contained within nodes.
@ -46,15 +45,6 @@ func NewBKVTree[K comparable, V any](m int, comparator func(v1, v2 K) int, safe
}
}
// NewBKVTreeWithChecker instantiates a B-tree with `m` (maximum number of children), a custom key comparator and nil checker.
// The parameter `safe` is used to specify whether using tree in concurrent-safety, which is false in default.
// The parameter `checker` is used to specify whether the given value is nil.
func NewBKVTreeWithChecker[K comparable, V any](m int, comparator func(v1, v2 K) int, checker NilChecker[V], safe ...bool) *BKVTree[K, V] {
t := NewBKVTree[K, V](m, comparator, safe...)
t.RegisterNilChecker(checker)
return t
}
// NewBKVTreeFrom instantiates a B-tree with `m` (maximum number of children), a custom key comparator and data map.
// The parameter `safe` is used to specify whether using tree in concurrent-safety,
// which is false in default.
@ -66,37 +56,6 @@ func NewBKVTreeFrom[K comparable, V any](m int, comparator func(v1, v2 K) int, d
return tree
}
// NewBKVTreeWithCheckerFrom instantiates a B-tree with `m` (maximum number of children), a custom key comparator, nil checker and data map.
// The parameter `safe` is used to specify whether using tree in concurrent-safety, which is false in default.
// The parameter `checker` is used to specify whether the given value is nil.
func NewBKVTreeWithCheckerFrom[K comparable, V any](m int, comparator func(v1, v2 K) int, data map[K]V, checker NilChecker[V], safe ...bool) *BKVTree[K, V] {
tree := NewBKVTreeWithChecker[K, V](m, comparator, checker, safe...)
for k, v := range data {
tree.doSet(k, v)
}
return tree
}
// RegisterNilChecker registers a custom nil checker function for the map values.
// This function is used to determine if a value should be considered as nil.
// The nil checker function takes a value of type V and returns a boolean indicating
// whether the value should be treated as nil.
func (tree *BKVTree[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
tree.mu.Lock()
defer tree.mu.Unlock()
tree.nilChecker = nilChecker
}
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
func (tree *BKVTree[K, V]) isNil(value V) bool {
if tree.nilChecker != nil {
return tree.nilChecker(value)
}
return any(value) == nil
}
// Clone clones and returns a new tree from current tree.
func (tree *BKVTree[K, V]) Clone() *BKVTree[K, V] {
if tree == nil {
@ -494,7 +453,7 @@ func (tree *BKVTree[K, V]) Right() *BKVTreeEntry[K, V] {
//
// It returns value with given `key`.
func (tree *BKVTree[K, V]) doSet(key K, value V) V {
if tree.isNil(value) {
if any(value) == nil {
return value
}
tree.tree.Put(key, value)

View File

@ -24,7 +24,6 @@ type RedBlackKVTree[K comparable, V any] struct {
mu rwmutex.RWMutex
comparator func(v1, v2 K) int
tree *redblacktree.Tree[K, V]
nilChecker NilChecker[V]
}
// RedBlackKVTreeNode is a single element within the tree.
@ -42,15 +41,6 @@ func NewRedBlackKVTree[K comparable, V any](comparator func(v1, v2 K) int, safe
return &tree
}
// NewRedBlackKVTreeWithChecker instantiates a red-black tree with the custom key comparator and `nilChecker`.
// The parameter `safe` is used to specify whether using tree in concurrent-safety, which is false in default.
// The parameter `checker` is used to specify whether the given value is nil.
func NewRedBlackKVTreeWithChecker[K comparable, V any](comparator func(v1, v2 K) int, checker NilChecker[V], safe ...bool) *RedBlackKVTree[K, V] {
t := NewRedBlackKVTree[K, V](comparator, safe...)
t.RegisterNilChecker(checker)
return t
}
// NewRedBlackKVTreeFrom instantiates a red-black tree with the custom key comparator and `data` map.
// The parameter `safe` is used to specify whether using tree in concurrent-safety,
// which is false in default.
@ -60,17 +50,6 @@ func NewRedBlackKVTreeFrom[K comparable, V any](comparator func(v1, v2 K) int, d
return &tree
}
// NewRedBlackKVTreeWithCheckerFrom instantiates a red-black tree with the custom key comparator, `data` map and `nilChecker`.
// The parameter `safe` is used to specify whether using tree in concurrent-safety, which is false in default.
// The parameter `checker` is used to specify whether the given value is nil.
func NewRedBlackKVTreeWithCheckerFrom[K comparable, V any](comparator func(v1, v2 K) int, data map[K]V, checker NilChecker[V], safe ...bool) *RedBlackKVTree[K, V] {
t := NewRedBlackKVTreeWithChecker[K, V](comparator, checker, safe...)
for k, v := range data {
t.doSet(k, v)
}
return t
}
// RedBlackKVTreeInit instantiates a red-black tree with the custom key comparator.
// The parameter `safe` is used to specify whether using tree in concurrent-safety,
// which is false in default.
@ -96,26 +75,6 @@ func RedBlackKVTreeInitFrom[K comparable, V any](tree *RedBlackKVTree[K, V], com
}
}
// RegisterNilChecker registers a custom nil checker function for the map values.
// This function is used to determine if a value should be considered as nil.
// The nil checker function takes a value of type V and returns a boolean indicating
// whether the value should be treated as nil.
func (tree *RedBlackKVTree[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
tree.mu.Lock()
defer tree.mu.Unlock()
tree.nilChecker = nilChecker
}
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
func (tree *RedBlackKVTree[K, V]) isNil(value V) bool {
if tree.nilChecker != nil {
return tree.nilChecker(value)
}
return any(value) == nil
}
// SetComparator sets/changes the comparator for sorting.
func (tree *RedBlackKVTree[K, V]) SetComparator(comparator func(a, b K) int) {
tree.comparator = comparator
@ -230,7 +189,7 @@ func (tree *RedBlackKVTree[K, V]) GetOrSetFunc(key K, f func() V) V {
// GetOrSetFuncLock returns its `value` of `key`, or sets value with returned value of callback function `f` if it does
// not exist and then returns this value.
//
// GetOrSetFuncLock differs with GetOrSetFunc function is that it executes function `f` within mutex lock.
// GetOrSetFuncLock differs with GetOrSetFunc function is that it executes function `f`within mutex lock.
func (tree *RedBlackKVTree[K, V]) GetOrSetFuncLock(key K, f func() V) V {
tree.mu.Lock()
defer tree.mu.Unlock()
@ -633,7 +592,7 @@ func (tree *RedBlackKVTree[K, V]) UnmarshalValue(value any) (err error) {
//
// It returns value with given `key`.
func (tree *RedBlackKVTree[K, V]) doSet(key K, value V) (ret V) {
if tree.isNil(value) {
if any(value) == nil {
return
}
tree.tree.Put(key, value)

View File

@ -46,7 +46,7 @@ func NewRedBlackTreeFrom(comparator func(v1, v2 any) int, data map[any]any, safe
func (tree *RedBlackTree) lazyInit() {
tree.once.Do(func() {
if tree.RedBlackKVTree == nil {
tree.RedBlackKVTree = NewRedBlackKVTree[any, any](gutil.ComparatorTStr[any], false)
tree.RedBlackKVTree = NewRedBlackKVTree[any, any](gutil.ComparatorTStr, false)
}
})
}

View File

@ -1,210 +0,0 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gtree_test
import (
"testing"
"github.com/gogf/gf/v2/container/gtree"
"github.com/gogf/gf/v2/test/gtest"
"github.com/gogf/gf/v2/util/gutil"
)
func Test_KVAVLTree_TypedNil(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Student struct {
Name string
Age int
}
avlTree := gtree.NewAVLKVTree[int, *Student](gutil.ComparatorTStr[int], true)
for i := 0; i < 10; i++ {
if i%2 == 0 {
avlTree.Set(i, &Student{})
} else {
var s *Student = nil
avlTree.Set(i, s)
}
}
t.Assert(avlTree.Size(), 10)
avlTree2 := gtree.NewAVLKVTree[int, *Student](gutil.ComparatorTStr[int], true)
avlTree2.RegisterNilChecker(func(student *Student) bool {
return student == nil
})
for i := 0; i < 10; i++ {
if i%2 == 0 {
avlTree2.Set(i, &Student{})
} else {
var s *Student = nil
avlTree2.Set(i, s)
}
}
t.Assert(avlTree2.Size(), 5)
})
}
func Test_KVBTree_TypedNil(t *testing.T) {
type Student struct {
Name string
Age int
}
gtest.C(t, func(t *gtest.T) {
btree := gtree.NewBKVTree[int, *Student](100, gutil.ComparatorTStr[int], true)
for i := 0; i < 10; i++ {
if i%2 == 0 {
btree.Set(i, &Student{})
} else {
var s *Student = nil
btree.Set(i, s)
}
}
t.Assert(btree.Size(), 10)
btree2 := gtree.NewBKVTree[int, *Student](100, gutil.ComparatorTStr[int], true)
btree2.RegisterNilChecker(func(student *Student) bool {
return student == nil
})
for i := 0; i < 10; i++ {
if i%2 == 0 {
btree2.Set(i, &Student{})
} else {
var s *Student = nil
btree2.Set(i, s)
}
}
t.Assert(btree2.Size(), 5)
})
}
func Test_KVRedBlackTree_TypedNil(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Student struct {
Name string
Age int
}
redBlackTree := gtree.NewRedBlackKVTree[int, *Student](gutil.ComparatorTStr[int], true)
for i := 0; i < 10; i++ {
if i%2 == 0 {
redBlackTree.Set(i, &Student{})
} else {
var s *Student = nil
redBlackTree.Set(i, s)
}
}
t.Assert(redBlackTree.Size(), 10)
redBlackTree2 := gtree.NewRedBlackKVTree[int, *Student](gutil.ComparatorTStr[int], true)
redBlackTree2.RegisterNilChecker(func(student *Student) bool {
return student == nil
})
for i := 0; i < 10; i++ {
if i%2 == 0 {
redBlackTree2.Set(i, &Student{})
} else {
var s *Student = nil
redBlackTree2.Set(i, s)
}
}
t.Assert(redBlackTree2.Size(), 5)
})
}
func Test_NewKVAVLTreeWithChecker_TypedNil(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Student struct {
Name string
Age int
}
avlTree := gtree.NewAVLKVTree[int, *Student](gutil.ComparatorTStr[int], true)
for i := 0; i < 10; i++ {
if i%2 == 0 {
avlTree.Set(i, &Student{})
} else {
var s *Student = nil
avlTree.Set(i, s)
}
}
t.Assert(avlTree.Size(), 10)
avlTree2 := gtree.NewAVLKVTreeWithChecker[int, *Student](gutil.ComparatorTStr[int], func(student *Student) bool {
return student == nil
}, true)
for i := 0; i < 10; i++ {
if i%2 == 0 {
avlTree2.Set(i, &Student{})
} else {
var s *Student = nil
avlTree2.Set(i, s)
}
}
t.Assert(avlTree2.Size(), 5)
})
}
func Test_NewKVBTreeWithChecker_TypedNil(t *testing.T) {
type Student struct {
Name string
Age int
}
gtest.C(t, func(t *gtest.T) {
btree := gtree.NewBKVTree[int, *Student](100, gutil.ComparatorTStr[int], true)
for i := 0; i < 10; i++ {
if i%2 == 0 {
btree.Set(i, &Student{})
} else {
var s *Student = nil
btree.Set(i, s)
}
}
t.Assert(btree.Size(), 10)
btree2 := gtree.NewBKVTreeWithChecker[int, *Student](100, gutil.ComparatorTStr[int], func(student *Student) bool {
return student == nil
}, true)
for i := 0; i < 10; i++ {
if i%2 == 0 {
btree2.Set(i, &Student{})
} else {
var s *Student = nil
btree2.Set(i, s)
}
}
t.Assert(btree2.Size(), 5)
})
}
func Test_NewRedBlackKVTreeWithChecker_TypedNil(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Student struct {
Name string
Age int
}
redBlackTree := gtree.NewRedBlackKVTree[int, *Student](gutil.ComparatorTStr[int], true)
for i := 0; i < 10; i++ {
if i%2 == 0 {
redBlackTree.Set(i, &Student{})
} else {
var s *Student = nil
redBlackTree.Set(i, s)
}
}
t.Assert(redBlackTree.Size(), 10)
redBlackTree2 := gtree.NewRedBlackKVTreeWithChecker[int, *Student](gutil.ComparatorTStr[int], func(student *Student) bool {
return student == nil
}, true)
for i := 0; i < 10; i++ {
if i%2 == 0 {
redBlackTree2.Set(i, &Student{})
} else {
var s *Student = nil
redBlackTree2.Set(i, s)
}
}
t.Assert(redBlackTree2.Size(), 5)
})
}

Some files were not shown because too many files have changed in this diff Show More