web框架的原理以及web框架的实现（python）

青旅半醒 2022-06-08 11:11 233阅读 0赞

在学习了动态服务器的实现之后（wsgi），便引入了web框架。

何为web框架？其实就相当于人的骨架一样，有了框架之后我们便可以往里面添加肉，添加各种需要添加的，由此而组成了一个人。而web也是如此，我们希望用户可以直接往框架里添加功能，同时不用去管怎样处理用户的请求，即我们要实现一个方法，可以将用户的请求（无论是静态资源还是动态资源）进行路由分发，分配给具体的函数去执行（这也就是web框架的主体）。

在wsgi协议里，我们通过函数application实现了该功能，但那样的实现对用户不很友好，所有的方法都要自己去实现编写，且重用性差（仅仅是一个函数），不具备框架的功能，因此我们至少应该清楚我们编写的web框架应该是一个类，具有相当好的重用性以及封装性。

我们知道函数application里的参数分别是env以及start\_response，而start\_response是一个服务器内部的函数，具体作用是处理http相应的头信息，所以我们web框架的主要功能，便是对web框架内的urls（表示web框架内部的资源）进行遍历查找，将用户请求的资源（env.PATH\_INFO）与urls里的数据进行对比，如果存在则实现相应功能。

因此框架的源代码如下：

# coding:utf-8
    import time
    #from MyWebServer import HTTPServer
    
    HTMLROOT = "."
    
    class Application(object):
        # web框架的主体
        def __init__(self, urls):
            self.urls = urls
    
        def __call__(self, env, start_response):
            path = env.get("PATH_INFO", "/")
            if path.startswith("/static"):
                # 如果请求的是静态资源 提取出文件名 在根目录下打开
                file_name = path[7:]
                try:
                    file = open(HTMLROOT + file_name, "rb")
                except IOError as e:
                    # 找不到文件
                    print(e)
                    status = "404 NOT FOUND"
                    headers = []
                    start_response(status, headers)
                    return "file not found"
                else:
                    # 找到文件并提取信息
                    data = file.read()
                    file.close()
                    status = "200 OK"
                    headers = [("Content-Type", "html")]
                    start_response(status, headers)
                    # 返回html文件的数据
                    return data.decode('utf-8')
    
            for url, app in self.urls:
                # 此处是路由的功能 对urls进行遍历 如果请求的动态资源存在于env中 则执行相应函数
                if url == env.get("PATH_INFO", "/"):
                    return app(env, start_response)
            status = "404 NOT FOUND"
            headers = []
            start_response(status, headers)
            return "NOT FOUND"
    
    # 相应的请求实现的功能
    def show_time(env, start_response):
        status = "200 OK"
        headers = [("Content-Type", "text/plain")]
        start_response(status, headers)
        return time.ctime()
    
    
    def say_hello(env, start_response):
        status = "200 OK"
        headers = [("Content-Type", "text/plain")]
        start_response(status, headers)
        return "hello, world"
    
    # urls表示的是动态资源，字典中的值对应函数，键是请求的文件名
    urls = [
            ("/", show_time),
            ("/ctime", show_time),
            ("/sayHello", say_hello)
        ]
    # 直接创建对象 便于服务器调用
    app = Application(urls)
    
    # if __name__ == "__main__":
    # urls = [
    # ("/", show_time),
    # ("/ctime", show_time),
    # ("/sayHello", say_hello)
    # ]
    # app = Application(urls)
    #
    # webServer = HTTPServer(app)
    # webServer.bind(7788)
    # webServer.start()

服务器作为执行程序，代码如下：

# coding:utf-8
    
    import socket
    import re
    import sys
    from multiprocessing import Process
    #from MyWebFrameWork import app
    
    class HTTPServer(object):
        """服务器类 Application表示的是web框架里的app 对象"""
    
        def __init__(self, Application):
            self.server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
            self.server_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
            self.app = Application
    
        def start(self):
            self.server_socket.listen(128)
            while True:
                client_socket, client_address = self.server_socket.accept()
                # print("[%s, %s]用户连接上了" % (client_address[0],client_address[1]))
                print("[%s, %s]用户连接上了" % client_address)
                handle_client_process = Process(target=self.handle_client, args=(client_socket,))
                handle_client_process.start()
                client_socket.close()
    
        def start_response(self, status, headers):
            """ status = "200 OK" headers = [ ("Content-Type", "text/plain") ] star """
            response_headers = "HTTP/1.1 " + status + "\r\n"
            for header in headers:
                response_headers += "%s: %s\r\n" % header
    
            self.response_headers = response_headers
    
        def handle_client(self, client_socket):
            """处理客户端请求"""
            # 获取客户端请求数据
            request_data = client_socket.recv(1024)
            print("request data:", request_data)
            request_lines = request_data.splitlines()
            for line in request_lines:
                print(line)
    
            # 解析请求报文
            # 'GET / HTTP/1.1'
            request_start_line = request_lines[0]
            # 提取用户请求的文件名
            print("*" * 10)
            print(request_start_line.decode("utf-8"))
            file_name = re.match(r"\w+ +(/[^ ]*) ", request_start_line.decode("utf-8")).group(1)
            method = re.match(r"(\w+) +/[^ ]* ", request_start_line.decode("utf-8")).group(1)
    
            # "/ctime.py"
            # "/sayhello.py"
    
            print("file_name:", file_name)
            print("method:", method)
            env = {
                "PATH_INFO": file_name,
                "METHOD": method
            }
            response_body = self.app(env, self.start_response)
    
            response = self.response_headers + "\r\n" + response_body
    
            print("response data:", response)
    
            # 向客户端返回响应数据
            client_socket.send(bytes(response, "utf-8"))
    
            # 关闭客户端连接
            client_socket.close()
    
        def bind(self, port):
            self.server_socket.bind(("", port))
    
    def main():
        # 这是一种固定框架的实现
        # my_server = HTTPServer(app)
        # my_server.bind(7788)
        # my_server.start()
    
        # 这是一种非固定的实现 具体用哪一个框架 由输入的参数决定
        if len(sys.argv) < 2:
            sys.exit("python MyWebServer.py Module:Application")
        module_name, app_name = sys.argv[1].split(':')
        m = __import__(module_name)
        app = getattr(m, app_name)
        my_server = HTTPServer(app)
        my_server.bind(7788)
        my_server.start()
    
    if __name__ == '__main__':
        main()

运行环境为pycharm，在script parameter里输入MyWebFrameWork:app，表示命令行中参数的传入。

在浏览器中输入127.0.0.1:7788/static/index.html 会显示如下页面：（静态页面的请求）

![这里写图片描述][SouthEast]

输入127.0.0.1:7788/ctime 显示：（动态资源的请求）

![这里写图片描述][SouthEast 1]

输入127.0.0.1:7788/sayHello 显示：（动态资源的请求）

![这里写图片描述][SouthEast 2]

[SouthEast]: /images/20220608/dbd652111f9c49909bb056c36e90b05d.png
[SouthEast 1]: /images/20220608/de6f81ef4a494d48a09e54108844b8c4.png
[SouthEast 2]: /images/20220608/5824e6b2bac34a419cfff06bae769ab2.png