这一篇教程，我们对服务器进行优化，并且创建CMD客户端，通过命令进行访问。
先不用头疼，实现过程并不复杂。
一、服务器的再次实现
首先，我们先对服务器代码进行优化。
在之前的代码中，请求文件有正常和失效两个状态，处理请求时会返回不同的状态值和相应的数据。
在新版本中，正常的状态只是返回数据，失效的状态我们抛出故障异常，包括：文件不存在异常和文件访问受限异常。
文件不存在比较好理解，那么，什么是文件访问受限呢？
首先，下载时如果提供的密钥不匹配，则应该抛出文件访问受限的异常。
另外，我们是通过路径访问文件，允许访问的空间是我们设定的共享目录，除了这个目录，硬盘上的其它目录都是不允许访问的。
如果有节点发来的请求是当前节点共享目录之外的目录，此时也要返回文件访问受限的异常。
例如，在上一个版本的服务器运行时，我们在客户端可以通过类似”../file.txt”的文件名获取服务器指定共享目录上一级目录中的其它资源。
我们要杜绝这样的问题发生。
所以，在新版本中，我们主要做如下改动：
- 将状态变量取消，添加两个异常状态代码的变量，分别代表文件不存在和文件访问受限；
- 创建两个自定义异常的类；
- 处理请求时，如果捕获自定义异常，抛出异常。
示例代码：（优化部分代码带有注释）
from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.client import ServerProxy, Fault # 导入故障异常类Fault
from os.path import isfile, abspath, join # 导入绝对路径的方法abspath
from urllib.parse import urlparse
import sys # 导入系统模块
SimpleXMLRPCServer.allow_reuse_address = 1 # 保证节点服务器重启时能够立即访问
MAX_HISTORY_LENGTH = 6
UNHANDLED = 100 # 文件不存在的异常代码
ACCESS_DENIED = 200 # 文件访问受限的异常代码
class UnhandledQuery(Fault): # 创建自定义异常类
def __init__(self, message='无法处理请求！'): # 定义构造方法
Fault.__init__(self, UNHANDLED, message) # 重载超类构造方法
class AccessDenied(Fault): # 创建自定义异常类
def __init__(self, message='访问资源受限！'): # 定义构造方法
Fault.__init__(self, ACCESS_DENIED, message) # 重载超类构造方法
def inside(dir_path, file_path): # 定义文件路径检查的方法
directory = abspath(dir_path) # 获取共享目录的绝对路径
file = abspath(file_path) # 获取请求资源的绝对路径
return file.startswith(join(directory, '')) # 返回请求资源的路径是否以共享目录路径开始
def get_port(url):
result = urlparse(url)[1]
port = result.split(':')[-1]
return int(port)
class Node:
def __init__(self, url, dir_name, secret):
self.url = url
self.dirname = dir_name
self.secret = secret
self.known = set()
def _start(self):
server = SimpleXMLRPCServer(('', get_port(self.url)), logRequests=False)
server.register_instance(self)
server.serve_forever()
def _handle(self, filename):
file_path = join(self.dirname, filename)
if not isfile(file_path): # 如果路径不是一个文件
raise UnhandledQuery # 抛出文件不存在的异常
if not inside(self.dirname, file_path): # 如果请求的资源不是共享目录中的资源
raise AccessDenied # 抛出访问资源受限异常
return open(file_path).read() # 未发生异常时返回读取的文件数据
def _broadcast(self, filename, history):
for other in self.known.copy():
if other in history:
continue
try:
server = ServerProxy(other)
return server.query(filename, history)
except Fault as f: # 如果捕获访问故障异常获取异常代码
if f.faultCode == UNHANDLED: # 如果是文件不存在异常
pass # 不做任何处理
else: # 如果是其它故障异常
self.known.remove(other) # 从已知节点列表中移除节点
except: # 如果捕获其它异常（非故障异常）
self.known.remove(other) # 从已知节点列表中移除节点
raise UnhandledQuery # 如果已知节点都未能请求到资源，抛出文件不存在异常。
def query(self, filename, history=[]):
try:
return self._handle(filename)
except UnhandledQuery: # 如果捕获文件不存在的异常
history.append(self.url)
if len(history) >= MAX_HISTORY_LENGTH:
raise
return self._broadcast(filename, history)
def hello(self, other):
self.known.add(other)
return 0 # 必须返回非None的值
def fetch(self, filename, secret):
if secret != self.secret: # 如果密钥不匹配
raise AccessDenied # 抛出访问资源受限异常
result = self.query(filename)
with open(join(self.dirname, filename), 'w') as file:
file.write(result)
return 0 # 必须返回非None的值
def main(): # 定义主程序函数，用于测试当前代码是否正常。
url, directory, secret = sys.argv[1:] # 获取通过命令行终端输入参数
node = Node(url, directory, secret) # 创建节点对象
node._start() # 启动节点服务器
if __name__ == '__main__':
main() # 运行主程序
在上方代码中加入了一个main()函数，这个函数主要用于当前服务器代码的测试。
实际上，节点的创建以及服务器的启动，我们会放到客户端的代码中。
就好像我们打开一个BT软件的客户端，服务器也同时启动一样。
二、客户端的实现
客户端中我们要实现以下功能：
- 创建一定长度并且随机的下载密钥；
- 启动节点服务器；
- 加载节点文件中的URL到已知节点；
- 能够执行下载、退出的命令。
- 使用CMD命令行界面。
1、导入一些必须的模块。
示例代码：
from xmlrpc.client import ServerProxy, Fault # 导入服务器代理类和故障类 from random import choice # 导入随机选取的方法 from string import ascii_lowercase # 导入小写字母列表对象 from time import sleep # 导入延迟方法 from pserver import Node, UNHANDLED # 导入服务器中的节类和变量 from threading import Thread # 导入线程类 from cmd import Cmd # 导入命令类 import sys # 导入系统模块
2、定义两个变量。
因为服务器启动之后，客户端要从XML-PRC进行连接，为了保证服务器启动在连接之前，我们在启动服务器之后添加一个延时，再进行连接。这个延时的时长，通过变量来设定。
另外，下载密钥的长度，我们也通过变量来设定。
示例代码：
HEAD_START = 0.1 # 等待服务器启动时长 SECRET_LENGTH = 10 # 密钥长度
3、定义生成随机密钥的函数。
生成指定长度的随机密钥（小写字母的随机组合），我们要定义一个函数。
示例代码：
def random_string(length): # 定义随机密钥的函数
secret = ''
while length > 0:
length -= 1
secret += choice(ascii_lowercase) # 随机获取小写字母叠加到变量
return secret
4、定义客户端类。
因为要使用CMD界面，所以这个类要继承CMD类。
然后，类中对应命令的方法命名，都要以“do_”开头。
另外，还要注意，服务器如果直接在当前线程中启动，会影响客户端功能无法运行，所以，要把服务器在独立的线程中启动，并且将线程设置为守护线程。守护线程表示这个线程不重要，主线程退出时，不用等待这个线程运行结束。我们知道服务器的运行是死循环，在不发生异常时，永远不会运行结束，如果不将其设置为守护进程，就会导致主线程无法退出。
如果想更好地理解守护线程的作用，可以在运行客户端时开关守护线程的设置，执行exit命名来比较区别。
示例代码：
class Client(Cmd):
prompt = '>>>' # 重写超类中的命令提示符
def __init__(self, url_file, dir_name, url): # 定义构造方法
Cmd.__init__(self) # 重载超类的构造方法
self.secret = random_string(SECRET_LENGTH) # 创建密钥变量
node = Node(url, dir_name, self.secret) # 创建节点对象
thread = Thread(target=node._start) # 在独立的线程中启动服务器
thread.setDaemon(True) # 将线程设置为守护线程
thread.start() # 启动线程
sleep(HEAD_START) # 等待服务器启动
self.server = ServerProxy(url) # 创建服务器代理对象
for line in open(url_file): # 读取URL文件
self.server.hello(line.strip()) # 添加URL文件中的URL到已知节点集合
def do_fetch(self, filename): # 定义下载命令的方法
try:
self.server.fetch(filename, self.secret) # 调用服务器代理对象的下载方法
except Fault as f: # 捕获故障异常
if f.faultCode != UNHANDLED: # 如果异常代码不是未找到文件
pass # 不做处理
print('找不到文件：', filename)
def do_exit(self, arg): # 定义退出命令的方法
print('------------------退出程序------------------')
sys.exit() # 系统退出
5、定义主程序函数。
示例代码：
def main(): # 定义主程序函数
urlfile, dir_name, url = sys.argv[1:] # 获取通过命令行输入的参数
client = Client(urlfile, dir_name, url) # 创建客户端对象
client.cmdloop() # 启动命令行循环执行
6、运行客户端代码。
示例代码：
if __name__ == '__main__':
main()
完成以上代码的编写之后，我们再做一些准备。
以启动3个客户端为例，准备内容如下所述。
1、创建多个共享目录，并准备共享文件。
在项目文件夹中创建不同的文件夹作为不同URL的共享目录：NodeFiles01、NodeFiles02、NodeFiles03。
然后，在NodeFiles01文件夹中创建一个“file.txt”的测试文件。
2、创建多个URL文件。
URL文件是作为每个节点的已知节点，对应启动的不同客户端。
所以，在项目文件夹中，URL文件文件也需要准备3个：url1.txt、url2.txt、url3.txt。
文件内容（url1.txt）：
http://127.0.0.1:7777
http://127.0.0.1:8888
文件内容（url2.txt）：
http://127.0.0.1:6666
http://127.0.0.1:8888
文件内容（url3.txt）：
http://127.0.0.1:7777
完成以上准备之后，我们进行测试。
在命令行终端中，通过命令启动3个客户端。
pclient.py url1.txt NodeFiles01 http://127.0.0.1:6666
pclient.py url2.txt NodeFiles02 http://127.0.0.1:7777
pclient.py url3.txt NodeFiles03 http://127.0.0.1:8888
然后，在第3个端口号为“8888”的客户端中，我们执行下载命令。
如果在“NodeFiles03”文件夹中出现了“file.txt”文件，则说明测试成功。
而下载过程是“8888”端口的客户端先在当前节点的共享目录中查找请求的文件，发现文件不存在后，向已知节点“7777”端口的服务器发出了请求，而在“7777”端口服务器的共享目录也没有请求的文件，所以“7777”端口的服务器对已知节点（url2.txt中的URL）广播请求，“6666”端口的节点的服务器接收到请求进行处理，找到了请求的文件，将文件数据读取返回。
本节练习源代码：【点此下载】
转载请注明：魔力Python » 练习项目16：P2P在线文件共享（二）