NC65实现Restful接口开发及调试

已于 2023-09-09 16:26:57 修改
阅读量7k 收藏 19
点赞数 6
分类专栏： NC 文章标签： restful java 后端
于 2021-04-29 12:07:20 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010741112/article/details/116265784
版权
  1. 在nchome中的modules里对应的业务模块的META-INF中添加 occ.rest文件，开发项目中也是在项目对应的META-INF下，如图：
    在这里插入图片描述

在这里插入图片描述
在模块的META-INF文件夹下，增加occ.rest扩展名的接口文件，内容为xml格式，参考脚本如下：

<?xml version="1.0" encoding='gb2312'?>
<module>
	<rest>
		<resource classname="nc.pubitf.api.rest.occ.SaleTargetRestResource"  exinfo=""/>
	</rest>
</module>
  1. 在public端（有些人也算放在private端，看个人吧）对应的目录结构下，添加相关的接口处理服务类SaleTargetRestResource，内容如下：
package nc.pubitf.api.rest.occ;

import java.util.ArrayList;
import java.util.List;

import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

import mobile.bc.api.base.PublicRestResource;
import nc.bs.framework.common.NCLocator;
import nc.itf.uap.IUAPQueryBS;
import nc.jdbc.framework.SQLParameter;
import nc.jdbc.framework.processor.BeanListProcessor;
import nc.pubitf.api.rest.base.ErrInfoEnum;
import nc.pubitf.api.rest.base.Response;
import nc.vo.pub.BusinessException;

@Path("/occ/query")
public class SaleTargetRestResource extends PublicRestResource{
	
	private static IUAPQueryBS queryBS = NCLocator.getInstance().lookup(IUAPQueryBS.class);
	
	@POST
	@Path("/sale-target-info")
	@Consumes(MediaType.APPLICATION_JSON)
	@Produces(MediaType.APPLICATION_JSON)
	public String querySaleTarget(QuerySaleTargetInfoRequestParam queryParam) {
		Response<List<SaleTargetInfoVO>> response = new Response<>();
		try {
			queryParam.checkParamIsNull();
		} catch (Exception e) {
			return response.err(ErrInfoEnum.INVLIAD_PARAMS.getCode(), e.getMessage()).toString();
		}
		
		List<SaleTargetInfoVO> targetInfoVO = getSaleTargetInfo(queryParam);
		response.ok(targetInfoVO);
		
		return response.toString();
	}

	@SuppressWarnings("unchecked")
	private List<SaleTargetInfoVO> getSaleTargetInfo(QuerySaleTargetInfoRequestParam queryParam) {
		String sql = "select distinct sr_target.blowsetflag,\r\n" + 
				"                sr_target.dbegindate,\r\n" + 
				"                sr_target.denddate,\r\n" + 
				"                sr_target.fcyclesetflag,\r\n" + 
				"                sr_target.fheadshowflag,\r\n" + 
				"                sr_target.fmaintainflag,\r\n" + 
				"                sr_target.fmarsetflag,\r\n" + 
				"                sr_target.fyearflag,\r\n" + 
				"                sr_target.pk_group,\r\n" + 
				"                sr_target.pk_org,\r\n" + 
				"                sr_target.pk_target,\r\n" + 
				"                sr_target.vcode,\r\n" + 
				"                sr_target.vname,\r\n" + 
				"                sr_target.vnote\r\n" + 
				"  from sr_target sr_target\r\n" + 
				" where sr_target.pk_org = '?'\r\n" + 
				"   and nvl(sr_target.dr, 0) = 0\r\n" + 
				
				" order by sr_target.pk_target";
		
		SQLParameter sqlParam = new SQLParameter();
		sqlParam.addParam(queryParam.getPkOrg());
		
		List<SaleTargetInfoVO> result = new ArrayList<SaleTargetInfoVO>();
		try {
			result = (List<SaleTargetInfoVO>) queryBS.executeQuery(sql, sqlParam, new BeanListProcessor(SaleTargetInfoVO.class));
		} catch (BusinessException e) {
			e.printStackTrace();
		}
		
		return result;
	}
	
}


package nc.pubitf.api.rest.occ;

public class SaleTargetInfoVO {
	/**
	 * 统一设定下级销售组织指标值
	 */
	private String blowsetflag;
	/**
	 * 开始日期
	 */
	private String dbegindate;

