MT接口手册哈尔滨蔬菜批发0716.docx
《MT接口手册哈尔滨蔬菜批发0716.docx》由会员分享，可在线阅读，更多相关《MT接口手册哈尔滨蔬菜批发0716.docx（33页珍藏版）》请在冰豆网上搜索。
MT接口手册哈尔滨蔬菜批发0716
eWeighingⅡPlus
WEBSERVICE
技术开发手册
目录
修改历史3
1.WEBService介绍4
1.1WEBService定义4
1.2WEBService的工作原理4
1.3MTWEBService架构5
1.4WEBService方案的益处6
2.WEBService安装、配置7
2.1TOMCAT安装、配置7
2.2JBOSS安装配置9
3.MTWEBService接口规范11
3.1大小写11
3.2特殊字符说明11
3.3请求11
3.4应答11
3.5.特殊字段类型12
4.详细接口定义12
4.1获取产品列表12
4.2获取仪表配置参数12
4.3获取仪表数据库参数13
4.4获取服务器状态14
4.5打印模板下载15
4.6操作员验证16
4.7获取买卖方会员信息17
4.8上传交易数据18
4.9结账20
4.10补打21
4.11返销22
4.12业务查询22
4.13卖方批次查询24
4.14批次产品查询25
5.JSP的编写示例27
修改历史
日期
修改人
修改主题
修改清单
20120716
ljh
创建
1.WEBService介绍
1.1WEBService定义
WEBService其实很简单，所谓WEBService就是定义了一套标准的调用过程：
a服务器首先用一套标准的方法向外界描述它所提供的服务的内容，就属于WSDL。
b客户端需要以一种标准的协议来调用此服务，这属于SOAP。
c服务提供者将服务内容放在一个公共的网址让大家查询，就属于UDDI。
XML、SOAP、WSDL、UDDI构成WEB服务的基础
图1-1
1.2WEBService的工作原理
WEBService的工作原理分为两步：
第一步是在服务器上创造服务并将其在一台“目录服务器”上注册；
第二步是客户端查找并调用该服务。
服务器：
提供WEBservice服务
客户端：
调用WEBservice服务
目录服务器：
提供webservice的地址目录，供服务调用者查找。
一、生成并注册服务
（1）服务器按规格生成服务的类和方法，可以是java的bean，也可以是.net。
（2）服务器向“目录服务器”注册自己的这些方法。
（3）“目录服务器”对外发布一个可调用的方法（服务）目录
（4）客户端向“目录服务器”查找这些服务，获得这些服务的地址之后再去请求服务。
在这个过程中，服务器，客户端和目录服务器是三个必需的角色，客户端和服务器都需要知道目录服务器的地址。
二、Client和Server之间交互
（1）client生成一个XMLWEBserviceproxyclass的对象。
（2）client调用Proxyobject的一个方法amethod.
（3）该方法和参数被打包（SOAP），串行化后通过网络送到服务器侧。
.
（4）在服务器侧，XMLWEBService解包，反串行化，来还原方法和参数。
这时候，就要生成一个WEBService的实例，用来调用那个传过来方法和参数。
（5）运行那个神奇的远程方法。
（6）得到结果后，串行化返回值，通过网络送回Client端。
（7）Client端再反串行化，拿出值来，把这些值送到Proxy中去。
（8）Theproxyobject再把这个值转交给Client。
1.3MTWEBService架构
MTWEBService标准版由于提供最基本的通讯功能，使用最简单的JSP方式，架构比较简单，没有专门的“目录服务器”。
用户可以根据自己的需要扩展目录服务器。
图1-2所示为MTWEBService架构。
图1-2
1.4WEBService方案的益处
WEBService特点以及优势：
1．通讯稳定
与现有的产品方案（MTServer）相比，开源WEB服务器产品（ApacheTomcat、JBoss），经过全世界的开发者的测试，产品性能非常稳定，并且可以免费得到其源代码进行修改。
商业WEB服务器产品性能非常优越（WEBlogic、WEBsphere），并且都经历过全世界大规模商用的考验，并且有其开发公司IBM和Oracle的支持，其稳定性更是有保障。
2．扩展性强
采用WEB服务架构可以在保持接口不变的情况下随意扩展，甚至可以扩展为云。
WEB服务架构是现在流行最广的网络架构，采用XML格式进行通讯，可以无缝和SAP等ERP系统对接，解决了接入客户的信息化管理系统的问题。
3．跨平台特性
无论是开源WEB服务器产品还是商业WEB服务器产品，都可以完美运行在各种类型操作系统之上。
因此，WEBService具备原生的跨平台支持。
4．开发方便
客户自己进行最简单的开发只需编写JSP就可以了，更改保存后就生效，开发非常方便。
5．维护方便
在接入因特网的情况下，可以方便的对客户进行远程维护。
2.WEBService安装、配置
2.1TOMCAT安装、配置
系统需求
1．安装JDK1.6
2．安装TOMCAT5.5
3．运行TOMCAT
4．在浏览器地址栏输入http:
//127.0.0.1:
8080测试TOMCATWEB服务是否运行正常，如果正常的如下显示
5．数据库模块
将数据库驱动（SQL2000驱动mssqlserver.jar、msutil.jar、msbase.jar，Oracle数据库库驱动为：
classes12.jar）拷贝到C:
\ProgramFiles\ApacheSoftwareFoundation\Tomcat5.5\common\lib目录下
6．日志模块
TOMCAT5.5自带log4j日志模块
7．安装XML解析模块
示例使用jdom进行XML解析，将jdom.jar拷贝到C:
\ProgramFiles\ApacheSoftwareFoundation\Tomcat5.5\common\lib目录下
8．将NM整个目录拷贝到C:
\ProgramFiles\ApacheSoftwareFoundation\Tomcat5.5\WEBapps目录下
在浏览器地址栏输入http:
//127.0.0.1:
8080/NM/+相应的模块+参数，进行数据测试
2.2JBOSS安装配置
系统需求
JBOSS是一个运行EJB的J2EE（WEB）应用服务器，也是除IBM公司的WEBSphere和Oracle公司的WEBLogic之外的唯一的企业级J2EE（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:
\ProgramFiles\Java\jdk1.5.0
3．设置JBOSS_HOME
示例将jboss-5.1.0.GA.NM7.2拷贝到计算机E：
根目录下，因此将JBOSS_HOME设置为E:
\jboss-5.1.0.GA.NM7.2
4．设置CLASSPATH
在WIN2003下，CLASSPATH添加
.;%JAVA_HOME\lib\tools.jar%;%JAVA_HOME\lib\dt.jar%;%JAVA_HOME\jre\lib\rt.jar%;E:
\jboss-5.1.0.GA.NM7.2\common\lib
5．运行JBOSS
双击E:
\jboss-5.1.0.GA.NM7.2\bin\run.bat运行JBOSS，在浏览器地址栏输入http:
//127.0.0.1:
8080测试JBOSSWEB服务是否运行正常，如果正常的如下显示
6．拷贝数据库驱动到E:
\jboss-5.1.0.GA.NM7.2\server\all\lib目录（SQL2000驱动mssqlserver.jar、msutil.jar、msbase.jarMT已经拷贝到该目录）
7．日志模块
开发进行中。
。
。
8．安装XML解析模块
开发进行中。
。
。
9．将MT的农贸接口NM.war整个目录拷贝到jboss-5.1.0.GA.NM7.2\server\default\deploy\目录下
在浏览器地址栏输入http:
//127.0.0.1:
8080/NM/+相应的模块+参数，进行数据测试
3.MTWEBService接口规范
3.1大小写
大小写敏感，前后台要求一致，包括jsp名、参数名及内部xml标记属性。
单词开头字母使用大写，其余小写。
举例：
UserCode
3.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.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.特殊字段类型
金额：
数值字符串，长度不超过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?
Req=
返回示例
正确
一个data节点表示一个产品。
错误
”/>
备注
国标商品编码与商品简码一一对应，也可以相等。
4.2获取仪表配置参数
名称
Config.jsp
用途
获取仪表配置参数。
调用说明
该接口在仪表启动时调用，获取配置参数后，更新本地数据库。
当后台服务器器更新管理员口令，需要重启仪表。
若仪表脱机，那么前次联机的数据始终
有效。
入参
英文名
解释
类型说明
出参
英文名
解释
类型说明
CompanyId
市场名称
字符串，长度不超过40个字节。
Admin
Admin的密码
数字字符串，长度不超过10个字节。
Prefix
前缀
字符串，长度不超过10个字节。
IcPass
Ic卡基本信息区域密码
长度为12个字节的字符串。
采用16进制文本串：
0~9,a~f，不区分大小写。
调用示例
http:
//127.0.0.1:
8080/NM/Config.jsp
返回示例
正确
Prefix=“MT”IcPass=”6a7a01544c44”/>
错误
备注
4.3获取仪表数据库参数
名称
Sys.jsp
用途
获取仪表数据库参数。
调用说明
设备初始化时调用，进行基础参数设置。
（慎用！
）
入参
英文名
解释
类型说明
出参
英文名
解释
类型说明
Code
参数编码
数值字符串，长度不超过10个字节。
作为主键，不能重复。
Value
参数值
数值字符串，大小不超过20字符。
Name
参数名称
字符串，长度不超过100个字节。
注释用。
Remark
备注
字符串，长度不超过100个字节。
调用示例
http:
//127.0.0.1:
8080/NM/Sys.jsp
返回示例
正确
ap;2:
gx;3:
dh;4:
hx;5:
hualiang;6:
weihai;8:
tf;9:
tf2;10:
sz”/>
联机;2:
脱机;3:
自动”/>
司磅员登录;2:
司磅员刷卡登录;3:
货主登录;4:
经纪人登录”/>
……
一个Data标记标识一条数据库配置。
错误
备注
4.4获取服务器状态
名称
SystemTime.jsp
用途
测试网络状态，获取服务器时间，同步仪表本地时间。
调用说明
该接口在仪表上电时调用，用于同步服务器时间。
入参
英文名
解释
类型说明
出参
英文名
解释
类型说明
DateTime
日期时间属性
日期格式：
yyyy-mm-ddhh:
mm:
ss
yyyy4位年份
mm2位月份
dd2位日期
hh2位小时，24小时制
mm2位分钟
ss2位秒
调用示例
http:
//127.0.0.1:
8080/NM/SystemTime.jsp
返回示例
正确
59:
14”/>
2010年10月26日，10点59分14秒
错误
”/>
备注
4.5打印模板下载
名称
PrintTemplate.jsp
用途
下载打印模板。
调用说明
仪表进行【基础数据更新】时调用该接口。
入参
英文名
解释
类型说明
出参
英文名
解释
类型说明
完整的打印模板xml文件
请参考打印模板设计说明文档。
调用示例
http:
//127.0.0.1:
8080/NM/PrintTemplate.jsp
返回示例
正确
xmlversion="1.0"encoding="UTF-8"?
>
北京XXXXXX市场
IC卡交易流水号:
--------------------------------------
品名单价数量金额件数
"4"/>
货款合计:
元
--------------------------------------
买方IC卡号:
买方姓名:
买方手续费:
买方应付:
IC余额:
--------------------------------------
货主IC卡号:
货主编号:
货主手续费:
货主应收:
--------------------------------------
司磅员:
日期:
======================================
第联
错误
……
超时或非打印模板
备注
4.6操作员验证
名称
User.jsp
用途
验证操作员权限。
调用说明
登录、返销、补打时，调用此接口。
入参
英文名
解释
类型说明
UserCode
操作员编码
长度不超过10个字节，只允许数字。
PassWd
密码
长度不超过10个字节，只允许数字。
OrgCode
市场编号
同ProductList.jsp中的OrgCode。
MeterId
仪表编号
长度为4个数字字符
PassVerify
是否需要密码验证
1需要密码校验。
0不需要密码校验。
Login
登录类型
1正常登录2退出3用户验证
出参
英文名
解释
类型说明
UserName
姓名
字符串，长度不超过20个字节。
UserType
类型（操作权限）
按字节定义操作权限，长度为10，可扩充。
见下方图示。
第1字节：
交易登录0无交易权限；1有
第2字节：
返销0无返销权限；1有
第3字节：
补打0无补打权限；1有
第4字节：
汇总0汇总本人；1汇总所有；
2无汇总权限
例如1111000000，表示可交易、返销、补打、汇总所有。
调用示例
http:
//127.0.0.1:
8080/NM/User.jsp?
Req=OrgCode=“1”MeterId=“0001”PassVerify=”1”Login=”1”/>
返回示例
登录成功
登录失败
备注
图操作员权限
4.7获取买卖方会员信息
名称
Member.jsp
用途
获取买卖方会员信息。
调用说明
查询买卖方信息、卖方刷卡或买方刷卡时调用此接口。
入参
英文名
解释
类型说明
IcSn
Ic卡物理卡号
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
用途
上传交易数据、买卖方信息，返回交易费率明细，等待结账。
调用说明
结算交易时
升级会员 