本文将讲解一下如何正确发起GQL请求和GQL工具使用过程中的常见问题。
请求url和请求方法在浏览器的请求标头里面可以查到，保持一致就可以向服务正常发送请求，但还缺少请求体确定请求哪个接口。
每个请求都包括两部分内容：1. Query 2. Variables
右键Query和Variables复制值直接拷贝到工具中就可以正常请求了。
注意：如果使用admin账号登录，请求的时候可以不携带Variables参数，因为admin没有权限控制，如果使用其他用户，就必须携带Variables参数，否则会被权限拦截。
Oinone社区 作者：yexiu原创文章，如若转载，请注明出处：https://doc.oinone.top/kai-fa-shi-jian/18579.html
访问Oinone官网:https://www.oinone.top获取数式Oinone低代码应用平台体验
GQL GET 请求生成图片文件流 — 技术实现方案 基于 Oinone/Pamirs GQL GET 文件流机制，参考 FileAction#downloadFormData（查询型）与 ExcelExportTaskAction#createExportTask（同步写流），实现「按业务 ID 动态生成图片并输出文件流」的通用指南。 1. 背景与目标 1.1 需求 在业务场景中，需要根据业务 ID（如订单 ID、模板 ID、单据 ID）在后端动态渲染图片（条码、标签、证书、预览图等），并将结果以文件流形式返回给前端。 1.2 约束 复用 Oinone 既有鉴权、会话、模块路由体系，不新增独立 REST 下载接口。 与 Excel 同步导出保持一致的调用方式：通过 GET 访问 /pamirs/{module}?query=…&variables=…。 前端仅两种消费方式： 页面预览：<img :src="imageUrl" /> 触发下载：window.open(imageUrl, '_blank') 2. 参考实现 2.1 查询型文件流（图片查看应对齐此模式） 图片查看属于只读查询，应使用 query + @Function(type = QUERY)，与 CDN 文件下载一致： // @oinone/kunlun-vue-ui-common/…/UploadService.ts const gql = `query{resourceFileFormQuery{downloadFormData(resourceFileForm:{downloadUrl:"${url}"}){filename}}}`; window.open(UrlHelper.appendBasePath(`/pamirs/file?query=${encodeURIComponent(gql)}`), '_blank'); // pamirs-core/pamirs-file2/…/FileAction.java @Function.Advanced(displayName = "前端下载数据", type = FunctionTypeEnum.QUERY) public ResourceFileForm downloadFormData(ResourceFileForm resourceFileForm) { // 直接写 HttpServletResponse 输出流 response.setContentType("application/octet-stream"); response.setHeader("Content-Disposition", "attachment; filename=" + …); IOUtils.copy(inputStream, response.getOutputStream()); return new ResourceFileForm(); } 图片查看用 GQL.query，不用 GQL.mutation。 2.2 同步写流机制（共用） 无论 query 还是 mutation，文件流输出的底层机制相同：在 Function/Action 执行过程中直接写 HttpServletResponse。 2.2.1 HTTP 网关：RequestController GET /pamirs/{moduleName}?query={gql}&variables={json} POST /pamirs/{moduleName} body: { query, variables } GET 与 POST 走同一执行链路： // pamirs-framework/pamirs-gateways-graph-java/…/RequestController.java @RequestMapping(value = "/pamirs/{moduleName}", method = RequestMethod.GET) public DeferredResult<String> pamirsGet( @PathVariable("moduleName") String moduleName, @RequestParam("query") String gql, @RequestParam(value = "variables", required = false) String variables, …) { PamirsClientRequestParam gqlRequest = new PamirsClientRequestParam(); gqlRequest.setQuery(gql); if (!StringUtils.isBlank(variables)) { gqlRequest.setVariables(JsonUtils.parseMap(variables)); } return pamirsPost(moduleName, gqlRequest, request, response); } variables.path 在 RequestHelper.preparePamirsRequestParam 中经 SessionPrepareApi.prepare 注入会话上下文，与前端 getSessionPath() 对应。 2.2.2 Excel 导出对照：ExcelFileServiceImpl#doExportSync Excel 同步导出使用 mutation（createExportTask），因为会创建导出任务记录；图片查看无此副作用，故用 query。 同步导出的关键：劫持 FileClient.upload，将字节直接写入当前…
本文核心是带大家全面了解oinone的序列方式，包括支持的序列化类型、注意点、如果新增客户化序列化方式以及字段默认值的反序列化。 字段序列化方式说明 序列化方式 说明 备注 JSON JSON序列化 主要用于模型相关类型字段的序列化，是@Field.serialize默认选项 DOT 点拼接集合元素 COMMA 逗号拼接集合元素 BIT 按位与，2次幂数求和 非@Field.serialize可选项列表，用于二进制枚举序列化不需要配置，由oinone自动推断 字段序列化方式举例 1、给模型PetItemDetail 增加两个字段：petItemDetails类型为List 和 tags类型为List，并设置为不同的序列化方式，petItemDetails为JSON（缺省就是JSON，可不配），tags为COMMA。2、同时设置 @Field.Advanced(columnDefinition = "varchar(1024)")，防止序列化后存储过长。 @Model.model(PetItem.MODEL_MODEL) @Model(displayName = "宠物商品",summary="宠物商品",labelFields = {"itemName"}) public class PetItem extends AbstractDemoCodeModel{ public static final String MODEL_MODEL="demo.PetItem"; @Field(displayName = "品种") @Field.many2one @Field.Relation(relationFields = {"typeId"},referenceFields = {"id"}) private PetType type; @Field(displayName = "品种类型",invisible = true) private Long typeId; @Field(displayName = "详情", serialize = Field.serialize.JSON, store = NullableBoolEnum.TRUE) @Field.Advanced(columnDefinition = "varchar(1024)") private List<PetItemDetail> petItemDetails; @Field(displayName = "商品标签",serialize = Field.serialize.COMMA,store = NullableBoolEnum.TRUE,multi = true) @Field.Advanced(columnDefinition = "varchar(1024)") private List<String> tags; } 字段序列化注意点 必须使用Field#store属性将字段存储设置为NullableBoolEnum.TRUE。 使用Field#serialize属性指定序列化方式，默认为JSON。 如把PetItemDetail设置为存储模型，须在PetItem的petItemDetails字段上使用Field.Relation#store属性将关联关系存储设置为false。不然会同时存储petItemDetails字段和对应的PetItemDetail表记录 注册自己的序列化器 注册自己的序列化器（实现pro.shushi.pamirs.meta.api.core.orm.serialize.Serializer接口）， 如oinone的DOT的序列化方式，用type()方法返回值做匹配，serialize和deserialize分别对应序列化和反序列化方法。 package pro.shushi.pamirs.framework.compute.serialize; import org.apache.commons.lang3.StringUtils; import org.springframework.stereotype.Component; import pro.shushi.pamirs.meta.annotation.fun.extern.Slf4j; import pro.shushi.pamirs.meta.api.core.orm.serialize.Serializer; import pro.shushi.pamirs.meta.common.constants.CharacterConstants; import pro.shushi.pamirs.meta.enmu.SerializeEnum; import pro.shushi.pamirs.meta.util.TypeUtils; import java.util.ArrayList; import java.util.Collections; import java.util.List; /** * 点表达式序列生成处理器实现 * @author shushi@shushi.pro * @version 1.0.0 */ @SuppressWarnings("rawtypes") @Slf4j @Component public class DotSerializeProcessor implements Serializer<Object, String> { @Override public String serialize(String ltype, Object value) { if (null == value) { return null; } if (List.class.isAssignableFrom(value.getClass())) { return StringUtils.join((List) value, CharacterConstants.SEPARATOR_DOT); } else { return StringUtils.join(Collections.singletonList(value), CharacterConstants.SEPARATOR_DOT); } } @SuppressWarnings("unchecked") @Override public Object deserialize(String ltype, String ltypeT, String value,…
场景描述 在某些场景下，可能需要实现 用户首次登录强制修改密码的功能，或者存在修改平台默认密码等校验规则等需求；本文将讲解不改变平台代码的情况下，如何实现这些功能需求。 首次登录修改密码 方案概述 自定义User增加是否是第一次登录的属性，登录后执行一个扩展点。 判断是否是一次登录，如果是则返回对应的状态码，前端根据状态码重定向到修改密码的页面。修改完成则充值第一次登录的标识。 PS：首次登录的标识平台前端已默认实现 扩展PamirsUser(例如：DemoUser) /** * @author wangxian */ @Model.model(DemoUser.MODEL_MODEL) @Model(displayName = "用户", labelFields = {"nickname"}) @Model.Advanced(index = {"companyId"}) public class DemoUser extends PamirsUser { public static final String MODEL_MODEL = "demo.DemoUser"; @Field.Integer @Field.Advanced(columnDefinition = "bigint DEFAULT '0'") @Field(displayName = "公司ID", invisible = true) private Long companyId; /** * 默认true->1 */ @Field.Boolean @Field.Advanced(columnDefinition = "tinyint(1) DEFAULT '1'") @Field(displayName = "是否首次登录") private Boolean firstLogin; } 定义扩展点接口(实际项目按需要增加和删减接口的定义) import pro.shushi.pamirs.meta.annotation.Ext; import pro.shushi.pamirs.meta.annotation.ExtPoint; import pro.shushi.pamirs.user.api.model.tmodel.PamirsUserTransient; @Ext(PamirsUserTransient.class) public interface PamirsUserTransientExtPoint { @ExtPoint PamirsUserTransient loginAfter(PamirsUserTransient user); @ExtPoint PamirsUserTransient loginCustomAfter(PamirsUserTransient user); @ExtPoint PamirsUserTransient firstResetPasswordAfter(PamirsUserTransient user); @ExtPoint PamirsUserTransient firstResetPasswordBefore(PamirsUserTransient user); @ExtPoint PamirsUserTransient modifyCurrentUserPasswordAfter(PamirsUserTransient user); @ExtPoint PamirsUserTransient modifyCurrentUserPasswordBefore(PamirsUserTransient user); } 编写扩展点实现(例如：DemoUserLoginExtPoint) @Order(0) @Component @Ext(PamirsUserTransient.class) @Slf4j public class DemoUserLoginExtPoint implements PamirsUserTransientExtPoint { @Override @ExtPoint.Implement public PamirsUserTransient loginAfter(PamirsUserTransient user) { return checkFirstLogin(user); } private PamirsUserTransient checkFirstLogin(PamirsUserTransient user) { //首次登录需要修改密码 Long userId = PamirsSession.getUserId(); if (userId == null) { return user; } DemoUser companyUser = new DemoUser().queryById(userId); // 判断用户是否是第一次登录，如果是第一次登录，需要返回错误码，页面重新向登录 Boolean isFirst = companyUser.getFirstLogin(); if (isFirst) { //如果是第一次登录，返回一个标识给前端。 // 首次登录的标识平台已默认实现 user.setBroken(Boolean.TRUE); user.setErrorCode(UserExpEnumerate.USER_FIRST_LOGIN_ERROR.code()); return user; } return user; } @Override public PamirsUserTransient loginCustomAfter(PamirsUserTransient user) { return checkFirstLogin(user); } @Override…
一、背景与问题 Oinone 的树形下拉组件（TreeSelect）和树视图（Tree）在查询数据时，最终调用的是树节点所配置模型的数据管理器函数： 树接口 调用的数据管理器函数 场景 fetchAll queryListByWrapper 一次性全量加载 fetchChildren queryPage 按层级懒加载（默认） queryKeywords4Tree queryListByWrapper 关键字搜索 reverselyQuery queryListByWrapper 已选数据回填 官方文档原文：「所有树查询接口都会调用模型对应的数据管理器函数，可以通过重写的方式修改其查询结果。」 直接覆写的风险 如果直接在原模型（如 business.PamirsDepartment）上覆写 queryPage： // ⚠️ 危险写法：会影响所有使用 PamirsDepartment.queryPage 的场景 @Component @Model.model(PamirsDepartment.MODEL_MODEL) public class DeptQueryAction { @Function.Advanced(type = FunctionTypeEnum.QUERY, category = FunctionCategoryEnum.QUERY_PAGE) @Function.fun(FunctionConstants.queryPage) @Function(openLevel = {FunctionOpenEnum.LOCAL, FunctionOpenEnum.REMOTE, FunctionOpenEnum.API}) public Pagination<PamirsDepartment> queryPage(Pagination<PamirsDepartment> page, IWrapper<PamirsDepartment> queryWrapper) { // 追加过滤条件… return new PamirsDepartment().queryPage(page, queryWrapper); } } 该覆写会全局生效——不仅是树形下拉，所有调用 PamirsDepartment 的 queryPage 的地方（组织架构页面、人员管理列表、权限分配、框架内部关联查询等）都会受到影响，容易引发难以排查的副作用。 二、推荐方案：代理模型（PROXY）隔离 核心思路 创建一个继承原模型的代理模型（ModelTypeEnum.PROXY），拥有独立的模型命名空间 在代理模型中重新声明自关联字段（如 parent），将关联目标指向代理模型自身 在代理模型的 Action 中覆写数据管理器函数，追加树形场景专属的过滤逻辑 树形下拉的视图 DSL 中，<node> 的 model 指向代理模型 代理模型与原模型共享同一张数据表，但函数注册在各自独立的命名空间下，互不干扰。 框架官方示例 Oinone 框架自身就采用了这一模式：ResourceRegionProxyModel 继承 ResourceRegion，用于地区页面的代理展示，其扩展点 ResourceRegionProxyModelExtPoint 中的 queryPageAfter 只影响代理模型自身的查询。 三、完整实现步骤（以 PamirsDepartment 为例） 场景假设 业务需求：某个表单页面的「部门」树形下拉只需要展示当前公司（companyCode == 当前用户公司）且启用状态（dataStatus == ENABLED）的部门，而系统中其他使用 PamirsDepartment 的地方（组织架构、权限管理等）不受影响。 步骤 1：定义代理模型 package com.example.demo.model; import pro.shushi.pamirs.meta.annotation.Field; import pro.shushi.pamirs.meta.annotation.Model; import pro.shushi.pamirs.meta.enmu.ModelTypeEnum; import pro.shushi.pamirs.business.api.model.PamirsDepartment; import java.util.List; /** * 部门树形下拉专用代理模型 * <p> * 继承 PamirsDepartment，共享同一张数据表， * 但拥有独立的函数命名空间，覆写 queryPage 不影响原模型。 */ @Model.model(DeptTreeProxy.MODEL_MODEL) @Model.Advanced(type = ModelTypeEnum.PROXY) @Model(displayName = "部门(树选择)", labelFields = "name") public class DeptTreeProxy extends PamirsDepartment { public static final String MODEL_MODEL = "demo.DeptTreeProxy"; /** * 【必须重新声明】上级部门（自关联字段） * <p> * 基类 PamirsDepartment 中 parent 的类型是 PamirsDepartment， * 代理模型必须将其覆盖为指向自身（DeptTreeProxy）， * 否则设计器/树组件无法在代理模型命名空间内构成完整的自关联关系， * 导致树形下拉无法正确展开层级。 */ @Field.many2one @Field.Relation(relationFields = {"parentCode"}, referenceFields = {"code"}) @Field(displayName = "上级部门")…
总体描述 Oinone有一个非常重要的特性：通过平台承载标准化产品（标品）。针对不同客户的个性化需求，不再直接修改标准产品代码，而是以扩展包的形式进行扩展和定制化，通过继承和重写标准产品的能力来满足客户需求。 本文讲解述怎么通过标品构建扩展工程的过程。 构建标品 按照Oinone的规范构建标品工程 构建扩展包 在定制模块中指定上游模块 上游依赖模块upstreams，模块定义如下： @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface Module { // 显示名称 @AliasFor("displayName") String value() default ""; // 依赖模块名列表 String[] dependencies() default ModuleConstants.MODULE_BASE; // 上游模块名列表 String[] upstreams() default {}; …… 扩展模块示例 @Component @Module( name = SecondModule.MODULE_NAME, displayName = "DEMO扩展", version = "1.0.0", // 指定上游模块（标品模块，可以为多个） upstreams = DemoModule.MODULE_MODULE, priority = 1, dependencies = {ModuleConstants.MODULE_BASE, CommonModule.MODULE_MODULE, UserModule.MODULE_MODULE, AuthModule.MODULE_MODULE, BusinessModule.MODULE_MODULE, // 上游模块（标品模块，可以为多个） DemoModule.MODULE_MODULE, } ) @Module.module(SecondModule.MODULE_MODULE) @Module.Advanced(selfBuilt = true, application = true) @UxHomepage(@UxRoute(model = WorkRecord.MODEL_MODEL)) public class SecondModule implements PamirsModule { public static final String MODULE_MODULE = "demo_core_ext"; public static final String MODULE_NAME = "DemoCoreExt"; @Override public String[] packagePrefix() { return new String[]{ "pro.shushi.pamirs.second" }; } } application.yml配置文件 pamirs: boot: modules: ….. – demo_core // 加标准工程 – demo_core_ext maven配置 父工程依赖 <dependencyManagement> <dependencies> ….. <dependency> <groupId>pro.shushi.pamirs.demo</groupId> <artifactId>pamirs-demo-api</artifactId> <version>1.0.0-SNAPSHOT</version> </dependency> <dependency> <groupId>pro.shushi.pamirs.demo</groupId> <artifactId>pamirs-demo-core</artifactId> <version>1.0.0-SNAPSHOT</version> </dependency> ….. </dependencies> </dependencyManagement> api子工程加入依赖 <dependency> <groupId>pro.shushi.pamirs.demo</groupId> <artifactId>pamirs-demo-api</artifactId> </dependency> boot子工程加入依赖 <dependency> <groupId>pro.shushi.pamirs.demo</groupId> <artifactId>pamirs-demo-core</artifactId> </dependency> 数据库设置 base数据库要跟标品工程一致 注意事项 标品工程的第三方依赖，在扩展工程都要有，否则启动会报错 扩展模块功能开发 菜单扩展 1、可以按需隐藏标品的菜单； 2、可以根据扩展包的实际情况增加菜单； 模型扩展 1、扩展包可继承标品已有模型； 新增字段、覆盖字段，不继承 2、扩展包可根据实际情况新增自有模型； 函数扩展 1、扩展包可根据实际情况【覆写】标品中的函数； 2、扩展包可根据实际情况【新增】自有函数； 3、扩展包可通过Hook机制实现业务的个性化； 4、扩展包可根据自身业务情况实现标品中的扩展点； 5、……
