NC65数据库操作实战:从基础查询到安全防御的深度指南
如果你正在用NC65做开发,数据库操作这块绝对是绕不开的核心。无论是简单的单据查询,还是复杂的业务逻辑处理,前后台如何高效、安全地跟数据库打交道,直接决定了代码的质量和系统的稳定性。我见过不少项目,初期为了图快,SQL语句写得随心所欲,等到数据量上来或者遇到安全审计时,问题就全暴露出来了。这篇文章,我想抛开那些官方文档式的罗列,结合我这些年踩过的坑和积累的经验,跟你聊聊NC65里数据库操作那些真正值得注意的细节。我们会从前台、后台、通用三种场景的代码写法入手,但重点会放在如何构建健壮的、可维护的、尤其是能有效防范SQL注入的数据库访问层。这不是一篇简单的API说明书,而是一份力求让你知其然更知其所以然的实战手册。
1. 前台(Client端)数据库操作:精准与高效
在NC65的客户端(通常指UAP客户端)进行数据库操作,核心目标是响应迅速和数据精准。由于直接面向用户操作,每一次查询或更新都应力求在毫秒级内完成,并准确返回界面所需的数据形态。很多开发者习惯在这里拼接SQL字符串,这恰恰是风险的起点。
1.1 核心服务:IUAPQueryBS 的灵活运用
IUAPQueryBS 是前台最常用的查询服务。它的强大之处在于通过不同的 Processor,可以将原始的 ResultSet 自动转换成我们业务开发中直接需要的各种数据结构。
// 获取查询服务实例
IUAPQueryBS queryBS = NCLocator.getInstance().lookup(IUAPQueryBS.class);
String sql = "SELECT pk_material, code, name FROM bd_material WHERE nvl(dr, 0) = 0 AND code LIKE ?";
SQLParameter param = new SQLParameter();
param.addParam("01%"); // 使用参数化查询,防止注入
// 场景一:返回 List<Map<String, Object>>,适用于动态表格渲染
List<Map<String, Object>> mapList = (List<Map<String, Object>>) queryBS.executeQuery(sql, param, new MapListProcessor());
// 场景二:返回特定VO的集合,适用于强类型业务处理
List<MaterialVO> voList = (List<MaterialVO>) queryBS.executeQuery(sql, param, new BeanListProcessor(MaterialVO.class));
// 场景三:返回单列值的集合,例如获取所有物料编码
List<String> codeList = (List<String>) queryBS.executeQuery("SELECT code FROM bd_material WHERE dr=0", new ColumnProcessor("code"));
注意:
NCLocator.getInstance().lookup()是获取NC远程服务标准方式。对于查询类服务,它内部处理了与后台的通信,开发者无需关心网络细节。
不同的 Processor 决定了数据返回的“形状”。选择哪一个,取决于你的后续业务逻辑。这里有个简单的选择参考:
| Processor 类型 | 返回数据类型 | 典型应用场景 |
|---|---|---|
MapListProcessor | List<Map<String, Object>> | 前端表格展示、动态列查询、数据导出 |
BeanListProcessor | List<YourVO> | 业务逻辑处理、流程审批、数据校验 |
ColumnProcessor | List<Object> 或 单值 | 获取下拉框选项、检查唯一性(如编码是否存在) |
ArrayListProcessor | List<Object[]> | 需要同时处理多列但无需映射为VO的复杂计算 |
MapProcessor | Map<String, Object> | 根据主键查询单条记录详情 |
1.2 单据数据查询:HYPubBO_Client
对于基于聚合VO(AggVO)的单据数据查询,NC提供了更上层的封装。如果你已经拿到了单据的表头主键(可能是多个),直接获取完整的单据数据模型是最佳选择。
// 假设我们有一张销售订单的单据,其聚合VO类为 SaleOrderAggVO
String pk_saleorder = "1001A110000000000ABC";
Class aggVOClass = SaleOrderAggVO.class;
String[] pks = new String[]{pk_saleorder};
// 通过主键查询聚合VO
SaleOrderAggVO aggVO = (SaleOrderAggVO) HYPubBO_Client.queryBillVOByPrimaryKey(aggVOClass, pks);
if (aggVO != null) {
// 获取表头VO
SaleOrderHeaderVO headerVO = (SaleOrderHeaderVO) aggVO.getParentVO();
String billCode = headerVO.getVbillcode();
// 获取表体VO数组
SaleOrderItemVO[] itemVOs = (SaleOrderItemVO[]) aggVO.getChildrenVO();
// ... 后续业务逻辑
}
这个方法内部封装了关联子表查询、版本控制(dr, ts)等细节,比自己写SQL拼接AggVO要可靠和高效得多。它特别适用于需要获取完整单据数据进行展示、修改或下游业务触发的场景。
2. 后台(Private端)数据库操作:掌控力与性能
后台(通常指EJB端或私有方法)的数据库操作拥有更高的自由度和更强的掌控力。这里可以使用 BaseDAO 直接执行原生SQL,但随之而来的也是更大的责任——你需要自己管理事务、处理异常,以及,至关重要的,防范安全风险。
2.1 BaseDAO:直接与数据库对话
BaseDAO 是后台最基础的数据库访问工具。它提供了执行查询和更新的核心方法。
// 创建BaseDAO实例
BaseDAO baseDAO = new BaseDAO();
// --- 插入操作 ---
GeneralOutHeadVO newHeadVO = new GeneralOutHeadVO();
// ... 设置newHeadVO的各项属性
try {
HYPubBO.insert(newHeadVO); // 使用HYPubBO插入VO,这是更常用的方式
// 或者,对于非常规插入,可以使用baseDAO.executeUpdate
// String insertSQL = "INSERT INTO ic_generalout_h (pk, vbillcode) VALUES (?, ?)";
// SQLParameter params = new SQLParameter();
// params.addParam(UUID.randomUUID().toString());
// params.addParam("CGD20241101001");
// int affectedRows = baseDAO.executeUpdate(insertSQL, params);
} catch (DAOException e) {
// 必须进行异常处理,记录日志或抛出业务异常
logger.error("插入普通出库单表头失败", e);
throw new BusinessException("保存单据失败");
}
// --- 更新与删除 ---
String updateSQL = "UPDATE bd_material SET name = ? WHERE pk_material = ? AND dr=0";
SQLParameter updateParams = new SQLParameter();
updateParams.addParam("新的物料名称");
updateParams.addParam("1001A110000000001XYZ");
int updatedCount = baseDAO.executeUpdate(updateSQL, updateParams);
if (updatedCount == 0) {
// 可能记录已被逻辑删除或不存在
logger.warn("更新物料失败,记录可能不存在或已删除。");
}
提示:
HYPubBO.insert/update/delete方法内部已经包含了对于dr(删除标记)、ts(时间戳) 等NC底层字段的处理,在操作业务VO时,优先使用这些封装方法,而非自己编写增删改SQL。
2.2 高级查询与自定义结果处理
BaseDAO.executeQuery 的强大之处在于其第二个参数:IProcessor。除了内置的几种Processor,我们可以实现自定义的 BaseProcessor 来处理任何复杂的、非标准的结果集映射。
假设我们需要从一个复杂的多表连接查询中,提取一个特定的、非VO的DTO对象列表:
String complexSql = new StringBuilder()
.append("SELECT m.code as mat_code, m.name as mat_name, c.name as class_name, u.name as unit_name ")
.append("FROM bd_material m ")
.append("LEFT JOIN bd_materialclass c ON m.pk_materialclass = c.pk_materialclass ")
.append("LEFT JOIN bd_measdoc u ON m.pk_measdoc = u.pk_measdoc ")
.append("WHERE m.dr = 0 AND c.dr = 0 ")
.append("AND m.code LIKE ?")
.toString();
SQLParameter param = new SQLParameter();
param.addParam("01%");
List<MaterialDetailDTO> detailList = (List<MaterialDetailDTO>) baseDAO.executeQuery(complexSql, param,
new BaseProcessor() {
private static final long serialVersionUID = 1L;
@Override
public Object processResultSet(ResultSet rs) throws SQLException {
List<MaterialDetailDTO> list = new ArrayList<>();
while (rs.next()) {
MaterialDetailDTO dto = new MaterialDetailDTO();
dto.setMaterialCode(rs.getString("mat_code"));
dto.setMaterialName(rs.getString("mat_name"));
dto.setClassName(rs.getString("class_name"));
dto.setUnitName(rs.getString("unit_name"));
list.add(dto);
}
return list;
}
});
这种方式提供了极大的灵活性,尤其适用于报表查询、数据转换等场景,避免了为了一次性查询而创建大量冗余VO的情况。
3. 前后台通用查询模式:IBillQueryService
有些服务设计之初就是为了同时适应前后台环境,IBillQueryService 就是一个典型代表。它常用于基于复杂条件的单据数据查询。
// 获取服务,此方式前后台均可使用
IBillQueryService queryService = NCLocator.getInstance().lookup(IBillQueryService.class);
// 构建查询条件
String condition = "nvl(dr,0)=0 and vbillstatus >= ? and dbilldate >= ?";
SQLParameter params = new SQLParameter();
params.addParam(2); // 假设状态>=2为已审核
params.addParam(DateUtils.getStartDateOfMonth(new Date())); // 本月单据
// 执行查询,返回指定VO的集合
List<SaleOrderHeaderVO> orderList = queryService.queryBillVOsByCondition(SaleOrderHeaderVO.class, condition, params, null);
// 也可以查询聚合VO
String[] pk_orgs = new String[]{"1001", "1002"};
List<SaleOrderAggVO> aggList = queryService.queryAggVOsByPKs(SaleOrderAggVO.class, pk_orgs);
它的优势在于一致性,同一套查询逻辑,在需要同时支持B/S和C/S端调用时,可以复用代码。但其查询能力通常介于灵活的 BaseDAO 和便捷的 HYPubBO_Client 之间,适合中等复杂度的条件查询。
4. SQL注入防御:从认知到实践的绝对准则
聊了这么多操作数据库的方法,现在我们必须面对最严肃的话题:安全。SQL注入不是危言耸听,而是真实存在、且利用门槛极低的攻击手段。在NC65开发中,防御的核心原则就一条:永远不要将用户输入直接拼接到SQL语句中。
4.1 风险案例:一个搜索框引发的灾难
看看这段危险的代码,在查询物料时,直接拼接了用户输入的 searchKey:
// 危险!绝对禁止!
String userInput = request.getParameter("matCode"); // 用户输入: ' OR '1'='1
String sql = "SELECT * FROM bd_material WHERE code LIKE '%" + userInput + "%' AND dr=0";
List list = baseDAO.executeQuery(sql, new MapListProcessor());
当用户输入 ' OR '1'='1 时,最终的SQL会变成:
SELECT * FROM bd_material WHERE code LIKE '%' OR '1'='1' AND dr=0
WHERE 条件变成了永远为真,攻击者可以泄露整张表的数据。如果用户输入更恶意的 '; DROP TABLE bd_material; --,后果不堪设想。
4.2 正确的防御姿势:参数化查询(SQLParameter)
NC65提供了 SQLParameter 类来完美解决这个问题。它的原理是使用预编译语句(PreparedStatement),将SQL语句结构(命令)和用户提供的数据(参数)分开发送给数据库。数据库先编译命令结构,再将参数作为纯数据处理,从根本上杜绝了将参数解释为SQL命令的可能性。
标准使用范式如下:
StringBuilder safeSql = new StringBuilder();
safeSql.append("SELECT m.pk_material, m.code, m.name, s.stock_num ");
safeSql.append("FROM bd_material m ");
safeSql.append("LEFT JOIN ic_stock_h s ON m.pk_material = s.pk_material ");
safeSql.append("WHERE m.dr = 0 AND s.dr = 0 ");
safeSql.append("AND m.code LIKE ? "); // 使用 ? 作为占位符
safeSql.append("AND s.pk_warehouse = ? ");
safeSql.append("ORDER BY m.code");
SQLParameter params = new SQLParameter();
// 按顺序添加参数,类型会自动匹配
params.addParam("%" + userInputCode + "%"); // 即使这里拼接了%,也是在参数值内部,不是SQL结构
params.addParam(selectedWarehousePk);
// 使用BaseDAO执行
List<Map<String, Object>> result = (List<Map<String, Object>>) baseDAO.executeQuery(safeSql.toString(), params, new MapListProcessor());
// 在IUAPQueryBS中用法完全一样
IUAPQueryBS queryBS = NCLocator.getInstance().lookup(IUAPQueryBS.class);
List<MaterialVO> voResult = (List<MaterialVO>) queryBS.executeQuery(safeSql.toString(), params, new BeanListProcessor(MaterialVO.class));
关键点:
?占位符代表一个参数位置。params.addParam()方法按顺序绑定参数值。- 即使参数值本身包含SQL特殊字符(如单引号),数据库驱动也会对其进行正确的转义处理,确保其仅为数据值。
4.3 不只是查询:增删改同样需要参数化
防御SQL注入适用于所有执行SQL的场景,包括 INSERT、UPDATE、DELETE。
// 用户注册场景,防止注入
String insertUserSql = "INSERT INTO sm_user (pk_user, user_code, user_name, password) VALUES (?, ?, ?, ?)";
SQLParameter insertParams = new SQLParameter();
insertParams.addParam(generatePrimaryKey());
insertParams.addParam(userInputCode); // 来自前端
insertParams.addParam(userInputName); // 来自前端
insertParams.addParam(encryptedPassword); // 加密后的密码
int count = baseDAO.executeUpdate(insertUserSql, insertParams);
// 更新场景
String updateSql = "UPDATE sm_user SET password = ? WHERE user_code = ?";
SQLParameter updateParams = new SQLParameter();
updateParams.addParam(newEncryptedPwd);
updateParams.addParam(userCode);
baseDAO.executeUpdate(updateSql, updateParams);
4.4 额外的安全加固层:输入验证与最小权限原则
参数化查询是基石,但构建纵深防御体系更稳妥。
-
输入验证与过滤:在参数进入SQL之前,进行业务逻辑上的校验。
// 例如,物料编码可能只允许数字和字母 if (!userInputCode.matches("^[A-Za-z0-9]+$")) { throw new BusinessException("物料编码格式非法"); } // 对于日期参数,尝试转换为日期对象,格式错误则抛出异常 try { Date billDate = DateUtils.parseDate(userInputDate, "yyyy-MM-dd"); params.addParam(billDate); } catch (ParseException e) { throw new BusinessException("日期格式错误,应为YYYY-MM-DD"); } -
数据库账户权限最小化:连接NC数据库的应用程序账户,不应拥有
DROP、ALTER等高危权限。在NC体系中,这通常由系统管理员配置,但开发者应有此意识。 -
避免动态拼接表名/列名:有时业务需要动态选择表,如果必须这样做,务必使用白名单机制。
// 错误做法 // String tableName = request.getParameter("table"); // 风险! // String sql = "SELECT * FROM " + tableName; // 正确做法:白名单校验 Map<String, String> allowedTables = new HashMap<>(); allowedTables.put("mat", "bd_material"); allowedTables.put("cust", "bd_customer"); String tableKey = request.getParameter("table"); String safeTableName = allowedTables.get(tableKey); if (safeTableName == null) { throw new BusinessException("非法的数据表请求"); } String sql = "SELECT code, name FROM " + safeTableName + " WHERE dr=0"; // 表名本身不是用户数据,无法参数化,故用白名单。
5. 性能优化与最佳实践锦囊
掌握了安全和基础操作后,如何让数据库交互更快、更稳?这里有几个从实战中总结的要点。
连接与资源管理:
- NC的
BaseDAO、IUAPQueryBS等服务内部已经管理了数据库连接池(如UAP连接池)。开发者通常无需手动获取或关闭连接。但务必注意,不要在循环内部频繁创建BaseDAO或查找(lookup)服务实例,这会造成不必要的开销。
索引意识:
- 编写SQL时,要有意识地考虑是否会利用到索引。
WHERE子句中的条件字段、ORDER BY和JOIN的关联字段,通常是建立索引的候选。 - 避免在WHERE条件中对字段进行函数操作,如
WHERE UPPER(code) = 'ABC',这会导致索引失效。
批量操作:
- 当需要插入或更新大量数据时(如数据初始化、接口导入),使用批量处理能极大提升性能。
BaseDAO dao = new BaseDAO(); String insertSql = "INSERT INTO temp_import_data (pk, biz_code, amount) VALUES (?, ?, ?)"; List<SQLParameter> batchParams = new ArrayList<>(); for (ImportData data : dataList) { SQLParameter param = new SQLParameter(); param.addParam(data.getPk()); param.addParam(data.getBizCode()); param.addParam(data.getAmount()); batchParams.add(param); } // BaseDAO本身可能不直接暴露批处理接口,但可以循环执行,或考虑使用HYPubBO的批量插入VO方法 // 更优的做法是使用NC的批量操作工具类,如BatchProcessor
查询只取所需:
- 使用
SELECT *很方便,但会传输不必要的数据,尤其是在表字段很多或包含大字段(如CLOB)时。明确列出需要的字段。// 不佳 String sql = "SELECT * FROM bd_material WHERE ..."; // 更佳 String sql = "SELECT pk_material, code, name, spec FROM bd_material WHERE ...";
事务边界清晰:
- 在后台Service方法中,一组相关的数据库操作(如保存单据头体)应放在同一个事务中。NC通常通过
@Transaction注解或配置声明事务。确保你的业务方法要么全部成功,要么全部回滚,避免出现数据不一致。
最后,关于日志记录,我建议对执行时间过长的SQL进行监控。可以在开发阶段,在关键数据库操作前后记录时间戳,找出潜在的性能瓶颈。生产环境则可以通过NC的监控工具或数据库自身的慢查询日志来分析。数据库操作没有银弹,真正的技巧来自于对业务场景的深刻理解、对安全纪律的严格遵守,以及不断的实践、测试和调优。把这些点都做到位,你写出的NC65数据访问代码,离稳健和高效就不远了。
100



被折叠的 条评论
为什么被折叠?



