diff --git a/llms-full.txt b/llms-full.txt index b5f93ba..fb30d7e 100644 --- a/llms-full.txt +++ b/llms-full.txt @@ -1062,7 +1062,7 @@ DateTime endTime; //会议结束时间 - **如何创建/生成:** RPC有4种创建方式:a.DTO创建后会自动创建RPC,RPC的公开性与DTO的公开性保持一致;b.返回DTO的读方案会根据分页情况、以及是否生成计数函数的配置自动生成非公开的RPC c.写方案创建后会自动生成非公开的RPC d.如果上述三种RPC无法满足需求,则可以通过TOCO创建自定义RPC完整指定功能,需指定具体的参数和返回值以及公开性等。 - **优先复用:** 当用户需要创建一个RPC时,如果用户有明确要求创建的方式,则按照用户的要求来创建。如果没有明确要求,则通常先判断是否可以通过创建读方案、写方案、DTO来使TOCO自动创建出对应的RPC,最后再考虑通过TOCO创建自定义RPC - **自定义RPC和代码中手写方法的关系:** 二者都可以通过手动的方式实现一个服务层的方法,应用场景的区别在于:如果一个方法需要被其他模块订阅,则通常使用自定义RPC;如果一个方法只是某个API私有调用,不需要给外部模块开放,则可以使用代码手写方法 -- **关键配置:** 类名(以Service结尾)、是否公开、方法名(小写字母+下划线)、请求参数、返回值 +- **关键配置:** 类名(驼峰,首字母大写,以Service结尾)、是否公开、方法名(驼峰,首字母小写)、请求参数、返回值 - **参数类型:** RPC的参数**只能**为QTO、BTO、Enum、基本类型,可为单值或列表。注意如果是对象类型,则优先使用QTO、BTO作为参数,**禁止使用**VO、EO和自定义结构如Object - **返回值类型:** RPC的返回值**只能**为DTO、Enum、基本类型,可为单值或列表,**禁止使用**VO、QTO、BTO、EO、自定义结构如Object作为返回值。注意如果是对象类型,则优先使用DTO作为返回值 - **TOCO中json结构描述:** 在TOCO中,DTO使用一个json结构表示,示例如下: @@ -1092,7 +1092,7 @@ requestParams为请求参数列表,response为返回结构,requestParams中 #### **2.14 应用程序接口 (API)** - **定义与用途:** 在TOCO中,API用于定义对外暴露的HTTP接口 - **如何创建/生成:** API一般为通过TOCO创建,需指定具体的参数和返回值等 -- **关键配置:** uri(加粗展示,一般为/api/${moduleName}/xxx,如/api/user/create,全局唯一。如果用户有特殊命名规则的话以用户要求为准)、类名(以Controller结尾)、方法名、请求参数、返回值 +- **关键配置:** uri(加粗展示,一般为/api/${moduleName}/xxx,如/api/user/create,全局唯一。如果用户有特殊命名规则的话以用户要求为准)、类名(以Controller结尾)、方法名(驼峰,首字母小写)、请求参数、返回值 - **参数类型:** API的参数**只能**为QTO、BTO、Enum、基本类型,可为单值或列表。注意如果是对象类型,则优先使用QTO、BTO作为参数。**禁止使用**DTO、EO和自定义结构如Object - **返回值类型:** TOCO的API运行在自己的Java脚手架中,脚手架会自动对API的返回值做一层对象包装(code、message、data)。所以在TOCO中,API的返回值无需考虑返回码和错误信息,只需考虑返回的数据本身。TOCO中API的返回值**只能**为VO、Enum、基本类型,可为单值或列表,**禁止使用**DTO、QTO、BTO、EO、自定义结构如Object作为返回值。注意如果是对象类型,则优先使用VO作为返回值。 - **TOCO中json结构描述:** 在TOCO中,API使用一个json结构表示,示例如下: