MT接口手册哈尔滨蔬菜批发0716.docx

1、MT接口手册哈尔滨蔬菜批发0716eWeighingPlusWEBSERVICE技术开发手册目录修改历史 31. WEB Service 介绍 41.1 WEB Service 定义 41.2 WEB Service的工作原理 41.3 MT WEB Service架构 51.4 WEB Service方案的益处 62. WEB Service安装、配置 72.1 TOMCAT安装、配置 72.2 JBOSS安装配置 93. MT WEB Service 接口规范 113.1 大小写 113.2 特殊字符说明 113.3 请求 113.4 应答 113.5. 特殊字段类型 124. 详细接口定

2、义 124.1 获取产品列表 124.2 获取仪表配置参数 124.3 获取仪表数据库参数 134.4 获取服务器状态 144.5 打印模板下载 154.6 操作员验证 164.7 获取买卖方会员信息 174.8 上传交易数据 184.9 结账 204.10 补打 214.11 返销 224.12 业务查询 224.13 卖方批次查询 244.14 批次产品查询 255. JSP的编写示例 27修改历史日期修改人修改主题修改清单20120716ljh创建1. WEB Service 介绍1.1 WEB Service 定义WEB Service其实很简单，所谓WEB Service就是定义了一

3、套标准的调用过程：a 服务器首先用一套标准的方法向外界描述它所提供的服务的内容，就属于WSDL。b 客户端需要以一种标准的协议来调用此服务，这属于SOAP。c 服务提供者将服务内容放在一个公共的网址让大家查询，就属于UDDI。XML、SOAP、WSDL、UDDI构成WEB服务的基础图1-11.2 WEB Service的工作原理WEB Service的工作原理分为两步：第一步是在服务器上创造服务并将其在一台“目录服务器”上注册；第二步是客户端查找并调用该服务。服务器：提供WEB service服务客户端：调用WEB service服务目录服务器：提供web service的地址目录，供服务调用

4、者查找。一、生成并注册服务（1）服务器按规格生成服务的类和方法，可以是java的bean，也可以是.net。（2）服务器向“目录服务器”注册自己的这些方法。（3）“目录服务器”对外发布一个可调用的方法（服务）目录（4）客户端向“目录服务器”查找这些服务，获得这些服务的地址之后再去请求服务。在这个过程中，服务器，客户端和目录服务器是三个必需的角色，客户端和服务器都需要知道目录服务器的地址。二、Client和Server之间交互(1) client 生成一个XML WEB service proxy class的对象。(2) client 调用 Proxy object的一个方法 a method

5、. (3)该方法和参数被打包(SOAP)，串行化后通过网络送到服务器侧。. (4) 在服务器侧，XML WEB Service解包，反串行化，来还原方法和参数。这时候，就要生成一个WEB Service的实例，用来调用那个传过来方法和参数。 (5)运行那个神奇的远程方法。 (6) 得到结果后，串行化返回值，通过网络送回Client端。 (7) Client端再反串行化，拿出值来，把这些值送到Proxy 中去。(8) The proxy object 再把这个值转交给Client。1.3 MT WEB Service架构MT WEB Service标准版由于提供最基本的通讯功能，使用最简单的JS

6、P方式，架构比较简单，没有专门的“目录服务器”。用户可以根据自己的需要扩展目录服务器。图1-2所示为 MT WEB Service架构。图1-21.4 WEB Service方案的益处 WEB Service特点以及优势： 1 通讯稳定 与现有的产品方案（MTServer）相比，开源WEB服务器产品（Apache Tomcat、JBoss），经过全世界的开发者的测试，产品性能非常稳定，并且可以免费得到其源代码进行修改。 商业WEB服务器产品性能非常优越（WEBlogic、WEBsphere），并且都经历过全世界大规模商用的考验，并且有其开发公司IBM和Oracle的支持，其稳定性更是有保障。2

7、 扩展性强 采用WEB 服务架构可以在保持接口不变的情况下随意扩展，甚至可以扩展为云。WEB 服务架构是现在流行最广的网络架构，采用XML格式进行通讯，可以无缝和SAP等ERP系统对接，解决了接入客户的信息化管理系统的问题。3 跨平台特性无论是开源WEB服务器产品还是商业WEB服务器产品，都可以完美运行在各种类型操作系统之上。因此，WEB Service具备原生的跨平台支持。4 开发方便客户自己进行最简单的开发只需编写JSP就可以了，更改保存后就生效，开发非常方便。5 维护方便在接入因特网的情况下，可以方便的对客户进行远程维护。2. WEB Service安装、配置2.1 TOMCAT安装、配