	/**
	 * 结束日期
	 */
	private String denddate;

	/**
	 * 指标设定周期
	 */
	private String fcyclesetflag;

	/**
	 * 指标维护表头设置
	 */
	private String fheadshowflag;

	/**
	 * 指标维护方式
	 */
	private String fmaintainflag;

	/**
	 * 物料指标设定方式
	 */
	private String fmarsetflag;

	/**
	 * 年度
	 */
	private String fyearflag;

	/**
	 * 集团
	 */
	private String pk_group;

	/**
	 * 销售组织
	 */
	private String pk_org;

	/**
	 * 指标设置主实体
	 */
	private String pk_target;

	/**
	 * 销售指标表编号
	 */
	private String VCODE = "vcode";

	/**
	 * 销售指标表名称
	 */
	private String vname;

	/**
	 * 备注
	 */
	private String vnote;
	
	public String getBlowsetflag() {
		return blowsetflag;
	}

	public void setBlowsetflag(String blowsetflag) {
		this.blowsetflag = blowsetflag;
	}

	public String getDbegindate() {
		return dbegindate;
	}

	public void setDbegindate(String dbegindate) {
		this.dbegindate = dbegindate;
	}

	public String getDenddate() {
		return denddate;
	}

	public void setDenddate(String denddate) {
		this.denddate = denddate;
	}

	public String getFcyclesetflag() {
		return fcyclesetflag;
	}

	public void setFcyclesetflag(String fcyclesetflag) {
		this.fcyclesetflag = fcyclesetflag;
	}

	public String getFheadshowflag() {
		return fheadshowflag;
	}

	public void setFheadshowflag(String fheadshowflag) {
		this.fheadshowflag = fheadshowflag;
	}

	public String getFmaintainflag() {
		return fmaintainflag;
	}

	public void setFmaintainflag(String fmaintainflag) {
		this.fmaintainflag = fmaintainflag;
	}

	public String getFmarsetflag() {
		return fmarsetflag;
	}

	public void setFmarsetflag(String fmarsetflag) {
		this.fmarsetflag = fmarsetflag;
	}

	public String getFyearflag() {
		return fyearflag;
	}

	public void setFyearflag(String fyearflag) {
		this.fyearflag = fyearflag;
	}

	public String getPk_group() {
		return pk_group;
	}

	public void setPk_group(String pk_group) {
		this.pk_group = pk_group;
	}

	public String getPk_org() {
		return pk_org;
	}

	public void setPk_org(String pk_org) {
		this.pk_org = pk_org;
	}

	public String getPk_target() {
		return pk_target;
	}

	public void setPk_target(String pk_target) {
		this.pk_target = pk_target;
	}

	public String getVCODE() {
		return VCODE;
	}

	public void setVCODE(String vCODE) {
		VCODE = vCODE;
	}

	public String getVname() {
		return vname;
	}

	public void setVname(String vname) {
		this.vname = vname;
	}

	public String getVnote() {
		return vnote;
	}

	public void setVnote(String vnote) {
		this.vnote = vnote;
	}

}


package nc.pubitf.api.rest.base;

import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.Collection;

import javax.validation.constraints.NotNull;

import org.apache.commons.lang.StringUtils;

import nc.vo.pub.BusinessException;

/**
 * Restful请求参数基类
 * 
 * @author tangxyc
 * 
 */
public class BaseRequestParam {

	/**
	 * 通过反射将字段上标识了@NotNull注解的值进行是否为空判断，如果为空则抛出异常
	 * 
	 * @throws Exception
	 */
	public void checkParamIsNull() throws Exception {
		Field[] fields = this.getClass().getDeclaredFields();
		for (Field field : fields) {
			boolean isNotNull = field.isAnnotationPresent(NotNull.class);
			Object fieldValue = getFieldValue(field);
			if (isNotNull
					&& (fieldValue == null
							|| (fieldValue instanceof String && StringUtils
									.isBlank((String) fieldValue)) || (fieldValue instanceof Collection
							&& ((Collection) fieldValue).isEmpty()))) {
				NotNull notNull = field.getAnnotation(NotNull.class);
				throw new BusinessException(notNull.message());
			}
		}
	}

