Skills 设计思路分享｜一键实现 OneService 接口调用

项目背景

未初始化 OS

已初始化 OS

设计思路

SKILL.md

---name: GenerateOSMethoddescription: 生成OnsService API调用方法---## 前置条件#### 1.检查当前项目的infra目录中是否存在OneService的相关目录，并引入OneService的SDK并初始化好Client#### 2.若当前项目未引入OneService的SDK或未初始化Client，请先引入并初始化好Client，按照以下步骤：- 导入OneService的工具库，终端输入`go get xxx/xxx/sqlclient`- 在infra目录下创建one_service目录，用于存放OneService的相关代码，包括Client的初始化代码- 在one_service目录下创建client.go文件，用于初始化OneService的Client，代码示例如下：```gopackage one_serviceimport("xxx/xxx/sqlclient""xxx/xxx/logs""xxx/xxx/utils""context""sync")var Client *sqlclient.SQLClientvar once sync.Oncefunc InitOneService(){if Client != nil {return    }    once.Do(func() {// init client       var err error       Client, err = sqlclient.NewSqlClient()if err != nil {          panic(err)       }    })}func SqlQuery(ctx context.Context, id string, sql string, res interface{}) error {    err := Client.SqlQuery(ctx, id, sql, res)if err != nil {       logs.CtxError(ctx, "[SqlQuery] query sql failed.id:%s,sql:%s,err:%s", id, sql, err.Error())return err    }return nil}func QueryWithParam(ctx context.Context, id string, param map[string]interface{}, res interface{}) error {    err := Client.QueryWithParams(ctx, id, param, res)if err != nil {       logs.CtxError(ctx, "[QueryWithParam] query sql failed.id:%s,param:%s,err:%s", id, utils.JsonMarshal(ctx, param), err.Error())return err    }return nil}```- 将InitOneService方法添加到infra目录下的init.go文件中，确保Client在项目启动时就被初始化好- 如果当前项目的infra目录下已经存在OneService的相关目录，并有了初始化好的Client，检查是否有SqlQuery或QueryWithParam方法，没有则新增## 规定#### 1.你只有在以下情况下才需要使用GenerateOSMethod SKILL，使用前先检查前置条件- 用户提到需要使用/新增OnsService接口- 用户提供的代码生成链路文档、技术方案文档当中提到需要使用/新增OnsService接口#### 2.你必须严格按照SKILL.md文件中规定的【流程】进行操作，不能偏离流程，只能在流程规定的阶段生成代码#### 3.生成的API描述，参考api_description.md文件中的示例，保存到api_description.md文件中#### 4.新增一个go文件，存放到infra/one_service目录（或者已有的infra下的其他OneService相关目录）下，新增的代码（API ID，调用方法，SQL语句，请求参数，响应参数）都存放到新增的go文件中，参考examples.md文件中的示例---## 流程### 1. 检查用户是否输入了需要调用的OnsService的API ID检查用户输入内容和文档当中是否明确指出了需要调用的OnsService的API ID如果没有明确列出，请让用户输入确认需要调用的OnsService的API ID### 2. 遍历当前已有OnsService API调用方法在api_description.md文件中遍历所有定义好的OnsService的API ID通过API ID进行匹配，检查是否已存在调用当前OneService API的方法如果用户输入多个API ID，遍历每个ID进行匹配，然后列出每个API ID的调用方法的存在情况### 3. 检查用户是否确认调用/新增OnsService接口上一步列出所有输入的API ID的调用方法的存在情况的列表，发送给用户，让用户确认- 匹配到已有的OneService API调用方法，提示用户是否直接使用- 如果没有匹配到已有的OneService API调用方法，提示用户确认是否新增### 4. 收集OnsService API信息- 如果用户确认直接使用，直接使用已有的调用方法- 如果用户确认新增，提示用户输入新增的OneService API的相关信息，包括API ID、SQL语句、请求参数、响应参数等### 5. 生成OnsService API相关代码根据用户输入的接口信息，需要生成以下内容- api_description.md文件中新增对应API ID的描述，参考api_description.md文件中的示例- 根据用户的输入，结合examples.md文件里的示例，生成新的go文件，存放到infra/one_service目录下- 最终的效果，应该是只在infra/one_service目录（或者已有的infra下的其他OneService相关目录）下新增一个go文件，在api_description.md文件中新增对应API  ID的描述

