Yigo Java Customization

二开类编写规范

基本结构

package com.bokesoft.erp.模块.function;

import com.bokesoft.erp.entity.util.EntityContextAction;
import com.bokesoft.yes.mid.cmd.richdocument.strut.RichDocumentContext;

public class XxxFormula extends EntityContextAction {

    public XxxFormula(RichDocumentContext _context) {
        super(_context);
    }

    // 二开方法
    public 返回值 方法名(参数...) throws Throwable {
        // 业务逻辑
    }
}

关键要求

1. 必须继承 EntityContextAction
2. 构造方法必须接受 RichDocumentContext 参数并调用 super(_context)
3. 方法声明 throws Throwable
4. 在 XML 表达式中通过 com.bokesoft.erp.模块.function.类名.方法名(参数) 调用

BillEntity（表单实体）

BillEntity 是由 YigoCAD 工具自动生成的 Java 类，封装了整个 Form 表单的数据操作。

主要能力

使用示例

// 从上下文解析表单
PM_Strategy strategies = PM_Strategy.parseEntity(_context);

// 读取表头字段
Long unitID = strategies.getStrategyUnitID();
String code = strategies.getCode();

// 设置字段值（链式调用）
strategies.setStrategyUnitID(100L).setCallHorizon(30);

// 遍历明细表
for (EPM_StrategyDtl dtl : strategies.epm_strategyDtls()) {
    Long packageUnitID = dtl.getPackageUnitID();
    int cycleLength = dtl.getCycleLength();
}

// 新增明细行
EPM_StrategyDtl newDtl = strategies.newEPM_StrategyDtl();
newDtl.setPackageNo(1).setCycleNotes("新周期");

// 从数据库加载另一个表单
PM_Strategy other = PM_Strategy.load(_context, targetOID);

字段常量

BillEntity 中为每个控件（Field）生成了 public static final String 常量，格式为：

• 表头字段：字段Key（如 PM_Strategy.SchedulingIndicator）
• 明细字段：Dtl_字段Key（如 PM_Strategy.Dtl_CycleLength）
• 操作：Opt_操作Key（如 PM_Strategy.Opt_DicNew）

TableEntity（表实体）

TableEntity 封装了 DataObject 中某张表的数据，使用 ColumnKey 访问。

与 BillEntity 的区别

使用示例

// 获取 TableEntity
EPM_Strategy tableEntity = strategies.epm_strategy();

// 按 ColumnKey 访问
String code = tableEntity.getCode();
Long clientID = tableEntity.getClientID();

// 动态字段访问
Object value = tableEntity.valueByFieldKey("DuePack1");
tableEntity.valueByFieldKey("DuePack1", "新值");

Loader（数据加载器）

BillEntity/TableEntity 提供 loader(_context) 链式加载器：

// 链式条件查询
List<BK_Unit> unitList = BK_Unit.loader(_context)
    .UnitSystemID(systemID)
    .loadList();

// 单条查询
BK_Unit unit = BK_Unit.loader(_context)
    .Code("d")
    .loadFirst();

// 按 OID 加载
BK_Unit unit = BK_Unit.load(_context, unitID);

SqlString（SQL 查询）

当需要执行自定义 SQL 时，使用 SqlString 防注入拼接：

SqlString sql = new SqlString()
    .append("select * from ", EPP_Routing_MaintenancePack.EPP_Routing_MaintenancePack,
            " where ", EPP_Routing_MaintenancePack.IsRelation, "=")
    .appendPara(1)
    .append(" and PackageShortText = ")
    .appendPara(billDtlID);

DataTable rst = getResultSet(sql);

// 遍历结果
if (rst != null && rst.size() > 0) {
    for (int rowIndex = 0; rowIndex < rst.size(); rowIndex++) {
        Long soid = rst.getLong(rowIndex, "SOID");
        String name = rst.getString(rowIndex, "Name");
    }
}

SqlString 方法

MessageFacade（消息提示）

// 获取消息文本
String msg = MessageFacade.getMsgContent(MessageConstant.MSG_CODE);

// 抛出异常消息（中断操作）
MessageFacade.throwException(MessageConstant.MSG_CODE, param1, param2);

RichDocumentContext 上下文

// 获取当前表单文档
RichDocument doc = _context.getRichDocument();
// 或使用 EntityContextAction 的快捷方法
RichDocument doc = getDocument();

// 执行 SQL
DataTable rst = _context.getResultSet(sqlString);
// 或快捷方法
DataTable rst = getResultSet(sql);

// 获取 Paras 自定义参数
Object para = _context.getParas().get("key");
_context.getParas().put("key", value);

// 获取环境信息
String locale = _context.getEnv().getLocale();

RichDocument（表单数据）

RichDocument doc = getDocument();

// 读写表头字段
Object value = doc.getHeadFieldValue("FieldKey");
doc.setHeadFieldValue("FieldKey", newValue);

// 获取明细表数据
DataTable dtlTable = doc.getDataTable("TableKey");

// 新增明细行
int rowIndex = doc.appendDetail("TableKey");

// 删除明细行
doc.deleteDetail("TableKey", oid);

在 XML 中调用二开方法

<!-- 在控件属性中调用（返回布尔值控制 Enable） -->
<Dict Enable="IIF(ToBool(com.bokesoft.erp.pm.function.StrategiesFormula.isExistStrategiesPackage()),false,!ReadOnly())"/>

<!-- 在 CheckRule 中调用（返回错误消息或空串） -->
<CheckRule><![CDATA[
var msg = com.bokesoft.erp.pm.function.StrategiesFormula.checkCycleLength(SchedulingIndicator, PackageUnitID, CycleLength, IsCycleSet);
IIF(msg!='', msg, true)
]]></CheckRule>

<!-- 在 ItemFilter 中调用（返回 SqlString） -->
<FilterValue Index="1" ParaValue="IIF(SchedulingIndicator&gt;=0, ' soid in ('&amp;com.bokesoft.erp.pm.function.StrategiesFormula.getStrategyUnitIDbyIndicator(SchedulingIndicator)&amp;' )', '1=2')"/>

与其他 Skill 的配合