优雅停机与清理
清单 21-20 中的代码按照我们的预期通过线程池异步响应请求。我们收到了一些关于未直接使用的 workers、id 和 thread 字段的警告，这提醒我们还没有进行任何清理。当我们使用不太优雅的 ctrl-C 方式停止主线程时，所有其他线程也会立即停止，即使它们正在处理请求。
接下来，我们将实现 Drop trait，以便对池中的每个线程调用 join，使它们在关闭之前能够完成正在处理的请求。然后，我们将实现一种方式，告诉线程它们应该停止接受新请求并关闭。为了看到这段代码的实际效果，我们将修改我们的服务器，使其在接受两个请求后就优雅地关闭其线程池。
随着我们的进展，有一点需要注意：这些都不会影响处理执行闭包的代码部分，因此如果我们将线程池用于异步运行时，这里的一切都会是相同的。
在 ThreadPool 上实现 Drop Trait
让我们从在线程池上实现 Drop 开始。当池被丢弃时，我们的所有线程应该 join 以确保它们完成工作。清单 21-22 显示了 Drop 实现的第一次尝试；这段代码还不能完全工作。
use std::{
sync::{Arc, Mutex, mpsc},
thread,
};
pub struct ThreadPool {
workers: Vec<Worker>,
sender: mpsc::Sender<Job>,
}
type Job = Box<dyn FnOnce() + Send + 'static>;
impl ThreadPool {
/// Create a new ThreadPool.
///
/// The size is the number of threads in the pool.
///
/// # Panics
///
/// The `new` function will panic if the size is zero.
pub fn new(size: usize) -> ThreadPool {
assert!(size > 0);
let (sender, receiver) = mpsc::channel();
let receiver = Arc::new(Mutex::new(receiver));
let mut workers = Vec::with_capacity(size);
for id in 0..size {
workers.push(Worker::new(id, Arc::clone(&receiver)));
}
ThreadPool { workers, sender }
}
pub fn execute<F>(&self, f: F)
where
F: FnOnce() + Send + 'static,
{
let job = Box::new(f);
self.sender.send(job).unwrap();
}
}
impl Drop for ThreadPool {
fn drop(&mut self) {
for worker in &mut self.workers {
println!("Shutting down worker {}", worker.id);
worker.thread.join().unwrap();
}
}
}
struct Worker {
id: usize,
thread: thread::JoinHandle<()>,
}
impl Worker {
fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
let thread = thread::spawn(move || {
loop {
let job = receiver.lock().unwrap().recv().unwrap();
println!("Worker {id} got a job; executing.");
job();
}
});
Worker { id, thread }
}
}首先，我们遍历线程池中的每个 Worker。我们使用 &mut 因为 self 是一个可变引用，并且我们也需要能够修改 worker。对于每个 Worker，我们打印一条消息说这个特定的 Worker 实例正在关闭，然后我们对该 Worker 实例的线程调用 join。如果对 join 的调用失败，我们使用 unwrap 使 Rust panic 并进入不优雅的关闭。
这是我们编译这段代码时得到的错误：
$ cargo check
Checking hello v0.1.0 (file:///projects/hello)
error[E0507]: cannot move out of `worker.thread` which is behind a mutable reference
--> src/lib.rs:52:13
|
52 | worker.thread.join().unwrap();
| ^^^^^^^^^^^^^ ------ `worker.thread` moved due to this method call
| |
| move occurs because `worker.thread` has type `JoinHandle<()>`, which does not implement the `Copy` trait
|
note: `JoinHandle::<T>::join` takes ownership of the receiver `self`, which moves `worker.thread`
--> /rustc/1159e78c4747b02ef996e55082b704c09b970588/library/std/src/thread/mod.rs:1921:17
For more information about this error, try `rustc --explain E0507`.
error: could not compile `hello` (lib) due to 1 previous error
错误告诉我们不能调用 join，因为我们只有每个 worker 的可变借用，而 join 需要获取其参数的所有权。为了解决这个问题，我们需要将线程从拥有 thread 的 Worker 实例中移出来，以便 join 可以消费该线程。一种方法是在清单 18-15 中采取同样的方法。如果 Worker 持有一个 Option<thread::JoinHandle<()>>，我们可以在 Option 上调用 take 方法将值从 Some 变体中移出，并在其位置留下一个 None 变体。换句话说，一个正在运行的 Worker 将在 thread 中拥有一个 Some 变体，而当我们想要清理一个 Worker 时，我们将 Some 替换为 None，以便该 Worker 没有可运行的线程。
然而，这种情况唯一会在丢弃 Worker 时出现。作为交换，我们在任何访问 worker.thread 的地方，都必须处理 Option<thread::JoinHandle<()>>。惯用的 Rust 会大量使用 Option，但当你发现自己像这样将已知始终存在的东西包装在 Option 中作为变通方法时，最好寻找替代方法以使代码更简洁且不易出错。
在这种情况下，有一个更好的替代方案：Vec::drain 方法。它接受一个范围参数来指定要从向量中移除哪些项，并返回这些项的一个迭代器。传递 .. 范围语法将移除向量中的所有值。
因此，我们需要像这样更新 ThreadPool 的 drop 实现：
#![allow(unused)]
fn main() {
use std::{
sync::{Arc, Mutex, mpsc},
thread,
};
pub struct ThreadPool {
workers: Vec<Worker>,
sender: mpsc::Sender<Job>,
}
type Job = Box<dyn FnOnce() + Send + 'static>;
impl ThreadPool {
/// Create a new ThreadPool.
///
/// The size is the number of threads in the pool.
///
/// # Panics
///
/// The `new` function will panic if the size is zero.
pub fn new(size: usize) -> ThreadPool {
assert!(size > 0);
let (sender, receiver) = mpsc::channel();
let receiver = Arc::new(Mutex::new(receiver));
let mut workers = Vec::with_capacity(size);
for id in 0..size {
workers.push(Worker::new(id, Arc::clone(&receiver)));
}
ThreadPool { workers, sender }
}
pub fn execute<F>(&self, f: F)
where
F: FnOnce() + Send + 'static,
{
let job = Box::new(f);
self.sender.send(job).unwrap();
}
}
impl Drop for ThreadPool {
fn drop(&mut self) {
for worker in self.workers.drain(..) {
println!("Shutting down worker {}", worker.id);
worker.thread.join().unwrap();
}
}
}
struct Worker {
id: usize,
thread: thread::JoinHandle<()>,
}
impl Worker {
fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
let thread = thread::spawn(move || {
loop {
let job = receiver.lock().unwrap().recv().unwrap();
println!("Worker {id} got a job; executing.");
job();
}
});
Worker { id, thread }
}
}
}这解决了编译器错误，并且不需要对我们的代码进行任何其他更改。请注意，由于在 panic 时也可能调用 drop，因此 unwrap 也可能会 panic 并导致双重 panic，这会立即崩溃程序并结束任何正在进行的清理。这对于示例程序来说没问题，但不推荐用于生产代码。
向线程发送停止监听任务的信号
通过我们所做的所有更改，我们的代码编译没有任何警告。然而，坏消息是这段代码还没有按照我们想要的方式运行。关键在于 Worker 实例的线程运行的闭包中的逻辑：目前，我们调用 join，但这不会关闭线程，因为它们会永远循环寻找任务。如果我们尝试使用当前的 drop 实现来丢弃 ThreadPool，主线程将永远阻塞，等待第一个线程完成。
要解决这个问题，我们需要在 ThreadPool 的 drop 实现中进行一个更改，然后在 Worker 循环中进行一个更改。
首先，我们将更改 ThreadPool 的 drop 实现，在等待线程完成之前显式丢弃 sender。清单 21-23 显示了将 sender 显式丢弃的 ThreadPool 的更改。与线程不同，这里我们确实需要使用 Option 才能通过 Option::take 将 sender 从 ThreadPool 中移出。
use std::{
sync::{Arc, Mutex, mpsc},
thread,
};
pub struct ThreadPool {
workers: Vec<Worker>,
sender: Option<mpsc::Sender<Job>>,
}
// --snip--
type Job = Box<dyn FnOnce() + Send + 'static>;
impl ThreadPool {
/// Create a new ThreadPool.
///
/// The size is the number of threads in the pool.
///
/// # Panics
///
/// The `new` function will panic if the size is zero.
pub fn new(size: usize) -> ThreadPool {
// --snip--
assert!(size > 0);
let (sender, receiver) = mpsc::channel();
let receiver = Arc::new(Mutex::new(receiver));
let mut workers = Vec::with_capacity(size);
for id in 0..size {
workers.push(Worker::new(id, Arc::clone(&receiver)));
}
ThreadPool {
workers,
sender: Some(sender),
}
}
pub fn execute<F>(&self, f: F)
where
F: FnOnce() + Send + 'static,
{
let job = Box::new(f);
self.sender.as_ref().unwrap().send(job).unwrap();
}
}
impl Drop for ThreadPool {
fn drop(&mut self) {
drop(self.sender.take());
for worker in self.workers.drain(..) {
println!("Shutting down worker {}", worker.id);
worker.thread.join().unwrap();
}
}
}
struct Worker {
id: usize,
thread: thread::JoinHandle<()>,
}
impl Worker {
fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
let thread = thread::spawn(move || {
loop {
let job = receiver.lock().unwrap().recv().unwrap();
println!("Worker {id} got a job; executing.");
job();
}
});
Worker { id, thread }
}
}Worker 线程之前显式丢弃 sender丢弃 sender 会关闭通道，这表示不会再有消息被发送。当这种情况发生时，Worker 实例在无限循环中执行的所有 recv 调用都将返回一个错误。在清单 21-24 中，我们更改了 Worker 循环，使其在这种情况下优雅地退出循环，这意味着当 ThreadPool 的 drop 实现调用 join 时，线程将完成。
use std::{
sync::{Arc, Mutex, mpsc},
thread,
};
pub struct ThreadPool {
workers: Vec<Worker>,
sender: Option<mpsc::Sender<Job>>,
}
type Job = Box<dyn FnOnce() + Send + 'static>;
impl ThreadPool {
/// Create a new ThreadPool.
///
/// The size is the number of threads in the pool.
///
/// # Panics
///
/// The `new` function will panic if the size is zero.
pub fn new(size: usize) -> ThreadPool {
assert!(size > 0);
let (sender, receiver) = mpsc::channel();
let receiver = Arc::new(Mutex::new(receiver));
let mut workers = Vec::with_capacity(size);
for id in 0..size {
workers.push(Worker::new(id, Arc::clone(&receiver)));
}
ThreadPool {
workers,
sender: Some(sender),
}
}
pub fn execute<F>(&self, f: F)
where
F: FnOnce() + Send + 'static,
{
let job = Box::new(f);
self.sender.as_ref().unwrap().send(job).unwrap();
}
}
impl Drop for ThreadPool {
fn drop(&mut self) {
drop(self.sender.take());
for worker in self.workers.drain(..) {
println!("Shutting down worker {}", worker.id);
worker.thread.join().unwrap();
}
}
}
struct Worker {
id: usize,
thread: thread::JoinHandle<()>,
}
impl Worker {
fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
let thread = thread::spawn(move || {
loop {
let message = receiver.lock().unwrap().recv();
match message {
Ok(job) => {
println!("Worker {id} got a job; executing.");
job();
}
Err(_) => {
println!("Worker {id} disconnected; shutting down.");
break;
}
}
}
});
Worker { id, thread }
}
}recv 返回错误时显式跳出循环为了看到这段代码的实际效果，让我们修改 main 以在接受两个请求后优雅地关闭服务器，如清单 21-25 所示。
use hello::ThreadPool;
use std::{
fs,
io::{BufReader, prelude::*},
net::{TcpListener, TcpStream},
thread,
time::Duration,
};
fn main() {
let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
let pool = ThreadPool::new(4);
for stream in listener.incoming().take(2) {
let stream = stream.unwrap();
pool.execute(|| {
handle_connection(stream);
});
}
println!("Shutting down.");
}
fn handle_connection(mut stream: TcpStream) {
let buf_reader = BufReader::new(&stream);
let request_line = buf_reader.lines().next().unwrap().unwrap();
let (status_line, filename) = match &request_line[..] {
"GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
"GET /sleep HTTP/1.1" => {
thread::sleep(Duration::from_secs(5));
("HTTP/1.1 200 OK", "hello.html")
}
_ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
};
let contents = fs::read_to_string(filename).unwrap();
let length = contents.len();
let response =
format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
stream.write_all(response.as_bytes()).unwrap();
}你不会希望一个真实的 Web 服务器在只服务两个请求后关闭。这段代码只是演示优雅停机与清理功能在正常工作。
take 方法定义在 Iterator trait 中，将迭代限制为最多前两个项目。ThreadPool 将在 main 结束时超出作用域，并且 drop 实现将运行。
使用 cargo run 启动服务器，并发出三个请求。第三个请求应该出错，在你的终端中，你应该会看到类似于以下的输出：
$ cargo run
Compiling hello v0.1.0 (file:///projects/hello)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.41s
Running `target/debug/hello`
Worker 0 got a job; executing.
Shutting down.
Shutting down worker 0
Worker 3 got a job; executing.
Worker 1 disconnected; shutting down.
Worker 2 disconnected; shutting down.
Worker 3 disconnected; shutting down.
Worker 0 disconnected; shutting down.
Shutting down worker 1
Shutting down worker 2
Shutting down worker 3
你可能会看到不同的 Worker ID 顺序和消息打印。我们可以从消息中看出这段代码是如何工作的：Worker 实例 0 和 3 获得了前两个请求。服务器在第二个连接后停止接受连接，并且在 Worker 3 甚至开始其任务之前，ThreadPool 上的 Drop 实现就开始执行。丢弃 sender 会断开所有 Worker 实例的连接，并告诉它们关闭。每个 Worker 实例在断开连接时打印一条消息，然后线程池调用 join 等待每个 Worker 线程完成。
注意此特定执行的一个有趣方面：ThreadPool 丢弃了 sender，并且在任何 Worker 收到错误之前，我们尝试 join Worker 0。Worker 0 尚未从 recv 获得错误，因此主线程阻塞，等待 Worker 0 完成。与此同时，Worker 3 收到了一个任务，然后所有线程都收到了错误。当 Worker 0 完成时，主线程等待其余的 Worker 实例完成。这时，它们都已经退出了循环并停止了。
恭喜！我们现在已经完成了项目；我们有了一个使用线程池异步响应的基础 Web 服务器。我们能够执行服务器的优雅停机，这会清理池中的所有线程。
以下是完整的参考代码：
use hello::ThreadPool;
use std::{
fs,
io::{BufReader, prelude::*},
net::{TcpListener, TcpStream},
thread,
time::Duration,
};
fn main() {
let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
let pool = ThreadPool::new(4);
for stream in listener.incoming().take(2) {
let stream = stream.unwrap();
pool.execute(|| {
handle_connection(stream);
});
}
println!("Shutting down.");
}
fn handle_connection(mut stream: TcpStream) {
let buf_reader = BufReader::new(&stream);
let request_line = buf_reader.lines().next().unwrap().unwrap();
let (status_line, filename) = match &request_line[..] {
"GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
"GET /sleep HTTP/1.1" => {
thread::sleep(Duration::from_secs(5));
("HTTP/1.1 200 OK", "hello.html")
}
_ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
};
let contents = fs::read_to_string(filename).unwrap();
let length = contents.len();
let response =
format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
stream.write_all(response.as_bytes()).unwrap();
}use std::{
sync::{Arc, Mutex, mpsc},
thread,
};
pub struct ThreadPool {
workers: Vec<Worker>,
sender: Option<mpsc::Sender<Job>>,
}
type Job = Box<dyn FnOnce() + Send + 'static>;
impl ThreadPool {
/// Create a new ThreadPool.
///
/// The size is the number of threads in the pool.
///
/// # Panics
///
/// The `new` function will panic if the size is zero.
pub fn new(size: usize) -> ThreadPool {
assert!(size > 0);
let (sender, receiver) = mpsc::channel();
let receiver = Arc::new(Mutex::new(receiver));
let mut workers = Vec::with_capacity(size);
for id in 0..size {
workers.push(Worker::new(id, Arc::clone(&receiver)));
}
ThreadPool {
workers,
sender: Some(sender),
}
}
pub fn execute<F>(&self, f: F)
where
F: FnOnce() + Send + 'static,
{
let job = Box::new(f);
self.sender.as_ref().unwrap().send(job).unwrap();
}
}
impl Drop for ThreadPool {
fn drop(&mut self) {
drop(self.sender.take());
for worker in &mut self.workers {
println!("Shutting down worker {}", worker.id);
if let Some(thread) = worker.thread.take() {
thread.join().unwrap();
}
}
}
}
struct Worker {
id: usize,
thread: Option<thread::JoinHandle<()>>,
}
impl Worker {
fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
let thread = thread::spawn(move || {
loop {
let message = receiver.lock().unwrap().recv();
match message {
Ok(job) => {
println!("Worker {id} got a job; executing.");
job();
}
Err(_) => {
println!("Worker {id} disconnected; shutting down.");
break;
}
}
}
});
Worker {
id,
thread: Some(thread),
}
}
}我们还可以做更多！如果你想继续增强这个项目，以下是一些想法：
- 为
ThreadPool及其公有方法添加更多文档。 - 添加库功能的测试。
- 将对
unwrap的调用改为更稳健的错误处理。 - 使用
ThreadPool执行除服务 Web 请求之外的其他任务。 - 在 crates.io 上找一个线程池 crate，并使用该 crate 实现一个类似的 Web 服务器。然后，将其 API 和稳健性与我们实现的线程池进行比较。
总结
做得很好！你已成功读完本书！我们要感谢你加入我们这段 Rust 之旅。你现在已经准备好实现自己的 Rust 项目，并帮助其他人的项目了。请记住，有一个热情的 Rustaceans 社区，他们很乐意帮助你解决在 Rust 之旅中遇到的任何挑战。