go项目zero框架中用gentool解决指定表生成结构体被覆盖的解决方案

在使用 GoZero 框架进行项目开发时,gentool 是一个非常方便的工具,它可以根据数据库表结构自动生成 Go 语言结构体和其他相关文件。然而,在使用 gentool 生成结构体时,可能会遇到一个问题:如果多次运行 gentool,它会覆盖已生成的结构体文件,导致之前的自定义更改丢失。

为了避免这种情况,您可以配置 gentool 工具并通过 -c 参数指定配置文件,以确保结构体文件不会被覆盖,或者在生成时保留已有的自定义内容。下面是一个解决方案,帮助您避免在多次生成时覆盖原有的结构体定义。

解决方案:通过 -c "./gen.tool" 参数配置 gentool

1. 配置 gen.tool 文件

首先,您需要创建一个 gen.tool 配置文件,用于定义如何生成文件、哪些文件需要保留以及如何合并生成的代码。

假设您已经有了一个数据库表,我们将生成对应的结构体文件,并避免结构体文件被完全覆盖。

gen.tool 配置文件示例:

json 复制代码
{
  "databases": [
    {
      "name": "your_database_name",        // 数据库名称
      "tables": ["table1", "table2"],      // 需要生成结构体的表
      "output": "./models",                // 结构体输出路径
      "replace": false                     // 防止覆盖文件
    }
  ]
}
  • name:指定数据库的名称。
  • tables:列出需要生成结构体的表名称。
  • output:指定生成的结构体文件的输出目录。
  • replace :设置为 false,防止 gentool 工具覆盖已有的结构体文件。这样,在结构体文件已经存在的情况下,gentool 会跳过已生成的文件。

2. 使用 gentool 命令生成代码

在项目根目录下,您可以使用以下命令来执行 gentool,并通过 -c 参数指定配置文件路径:

bash 复制代码
gentool -c "./gen.tool"
  • -c "./gen.tool" :指定您的 gen.tool 配置文件路径。
  • gentool 会根据配置文件的内容,自动生成相应的 Go 结构体,并将其输出到您指定的路径。如果配置了 replace: falsegentool 会避免覆盖已经存在的结构体文件。

3. 合并自定义代码

如果您已经手动修改了生成的结构体文件,您可以将自定义代码和 gentool 生成的代码分开管理,或者使用结构体的嵌入式方法(例如,组合 Model 结构体),这样即使 gentool 更新生成的文件,您的自定义代码仍然能够保持不变。

例如,使用组合(Embedding)来分离自动生成的部分和手动修改的部分:

go 复制代码
package models

import "time"

// 生成的结构体
type User struct {
    ID        int64     `json:"id"`
    Name      string    `json:"name"`
    CreatedAt time.Time `json:"created_at"`
    UpdatedAt time.Time `json:"updated_at"`
}

// 手动扩展的部分
type UserWithExtra struct {
    User   // 组合生成的结构体
    ExtraInfo string `json:"extra_info"` // 自定义字段
}

在这种方式下,即使重新生成了 User 结构体,您仍然可以在 UserWithExtra 中添加您自己的字段或方法,而不会受到影响。

4. 生成后的注意事项

  • 确保在每次运行 gentool 之前,您已经正确配置了 gen.tool 文件,并根据需要调整 replace 设置。
  • 如果您有其他工具或手动修改的部分,建议通过 Git 或其他版本控制工具来管理生成的代码,以便更好地跟踪每次变动。

5. 总结

通过配置 gentool 并使用 -c "./gen.tool" 参数,您可以有效地避免自动生成的 Go 结构体文件被覆盖,保持手动修改的代码不受影响。通过适当的配置文件和文件管理策略,您可以在多次生成代码时,仍然能够保留自定义的代码部分。

此外,使用组合模式(embedding)或者将生成的代码与自定义代码分开管理,是避免结构体文件被覆盖的好方法。

相关推荐
1-programmer2 分钟前
【Go研究】Go语言脚本化的可行性——yaegi项目体验
开发语言·后端·golang
长安不及十里26 分钟前
Spring Security 搭建一套基于 JWT 的 OAuth 2.0 架构
数据库·spring·架构
我命由我123451 小时前
27.Java 线程间通信(synchronized 实现线程间通信、Lock 实现线程间通信)
java·开发语言·后端·java-ee·intellij-idea·juc·后端开发
星辰大海的精灵1 小时前
SpringBoot 整合 Elastic-Job 实现任务分布式调度
java·spring boot·后端
qxlxi1 小时前
【mybatis】Mybatis整体架构解析
架构·mybatis
XianxinMao1 小时前
云架构:考量与框架
架构
Q_19284999061 小时前
基于Spring Boot微信小程序电影管理系统
spring boot·后端·微信小程序
qq_171538851 小时前
Spring Cloud微服务多模块架构:父子工程搭建实践
spring cloud·微服务·架构
念言-ny2 小时前
springboot远程链接Hadoop
hadoop·spring boot·后端
Alan CGH2 小时前
高并发写利器-组提交,我的Spring组件实战
java·后端·spring