examples.md

---
name：examplesdescription：OnsService的API调用方法代码示例---方式一：用户输入的是请求参数，调用QueryWithParams方法查询示例数据```gopackage one_serviceimport("context""xxx/xxx/jsonx""xxx/xxx/logs")const(// 示例API ID    OneServiceAppId_Example = xxxxxxxx)type ExampleData struct {    ExampleID int64 `gorm:"column:example_id"` // 示例ID}// 查询示例数据func GetExampleData(ctx context.Context, exampleIds []int64)(map[int64]*ExampleData, error){iflen(exampleIds)== 0 {return nil, nil    }// OneService入参    params := map[string]interface{}{}// 示例ID列表    params["example_ids"] = exampleIds// OneService出参    var rpcResp []*ExampleData// 调用 OneService SQL 查询数据    err := QueryWithParams(ctx, OneServiceAppId_Example, params, &rpcResp)if err != nil {       logs.CtxError(ctx, "GetExampleData QueryWithParams err:%v", err)return nil, err    }    logs.CtxInfo(ctx, "GetExampleData appID %v, req is %v, resp is %v", OneServiceAppId_Example, jsonx.ToString(params), jsonx.ToString(rpcResp))    result := make(map[int64]*ExampleData, len(rpcResp))for _, item := range rpcResp {if item == nil {continue       }// 以 example_id 为 key 聚合       result[item.ExampleID] = item    }return result, nil}```方式二：用户输入的是SQL语句，调用SqlQuery方法查询示例数据```gopackage one_serviceimport ("context""fmt""strings""xxx/xxx/jsonx""xxx/xxx/logs""xxx/xxx/utils/conv")const (// 示例API ID    OneServiceAppId_Example = xxxxxxxx)type ExampleData struct {    ExampleID int64 `gorm:"column:example_id"` // 示例ID}const (// 示例SQL    ExampleSql = "select example_id from example_table where example_id in (:example_ids)")// 查询示例数据func GetExampleData(ctx context.Context, exampleIds []int64) (map[int64]*ExampleData, error) {if len(exampleIds) == 0 {return nil, nil    }// OneService出参    var rpcResp []*ExampleData// 调用 OneService SQL 查询数据    err := SqlQuery(ctx, OneServiceAppId_Example, ExampleSql, &rpcResp)if err != nil {       logs.CtxError(ctx, "GetExampleData SqlQuery err:%v", err)return nil, err    }    logs.CtxInfo(ctx, "GetExampleData appID %v, req is %v, resp is %v",       OneServiceAppId_Example,       fmt.Sprintf(ExampleSql, strings.Join(conv.Int64sToStrs(exampleIds), ",")),       jsonx.ToString(rpcResp))    result := make(map[int64]*ExampleData, len(rpcResp))for _, item := range rpcResp {if item == nil {continue       }// 以 example_id 为 key 聚合       result[item.ExampleID] = item    }return result, nil}
```

api_description.md

---
name：api_descriptiondescription：OnsService的API描述---## 接口列表### API 名称（方式一示例，生成代码参考examples.md）API ID：用户输入生成代码文件：根据API名称生成对应的go文件请求参数| 参数名称    | 参数类型       | 是否必须 | 参数描述   ||:--------|:-----------|:-----|:-------|| xxx_ids | array[int] | 否    | xxid列表 ||         |            |      |        |返回参数| 参数名称   | 参数类型 | 是否必须 | 参数描述 ||:-------|:-----|:-----|:-----|| xxx_id | int  | 否    | xxid ||        |      |      |      |---### API 名称（方式二示例，生成代码参考examples.md）API ID：用户输入生成代码文件：根据API名称生成对应的go文件请求SQL：select ...请求参数| 参数名称    | 参数类型       | 是否必须 | 参数描述   ||:--------|:-----------|:-----|:-------|| xxx_ids | array[int] | 否    | xxid列表 ||         |            |      |        |返回参数| 参数名称   | 参数类型 | 是否必须 | 参数描述 ||:-------|:-----|:-----|:-----|| xxx_id | int  | 否    | xxid ||        |      |      |      |
---