mll-axum-utils 0.2.1

一个 Axum 的工具库
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

use std::{
    fs::File,
    io::Write,
    net::SocketAddr,
    sync::mpsc::{channel, Sender},
    task::{Context, Poll},
};

use axum::{
    body::Body,
    extract::ConnectInfo,
    http::{header::LOCATION, Request},
    response::Response,
};
use chrono::{DateTime, Local};
use color_string::{cs, fonts, Colored, Font::*};
use futures_util::future::BoxFuture;
use percent_encoding::percent_decode;
use tower::{Layer, Service};

use crate::utils::create_log_file;

/// # Examples
/// ```no_run
/// use axum::Router;
/// use mll_axum_utils::middleware::logger::Logger;
/// use std::net::SocketAddr;
///
/// #[tokio::main]
/// async fn main() {
/// let addr = "127.0.0.1:3000";
///     let app = Router::new().layer(Logger::default());
///
///     axum::Server::bind(&addr.parse().unwrap())
///         .serve(app.into_make_service_with_connect_info::<SocketAddr>())
///         .await
///         .unwrap();
/// }
/// ```
#[derive(Clone)]
pub struct Logger {
    sender: Sender<LogMsg>,
}

impl Logger {
    /// # Examples
    /// ```no_run
    /// use mll_axum_utils::middleware::logger::Logger;
    /// Logger::new("logs/%Y-%m-%d.log", true, true);
    /// ```
    pub fn new(format: &str, stdout: bool, file_out: bool) -> Self {
        let mut time = Local::now();

        let mut file = file_out.then(|| {
            let path = time.format(format).to_string();
            create_log_file(path)
        });

        let (sender, rx) = channel::<LogMsg>();
        // 单独线程 同步写入日志
        let format = format.to_string();
        tokio::spawn(async move {
            for msg in rx {
                if stdout {
                    msg.stdout()
                }

                if let Some(file) = file.as_mut() {
                    // 切换日志文件
                    if time.date_naive() != msg.begin.date_naive() {
                        time = msg.begin;
                        *file = create_log_file(time.format(&format).to_string())
                    }
                    msg.file_out(file)
                }
            }
        });

        Self { sender }
    }
}

impl Default for Logger {
    fn default() -> Self {
        Self::new("logs/%Y-%m-%d.log", true, false)
    }
}

impl<S> Layer<S> for Logger {
    type Service = LoggerService<S>;

    fn layer(&self, inner: S) -> Self::Service {
        LoggerService {
            inner,
            sender: self.sender.clone(),
        }
    }
}

#[derive(Clone)]
pub struct LoggerService<S> {
    inner: S,
    sender: Sender<LogMsg>,
}

impl<S> Service<Request<Body>> for LoggerService<S>
where
    S: Service<Request<Body>, Response = Response> + Send + 'static,
    S::Future: Send + 'static,
{
    type Response = S::Response;
    type Error = S::Error;
    type Future = BoxFuture<'static, Result<Self::Response, Self::Error>>;

    fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        self.inner.poll_ready(cx)
    }

    fn call(&mut self, req: Request<Body>) -> Self::Future {
        // 开始时间
        let begin = Local::now();
        // 请求方式
        let method = req.method().to_string();
        // 连接 ip
        let ip = match req.extensions().get::<ConnectInfo<SocketAddr>>() {
            Some(v) => v.0.ip().to_string(),
            None => panic!("Axum service 未配置 ConnectInfo<SocketAddr>"),
        };
        // 请求路径 解码为 utf-8
        let mut path = percent_decode(req.uri().path().as_bytes())
            .decode_utf8_lossy()
            .to_string();

        let sender = self.sender.clone();
        let future = self.inner.call(req);

        Box::pin(async move {
            let response: Self::Response = future.await?;
            // 状态码
            let status = response.status().as_u16();
            // 是否重定向
            if let Some(p) = response.headers().get(LOCATION) {
                path = format!(
                    "{path} -> {}",
                    percent_decode(p.as_bytes()).decode_utf8_lossy()
                )
            }

            let msg = LogMsg {
                logo: "[AXUM]".into(),
                begin,
                end: Local::now(),
                status,
                ip,
                method,
                path,
                other: "".into(),
            };

            if let Err(err) = sender.send(msg) {
                eprintln!("Send 日志时出现错误 -> {err}")
            }
            Ok(response)
        })
    }
}

struct LogMsg {
    logo: String,
    begin: DateTime<Local>,
    end: DateTime<Local>,
    status: u16,
    ip: String,
    method: String,
    path: String,
    other: String,
}

impl LogMsg {
    fn stdout(&self) {
        let status = match self.status / 100 {
            2 => cs!(BgGreen; " {} ", self.status),
            3 => cs!(BgBlue; " {} ", self.status),
            4 | 5 => cs!(BgRed; " {} ", self.status),
            _ => cs!(BgYellow; " {} ", self.status),
        };

        let method = match self.method.as_str() {
            "GET" | "POST" => cs!(BgBlue; " {:<6} ", self.method),
            "DELETE" => cs!(BgRed; " {:<6} ", self.method),
            _ => cs!(BgYellow; " {:<6} ", self.method),
        };

        println!(
            "[{}] {} |{}| {:>6} | {} |{} {} {}",
            self.begin.format("%Y-%m-%d %H:%M:%S").color(127, 132, 142),
            self.logo.fonts(fonts!(Bold, Purple)),
            status,
            format!("{}ms", (self.end - self.begin).num_milliseconds()),
            cs!(Yellow; "{:<15}", self.ip),
            method,
            self.path,
            self.other
        );
    }

    fn file_out(&self, file: &mut File) {
        let msg = format!(
            "[{}] {} | {} | {:>6} | {:>15} | {:<6} {} {}\n",
            self.begin.format("%Y-%m-%d %H:%M:%S"),
            self.logo,
            self.status,
            format!("{}ms", (self.end - self.begin).num_milliseconds()),
            self.ip,
            self.method,
            self.path,
            self.other
        );
        if let Err(err) = file.write_all(msg.as_bytes()) {
            println!("日志写入文件时出错 -> {err}")
        }
    }
}