protoc-gen-gorm 开源项目教程

protoc-gen-gorm 开源项目教程

protoc-gen-gormA protobuf compiler plugin designed to generate GORM models and APIs for simple object persistence tasks.项目地址:https://gitcode.com/gh_mirrors/pr/protoc-gen-gorm

1. 项目的目录结构及介绍

protoc-gen-gorm
├── README.md
├── examples
│   ├── basic
│   │   ├── basic.proto
│   │   └── main.go
│   └── advanced
│       ├── advanced.proto
│       └── main.go
├── gen
│   └── gorm
│       └── gorm.go
├── go.mod
├── go.sum
├── main.go
├── plugin
│   ├── gorm.go
│   └── options.go
└── templates
    └── gorm.go.tpl

• README.md: 项目介绍和使用说明。
• examples: 示例代码目录，包含基本和高级示例。
  • basic: 基本示例，展示如何使用 protoc-gen-gorm 生成基本的 GORM 代码。
  • advanced: 高级示例，展示如何使用更复杂的选项和功能。
• gen: 生成的代码目录，包含 GORM 相关的代码。
• go.mod 和 go.sum: Go 模块文件，用于管理依赖。
• main.go: 项目的主入口文件。
• plugin: 插件代码目录，包含 GORM 插件的核心实现。
• templates: 模板文件目录，包含用于生成代码的 Go 模板。

2. 项目的启动文件介绍

项目的启动文件是 main.go，它定义了插件的入口点，并调用插件代码生成 GORM 代码。以下是 main.go 的关键部分：

package main

import (
	"github.com/infobloxopen/protoc-gen-gorm/plugin"
	"google.golang.org/protobuf/compiler/protogen"
)

func main() {
	protogen.Options{}.Run(func(gen *protogen.Plugin) error {
		for _, f := range gen.Files {
			if !f.Generate {
				continue
			}
			plugin.GenerateFile(gen, f)
		}
		return nil
	})
}

• main 函数: 是程序的入口点，调用 protogen.Options{}.Run 方法来运行插件。
• plugin.GenerateFile: 生成 GORM 代码的核心逻辑，遍历所有需要生成的 Protobuf 文件并生成对应的 GORM 代码。

3. 项目的配置文件介绍

项目没有显式的配置文件，但可以通过 Protobuf 文件中的选项来配置生成的 GORM 代码。以下是一个示例 Protobuf 文件中的配置选项：

syntax = "proto3";

package example;

import "github.com/infobloxopen/protoc-gen-gorm/options/gorm.proto";

message User {
  option (gorm.opts).ormable = true;
  string id = 1 [(gorm.field).tag = {primary_key: true}];
  string name = 2;
  string email = 3;
}

• option (gorm.opts).ormable = true: 指定该消息需要生成 GORM 代码。
• (gorm.field).tag = {primary_key: true}: 指定字段的 GORM 标签，例如设置主键。

通过这些选项，可以在 Protobuf 文件中灵活配置生成的 GORM 代码。

protoc-gen-gormA protobuf compiler plugin designed to generate GORM models and APIs for simple object persistence tasks.项目地址:https://gitcode.com/gh_mirrors/pr/protoc-gen-gorm