8、置 系统需求1安装JDK1.62安装TOMCAT5.53运行TOMCAT 4在浏览器地址栏输入http:/127.0.0.1:8080测试TOMCAT WEB 服务是否运行正常，如果正常的如下显示5数据库模块将数据库驱动（SQL2000驱动mssqlserver.jar、msutil.jar、msbase.jar，Oracle 数据库库驱动为：classes12.jar ）拷贝到C:Program FilesApache Software FoundationTomcat 5.5commonlib目录下6日志模块TOMCAT5.5 自带log4j 日志模块7安装XML解析模块示例使用jdom进

9、行XML解析，将jdom.jar拷贝到C:Program FilesApache Software FoundationTomcat 5.5commonlib目录下8将NM整个目录拷贝到C:Program FilesApache Software FoundationTomcat 5.5WEBapps目录下在浏览器地址栏输入http:/127.0.0.1:8080/NM/ + 相应的模块 +参数，进行数据测试2.2 JBOSS安装配置 系统需求JBOSS是一个运行EJB的J2EE（WEB）应用服务器，也是除IBM公司的WEBSphere和 Oracle公司的WEBLogic之外的唯一的企业级J

10、2EE（WEB）应用服务器。相对于IBM和Oracle高昂的费用，JBOSS开源的，可以在任何商业应用中免费使用它，而不用支付费用。作为企业级J2EE（WEB）应用服务器，我们使用的jboss-5.1.0.GA经过测试，最少需要2G内存，单核2G以上CPU，适当的存储空间等条件，才能比较流畅的运行JBOSS配置专用服务器，能承受较大的数据量，适合大规模的农贸市场1安装jdk1.5.0略2设置JAVA_HOME示例的jdk1.5.0安装在默认目录下，因此JAVA_HOME设置为 C:Program FilesJavajdk1.5.03设置JBOSS_HOME示例将jboss-5.1.0.GA.N

11、M7.2拷贝到计算机E：根目录下，因此将JBOSS_HOME 设置为 E:jboss-5.1.0.GA.NM7.24设置CLASSPATH 在WIN2003 下，CLASSPATH 添加.;%JAVA_HOMElibtools.jar%;%JAVA_HOMElibdt.jar%;%JAVA_HOMEjrelibrt.jar%;E:jboss-5.1.0.GA.NM7.2commonlib5运行JBOSS双击E:jboss-5.1.0.GA.NM7.2 bin run.bat运行JBOSS，在浏览器地址栏输入http:/127.0.0.1:8080测试JBOSSWEB 服务是否运行正常，如果正常

12、的如下显示6拷贝数据库驱动到E:jboss-5.1.0.GA.NM7.2serveralllib目录（SQL2000驱动mssqlserver.jar、msutil.jar、msbase.jar MT已经拷贝到该目录）7日志模块开发进行中。8安装XML解析模块开发进行中。9将MT的农贸接口NM.war整个目录拷贝到jboss-5.1.0.GA.NM7.2serverdefaultdeploy 目录下在浏览器地址栏输入http:/127.0.0.1:8080/NM/ + 相应的模块 +参数，进行数据测试3. MT WEB Service 接口规范3.1 大小写大小写敏感，前后台要求一致，包括js

13、p名、参数名及内部xml标记属性。 单词开头字母使用大写，其余小写。举例：UserCode3.2 特殊字符说明请求与应答的实际参数内容，不得包含以下几种字符：双引号 “单引号 小于 反斜杠 /与 &这几种符号为http及xml的特殊格式字符，一旦实际内容包含此类字符，那么解析出错。3.3 请求样例：http:/127.0.0.1:8080/NM/User.jsp?Req=即：http头 + ip地址 + 端口号 + 模块号 + jsp名称 + ?Req=xml格式参数Xml根节点固定为Request，其下属性或子节点代表不同入参。如果没有参数，那么”?Req=xml格式参数” 部分可以省略。3

14、.4 应答以xml作为前后台之间传送的格式。Xml根节点格式固定，根节点名Response，包含两个属性：Return返回码、ErrorInfo错误提示。ErrorInfo属性为字符串类型，其长度不能超过256个字节。Return = “Success”，表示操作接口成功（校验成功），Return = “Failure”，表示操作接口失败。如果操作失败，Response节点必须包含ErrorInfo属性，一般前台对此属性不作转化，直接向用户提示，ErrorInfo请尽量使用较直观的中文。样例： 1. 2. 3. 3.1. 3.2. 3.3. 3.4. 3.5. 特殊字段类型金额 ： 数值字符串

15、，长度不超过10个字节，一般2位小数，单位元。重量： 数值字符串，长度不超过10个字节。小数位数由秤台的分度而定。4. 详细接口定义4.1 获取产品列表名称ProductList.jsp用途获取产品列表调用说明仪表进行【基础数据更新】时调用该接口。入参英文名解释类型说明OrgCode市场编码长度不超过10个字节。出参英文名解释类型说明ProdCode国标商品编码数字字符串，长度不超过8个字节。ProdName产品名称字符串，长度不超过50个字节。SimpleCode商品简码数字字符串，长度不超过8个字节。调用示例http:/127.0.0.1:8080/NM/ProductList.jsp?R

