mini-WebPython Web框架程序开发（logging日志）

Posted 2022-01-27 ZSYL

Python Web框架程序开发（logging日志）

• 1. logging日志的介绍
• 2. logging日志级别介绍
• 3. logging日志的使用
• 4. logging日志在mini-web项目中应用
• 5. 小结

1. logging日志的介绍

在现实生活中，记录日志非常重要，比如:银行转账时会有转账记录；飞机飞行过程中，会有个黑盒子（飞行数据记录器）记录着飞机的飞行过程，那在咱们python程序中想要记录程序在运行时所产生的日志信息，怎么做呢?

可以使用 logging 这个包来完成

记录程序日志信息的目的是:

1. 可以很方便的了解程序的运行情况
2. 可以分析用户的操作行为、喜好等信息
3. 方便开发人员检查bug

2. logging日志级别介绍

日志等级可以分为5个，从低到高分别是:

1. DEBUG
2. INFO
3. WARNING
4. ERROR
5. CRITICAL

日志等级说明:

• DEBUG：程序调试bug时使用
• INFO：程序正常运行时使用
• WARNING：程序未按预期运行时使用，但并不是错误，如:用户登录密码错误
• ERROR：程序出错误时使用，如:IO操作失败
• CRITICAL：特别严重的问题，导致程序不能再继续运行时使用，如:磁盘空间为空，一般很少使用
• 默认的是WARNING等级，当在WARNING或WARNING之上等级的才记录日志信息。
• 日志等级从低到高的顺序是: DEBUG < INFO < WARNING < ERROR < CRITICAL

3. logging日志的使用

在 logging 包中记录日志的方式有两种:

1. 输出到控制台
2. 保存到日志文件

日志信息输出到控制台的示例代码:

import logging

logging.debug('这是一个debug级别的日志信息')
logging.info('这是一个info级别的日志信息')
logging.warning('这是一个warning级别的日志信息')
logging.error('这是一个error级别的日志信息')
logging.critical('这是一个critical级别的日志信息')

运行结果:

WARNING:root:这是一个warning级别的日志信息
ERROR:root:这是一个error级别的日志信息
CRITICAL:root:这是一个critical级别的日志信息

说明:

• 日志信息只显示了大于等于WARNING级别的日志，这说明默认的日志级别设置为WARNING

logging 日志等级和输出格式的设置:

import logging

# 设置日志等级和输出日志格式
logging.basicConfig(level=logging.DEBUG,
                   	format='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s')

logging.debug('这是一个debug级别的日志信息')
logging.info('这是一个info级别的日志信息')
logging.warning('这是一个warning级别的日志信息')
logging.error('这是一个error级别的日志信息')
logging.critical('这是一个critical级别的日志信息')

运行结果:

2019-02-13 20:41:33,080 - hello.py[line:6] - DEBUG: 这是一个debug级别的日志信息
2019-02-13 20:41:33,080 - hello.py[line:7] - INFO: 这是一个info级别的日志信息
2019-02-13 20:41:33,080 - hello.py[line:8] - WARNING: 这是一个warning级别的日志信息
2019-02-13 20:41:33,080 - hello.py[line:9] - ERROR: 这是一个error级别的日志信息
2019-02-13 20:41:33,080 - hello.py[line:10] - CRITICAL: 这是一个critical级别的日志信息

代码说明:

• level 表示设置的日志等级
• format 表示日志的输出格式, 参数说明:
  • %(levelname)s: 打印日志级别名称
  • %(filename)s: 打印当前执行程序名
  • %(lineno)d: 打印日志的当前行号
  • %(asctime)s: 打印日志的时间
  • %(message)s: 打印日志信息

日志信息保存到日志文件的示例代码:

import logging

logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s',
                    filename="log.txt",
                    filemode="w")

logging.debug('这是一个debug级别的日志信息')
logging.info('这是一个info级别的日志信息')
logging.warning('这是一个warning级别的日志信息')
logging.error('这是一个error级别的日志信息')
logging.critical('这是一个critical级别的日志信息')

运行结果:

4. logging日志在mini-web项目中应用

web.py 程序使用logging日志示例:

import socket
import os
import threading
import sys
import framework
import logging

# 在程序入口模块，设置logging日志的配置信息，只配置一次，整个程序都可以使用，好比单例
logging.basicConfig(level=logging.DEBUG,
                    format="%(asctime)s-%(filename)s[lineno:%(lineno)d]-%(levelname)s-%(message)s",
                    filename="log.txt",
                    filemode="a")


