Python搭建本地静态Web服务器（多任务进阶版）

Posted 2021-12-22 ZSYL

Python搭建本地静态Web服务器

• 静态Web服务器-多任务版
• • 1. 静态Web服务器的问题
  • 2. 静态Web服务器-多任务版的示例代码
  • 3. 小结
• 静态Web服务器-面向对象开发
• • 1. 以面向对象的方式开发静态Web服务器
  • 2. 静态Web服务器-面向对象开发的示例代码
  • 3. 小结
• 静态Web服务器-命令行启动动态绑定端口号
• • 1. 开发命令行启动动态绑定端口号的静态web服务器
  • 2. 静态Web服务器-命令行启动动态绑定端口号的示例代码
  • 3. 小结

静态Web服务器-多任务版

学习目标

• 能够写出多线程版的多任务web服务器程序

---

1. 静态Web服务器的问题

目前的Web服务器，不能支持多用户同时访问，只能一个一个的处理客户端的请求，那么如何开发多任务版的web服务器同时处理 多个客户端的请求?

可以使用 多线程，比进程更加节省内存资源。

多任务版web服务器程序的实现步骤:

1. 当客户端和服务端建立连接成功，创建子线程，使用子线程专门处理客户端的请求，防止主线程阻塞。

2. 把创建的子线程设置成为守护主线程，防止主线程无法退出。

2. 静态Web服务器-多任务版的示例代码

import socket
import os
import threading

# 处理客户端请求
def handle_client_request(new_socket):
    # 代码执行到此，说明连接建立成功
    recv_client_data = new_socket.recv(4096)
    if len(recv_client_data) == 0:
        print('关闭浏览器了!')
        new_socket.close()
        return

    # 对二进制数据进行解码
    recv_client_content = recv_client_data.decode('utf-8')
    print(recv_client_content)
    # 根据指定字符串进行分割， 最大分割次数指定2
    request_list = recv_client_content.split(" ", maxsplit=2)

    # 获取请求资源路径
    request_path = request_list[1]
    print(request_path)

    # 判断请求的是否是根目录，如果是根目录设置返回的信息
    if request_path == "/":
        request_path = "/index.html"

    # 1. os.path.exits
    # os.path.exists("static/" + request_path)
    # 2. try-except
    try:
        # 打开文件读取文件中的数据, 提示：这里使用rb模式，兼容打开图片文件
        with open("static" + request_path, "rb") as file:  # 这里的file表示打开文件的对象
            file_data = file.read()
        # 提示： with open 关闭文件这步操作不用程序员来完成，系统帮我们来完成
    except Exception as e:
        # 代码执行到此，说明没有请求的该文件，返回404状态信息
        # 响应行
        response_line = "HTTP/1.1 404 Not Found\\r\\n"
        # 响应头
        response_header = "Server: PWS/1.0\\r\\n"
        # 读取404页面数据
        with open("static/error.html", "rb") as file:
            file_data = file.read()

        # 响应体
        response_body = file_data

        # 把数据封装成http 响应报文格式的数据
        response = (response_line +
                    response_header +
                    "\\r\\n").encode("utf-8") + response_body
        # 发送给浏览器的响应报文数据
        new_socket.send(response)

    else:
        # 代码执行到此，说明文件存在，返回200状态信息
        # 响应行
        response_line = "HTTP/1.1 200 OK\\r\\n"
        # 响应头
        response_header = "Server: PWS/1.0\\r\\n"
        # 响应体
        response_body = file_data

        # 把数据封装成http 响应报文格式的数据
        response = (response_line +
                    response_header +
                    "\\r\\n").encode("utf-8") + response_body

        # 发送给浏览器的响应报文数据
        new_socket.send(response)
    finally:
        # 关闭服务于客户端的套接字
        new_socket.close()

# 代码执行到此，说明没有请求的该文件，返回404状态信息
# 响应行


def main():
    # 创建tcp服务端套接字
    tcp_server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    # 设置端口号复用，程序退出端口号立即释放
    tcp_server_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
    # 绑定端口号
    tcp_server_socket.bind(("", 8000))
    # 设置监听
    tcp_server_socket.listen(128)
    # 循环等待接受客户端的连接请求
    while True:
        # 等待接受客户端的连接请求
        new_socket, ip_port = tcp_server_socket.accept()
        # 代码执行到此，说明连接建立成功
        print(ip_port)
        # 当客户端和服务器建立连接程，创建子线程
        sub_thread = threading.Thread(target=handle_client_request, args=(new_socket,))
        # 设置守护主线程
        sub_thread.setDaemon(True)
        # 启动子线程执行对应的任务
        sub_thread.start()


