WEB 模块详细设计说明

《WEB 模块详细设计说明》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、技术文件技术文件名称：WEB软件模块详细设计说明技术文件编号：版本：1.0共页(包括封面)拟制审核会签标准化批准住网通信技术有限公司XX软件模块详细设计说明〈版本号〉修改记录文件编号版本号拟制人/修改人拟制/修改日期更改理由主要更改内容（写要点即可）1.0李建永2006-1-17初版注1：每次更改归档文件（指归档到事业部或公司档案室的文件）时，需填写此表。注2：文件第一次归档时，“更改理由”、“主要更改内容”栏写“无”。第13页共13页XX软件模块详细设计说明〈版本号〉目录1编写目的32术语、定义和缩略语32.1术语、定义32.2缩略语33模块描述34模块设计45数据描述105.1数据结构

2、说明105.2全局变量说明106函数定义126.1引用函数定义126.2内部函数定义126.2.1内部函数1126.2.2内部函数2126.2.3内部函数n127接口设计127.1用户接口127.2硬件接口127.3软件接口137.3.1规范接口137.3.2非规范接口138其它说明139参考资料13第13页共13页XX软件模块详细设计说明〈版本号〉编写目的<要求：说明编写本文件的目的在于详细地说明××××模块中各成分的设计考虑，以利于程序员编制程序。>1术语、定义和缩略语1.1术语、定义<要求：逐项列出本文中用到的难以理解或可能引起混淆的术语及其定义。>CGICommonGatewayI

3、nterfaceCSSCascadingStyleSheetsMIMEMultipurposeInternetMailExtensionsFirmware嵌入式设备的软件nph-NoParseHeaderMini-httpd一种HTTPServerIEMicrosoftInternetExplorerNetscapeNavigatorNetscape的WEB浏览器1.2缩略语本文件应用了以下缩略语：<要求：逐项列出本文中用到的缩略语及其原文和汉语含义。>2模块描述<要求：从模块在系统中的位置，实现原理及方式、实现的主要功能等方面来描述该模块的概貌。>我们说的WEB模块是指运行在系统中的一个

4、WEB部件。它由两大部分组成，一是指WEB-Server，这是我们选用一个开源的WEBSerevermini-httpd；另一个部分是指WEB应用程序部分，它通常由静态的WEB页面（HTML文件）、图片及相关文件（如CSS文件）和动态的交互WEB部分，如CGI、ASP、JAVASCRIPT等。这里静态文件部分我们全部支持，动态WEB部分我们采用CGI+JAVASCRIPT的方式实现（这里JAVASCRIPT是指运行在运行客户端的JAVASCRIPT）。因为HTML我们使用HTML4.0以上版本，CSS使用2.0版及其以上，故客户端浏览器必须是IE4.0及更高版本、NetscapeNavig

5、ator4.0及更高的版本。目前CGI已经发布了2.0及以上版本，但是主流WEBServer急乎还是仅支持到CGI1.1版，所以后文提到CGI的相关的内容全部以CGI1.1为准。WEB模块的工作流程如下：第13页共13页XX软件模块详细设计说明〈版本号〉环境变量/及输入/输出流HTTP应答HTTP请求文件系统用户/浏览器WEBSERVERCGI脚本处理说明如下：1．左边的虚框内代表用户及其浏览器，右边的虚框代表整个WEB模板。2．用户通过浏览器向WEB模块发出HTTP请求。3．在WEB模块内部由HTTPServer子模块接收请求。4．HTTPServer解析HTTP头部，决定请求的类型为请

6、求静态文件还是请求CGI处理5．如果请求的为表态文件，如静态HTML页面，CSS文件，图片文件等，HTTPServer将从文件系统中读取该文件，并构造HTTP应答消息，返回客户端。6．如果请求的是CGI处理，HTTPSever读取CGI脚本文件，并发起新的进程运行之。7．CGI从环境变量和标准输入中获取输入参数，并解析输入处理请求，最后构造HTTP应答返通过标准输出将HTTP应答返回给客户浏览器。8．CGI处理时可以从文件系统中读取必要的信息，也可以向文件系统中存入必要的处理结果，如用户上传的文件等。重要注意：1．CGI脚本可以很多语言进行实现，如C、PERL、JAVAScript等，考虑

7、嵌入式系统的特点，及在本系统中没有PERL、JAVAScript等脚本解释器，故选择用C实现。2．本系统的参考实现为CE/3，在CE/3实现中HTTPServer并未发起新的进程来运行CGI脚本，而是修改了HTTPServer，让其直接调用CGI模块的处理入口函数。这样实现性能比较高，没有发起新进程的开销；不足之处是，一旦CGI处理模块出现问题，将可能影响HTTPServer的正常工作，甚至崩溃。这要求在CGI设计时必须