摘要
这 篇文章讨论了如何使用c#开发一个简单的web服务器应用程序。尽管我们可以使用任何一种支持.net的编程语言开发,但我选择了c#。本篇文章中的代码 是使用微软的β2版的visual c# compiler version 7.00.9254 [clr version v1.0.2914]编译通过的,对代码作一些小的改动后,使用β1版也可能编译通过。该web服务器应用程序能够与iis或其他任何web服务器软件同 时在一台服务器上运行,只要为它指定一个空闲的端口即可。在本篇文章中,我还假定读者对.net、c#或visual basic .net有一定的了解。
该web服务器应用程序能够向浏览器返回html格式的文件,而且支持图像,它不加载嵌入式图像或支持任何一种脚本语言。为了简单起见,我将它开发成一个命令行应用程序。
准备工作
首先,我们需要为这个web服务器应用程序定义一个根文件夹,例如,c:/mypersonalwebserver,然后在该要根目录下创建一个数据目录,例如,c:/mypersonalwebserver/data;最后在数据目录下创建三个文件,例如:
mimes.dat
vdirs.dat
default.dat
mime.dat中将包含该web服务器支持的mime类型,其格式为<扩展名>; ,例如:
.html;text/html
.htm;text/html
.bmp;image/bmp
vdirs.dat中包含有虚拟目录的信息,格式为; <物理目录>,例如:
/; c:/mywebserverroot/
test/; c:/mywebserverroot/imtiaz/
default.dat中包含有虚拟目录中文件的信息,例如:
default.html
default.htm
index.html
index.htm
为简单起见,我们将使用文本文件存储所有的信息,但我们也可以使用xml等其他的格式。在开始研究代码之前,我们先来看一下在登录网站时浏览器需要传递的头部信息。
我们以请求test.html为例进行说明。在浏览器的地址栏输入http://localhost:5050/test.html(记住,需要在url中包括端口号),服务器将得到下面的信息:
〈/drive:/physicaldir〉
get /test.html http/1.1
accept: image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, application/vnd.ms-powerpoint, application/vnd.ms-excel, application/msword, */*
accept-language: en-usaccept-encoding: gzip, deflate
user-agent: mozilla/4.0 (compatible; msie 5.5; windows nt 4.0; .net clr 1.0.2914)
host: localhost:5050connection: keep-alive
开始编程
namespace imtiaz
{
using system;
using system.io;
using system.net;
using system.net.sockets;
using system.text;
using system.threading ;
class mywebserver
{
private tcplistener mylistener ;
private int port = 5050 ; // 可以任意选择空闲的端口
//生成tcplistener的构建器开始监听给定的端口,它还启动调用startlisten()方法的一个线程
public mywebserver()
{
try
{
//开始监听给定的端口
mylistener = new tcplistener(port) ;
mylistener.start();
console.writeline("web server running... press ^c to stop...");
//启动调用startlisten方法的线程
thread th = new thread(new threadstart(startlisten));
th.start() ;
}
catch(exception e)
{
console.writeline("an exception occurred while listening :" +e.tostring());
}
}
我们定义了名字空间,包括应用程序必需的引用,初始化了构建器中的端口,启动了端口监听进程,创建了一个新的线程调用startlisten函数。
我们假设用户没有在url中提供文件名,在这种情况下我们必须自己确定缺省的文件名,并将它返回给浏览器,就象在iis中的文档标签中定义缺省的文档那样。
我们已经在default.dat中存储了缺省的文件名,并将文件存储在了数据目录中。getthedefaultfilename函数将目录路径作为输入参数,打开default.dat文件,在目录中查找文件,根据是否找到了文件返回文件名或一个空格。
public string getthedefaultfilename(string slocaldirectory)
{
streamreader sr;
string sline = "";
try
{
//打开default.dat,获得缺省清单
sr = new streamreader("data//default.dat");
while ((sline = sr.readline()) != null)
{
//在web服务器的根目录下查找缺少文件
if (file.exists( slocaldirectory + sline) == true)
break;
}
}
catch(exception e)
{
console.writeline("an exception occurred : " + e.tostring());
}
if (file.exists( slocaldirectory + sline) == true)
return sline;
else
return "";
}
象在iis中那样,我们必须将虚拟目录解析为物理目录。在vdir.dat中,我们已经存储了实际的物理目录和虚拟目录之间的映像关系。需要记住的是,在任何情况下,文件的格式都是重要的。
public string getlocalpath(string smywebserverroot, string sdirname)
{
treamreader sr;
string sline = "";
string svirtualdir = "";
string srealdir = "";
intistartpos = 0;
//删除多余的空格
sdirname.trim();
// 转换成小写
smywebserverroot = smywebserverroot.tolower();
// 转换成小写
sdirname = sdirname.tolower();
try
{
//打开vdirs.dat文件,获得虚拟目录
sr = new streamreader("data//vdirs.dat");
while ((sline = sr.readline()) != null)
{
//删除多余的空格
sline.trim();
if (sline.length > 0)
{
//找到分割符
istartpos = sline.indexof(";");
// 转换成小写
sline = sline.tolower();
svirtualdir = sline.substring(0,istartpos);
srealdir = sline.substring(istartpos + 1);
if (svirtualdir == sdirname)
{
break;
}
}
}
}
catch(exception e)
{
console.writeline("an exception occurred : " + e.tostring());
}
if (svirtualdir == sdirname)
return srealdir;
else
return "";
}
我们还必须使用用户提供的文件扩展名确定mime类型。
public string getmimetype(string srequestedfile)
{
streamreader sr;
string sline = "";
string smimetype = "";
string sfileext = "";
string smimeext = "";
// 转换成小写
srequestedfile = srequestedfile.tolower();
int istartpos = srequestedfile.indexof(".");
sfileext = srequestedfile.substring(istartpos);
try
{
//打开vdirs.dat文件,获得虚拟目录
sr = new streamreader("data//mime.dat");
while ((sline = sr.readline()) != null)
{
sline.trim();
if (sline.length > 0)
{
//找到分割符
istartpos = sline.indexof(";");
// 转换成小写
sline = sline.tolower();
smimeext = sline.substring(0,istartpos);
smimetype = sline.substring(istartpos + 1);
if (smimeext == sfileext)
break;
}
}
}
catch (exception e)
{
console.writeline("an exception occurred : " + e.tostring());
}
if (smimeext == sfileext)
return smimetype;
else
return "";
}
下面我们来编写建立和向浏览器(客户端)发送头部信息的函数。
public void sendheader( string shttpversion,
string smimeheader,
int itotbytes,
string sstatuscode,
ref socket mysocket)
{
string sbuffer = "";
//如果用户没有提供mime类型,则将其缺省地设置为text/html
if (smimeheader.length == 0 )
{
smimeheader = "text/html"; // default mime type is text/html
}
sbuffer = sbuffer + shttpversion + sstatuscode + "/r/n";
sbuffer = sbuffer + "server: cx1193719-b/r/n";
sbuffer = sbuffer + "content-type: " + smimeheader + "/r/n";
sbuffer = sbuffer + "accept-ranges: bytes/r/n";
sbuffer = sbuffer + "content-length: " + itotbytes + "/r/n/r/n";
byte[] bsenddata = encoding.ascii.getbytes(sbuffer);
sendtobrowser( bsenddata, ref mysocket);
console.writeline("total bytes : " + itotbytes.tostring());
}
sendtobrowser函数向浏览器发送信息,这是一个工作量比较大的函数。
public void sendtobrowser(string sdata, ref socket mysocket)
{
sendtobrowser (encoding.ascii.getbytes(sdata), ref mysocket);
}
public void sendtobrowser(byte[] bsenddata, ref socket mysocket)
{
int numbytes = 0;
try
{
if (mysocket.connected)
{
if (( numbytes = mysocket.send(bsenddata, bsenddata.length,0)) == -1)
console.writeline("socket error cannot send packet");
else
{
console.writeline("no. of bytes send {0}" , numbytes);
}
}
else
console.writeline("connection dropped....");
}
catch (exception e)
{
console.writeline("error occurred : {0} ", e );
}
}
我们已经有了编写一个互联网服务器应用程序的一些部件,下面我们将讨论互联网服务器应用程序中的关健函数。
public void startlisten()
{
int istartpos = 0;
string srequest;
string sdirname;
string srequestedfile;
string serrormessage;
string slocaldir;
string smywebserverroot = "c://mywebserverroot//";
string sphysicalfilepath = "";
string sformattedmessage = "";
string sresponse = "";
while(true)
{
//接受一个新的连接
socket mysocket = mylistener.acceptsocket() ;
console.writeline ("socket type " +mysocket.sockettype );
if(mysocket.connected)
{
console.writeline("/nclient connected!!/n==================/n
client ip {0}/n", mysocket.remoteendpoint) ;
//生成一个字节数组,从客户端接收数据
byte[] breceive = new byte[1024] ;
int i = mysocket.receive(breceive,breceive.length,0) ;
//将字节型数据转换为字符串
string sbuffer = encoding.ascii.getstring(breceive);
//上前我们将只处理get类型
if (sbuffer.substring(0,3) != "get" )
{
console.writeline("only get method is supported..");
mysocket.close();
return;
}
// 查找http请求
istartpos = sbuffer.indexof("http",1);
// 获取“http”文本和版本号,例如,它会返回“http/1.1”
string shttpversion = sbuffer.substring(istartpos,8);
//解析请求的类型和目录/文件
srequest = sbuffer.substring(0,istartpos - 1);
//如果存在/符号,则使用/替换
srequest.replace("//","/");
//如果提供的文件名中没有/,表明这是一个目录,我们解危需要查找缺省的文件名
if ((srequest.indexof(".") <1) && (!srequest.endswith("/")))
{
srequest = srequest + "/";
}
//解析请求的文件名
istartpos = srequest.lastindexof("/") + 1;
srequestedfile = srequest.substring(istartpos);
//解析目录名
sdirname = srequest.substring(srequest.indexof("/"), srequest.lastindexof("/")-3);
上面的代码无须多加解释,它接收用户的请求,将用户的请求由字节型数据转换为字符串型数据,然后查找请求的类型,解析http的版本号、文件和目录信息。
// 确定物理目录
if ( sdirname == "/")
slocaldir = smywebserverroot;
else
{
//获得虚拟目录
slocaldir = getlocalpath(smywebserverroot, sdirname);
}
console.writeline("directory requested : " + slocaldir);
//如果物理目录不存在,则显示出错信息
if (slocaldir.length == 0 )
{
serrormessage = "〈h2〉error!! requested directory does not exists〈/h2〉〈br〉";
//serrormessage = serrormessage + "please check data//vdirs.dat";
//对信息进行格式化
sendheader(shttpversion, "", serrormessage.length, " 404 not found", ref mysocket);
//向浏览器发送信息
sendtobrowser(serrormessage, ref mysocket);
mysocket.close();
continue;
}
提 示:微软的ie浏览器一般情况下总会显示一个比较“友好”一点的http错误网页,如果要显示我们的web服务器应用程序的错误信息,需要禁用ie中“显 示友好http错误信息”的功能,方法是依次点击“工具”->“互联网工具”,然后在其中的“高级”标签中即可以看到该选项。
如 果用户没有提供目录名,web服务器应用程序会使用getlocalpath函数获取物理目录的信息,如果目录不存在(或者没有映射为vdir.dat中 的条目),就会向浏览器发送错误信息。接下来web服务器应用程序会确定文件名,如果用户没有提供文件名,web服务器应用程序可以调用 getthedefaultfilename函数获取文件名,如果有错误发生,则会将错误信息发送到浏览器。
//如果文件名不存在,则查找缺省文件列表
if (srequestedfile.length == 0 )
{
// 获取缺省的文件名
srequestedfile = getthedefaultfilename(slocaldir);
if (srequestedfile == "")
{
serrormessage = "〈h2〉error!! no default file name specified〈/h2〉";
sendheader(shttpversion, "", serrormessage.length, " 404 not found",
ref mysocket);
sendtobrowser ( serrormessage, ref mysocket);
mysocket.close();
return;
}
}
下面我们来识别mime类型:
string smimetype = getmimetype(srequestedfile);
//构建物理路径
sphysicalfilepath = slocaldir + srequestedfile;
console.writeline("file requested : " + sphysicalfilepath);
最后一个步骤是打开被请求的文件,并将它发送给浏览器。
if (file.exists(sphysicalfilepath) == false)
{
serrormessage = "〈h2〉404 error! file does not exists...〈/h2〉";
sendheader(shttpversion, "", serrormessage.length, " 404 not found", ref mysocket);
sendtobrowser( serrormessage, ref mysocket);
console.writeline(sformattedmessage);
}
else
{
int itotbytes=0;
sresponse ="";
filestream fs = new filestream(sphysicalfilepath, filemode.open,fileaccess.read,
fileshare.read);
// 创建一个能够从filestream中读取字节数据的reader
binaryreader reader = new binaryreader(fs);
byte[] bytes = new byte[fs.length];
int read;
while((read = reader.read(bytes, 0, bytes.length)) != 0)
{
// 从文件中读取数据,并将数据发送到网络上
sresponse = sresponse + encoding.ascii.getstring(bytes,0,read);
itotbytes = itotbytes + read;
}
reader.close();
fs.close();
sendheader(shttpversion, smimetype, itotbytes, " 200 ok", ref mysocket);
sendtobrowser(bytes, ref mysocket);
//mysocket.send(bytes, bytes.length,0);
}
mysocket.close();
}
}
}
}
}
编译和执行
可以使用下图所示的命令编译我们的web服务器应用程序:
在我使用的.net开发工具中,无须指定任何库的名字,在较老版本的.net开发工具中,可能会需要使用/r参数添加对dll库文件的引用。
要运行该web服务器应用程序,只要如下图那样输入程序的名字,并按回车键即可。
now, let say user send the request, our web server will identify the default file name and sends to the browser.
现在,我们假设用户发送了请求,我们的web服务器应用程序将会决定使用缺省的文件,并将它返回给浏览器。如下图所示:
当然了,用户也可以请求图像文件
可能的改进
webserver仍然有许多地方可以加以改进。它不支持嵌入式图像和脚本,读者可以自己编写isapi过滤器,也可以使用iis isapi过滤器。
结束语
本篇文章展示了开发web服务器的基本原理,我们仍然可以对文章中的web服务器应用程序进行许多改进,希望它能够起到抛砖引玉的作用,对读者有所启迪。
新闻热点
疑难解答