详细设计说明书.docx

*有限公司*XXXXVLO详细设计说明书XXXXXXX部2008年5月编制部门EPG批准日期2008/1/22文档修改记录版本修订人修订说明批准人发布日期1.0.1.0XXX初稿，X年X月X日提交同行评审。*200805071.0.1.1XXX根据同行评审的结论做了修订。*20080508本文档中所包含的信息属于商业机密信息，如无*有限公司的书面许可，任何人都无模版版本信息编辑部门：EPG批准日期：2008/1/22编制部门EPG批准日期2008/1/22目录1弓I言11.1 编写目的11.2 背景11.3 定义11.4 法律法规和参考资料12 系统详细设计22.1.1 个股行情接口模块22.1.2 股票排名接口模块42.1.3 资讯接口模块62.1.4 交易（中间层服务）模块92.1.5 行情（中间层服务）模块172.1.6 资讯（中间层服务）模块223 管理后台数据库设计283.1 基本思路283.2 数据结构描述28编制部门EPG批准日期2（三）81221引言1.1编写目的本详细设计说明是项目设计阶段的必要文件，明确了本项目的需求的实现方式。本设计把系统划分成若干个模块，决定了各个模块之间的接口、模块之间传递的信息，已经数据结构、模块接口的设计。在本阶段中，确定应该如何具体实现所以的功能，从而为编码阶段把这些描述直接翻译成具体的程序设计语言提供依据。本设计的预期读者：项目开发人员、项目评审者、项目测试和维护人员。1.2背景项目名称*XXXXVl.0项目简称XXXXV1.0英文缩写项目编号P2008XXXX版本号1.0任务提出者开发者用户同其他系统的关系1.3定义1.4法律法规和参考资料项目需要说明书项目可行性研究报告项目立项申请表金融产品销售系统一周边接口规范功能模块接口(XXXX)“XXX”XXX分析系统通讯协议设计说明书编制部门EPG批准日期2（三）81222系统详细设计2.1.1 个股行情接口模块2.1.1.1 功能描述根据股票（或期货）信息获得该股票（或期货）的行情数据。行情数据包括实时数据（包含个股五档），分时数据，K线数据等。2.1.1.2 相关需求需求功能0401,0403,0404,04052.1.1.3 输入项股票信息（Codeinfo）。2.1.1.4 输出项行情信息（AnSWerQUOteData）2.1.1.5 相关数据结构说明AnswerQuoteData (tom quote) d«HMd DateMMdCodehfo(cmquct>codeT>peshortcodeStngArsRearTime(tom rMftim)An8TrendDataAmDayOala(E窜四Equote>CodeInfo股票信息类AnswerQuoteData行情信息类AnsRealTime实时行情信息类AnsTrendData分时行情信息类编制部门EPG批准日期2（三）8122AnsDayDataK线行情信息类2.1.1.6 相关接口或者存储过程说明QuoteManager:/获得实时行情信息publicstaticAnswerQuoteDatagetRealTime(Codeinfocodeinfo)throwsQuoteException；/获得分时行情信息publicstaticAnswerQuoteDatagetTrendData(Codeinfocodeinfo)throwsQuoteException；/获得K线行情信息publicstaticQuoteDatagetTechData(Codeinfocodeinfo)throwsQuoteException；2.1.1.7 主要页面设计无2.1.1.8 关键算法说明2.1.1.9 关键流程说明a）QuoteManager通过ConnectionPool获得有效的通向行情服务器的链接QuoteConnection。b）根据请求的行情类型，将股票（或期货）信息（CodeInfo）打包成请求数据包AskDataC）将请求数据包拼成二进制数据流通过QuoteConnection发送给行情服务器d）取得行情服务器返回的行情数据，并解析打包成AnSWerQUOteDaia,返回。2.1.1.10 特殊情况说明股票（期货）实时行情信息将使用缓存存储从行情服务器主推过来的，Client需要实时行情信息时，直接从缓存里获取。编制部门EPG批准日期2（三）81222.3. 1.LIl关键错误处理说明 链接超时：取消当前服务，断开链接，重连。 请求应当超时：从请求发生到收到应当的时间超过设置值，则重新发送请求。 链接断开：定时访问服务器，防止因为长期未响应导致被服务器主动断开；如果已经被断开，则过一定间隙后尝试连接备用服务器。 上诉超时的参数从配置文件中读取。2.1.1.12尚未解决的问题2.1.2股票排名接口模块2.1.2.1 功能描述根据用户请求，排序列出相应的股票数据2.1.2.2 相关需求需求功能04022.1.2.3 输入项排名请求信息：市场类型、显示数目、升降序、排序类型等2.1.2.4 输出项AnswerQuoteData编制部门批准日期2.1.2.5 相关数据结构说明AnswerQuoteDatadataHeadOetaHMdAnsReportDataAnsGeneraISortReqAnyRePorl:排行请求类ReqGeneraISon:排行请求类AnSRePOrtData:排行返回类AnsGeneralSort:fit行返回类1.1.1.1 6相关接口或者存储过程说明QuoteManager:/获得排名报表publicstaticAnswerQuoteDatagetReportData(ReqAnyReportreq)throwsQuoteException；/获得综合排名publicstaticAnswerQuoteDatagetGeneralData(ReqGeneralSortreq)throwsQuoteException；1.1.1.2 7主要页面设计2.1.2.8 关键算法说明编制部门EPG批准日期2（三）81222.1.2.9 关键流程说明参考个股行情接口模块2.1.2.10 特殊情况说明普通排名和综合排名的区分：对下来排名使用ReqAnyRePort请求（普通排名）：上海A股涨幅排名上海B股涨幅排名深圳A股涨幅排名深圳B股涨幅排名上海债券涨幅排名深圳债券涨幅排名上海基金涨幅排名深圳基金涨幅排名对下来排名使用ReqGenareISort请求（综合排名）：上海A股综合排名上海B股综合排名深圳A股综合排名深圳B股综合排名上海债券综合排名深圳债券综合排名上海基金综合排名深圳基金综合排名2.1.2.11 关键错误处理说明参考个股行情接口模块2.1.2.12 尚未解决的问题2.1.3资讯接口模块2.1.3.1功能描述提供资讯信息访问的接口。2.1. 3.2相关需求功能需求 0501, 0502, 0503, 0504,05052.1. 3. 3输入项InfoListIdInfoId2.1. 3.4输出项资讯信息(AnSlnfOrmationData)2.1.3.5相关数据结构说明InfoListRequest编制部门EPG批准日期2(H)8122InfoContentRequestAInfbrmationRequestAnswerhfbrmationDatadataHeadDataHeadAnsInfoContentAnsInfoListInfoListRequest:资讯分类信息请求类InfoContentRequest:资讯内容信息请求类AnsInfoList:资讯分类信息类AnsInfoContent:资讯内容类2.1.3.6相关接口或者存储过程说明InformationManager:/获得资讯栏目信息或索引信息publicstaticAnswerInformationDatagetlnfoList(InfoListRequest编制部门EPG批准日期2（三）8122request)throwsQuoteException；/获得资讯内容publicstaticAnswerInformationeDatagetInfoContent(InfoContentRequestrequest)throwsQuoteException；1.1.1.1 3.7主要页面设计2.1.3.8 关键算法说明2.1.3.9 关键流程说明参考个股行情接口模块2.1.3.10 特殊情况说明资讯栏目信息的取得将采用AR,而其它资讯信息则采用Socket向服务器发送请求的方式。由于包括个股资讯在内的资讯信息都保存在行情服务器，且采用的是同一套协议机制，所以资讯的接口和行情类似。2.1.3.11关键错误处理说明参考个股行情接口模块2.1. 3.12尚未解决的问题编制部门批准日期2.1.4交易（中间层服务）模块2.1.4.1 功能描述交易模块用来实现证券、期货、基金的登录、委托买卖、查询、账单、转帐等所有交易相关的功能。IPO图：2.1.4.2 相关需求需求功能：证券：01010124开放式基金：0201-0212期货：0301-03092.1.4.3 输入项输入项：页面输入：function_idexchange_typestock_accountstock_codeentrust_amountentrust_priceentrust_propentrust_bs*编制部门EPG批准日期2008/1/22query_directionquery_modeStarJdateend_datesession输入：versionidentity-lypeop_entrust_wayop_branch_noop_stationbranch_nofund_accountpassword交易模块的输入分为从web端提交的输入和从session提取的输入。2.1.4.4 输出项Json结构的输。输出项：出错时的输出项目：error_noerror_info正常输出时：可选输出项（由业务功能决定）：1 .无表格的反馈。反馈形式：filedl=valuelfiledn=valuen如：查询客户状态（证券）（功能号：209）branch_no=xxxxfund_account=xxxxonline_time=xxxxclient_name=xxxxmoney_count=xxxxmoney_type=xxxxenable_balance=xxxxexchange_type=xxxxStOCk_account=XXXX（具体可参考：金融产品销售系统一周边接口规范.xlS文件）2 .有表格的反馈（包含无表格反馈部分）反馈形式：编制部门EPG批准日期2（三）8122table=fieldI,field2,field3.fieldnvalue11,value12,value13.valueInvalue21,value22,value23.value2n.valuen1,valuen2,valuen3.valuenn编制部门EPG批准日期2(H)81222.1.4.5 相关数据结构说明编制部门EPG批准日期2（三）8122InputExAction根据bizType选择调用StoCk302（分支 1）PropretyipackInfoMethodiprocessEntrustFUtUreSlO04（分支 n-l）PropretyipackInfoMethodiprocessEntrustStoCk401（分支 2）PropretyipacklnfoMethodiprocessInquireFUtUreSl 504（分支 n）PropretyipackInfoMethodiprocesslnquire产生（机编制部门EPG批准日期2（三）81222.1.4.6相关接口或者存储过程说明由金融产品销售系统_周边接口规范（证券、期货、基金）的所有交易功能均本模块的定义方式由代码自动生产工具生成。2.1.4.7主要页面设计a）证券-普通委托-买入界面32.7432.0231.3130.5929.8729.1628.44中海发展28.48元14:56股东代码证券代码最新价格委托价格可用余额参考可买数量委托买入数量证券委托买入页面可参考页面设计的buystock.htm页面。b）证券一持仓编制部门EPG批准日期2（三）8122持仓信息操作证券名称证券代码股票余额可用余额成本价最新价市值参考盈亏买入/卖出方正科技600601l0100010.0009.4709470.00-530买入/卖出广电电子600602100OO900010.0007.89078900.0-21100.00买入/卖出方正科技600601100O100010.0009.4709470.00-530买入/卖出广电电子600602100900010.0007.89078900.0-21100.00买入/卖出方正科技600601l0100010.0009.4709470.00-530买入/卖出广电电子60060210000900010.0007.89078900.0-21100.00买入/卖出方正科技6006011000100010.0009.4709470.00-530买入/卖出广电电子600602100900010.0007.89078900.0-21100.00买入/卖出方正科技6006011000100010.0009.4709470.00-530买入/卖出广电电子600602100900010.0007.89078900.0-21100.00买入/卖出方正科技6006011000100010.0009.4709470.00-530买入/卖出广电电子600602IOooo900010.0007.89078900.0-21100.00买入/卖出方正科技6006011000100010.0009.4709470.00-530买入/卖出广电电子60060210000900010.0007.89078900.0-21100.00买入/卖出方正科技600601l0100010.0009.4709470.00-530买入/卖出广电电子60060210000900010.0007.89078900.0-21100.00买入/卖出方正科技600601l0100010.0009.4709470.00-530买入/卖出广电电子60060210000900010.0007.89078900.0-21100.00本页30条当前第2/8页上一页下一页末页证券持仓页面可参考页面设计的mystock.htm页面。C）基金一基金申购基金申购基金代码：购入金额阮）：确认.返回基金申购页面可参考页面设计的fund-perchase.htm页面。2.1.4.8关键算法说明2.1.4.9关键流程说明a） .web端通过ajax的请求方式向EXAction发生请求。b） .EXAciion首先校验数据合法性（Ioken令牌控制、SeSSiOn有效期控制）。c）EXAction根据业务类型和交易功能号确定具体交易业务。d）由具体业务处理类（bizProcess）填充AR通讯包内容，其中PaCklnfo（通讯包结构）的营业部号、功能号、参数个数必须给定，整理好哪些是SeSSiOn中读取的参数，那些是从页面提供的参数，全部填充到PackInfo里aramBody类型的容器中。e）AR通讯发包，接受应当结构保存在ARDataSel类中。（对于登录功能完成后要把常用信息保存到session中，以便其他功能可以直接复用session保存的字段。）f）对结果按要求格式化（主要有排序、数据日期、时间、货币等的格式化）。g）对格式化后的结果集打包成Json结构，通过EXAction直接输出到页面。2. h）页面ajax回调函数解析JSOn结构，更加反馈的内容做相应的处理和用户提示。3. 1.4.10特殊情况说明3.1. 4.11关键错误处理说明提交的请求不合法：直接把出错原因和代码通过json反馈给页面约定：error_no:从-IoOoO到-100O5表示Web服务器自主返回的错误。具体的出错原因由ErrorJnfo返回。3.2. 4.12尚未解决的问题编制部门EPG批准日期2（三）81222.1.5行情（中间层服务）模块3.3. 5.1功能描述行情（中间层服务）模块用来实现证券、期货、基金的实时行情、分时图、K线图等行情功能相关从web端请求到接口服务的过程。IPO图：3.4. 5.2相关需求需求功能：0401,0402,0403,0404,04053.5. 5.3输入项输入项：stockcode行情请求功能代码3.6. 5.4输出项Json结构的输。输出项：出错时的输出项目：error_noerror_infb正常输出时：编制部门EPG批准日期2（三）8122AnswerQuoteData转换为Json接口输出。具体可参考：“投资通”网上行情分析系统通讯协议设计说明书2.1.5.5相关数据结构说明编制部门EPG批准日期2（三）8122Input根据行情请求功能号选择调用GetRealTime（实时行情）PropretyxodeinfbGetTeChData（K线图）PropretyicodeinfoGetTrendData（分时图）PropretyIcodeinfoGetGencralData（l名）Propretyzcodeinfb反馈AnSWerQUOteDataProprety:DataHeadPropretyiAnsRealTimeProprety:AnsTrendDataProprety:AnsDayTime组织JSon结构JsonProprety:fieldvaluePropretyitable编制部门EPG批准日期2（三）81222.1.5.6相关接口或者存储过程说明参考行情接口模块。2.1.5.7主要页面设计a）取实时行情（五档行情）当前行情证券名称中海发展价格（元）证券代码600026卖盘五13.64今开盘27.8卖盘五13.64昨收盘27.89卖盘五13.64最高价28.19卖盘五13.64最低价25.11卖盘五13.64涨趺-1.89卖盘五13.64总成交量636231卖盘五13.64总金额170961591.00卖盘五13.64当前价25.91卖盘五13.64涨停价30.68卖盘五13.64趺停价25.1卖盘五13.64取五档行情可参考页面设计的buystock.htm页面。中海发展28. 48元14:56b）取分时图32.7432.0231.3130.5929.8729.162R.44取分时图可参考页面设计的future-buy.htm页面。c）取K线图编制部门EPG批准日期2（三）8122期货搜索二易所V周瞰月瞰查询期货工具箱容量容9篁V均线(HA)MA5=27.99MAIO=27.66MA20=30.17取分时图可参考页面设计的futuremarket.hm页面。2.1.5.8关键算法说明2.1. 5.9关键流程说明a） .web端通过ajax的请求方式向QuoteAction发送行情请求。b） .QuoteAction填充CodeInfo结构类内容。C）QUoteACtion根据行情请求功能代码确定行情类别（实时、分时、K线、排名）。d）把请求结果AnswerQuoteData打包成Json结构，通过QuoteAction直接输出到页面。e）页面ajax回调函数解析Json结构，更加反馈的内容做相应的处理和用户提示。2.1. 5.10特殊情况说明AnswerQuoteData的结构集根据行情请求代码，分别调用不用的类来处理。可参照行情接口模块的规定。受控密）2.1.5.11关键错误处理说明提交的行情请求无法出来时：直接把出错原因和代码通过json反馈给页面约定：errojno:从-20000到-20020表示web服务器自主返回的行情错误。具体的出错原因由ErrOJinfO返回。行情先从缓存中取，如果该缓存的行情已经更新，则到调用行情类请求行情，判断依据：缓存更新标志（行情接口在更新了本地内存的最新后，会修改对于缓存（如果缓存存在）的状态标志，置为过期，告诉请求者需重新向接口请求行情）。2.1. 5.12尚未解决的问题2.1.6资讯（中间层服务）模块2.1.6.1 功能描述资讯（中间层服务）模块用来实现证券、期货、基金的资讯栏目和资讯内容从Web端请求到接口服务的过程。IPO图：2.1.6.2 相关需求需求功能：0501-05112.1.6.3 输入项输入项：InfoListNoInfoId2.1.6.4 输出项Json结构的输出。输出项：出错时的输出项目：error_noerror-info正常输出时：AnSWerInfoLiSt（栏目列表）转换为Json接口输出。AnSWerInfOContent（资讯内容）转换为Json接口输出。具体可参考：“投资通”网上行情分析系统通讯协议设计说明书2.1.6.5 相关数据结构说明Input根据资讯栏目编号或资讯ID选择调用InfbLiStReqUeStInfoContentRequest反馈AnswerInfbLisAnswerInfbContent组织JSon结构3JSonPropretyifieldvalueProprelylableOutput编制部门EPG批准日期2（三）8122*2.1.6.6 相关接口或者存储过程说明参考资讯接口模块说明。2.1.6. 7主要页面设计a）资讯首页首页股票基金期货在线交易。股票。基金。证券。期货。外汇.今日导读- 传股指期货方案只待国务院最终放行- ,中球动宣布4月京沪等8城启dM商用- '面春标市场愎碌mirz-'3500 '-"- -国寿称市场误解“瘫;乏毒塞落敲柠盘菊版行- -'' ffi35i a- iw' z >>- 股票新闻 传股指期货方案只待国务院最终放行 中毯的宣布4月京沪等8威启的TDm啬用 ' E " Z 说春演麻福藏垂施-'"ffii' ' m w' z 高盛就3500点缶示俄预期更强硬反通 百等场旗始”法爸；乏看房窗放行用姿戢柠'>>.期货新闻- 传股指期货方案只待国务院最终放行44余泸与8施后i商甬- -国寿称而场误解w ”之益:终隹公示行- 高盛标350Ci预期更强硬反通Z''''-'z- -3500 'S面寿称市场误解.“潟”之意最落戢行提的汆行>>资讯首页参考页面设计的index.htm页面。b）证券资讯（部分）.基金新闻 传股指期货方案只待国务院最终放行 年花的直希4月京护客8施启）TD日百甫 国寿称用场误解“ ”之意最落敲行基衮 3500预期更强硬反通i'" ' t; z.3500. ' 国寿称市场偏解“海” ft-'>>编制部门EPG批准日期2008/1/22我关注的资讯上我关注的资讯我关注的资讯我关注的资讯 传般指期货方案只待国务院最终放行2008-03-28.由指国寿原市场由解二海仓”之董分出行登破后200盛启与8 传股箝期资方案只三语称市场误M“看沧”之诡蹇终放行最终欣存2O-（ 使股指期货方案只待国务院最高盛称双。点历而氐预期更强硬反通最终放行最终2008-03- 传展痴W高盛麻3500互而低WSWiiftft'2008-03-28”“仁证值会值息证as合值息证施合证粉合值息 传股指期货方案只待S3务院最终放行2008-03-28 传股指国寿称市场误解“减仓”之量最终放行最终戢行2008-03-28 传股指期货方案只国寿际市场谒解“减仓”之意最终放行最痴放行20-G3-28 传标指RNf*点得田&除量高21底3500<5宿示过稀好事口南眉调餐终扁后E2008-03-证券资讯页面参考页面设计的slock.htm页面。C）期货资讯（部分）即货要闻.中根回近】烟帙行业：消费年均增长率不会低于ISi（WJR） 28-28 .Rl silt ：消费年均增长率不会低于10%蒯报）28-28 t8S钢铁行业：沟费年均增长率不会低于10%I值）血8法二28 .石艮萌】 蹄石正：相交浮自南口示不£便于蔬肩谦）“无£法工&.机施看盘中银国际】帆帙行业：消费年均增长率不会低于报）28-O3-28 .""RBK） ik :酒费年均增长率不会低于10% （WJR） 20>28, .''"（wWi wik ： 6（WS）涵&& .伸破箭J 襁方亚:相应舁脸Q百手嬴丽掖； 08-<>3-28I名称滁趺幅最新价!酢收盘:开盘价I是否价I最低价买入价I分时走势周瞰月做64600&451064480644806448064480.WRUV14«MWlCnMl”3M沪铝0901-0.52%6460064510&44806448064480644806448040a沪瞰901-0.52U64600645106448064480644806448064480v*x沪铝0901-O.52UMeOO545106448064480644806448064480三kL沪版901-0.52%64600645106448064480644806448064480mf沪侣MOI-0.52%64600MSIO6448064460644806448064480沪瞰90152”MeOO6451064480644806448064364480fl.沪f8)901-0.52%64800645106446064480644806448064480厂E'EF沪铜D901沪£曲90152%-0.52%646006460064510645106448064480644806448064480644606448064480关注的H贷品走势图期货资讯页面参考页面设计的futures_index.htm页面。d）基金资讯（部分）编制部门EPG批准日期2（三）8122我关注/持有的基金代码基金名称投资方向最新净值操作510180180ETF申的便回/转换/分红设置510180180ETF申购屈回/转换/分红设置510180180ETF申购便回/转换/分红设置510180180ETFa申购阀回/转换/分红设置510180180ETFa申购原回/转换/分红设置510180180ETF申购底回/转换/分红设置510180180ETF申购阅回/转换/分红设置510180180ETF申购鹰回/转换/分红设置510180180ETF申购像回/转换/分红设置510180180ETF申购/欺回/转换/分红设置我关注/持有的基金的公告.券商信息中银畸辆帙行业：消费年均增长率不会低于IOtGH报）2008-03-28,中恨国际.中限酶钢铁柠加：清费年均场长企未含底手i%蒯报）2008-038.（RS中银国际丽函业：消费年均增长亲示各底手10%加报）2008-03-28中粮国际【中银国际】钢铁行业：消费年均取TlW）'20-03"2'''中银国际【中t丽麻1辆碳行业:消费车蜥武F建低于IOi而荻相2凝石莅8.中崛而除1中保的钢铁行必:消懑4M1手10%漉施）2008-03-鼠.【中银国际r小20HSWE必HligH÷hW6匕HyAnLceCllicmoso_oo，二idi记基金资讯页面参考页面设计的fund-main.htm页面。2.1.6.8关键算法说明2.1.6.9关键流程说明a）.web端通过ajax的请求方式向InfoAction发送行情请求。b）InfoAction根据资讯请求栏目或者资讯内容确定资讯请求类别。C）把请求结果AnswerInfoList或AnswerInfoContent打包成Json结构，通过InfoAction直接输出到页面。d）页面ajax回调函数解析JSOn结构，更加反馈的内容做相应的处理和用户提示。2.L6.10特殊情况说明AnswerQuoteData的结构集根据行情请求代码，分别调用不用的类来处理。可参照行情接口模块的规定。2.1.6.11关键错误处理说明提交的资讯请求无法出来时：直接把出错原因和代码通过json反馈给页面约定：error-no:AK-30000到-30020表示web服务器自主返回的资讯错误。具体的出错原因由ErrorJnfo返回。2.L6.12尚未解决的问题3管理后台数据库设计3.1 基本思路相对于C/S版的XXXX,浏览器版XXXX项目一些新的功能和模块（如我关注的基金、股票、期货，网站点击率，设置请求超时时间、网站模块配置等）需要新建一些数据库表，定义完表结构后还规范他们的接口，以生成存储过程，网站和数据库的联系是通过存储过程来进行的。本系统使用Oracle数据库。下面是各表的表结构，字段解释，接口的定义。详细的功能模块接口信息请参阅“功能模块接口.OraCle.xls”文件；详细的表定义请参阅“数据库设计说明书JracleHs”3.2 数据结构描述网站中需要用到但之前没有的表结构1 .我关注的产品（包含证券、基金、期货）2 .网站点击率3 .设置请求超时的时间4