	/**
	 * 通过字段的get方法获取字段值
	 * 
	 * @param field
	 * @return
	 * @throws Exception
	 */
	private Object getFieldValue(Field field) throws Exception {
		Method[] methods = this.getClass().getDeclaredMethods();
		for (Method method : methods) {
			String methodName = method.getName();
			// 通过属性的get方法获取属性值
			if (methodName.startsWith("get")
					&& methodName.substring(3, methodName.length())
							.toLowerCase()
							.equals(field.getName().toLowerCase())) {
				try {
					return method.invoke(this);
				} catch (IllegalAccessException | IllegalArgumentException
						| InvocationTargetException e) {
					throw new Exception("属性" + field.getName() + "的get方法调用异常: "
							+ e.getMessage());
				}
			}
		}
		return null;
	}
}


package nc.pubitf.api.rest.occ;

import javax.validation.constraints.NotNull;

import nc.pubitf.api.rest.base.BaseRequestParam;

/**
 * 根据组织编码查询销售指标
 * 
 * @author 
 *
 */
public class QuerySaleTargetInfoRequestParam extends BaseRequestParam {
	
	@NotNull(message = "组织PK不能为空")
	private String pkOrg;

	private String orgCode;

	private String customerCodes;

	public String getPkOrg() {
		return pkOrg;
	}

	public void setPkOrg(String pkOrg) {
		this.pkOrg = pkOrg;
	}

	public String getOrgCode() {
		return orgCode;
	}

	public void setOrgCode(String orgCode) {
		this.orgCode = orgCode;
	}

	public String getCustomerCodes() {
		return customerCodes;
	}

	public void setCustomerCodes(String customerCodes) {
		this.customerCodes = customerCodes;
	}

}
  1. 部署和测试

将上面的代码部署到bc模块后，重启中间件，Postman测试时，测试URL设置为：http://ip:port/uapws/rest/hanhoobc/occ/sale-target-info，其中/hanhoobc/occ为代码中的类声明中的Path值，而/sale-target-info是方法中的Path指，uapws/rest/为固定的NC65中的REST服务访问路径。Postman中设置请求方式为“POST”，请求HEAD参数Content-Type为application/json即可。效果如下：
在这里插入图片描述

在这里插入图片描述
开发环境调试，可能需要加上项目工程名，如地址“http://127.0.0.1/uapws/rest/NC_project_code/baseInfoRest/getOrgInfo”中的“NC_project_code”就是开发环境的项目工程名
在这里插入图片描述

注意：调试的时候，需要配置自变量，即添加uapws模块（已添加的忽略），不然调试没反应，我看了网上很多资料都没有说这一点，毕竟还是大多数人都是不熟悉这些东西的。配置如图：
在这里插入图片描述

在这里插入图片描述

NC中可以通过/uapws/service查看SOAP协议的接口的部署情况，REST协议的实际也有一个查看REST接口的serverlet，地址为uapws/restmanage,如下图，通过这个地址可以查看已经部署的REST接口清单以及接口所属的模块:
在这里插入图片描述