16、eq=返回示例正确 一个data节点表示一个产品。错误备注国标商品编码与商品简码一一对应，也可以相等。4.2 获取仪表配置参数名称Config.jsp用途获取仪表配置参数。调用说明该接口在仪表启动时调用，获取配置参数后，更新本地数据库。当后台服务器器更新管理员口令，需要重启仪表。若仪表脱机，那么前次联机的数据始终有效。入参英文名解释类型说明出参英文名解释类型说明CompanyId市场名称字符串，长度不超过40个字节。AdminAdmin的密码数字字符串，长度不超过10个字节。Prefix前缀字符串，长度不超过10个字节。IcPassIc卡基本信息区域密码长度为12个字节的字符串。采用16进制文

17、本串：09,af，不区分大小写。调用示例http:/127.0.0.1:8080/NM/Config.jsp返回示例正确 错误备注4.3 获取仪表数据库参数名称Sys.jsp用途获取仪表数据库参数。调用说明设备初始化时调用，进行基础参数设置。（慎用！）入参英文名解释类型说明出参英文名解释类型说明Code参数编码数值字符串，长度不超过10个字节。作为主键，不能重复。Value参数值数值字符串，大小不超过20字符。Name参数名称字符串，长度不超过100个字节。注释用。Remark备注字符串，长度不超过100个字节。调用示例http:/127.0.0.1:8080/NM/Sys.jsp返回示例正确

18、 一个Data标记标识一条数据库配置。错误备注4.4 获取服务器状态名称SystemTime.jsp用途测试网络状态，获取服务器时间，同步仪表本地时间。调用说明该接口在仪表上电时调用，用于同步服务器时间。入参英文名解释类型说明出参英文名解释类型说明DateTime日期时间属性日期格式：yyyy-mm-dd hh:mm:ssyyyy 4位年份mm 2位月份dd 2位日期hh 2位小时，24小时制mm 2位分钟ss 2位秒调用示例http:/127.0.0.1:8080/NM/SystemTime.jsp返回示例正确 2010年10月26日，10点59分14秒错误备注4.5 打印模板下载名称Pri

19、ntTemplate.jsp用途下载打印模板。调用说明仪表进行【基础数据更新】时调用该接口。入参英文名解释类型说明出参英文名解释类型说明完整的打印模板xml文件请参考打印模板设计说明文档。调用示例http:/127.0.0.1:8080/NM/PrintTemplate.jsp返回示例正确 北京XXXXXX市场 IC卡交易流水号: -品名 单价 数量 金额 件数 货款合计:元-买方IC卡号 : 买方姓名:买方手续费 :买方应付 : IC余额 :-货主IC卡号 : 货主编号:货主手续费 :货主应收 :-司磅员: 日期: = 第 联错误超时或非打印模板备注4.6 操作员验证名称User.jsp用途

20、验证操作员权限。调用说明登录、返销、补打时，调用此接口。入参英文名解释类型说明UserCode操作员编码长度不超过10个字节，只允许数字。PassWd密码长度不超过10个字节，只允许数字。OrgCode市场编号同ProductList.jsp中的OrgCode。MeterId仪表编号长度为4个数字字符PassVerify是否需要密码验证1 需要密码校验。0 不需要密码校验。Login登录类型1 正常登录 2退出 3用户验证出参英文名解释类型说明UserName姓名字符串，长度不超过20个字节。UserType类型(操作权限)按字节定义操作权限，长度为10，可扩充。见下方图示。第1字节：交易登录

21、 0无交易权限； 1有第2字节：返销 0无返销权限； 1 有第3字节：补打 0无补打权限； 1有第4字节：汇总 0 汇总本人；1汇总所有； 2无汇总权限例如1111000000，表示可交易、返销、补打、汇总所有。调用示例http:/127.0.0.1:8080/NM/User.jsp?Req=返回示例登录成功 登录失败备注图 操作员权限4.7 获取买卖方会员信息名称Member.jsp用途获取买卖方会员信息。调用说明查询买卖方信息、卖方刷卡或买方刷卡时调用此接口。入参英文名解释类型说明IcSnIc卡物理卡号4个16进制数。IcCode会员主体编码不超过13个字节。IcCode1发卡编号不超过13个字节。PassWd会员密码不超过10个字节。PassVerify是否需要密码验证1 需要密码验证0 不需要密码验证OrgCode市场编号同User.jsp中的OrgCode。出参英文名解释类型说明MemberType会员类型1 卖方 2买方 3万能型Balance余额金额调用示例http:/127.0.0.1:8080/NM/Member.jsp?Req=返回示例正确错误备注卖方刷卡，不需要密码验证；而买方刷卡，支付货币，需要密码验证。4.8 上传交易数据名称Put.jsp用途上传交易数据、买卖方信息，返回交易费率明细，等待结账。调用说明结算交易时