# http协议的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)
        # 把tcp服务器的套接字作为web服务器对象的属性
        self.tcp_server_socket = tcp_server_socket

    # 处理客户端请求
    @staticmethod
    def handle_client_request(new_socket):
        # 接收客户端的请求信息
        recv_data = new_socket.recv(4096)
        # 判断接收的数据长度是否为0
        if len(recv_data) == 0:
            new_socket.close()
            return

        # 对二进制数据进行解码
        recv_content = recv_data.decode("utf-8")
        print(recv_content)

        # 对数据按照空格进行分割
        request_list = recv_content.split(" ", maxsplit=2)
        # 获取请求的资源路径
        request_path = request_list[1]
        print(request_path)

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

        # 判断是否是动态资源请求，以后把后缀是.html的请求任务是动态资源请求
        if request_path.endswith(".html"):
            """动态资源请求"""
            logging.info("动态资源请求地址:" + request_path)
            # 动态资源请求找web框架进行处理，需要把请求参数给web框架
            # 准备给web框架的参数信息，都要放到字典里面
            env = 
                "request_path": request_path,
                # 传入请求头信息，额外的参数可以在字典里面在进行添加
            
            # 使用框架处理动态资源请求,
            # 1. web框架需要把处理结果返回给web服务器，
            # 2. web服务器负责把返回的结果封装成响应报文发送给浏览器
            status, headers, response_body = framework.handle_request(env)
            print(status, headers, response_body)
            # 响应行
            response_line = "HTTP/1.1 %s\\r\\n" % status
            # 响应头
            response_header = ""
            for header in headers:
                response_header += "%s: %s\\r\\n" % header

            # 响应报文
            response_data = (response_line +
                             response_header +
                             "\\r\\n" +
                             response_body).encode("utf-8")

            # 发送响应报文数据给浏览器
            new_socket.send(response_data)
            # 关闭连接
            new_socket.close()

        else:
            """静态资源请求"""
            logging.info("静态资源请求地址:" + request_path)
            # 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()

    # 启动服务器的方法
    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():

    # # # 获取终端命令行参数
    # params = sys.argv
    # if len(params) != 2:
    #     print("执行的命令格式如下: python3 xxx.py 9000")
    #     logging.warning("在终端启动程序参数的个数不等于2!")
    #     return
    #
    # # 判断第二个参数是否都是由数字组成的字符串
    # if not params[1].isdigit():
    #     print("执行的命令格式如下: python3 xxx.py 9000")
    #     logging.warning("在终端启动程序参数的类型不是数字字符串!")
    #     return
    #
    # # 代码执行到此，说明命令行参数的个数一定2个并且第二个参数是由数字组成的字符串
    # port = int(params[1])
    # 创建web服务器
    web_server = HttpWebServer(8000)
    # 启动服务器
    web_server.start()


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

framework.py 程序使用logging日志示例:

# 处理动态资源请求
def handle_request(env):
    # 获取动态的请求资源路径
    request_path = env["request_path"]
    print("动态资源请求的地址:", request_path)

    # 遍历路由列表，匹配请求的url
    for path, func in route_list:
        if request_path == path:
            # 找到了指定路由，执行对应的处理函数
            result = func()
            return result
    else:
        # 没有动态资源数据, 返回404状态信息
        result = not_found()
        logging.error("没有设置相关的路由信息:" + request_path)
        # 把处理后的结果返回给web服务器使用，让web服务器拼接响应报文时使用
        return result

说明:

• logging日志配置信息在程序入口模块设置一次，整个程序都可以生效。
  • logging.basicConfig 表示 logging 日志配置操作

5. 小结

• 记录python程序中日志信息使用 logging 包来完成

• logging日志等级有5个:

  1. DEBUG
  2. INFO
  3. WARNING
  4. ERROR
  5. CRITICAL

• 打印(记录)日志的函数有5个:

  1. logging.debug函数, 表示: 打印(记录)DEBUG级别的日志信息
  2. logging.info函数, 表示: 打印(记录)INFO级别的日志信息
  3. logging.warning函数, 表示: 打印(记录)WARNING级别的日志信息
  4. logging.error函数, 表示: 打印(记录)ERROR级别的日志信息
  5. logging.critical函数, 表示: 打印(记录)CRITICAL级别的日志信息

---

加油!

感谢!

努力!