NCC restful接口笔记
csh_on_route的博客
12-02 2218
ncc 发布restful接口 如环境中没有启用uapws模块，添加vm参数： -Duap.hotwebs=lfw,portal,fs,uapws 1、新建组件模块及接口类，继承AbstractUAPRestResource package nc.kq.md.rest; import javax.ws.rs.Consumes; import javax.ws.rs.POST; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws
NC65接口事例
zbluey的博客
12-26 3486
package nc.bs.gl.ds; import java.io.BufferedReader; import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.io.PrintWriter; import java.net.HttpURLConnection; import
NC65开发WebService接口
四叶猫的博客
06-09 2577
1、public中新建接口 package websfortest2.hello; public interface IHelloWorld { public String sayHelloName(String userid,String name); } 2、private中新建实现类 package websfortest2.hello; public class HelloWorldImpl implements IHelloWorld{ @Override public Strin
NC65客开常见问题以及解决方案
m0_46401054的博客
09-20 1278
复制单据违反唯一约束条件、实体[xxx]没有实现制定的业务接口:nc.itf.uap.pf.metadata.IHeadBodyQueryItf或者是 nc.uap.pf.metadata.HeadBodyQueryImpl、请检查该单据是否定义单据号规则、Error to init aggVOStyle、流程平台缓存中不存在该单据或交易类型、保存单据信息时报is not found in jndi、没有找到设置得单据模板信息、This Attribute is not in the Ref、点击查询得时候
NC65 REST接口开发及调试
Cc_Rain
07-07 2891
NC65中除了支持SOAP协议的webservice接口外，还支持REST协议的接口，NC65的REST服务封装的是restlet，找了很多资料终于弄清楚了，这里总结归纳一下，供朋友们参考： 1、接口注册方法 在模块的META-INF文件夹下，增加.rest扩展名的接口文件，内容为xml格式，参考脚本如下： <?xml version="1.0" encoding='gb2312'?> <module> <rest> <resource c
patch_NC65restful接口_20180629_dingyh5.zip
08-09
NC65通过自带的rest文件检索restful接口，实现对外开放的restful接口，使用方式和其他web系统的使用方法一致，只是规范了访问链接格式
NC65 rest接口 开发 NC65接口开发
左--右
02-27 1193
NC65 rest接口 开发 二、开发接口，继承extends AbstractUAPRestResource，（有的项目会继承别的方法如：AbstractNCCRestResource，MTFRestResource；有的是底层继承ServerResource）一、在对应模块META-INF下编写 xxx.rest 文件,也要放在Home里对应的目录下。把写的接口放在public 或 client 端。三、配置虚拟机参数改端口。四、postman 测试。
NC65采用Restful调用第三方接口示例
东风流浪
08-01 3184
import java.util.UUID; import org.springframework.http.HttpEntity; import org.springframework.http.HttpHeaders; import org.springframework.http.MediaType; import org.springframework.we...
NC65与OA系统接口实现及源码解析
1. NC65与OA接口源码的开发意义 接口源码允许NC65与OA系统在保持各自独立性的同时，能够交换必要的业务数据。例如，当一个公司的采购部门在OA系统中完成订单审批后，这个订单信息需要传送到NC65系统中进行后续的财务...
NC65 webService开发
12-11
UAP平台（NC65）下webService的开发流程，及测试方法（含过程截图）
NC65开发webservice
01-11
NC65开发使用UAP-STUDIO6.5插件来开发和发布WebService
NC6.5凭证接口说明
12-21
根节点标签：voucher （NC接口的默认值，请勿修改） 单据类型：gl （gl代表总账凭证，NC接口的默认值，请勿修改） 凭证类别：记账凭证 (部分账套写着：记帐凭证，请登录NC系统确认) 外部凭证导入到：12200404 (这个代码是NC账套的代码，登录时可见) 接收单位编码：12200404（同上） 外部系统的代码：RIPMS (悦和物业系统，已在NC中定义好，请勿修改) 会计凭证制表人：245_ff (就是可以登录到NC系统的会计人员的代码，请勿任意填写)
NC65开发文档,新手开发必备
04-01
NC65开发文档,开发环境 单据开发 扩展开发 流程开发 报表开发 数据字典,全包括,全方面了解学习NC65开发过程.
【NC65API接口开发】：构建强大的数据交换平台
[【NC65API接口开发】：构建强大的数据交换平台](https://opengraph.githubassets.com/2103e99ec13a8e97c06892349faf85491862d2f948210a9853c4db5b403bece6/Abutalif/simple-api-soap) # 摘要 本文全面介绍了NC65 ...
用友UAP与NC65流程开发：集成企业应用的关键步骤，移动化应用的实现方法
通过对企业应用集成（EAI）的理论框架、流程驱动的开发模式（BPM）以及移动化应用的趋势进行分析，本文揭示了用友UAP与NC65在实现企业流程自动化和移动化中的关键作用。接下来，文章通过实践经验，详细介绍
nc65报表数据中心开发
最新发布
01-08
### NC65 报表数据中心开发概述 NC65报表数据中心主要用于企业级应用中的数据展示和分析功能。通过集成多种图表组件和技术框架，能够实现复杂的数据可视化需求[^1]。 #### 主要技术栈 为了构建高效稳定的报表系统...
ncc开发rest接口
oliver486的博客
04-10 1165
将上面的代码部署到dm模块后，重启中间件，Postman测试时，测试URL设置为：http://ip:port/uapws/rest//hcr/positionclass/add，其中service/hello为代码中的类声明中的Path和方法中的Path，uapws/rest/为固定的NC中的REST服务访问路径。从NC65开始,NC中除了支持SOAP协议的webservice接口外，还支持REST协议的接口，NC65的REST服务封装的是restlet。NCC项目中Rest接口符合restful规范。
评论 20
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值