# 判断是否是主模块的代码
if __name__ == '__main__':
    main()

3. 小结

1. 当客户端和服务端建立连接成功，创建子线程，使用子线程专门处理客户端的请求，防止主线程阻塞。

while True:

	conn_socket, ip_port = tcp_server_socket.accept()
	
	# 开辟子线程并执行对应的任务
	
	sub_thread = threading.Thread(target=handle_client_request, args=(conn_socket,))

2. 把创建的子线程设置成为守护主线程，防止主线程无法退出。

# 开辟子线程并执行对应的任务
sub_thread = threading.Thread(target=handle_client_request, args=(conn_socket,))
sub_thread.setDaemon(True) # 设置守护主线程
sub_thread.start()

静态Web服务器-面向对象开发

学习目标

• 能够写出面向对象方式的多任务web服务器程序

---

1. 以面向对象的方式开发静态Web服务器

实现步骤:

1. 把提供服务的Web服务器抽象成一个类(HTTPWebServer)
2. 提供Web服务器的初始化方法，在初始化方法里面创建socket对象
3. 提供一个开启Web服务器的方法，让Web服务器处理客户端请求操作。

2. 静态Web服务器-面向对象开发的示例代码

import socket
import threading


# 定义web服务器类
class HttpWebServer(object):
    def __init__(self):
        # 创建tcp服务端套接字
        tcp_server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
        # 设置端口号复用, 程序退出端口立即释放
        tcp_server_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
        # 绑定端口号
        tcp_server_socket.bind(("", 9000))
        # 设置监听
        tcp_server_socket.listen(128)
        # 保存创建成功的服务器套接字
        self.tcp_server_socket = tcp_server_socket

    # 处理客户端的请求
    @staticmethod
    def handle_client_request(new_socket):
        # 代码执行到此，说明连接建立成功
        recv_client_data = new_socket.recv(4096)
        if len(recv_client_data) == 0:
            print("关闭浏览器了")
            new_socket.close()
            return

        # 对二进制数据进行解码
        recv_client_content = recv_client_data.decode("utf-8")
        print(recv_client_content)
        # 根据指定字符串进行分割， 最大分割次数指定2
        request_list = recv_client_content.split(" ", maxsplit=2)
        # 获取请求资源路径
        request_path = request_list[1]
        print(request_path)

        # 判断请求的是否是根目录，如果条件成立，指定首页数据返回
        if request_path == "/":
            request_path = "/index.html"

        try:
            # 动态打开指定文件
            with open("static" + request_path, "rb") as file:
                # 读取文件数据
                file_data = file.read()
        except Exception as e:
            # 请求资源不存在，返回404数据
            # 响应行
            response_line = "HTTP/1.1 404 Not Found\\r\\n"
            # 响应头
            response_header = "Server: PWS1.0\\r\\n"
            with open("static/error.html", "rb") as file:
                file_data = file.read()
            # 响应体
            response_body = file_data

            # 拼接响应报文
            response_data = (response_line + response_header + "\\r\\n").encode("utf-8") + response_body
            # 发送数据
            new_socket.send(response_data)

        else:
            # 响应行
            response_line = "HTTP/1.1 200 OK\\r\\n"
            # 响应头
            response_header = "Server: PWS1.0\\r\\n"

            # 响应体
            response_body = file_data

            # 拼接响应报文
            response_data = (response_line + response_header + "\\r\\n").encode("utf-8") + response_body
            # 发送数据
            new_socket.send(response_data)
        finally:
            # 关闭服务与客户端的套接字
            new_socket.close()

    # 启动web服务器进行工作
    def start(self):
        while True:
            # 等待接受客户端的连接请求
            new_socket, ip_port = self.tcp_server_socket.accept()
            # 当客户端和服务器建立连接程，创建子线程
            sub_thread = threading.Thread(target=self.handle_client_request, args=(new_socket,))
            # 设置守护主线程
            sub_thread.setDaemon(True)
            # 启动子线程执行对应的任务
            sub_thread.start()

# 程序入口函数
def main():
    # 创建web服务器对象
    web_server = HttpWebServer()
    # 启动web服务器进行工作
    web_server.start()


if __name__ == '__main__':
    main()

3. 小结

1. 把提供服务的Web服务器抽象成一个类(HTTPWebServer)

class HttpWebServer(object):

2. 提供Web服务器的初始化方法，在初始化方法里面创建socket对象

def __init__(self):

# 初始化服务端套接字，设置监听，代码省略..

3. 提供一个开启Web服务器的方法，让Web服务器处理客户端请求操作。

