更新 llms-full.txt
This commit is contained in:
@@ -1168,9 +1168,9 @@ DateTime endTime; //会议结束时间
|
|||||||
```
|
```
|
||||||
- **与API的关系:** BTO通常可作为API的参数,API接收到参数后可直接透传给内部的RPC进行调用,注意BTO只用作写操作的参数,**禁止用作查询参数结构**
|
- **与API的关系:** BTO通常可作为API的参数,API接收到参数后可直接透传给内部的RPC进行调用,注意BTO只用作写操作的参数,**禁止用作查询参数结构**
|
||||||
- **复杂场景处理:** 对于涉及多个写方案的复杂API,可以:
|
- **复杂场景处理:** 对于涉及多个写方案的复杂API,可以:
|
||||||
a. 创建一个主要的写方案,让其BTO作为API入参
|
a. 如果接口有一个主要的写场景,则创建一个主要的写方案,让其自动生成的BTO作为API入参,然后再增加其他基本类型的参数或EO
|
||||||
b. 使用基本类型参数,在流程中转换为各个写方案的BTO
|
b. 使用基本类型参数或EO,在接口执行流程中将基本类型参数转换为各个写方案自动生成的BTO
|
||||||
c. 如果流程过于复杂,优先考虑使用基本类型参数
|
c. 如果流程过于复杂,优先考虑使用基本类型参数或EO
|
||||||
#### **2.13 服务层方法 (RPC)**
|
#### **2.13 服务层方法 (RPC)**
|
||||||
- **定义与用途:** 在TOCO中,RPC为服务层的方法。RPC按照可见性可以分为两种,一种是公开RPC,可以被其他模块订阅,订阅后可以通过RPC适配器进行调用;另一种是非公开RPC,只能被当前模块调用。非公开RPC可以被公开,从而被其他模块订阅并调用
|
- **定义与用途:** 在TOCO中,RPC为服务层的方法。RPC按照可见性可以分为两种,一种是公开RPC,可以被其他模块订阅,订阅后可以通过RPC适配器进行调用;另一种是非公开RPC,只能被当前模块调用。非公开RPC可以被公开,从而被其他模块订阅并调用
|
||||||
- **如何创建/生成:** RPC有4种创建方式:a.DTO创建后会自动创建RPC,RPC的公开性与DTO的公开性保持一致;b.返回DTO的读方案会根据分页情况、以及是否生成计数函数的配置自动生成非公开的RPC c.写方案创建后会自动生成非公开的RPC,返回值为操作的聚合根实体记录的主键字段的值 d.如果上述三种RPC无法满足需求,则可以通过TOCO创建自定义RPC完整指定功能,需指定具体的参数和返回值以及公开性等。
|
- **如何创建/生成:** RPC有4种创建方式:a.DTO创建后会自动创建RPC,RPC的公开性与DTO的公开性保持一致;b.返回DTO的读方案会根据分页情况、以及是否生成计数函数的配置自动生成非公开的RPC c.写方案创建后会自动生成非公开的RPC,返回值为操作的聚合根实体记录的主键字段的值 d.如果上述三种RPC无法满足需求,则可以通过TOCO创建自定义RPC完整指定功能,需指定具体的参数和返回值以及公开性等。
|
||||||
@@ -1208,7 +1208,7 @@ requestParams为请求参数列表,response为返回结构,requestParams中
|
|||||||
- **如何创建/生成:** API一般为通过TOCO创建,需指定具体的参数和返回值等。
|
- **如何创建/生成:** API一般为通过TOCO创建,需指定具体的参数和返回值等。
|
||||||
- **TOCO中API的存储:** 注意API在TOCO中只存储了其URI和方法签名,不存储内部的执行流程逻辑,如果需要了解其内部的实现逻辑,则需要通过阅读API对应的代码。
|
- **TOCO中API的存储:** 注意API在TOCO中只存储了其URI和方法签名,不存储内部的执行流程逻辑,如果需要了解其内部的实现逻辑,则需要通过阅读API对应的代码。
|
||||||
- **关键配置:** uri(加粗展示,一般为/api/${moduleName}/xxx,如/api/user/create,全局唯一。如果用户有特殊命名规则的话以用户要求为准)、类名(以Controller结尾)、方法名(驼峰,首字母小写)、请求参数、返回值。注意如果一个API是分页查询且参数为Qto类型,则Qto中已经包含了分页所需的from、size、scrollId等属性,无需额外为API增加类似参数。
|
- **关键配置:** uri(加粗展示,一般为/api/${moduleName}/xxx,如/api/user/create,全局唯一。如果用户有特殊命名规则的话以用户要求为准)、类名(以Controller结尾)、方法名(驼峰,首字母小写)、请求参数、返回值。注意如果一个API是分页查询且参数为Qto类型,则Qto中已经包含了分页所需的from、size、scrollId等属性,无需额外为API增加类似参数。
|
||||||
- **参数类型:** API的参数**只能**为QTO、BTO、Enum、基本类型,可为单值或列表。注意如果是对象类型,则优先使用QTO、BTO作为参数。**禁止使用**DTO和自定义结构如Object
|
- **参数类型:** API的参数**只能**为读方案自动生成的QTO、写方案自动生成的BTO、EO、Enum、基本类型,可为单值或列表。注意如果是对象类型,则优先使用读方案自动生成的QTO、写方案自动生成的BTO作为参数。**禁止使用**DTO和自定义结构如Object作为参数
|
||||||
- **返回值类型:** TOCO的API运行在自己的Java脚手架中,脚手架会自动对API的返回值做一层对象包装(code、message、data)。所以在TOCO中,API的返回值无需考虑返回码和错误信息,只需考虑返回的数据本身。TOCO中API的返回值**只能**为VO、Enum、基本类型,可为单值或列表,**禁止使用**DTO、QTO、BTO、自定义结构如Object作为返回值。注意如果是对象类型,则优先使用VO作为返回值。
|
- **返回值类型:** TOCO的API运行在自己的Java脚手架中,脚手架会自动对API的返回值做一层对象包装(code、message、data)。所以在TOCO中,API的返回值无需考虑返回码和错误信息,只需考虑返回的数据本身。TOCO中API的返回值**只能**为VO、Enum、基本类型,可为单值或列表,**禁止使用**DTO、QTO、BTO、自定义结构如Object作为返回值。注意如果是对象类型,则优先使用VO作为返回值。
|
||||||
- **TOCO中json结构描述:** 在TOCO中,API使用一个json结构表示,示例如下:
|
- **TOCO中json结构描述:** 在TOCO中,API使用一个json结构表示,示例如下:
|
||||||
```json
|
```json
|
||||||
|
|||||||
Reference in New Issue
Block a user