Function、Action函数使用规范

Function的定义需要严格遵循Oinone的规范,

  • @Action是指页面上有按钮展示的方法,所有@Action注解的方法都是需要在权限处设置权限才能访问的。Action背后都对应一个Function。
  • @Function是Oinone的可管理的执行逻辑,是无处不在的。
  • 如果只是查询,不需要在页面有按钮,定义为@Function就可以了。

覆写常用默认数据管理器定义标准

    @Action.Advanced(name = FunctionConstants.create, managed = true)//默认取的是方法名
    @Action(displayName = "确定", summary = "添加", bindingType = ViewTypeEnum.FORM)
    public AuthRole create(AuthRole data) {

    @Action.Advanced(type = FunctionTypeEnum.UPDATE, managed = true)
    @Action(displayName = "更新", label = "确定", summary = "修改", bindingType = ViewTypeEnum.FORM)
    public AuthRole update(AuthRole data) {

    @Action.Advanced(type = FunctionTypeEnum.DELETE, managed = true)
    @Action(displayName = "删除", label = "删除", contextType = ActionContextTypeEnum.SINGLE_AND_BATCH)
    @Function.fun(FunctionConstant.deleteWithFieldBatch)
    public List<AuthRole> delete(List<AuthRoe> dataList) {

    @Function.Advanced(displayName = "查询角色列表", type = FunctionTypeEnum.QUERY, category = FunctionCategoryEnum.QUERY_PAGE, managed = true)
    @Function(openLevel = {FunctionOpenEnum.LOCAL, FunctionOpenEnum.REMOTE, FunctionOpenEnum.API})
    public Pagination<AuthRole> queryPage(Pagination<AuthRole> page, IWrapper<AuthRole> queryWrapper) {//注意方法名和入参名称必须和平台保持一致

    @Function.Advanced(displayName = "查询指定角色", type = FunctionTypeEnum.QUERY, category = FunctionCategoryEnum.QUERY_ONE, managed = true)
    @Function.fun(FunctionConstants.queryByEntity)
    @Function(openLevel = {FunctionOpenEnum.LOCAL, FunctionOpenEnum.REMOTE, FunctionOpenEnum.API})
    public AuthRole queryOne(AuthRole query) {//注意方法名和入参名称必须和平台保持一致

自定义函数定义标准

    @Action(displayName = "启用")
    @Action.Advanced(type = FunctionTypeEnum.UPDATE)
    public Teacher dataStatus(Teacher data) {
    }

    @Function
    @Function.Advanced(displayName = "构造", type = FunctionTypeEnum.QUERY)
    public Teacher constructAll(Teacher data) {
    }

注意事项:

  1. 覆写常用默认数据管理器Function定义需要严格按照以上函数定义,包括出入参名字定义、注解定义。定义错误会导致gql请求报错或者找不到函数。
  2. 定义@Action或者@Function时,函数出入参必须是当前类注解定义的@Model.model()的模型,或者被该模型字段全包含的的模型,比如它的父模型。
  3. 页面调用使用的@Action或者@Function方法,出入参必须是oinone的对象,且不能是基础的java类型,因为oinone的对象有元数据信息,这样才能完成前后端之间的自动交互
  4. managed = true定义当前函数为数据管理函数。它只有在重写平台默认数据管理器时需要使用。
  5. @Function.fun()代表定义函数编码,不可更改,默认与方法名称相同。同一个模型Action内不允许有两个相同的函数编码。
  6. 不要使用set、get、unset作为函数方法名的开头,不要使用toString作为函数方法名。
  7. 传输模型没有默认的数据管理器,所以不能定义数据管理函数。

    @Action和@Function注解使用约定

    • 重写内置数据管理器动作和函数的,应与平台注册方式完全保持一致。以下属性可根据需要进行修改:(必须)
    • @Function.Advanced#displayName
    • @Function#openLevel
    • 自定义方法不要与内置数据管理器中定义的动作和函数重名。(必须)
    • @Action和@Function注解不要混合使用。(自定义方法必须)
    • 如无特殊必要,请不要使用如下属性修改函数定义:(自定义方法必须)
    • @Function#name
    • @Function.fun#value
    • @Function.Advanced#managed
    • @Function.Advanced#builtin
    • @Function.Advanced#group
    • @Function.Advanced#version
    • @Action.Advanced#name
    • @Action.Advanced#args
    • @Action.Advanced#managed
    • @Action.Advanced#language
    • 自定义方法在选择注册动作或函数时,应按照如下规则进行判断:(必须)
    • 若该方法通过用户行为触发的,应注册为动作。
    • 若该方法通过“入口”进行控制的,应注册为函数。
    • 自定义方法若注册为动作时,应按照如下规则进行定义:
    • 使用@Action.Advanced#type属性定义函数类型,默认为UPDATE。混合操作的动作应明确列出所有类型。(必须)
    • 使用@Action#displayName属性定义动作功能名称。如无特殊必要,同一模型下的所有动作名称不要重复。页面展示名称重复的,可使用@Action#label属性定义展示名称。(必须)
    • 使用@Action#summary属性定义动作功能简要描述。
    • 使用@Action#contextType属性定义动作上下文类型,默认为SINGLE。(必须)
    • 使用@Action#bindingType属性定义动作所在视图类型,默认为TABLE。(必须)
    • 自定义方法若注册为函数时,应按照如下规则进行定义:
    • 使用@Function.Advanced#type属性定义函数类型,默认为UPDATE。混合操作的函数应明确列出所有类型。(必须)
    • 使用@Function#openLevel属性定义函数开放级别。(必须)
    • 使用@Function.Advanced#displayName属性定义函数功能名称。如无特殊必要,同一命名空间下的所有函数名称不要重复。(必须)
    • 使用@Function#summary属性定义函数功能简要描述。
    • 使用@Function.Advanced#category属性定义函数分类。

更多Function使用详见构建第一个Function

Oinone社区 作者:yexiu原创文章,如若转载,请注明出处:https://doc.oinone.top/wen-ti-zhen-duan/16197.html

访问Oinone官网:https://www.oinone.top获取数式Oinone低代码应用平台体验

(0)
yexiu的头像yexiu数式员工
上一篇 2024年8月19日 pm7:11
下一篇 2024年8月20日 am10:37

相关推荐

  • 保存多值字段SQL执行报错

    定义多值类型时,字段类型应该设置为List类型。 @Field.String @Field(displayName ="经费证明", multi = true, serialize = Field.serialize.JSON) private List<String> matchFund; 场景复现

    2024年8月30日
    56200
  • 跳转动作无权限问题排查

    版本: 5.0.X以上 现象 配置了一个跳转动作,并配置了加载函数。点击跳转到另一个页面,发现弹出“无权限进行该操作”错误。 原因 权限那边配置动作权限也都给了权限,但是为什么会出现这种情况呢?大概率是因为没有配置加载函数的权限,导致报错。 排查路径 5.0.X 以上版本权限控制是通过请求载荷里面的variables参数携带的path路径进行鉴权的。这个path路径是通过菜单名字一层一层拼接的。这个报错的根本原因就是因为这个无权限的请求的path路径下,没有这个加载函数的权限。所以要解决问题很简单,只需要在这个路径下配置上这个加载函数的权限就可以了。 ① 跳转页面是弹窗打开或抽屉打开:这种情况新打开的页面的path路径是不会变的,所使用的还是外面表格页面的路径,所以只需要把该加载函数配置到外面表格页面并隐藏掉,然后在权限那边配置上该动作权限问题就解决了。 ② 跳转页面是新窗口打开,这个时候新打开的页面的path路径是会变成新窗口所在的路径,所以只需要把该加载函数配置到跳转页面上,并隐藏掉,然后在权限那边配置上该动作权限问题也可以解决。 ③ 如果这个加载函数不需要有页面交互,或者页面和函数不属于同一个模型,则可以直接把这个函数改为Function绕过权限验证就好。

    2024年10月29日
    2.2K00
  • 序列化工具使用问题

    后端使用的JSON序列化JsonUtils.toJSONString(nodes);前端使用的JSON序列化PamirsJsonUtils.toJSONString(nodes, SerializerFeature.DisableCircularReferenceDetect, SerializerFeature.WriteDateUseDateFormat, SerializerFeature.BrowserCompatible);注意:用什么工具序列化,就用什么工具反序列化、parse 的时候,要保持一致, 使用PamirsJsonUtils序列化工具主要是为了解决枚举取值错误的问题以及id精度丢失问题。当出现这两个问题的时候,需要使用PamirsJsonUtils 进行序列化。

    2024年9月5日
    86200
  • O2M、M2O、M2M关系字段配置问题以及问题排查路径

    M2O关系字段 配置示例: @Field(displayName = “教师关联学生”) @Field.many2one @Field.Relation(relationFields = {“studentName”}, referenceFields = {“name”}) private Student students; 解析: 在这个多对一关系中,studentName为本模型的字段,name为Student的字段,这个多对一关系通过这两个字段关联起来。 在保存该关联关系时,会将name的值带到studentName里并保存在当前模型中(many) studentName字段必须是存储字段,因为在查询many的数据的时候是通过这个字段进行查询的。 name必须在关系模型即Student里面定义(one),studentName在本模型里面定义不定义都可以,如果没有的话会在本模型中创建该字段。 常见问题: 启动报错:根据报错内容进行相应修改 保存报错:Duplicate entry '******' for key 'PRIMARY',报这个错是因为studentName是唯一键,在将相同name的值赋值给studentName时导致唯一键冲突。其他关系也会有此情况。 O2M关系字段 配置示例: @Field(displayName = "教师关联宠物") @Field.one2many @Field.Relation(relationFields = {"id"}, referenceFields = {"teacherId"}) private List<PetShop> studentsCode; 解析: 在这个一对多关系中,id为本模型的字段,teacherId为PetShop的字段,这个一对多关系通过这两个字段关联起来。 在保存该关联关系时,会将id的值带到teacherId里并保存在PetShop模型中(many) id必须在本模型中定义(one), teacherId在PetShop模型里面定义不定义都可以,如果没有的话会在PetShop模型中创建该字段。 常见问题: 启动报错:根据报错内容进行相应修改 保存报错:请先保存关联关系模型:如果 id 为自定义字段 与 PetShop进行关联,那么保存关联关系时必须给id 赋值,不然会报错 M2M关系字段 配置示例1: @Field.many2many(through = OrderRelLogistics.MODEL_MODEL, relationFields = {"parentOrderId"}, referenceFields = {"logisticsBillId"}) @Field.Relation(relationFields = {"id"}, referenceFields = {"id"}) @Field(displayName = "物流单") private List<LogisticsBill> logisticsBillList; 解析: 在这个多对多关系中,id(左)为本模型的字段,id(右)为PetShop的字段。OrderRelLogistics.MODEL_MODEL为中间表,在保存关联关系时中间表会维护双方的关系字段,id(左)的值写到中间表的parentOrderId字段,id(右)的值写到中间表的logisticsBillId字段。 常见问题: 保存报错,请先保存关联关系模型:如果id(左)为在本模型自定义的字段,则需要在保存关联关系的时候的时候将该自定义赋值,这样才能正确保存关联关系。 配置示例2: 新增TalentTypeEnum @Dict(dictionary = TalentTypeEnum.DICTIONARY,displayName = “达人类型”) public class TalentTypeEnum extends BaseEnum { public static final String DICTIONARY =”top.TalentTypeEnum”; public final static TalentTypeEnum DOG =create(“DOG”,1,”狗达人”,”狗达人”); public final static TalentTypeEnum CAT =create(“CAT”,2,”猫达人”,”猫达人”); } 中间表定义 @Model.model(PetItemRelPetTalent.MODEL_MODEL) @Model(displayName = “中间表”, summary = “中间表”) public class PetItemRelPetTalent extends BaseRelation { public static final String MODEL_MODEL = “top.PetItemRelPetTalent”; @Field.String @Field(displayName = “商店ID”) private String petItemId; @Field.String @Field(displayName = “宠物ID”) private String petTalentId; @Field.String @Field(displayName = “宠物类型”) private TalentTypeEnum talentType; } 关系字段定义(关联关系中,使用”##“包括定义常量,这里定义常量"test") @Field(displayName = “推荐达人”) @Field.many2many( through = PetItemRelPetTalent.MODEL_MODEL, relationFields = {“petItemId”}, referenceFields = {“petTalentId”,”talentType”} ) @Field.Relation(relationFields = {“id”}, referenceFields = {“id”, “#2#”})…

    2024年8月9日
    97000
  • 函数如何跳过权限拦截

    跳过登录直接调用接口 示例: 跳过queryTea的权限验证 @Action(displayName = "queryTea", bindingType = ViewTypeEnum.FORM) @Action.Advanced(type = FunctionTypeEnum.UPDATE) public Teacher queryTea(Teacher data) { } 在yaml文件里面配置上该函数的namespace(模型编码)以及函数名字 pamirs: auth: fun-filter: – namespace: user.PamirsUserTransient fun: login #登录 – namespace: top.Teacher fun: queryTea 不跳过登录直接调用接口 示例: 在yaml文件里面配置上该函数的namespace(模型编码)以及函数名字 pamirs: auth: fun-filter-only-login: #登录后不再校验该函数的权限 – namespace: top.Teacher fun: queryTea 按包设置权限过滤 如何批量跳过权限验证?以上两种方式提供了在yml文件里面配置权限过滤的方式,但如果需要大量过滤权限,配置就变得很繁琐,所以下面主要介绍通过代码扩展的方式去控制权限。 示例: 以下示例通过控制包路径来跳过权限。 继承pro.shushi.pamirs.auth.api.spi.AuthFilterService接口 @Order(88) @Component public class CustomAuthFilterService implements AuthFilterService { public static final String skipClass = "pro.shushi.pamirs.top.core.action"; @Override public Boolean isAccessAction(String model, String name) { //从缓存中取函数 Action cacheAction = PamirsSession.getContext().getExtendCache(ActionCacheApi.class).get(model, name); if (cacheAction instanceof ServerAction) { ServerAction serverAction = (ServerAction) cacheAction; Function function = PamirsSession.getContext().getFunction(serverAction.getModel(), serverAction.getFun()); String clazz = function.getClazz(); //返回true就代表通过验证 if (clazz != null && clazz.startsWith(skipClass)) { return true; } } return null; } } 请求pro.shushi.pamirs.top.core.action路径下的动作可以通过验证。

    2024年8月22日
    82700

Leave a Reply

登录后才能评论