def start(self):
	while True:
		 service_client_socket, ip_port = self.tcp_server_socket.accept()
		 # 连接建立成功，开辟子线程处理客户端的请求
		 sub_thread = threading.Thread(target=self.handle_client_request, args=(service_client_socket,))
		 sub_thread.start()

静态Web服务器-命令行启动动态绑定端口号

学习目标

• 能够写出获取终端命令行参数动态绑定端口号的web服务器程序

1. 开发命令行启动动态绑定端口号的静态web服务器

实现步骤:

1. 获取执行python程序的终端命令行参数
2. 判断参数的类型，设置端口号必须是整型
3. 给Web服务器类的初始化方法添加一个端口号参数，用于绑定端口号

2. 静态Web服务器-命令行启动动态绑定端口号的示例代码

"""
@Author: ZS
@CSDN  : https://zsyll.blog.csdn.net/
@Time  : 2021/11/27 22:12
"""
import socket
import threading
import sys


# 定义web服务器类
class HttpWebServer(object):

    def __init__(self, port):
        # 创建tcp服务端套接字
        tcp_server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
        # 设置端口号复用, 程序退出端口立即释放
        tcp_server_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
        # 绑定端口号
        tcp_server_socket.bind(("", port))
        # 设置监听
        tcp_server_socket.listen(128)
        # 保存创建成功的服务器套接字
        self.tcp_server_socket = tcp_server_socket

    # 处理客户端的请求
    @staticmethod
    def handle_client_request(new_socket):
        # 代码执行到此，说明连接建立成功
        recv_client_data = new_socket.recv(4096)
        if len(recv_client_data) == 0:
            print("关闭浏览器了")
            new_socket.close()
            return

        # 对二进制数据进行解码
        recv_client_content = recv_client_data.decode("utf-8")
        print(recv_client_content)
        # 根据指定字符串进行分割， 最大分割次数指定2
        request_list = recv_client_content.split(" ", maxsplit=2)

        # 获取请求资源路径
        request_path = request_list[1]
        print(request_path)

        # 判断请求的是否是根目录，如果条件成立，指定首页数据返回
        if request_path == "/":
            request_path = "/index.html"

        try:
            # 动态打开指定文件
            with open("static" + request_path, "rb") as file:
                # 读取文件数据
                file_data = file.read()
        except Exception as e:
            # 请求资源不存在，返回404数据
            # 响应行
            response_line = "HTTP/1.1 404 Not Found\\r\\n"
            # 响应头
            response_header = "Server: PWS1.0\\r\\n"
            with open("static/error.html", "rb") as file:
                file_data = file.read()
            # 响应体
            response_body = file_data

            # 拼接响应报文
            response_data = (response_line + response_header + "\\r\\n").encode("utf-8") + response_body
            # 发送数据
            new_socket.send(response_data)
        else:
            # 响应行
            response_line = "HTTP/1.1 200 OK\\r\\n"
            # 响应头
            response_header = "Server: PWS1.0\\r\\n"

            # 响应体
            response_body = file_data

            # 拼接响应报文
            response_data = (response_line + response_header + "\\r\\n").encode("utf-8") + response_body
            # 发送数据
            new_socket.send(response_data)
        finally:
            # 关闭服务与客户端的套接字
            new_socket.close()

    # 启动web服务器进行工作
    def start(self):
        while True:
            # 等待接受客户端的连接请求
            new_socket, ip_port = self.tcp_server_socket.accept()
            # 当客户端和服务器建立连接程，创建子线程
            sub_thread = threading.Thread(target=self.handle_client_request, args=(new_socket,))
            # 设置守护主线程
            sub_thread.setDaemon(True)
            # 启动子线程执行对应的任务
            sub_thread.start()


# 程序入口函数
def main():

    print(sys.argv)
    # 判断命令行参数是否等于2,
    if len(sys.argv) != 2:
        print("执行命令如下: python3 xxx.py 8000")
        return

    # 判断字符串是否都是数字组成
    if not sys.argv[1].isdigit():
        print("执行命令如下: python3 xxx.py 8000")
        return

    # 获取终端命令行参数
    port = int(sys.argv[1])
    # 创建web服务器对象
    web_server = HttpWebServer(port)
    # 启动web服务器进行工作
    web_server.start()


if __name__ == '__main__':
    main()

3. 小结

1. 获取执行python程序的终端命令行参数

sys.argv

2. 判断参数的类型，设置端口号必须是整型

if not sys.argv[1].isdigit():
	print("启动命令如下: python3 xxx.py 9090")
	return
	
port = int(sys.argv[1])

3. 给Web服务器类的初始化方法添加一个端口号参数，用于绑定端口号

def __init__(self, port):
	self.tcp_server_socket.bind(("", port))

---

加油!

感谢!

努力!