草庐IT

Rust编程语言入门之项目实例:- 命令行程序

小乔的博客 2023-04-11 原文

项目实例:- 命令行程序

一、实例:接收命令行参数

本章内容

  • 12.1 接收命令行参数
  • 12.2 读取文件
  • 12.3 重构:改进模块和错误处理
  • 12.4 使用 TDD(测试驱动开发)开发库功能
  • 12.5 使用环境变量
  • 12.6 将错误消息写入标准错误而不是标准输出

创建项目

~/rust
➜ cargo new minigrep
     Created binary (application) `minigrep` package

~/rust
➜ cd minigrep


minigrep on  master [?] via ? 1.67.1
➜ c // code .

minigrep on  master [?] via ? 1.67.1
➜

main.rs 文件

use std::env;

fn main() {
    let args: Vec<String> = env::args().collect();

    // env::args_os() // OsString
    // println!("{:?}", args);

    let query = &args[1];
    let filename = &args[2];

    println!("Search for {}", query);
    println!("In file {}", filename);
}

运行

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ cargo run
   Compiling minigrep v0.1.0 (/Users/qiaopengjun/rust/minigrep)
    Finished dev [unoptimized + debuginfo] target(s) in 0.17s
     Running `target/debug/minigrep`
["target/debug/minigrep"]

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ 

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ cargo run 1234 abcd
    Finished dev [unoptimized + debuginfo] target(s) in 0.02s
     Running `target/debug/minigrep 1234 abcd`
["target/debug/minigrep", "1234", "abcd"]

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 took 2.3s 
➜ 

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 took 2.3s 
➜ cargo run abcd readme.txt
   Compiling minigrep v0.1.0 (/Users/qiaopengjun/rust/minigrep)
    Finished dev [unoptimized + debuginfo] target(s) in 0.39s
     Running `target/debug/minigrep abcd readme.txt`
Search for abcd
In file readme.txt

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 took 2.4s 
➜ 

二、实例:读取文件

src/main.rs 文件

use std::env;
use std::fs;

fn main() {
    let args: Vec<String> = env::args().collect();

    // env::args_os() // OsString
    // println!("{:?}", args);

    let query = &args[1];
    let filename = &args[2];

    println!("Search for {}", query);
    println!("In file {}", filename);

    let contents = fs::read_to_string(filename)
    .expect("Something went wrong reading the file");

    println!("With text:\n{}", contents);
}

poem.txt 文件

I'm nobody! Who are you?
Are you nobody, too?
Then there's a pair of us - don't tell!
They'd banish us, you know.

How dreary to be somebody!
How public, like a frog
To tell your name the livelong day
To an admiring bog!

运行

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ cargo run the poem.txt   
   Compiling minigrep v0.1.0 (/Users/qiaopengjun/rust/minigrep)
    Finished dev [unoptimized + debuginfo] target(s) in 0.41s
     Running `target/debug/minigrep the poem.txt`
Search for the
In file poem.txt
With text:
I'm nobody! Who are you?
Are you nobody, too?
Then there's a pair of us - don't tell!
They'd banish us, you know.

How dreary to be somebody!
How public, like a frog
To tell your name the livelong day
To an admiring bog!


minigrep on  master [?] is ? 0.1.0 via ? 

三、实例:重构(上:改善模块化)

二进制程序关注点分离的指导性原则

  • 将程序拆分为 main.rs 和 lib.rs ,将业务逻辑放入 lib.rs
  • 当命令行解析逻辑较少时,将它放在 main.rs 也行
  • 当命令行解析逻辑变复杂时,需要将它从 main.rs 提取到 lib.rs

经过上述拆分,留在 main 的功能有:

  • 使用参数值调用命令行解析逻辑
  • 进行其它配置
  • 调用 lib.rs 中的 run 函数
  • 处理 run 函数可能出现的错误

优化一:

use std::env;
use std::fs;

fn main() {
    let args: Vec<String> = env::args().collect();
    let (_query, filename) = parse_config(&args);
    let contents = fs::read_to_string(filename).expect("Something went wrong reading the file");
    println!("With text:\n{}", contents);
}

fn parse_config(args: &[String]) -> (&str, &str) {
    let query = &args[1];
    let filename = &args[2];

    (query, filename)
}

优化二:

use std::env;
use std::fs;

fn main() {
    let args: Vec<String> = env::args().collect();
    let config = parse_config(&args);
    let contents = fs::read_to_string(config.filename).expect("Something went wrong reading the file");
    println!("With text:\n{}", contents);
    println!("query: {:?}", config.query)
}

struct Config {
    query: String,
    filename: String,
}

fn parse_config(args: &[String]) -> Config  {
    let query = args[1].clone();
    let filename = args[2].clone();

    Config { query, filename }
}

优化三:

use std::env;
use std::fs;

fn main() {
    let args: Vec<String> = env::args().collect();
    let config = Config::new(&args);
    let contents =
        fs::read_to_string(config.filename).expect("Something went wrong reading the file");
    println!("With text:\n{}", contents);
    println!("query: {:?}", config.query)
}

struct Config {
    query: String,
    filename: String,
}

impl Config {
    fn new(args: &[String]) -> Config {
        let query = args[1].clone();
        let filename = args[2].clone();

        Config { query, filename }
    }
}

四、实例:重构(中:错误处理)

错误信息:

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ cargo run             
   Compiling minigrep v0.1.0 (/Users/qiaopengjun/rust/minigrep)
    Finished dev [unoptimized + debuginfo] target(s) in 0.11s
     Running `target/debug/minigrep`
thread 'main' panicked at 'index out of bounds: the len is 1 but the index is 1', src/main.rs:20:21
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ 

优化一:

use std::env;
use std::fs;

fn main() {
    let args: Vec<String> = env::args().collect();
    let config = Config::new(&args);
    let contents =
        fs::read_to_string(config.filename).expect("Something went wrong reading the file");
    println!("With text:\n{}", contents);
    println!("query: {:?}", config.query)
}

struct Config {
    query: String,
    filename: String,
}

impl Config {
    fn new(args: &[String]) -> Config {
        if args.len() < 3 {
            panic!("not enough arguments");
        }
        let query = args[1].clone();
        let filename = args[2].clone();

        Config { query, filename }
    }
}

优化二:

use std::env;
use std::fs;
use std::process;

fn main() {
    let args: Vec<String> = env::args().collect();
    let config = Config::new(&args).unwrap_or_else(|err| {
        println!("Problem parsing arguments: {}", err);
        process::exit(1);
    });
    let contents =
        fs::read_to_string(config.filename).expect("Something went wrong reading the file");
    println!("With text:\n{}", contents);
    println!("query: {:?}", config.query)
}

struct Config {
    query: String,
    filename: String,
}

impl Config {
    fn new(args: &[String]) -> Result<Config, &'static str> {
        if args.len() < 3 {
            return Err("not enough arguments");
        }
        let query = args[1].clone();
        let filename = args[2].clone();

        Ok(Config { query, filename })
    }
}

五、实例:重构(下:将业务逻辑移至 lib.rs)

优化一:

use std::env;
use std::fs;
use std::process;
use std::error::Error;

fn main() {
    let args: Vec<String> = env::args().collect();
    let config = Config::new(&args).unwrap_or_else(|err| {
        println!("Problem parsing arguments: {}", err);
        process::exit(1);
    });
    if let Err(e) = run(config) {
        println!("Application error: {}", e);
        process::exit(1);
    }
}

fn run(config: Config) -> Result<(), Box<dyn Error>> {
    let contents =
    fs::read_to_string(config.filename)?;
    println!("With text:\n{}", contents);
    println!("query: {:?}", config.query);
    Ok(())
}

struct Config {
    query: String,
    filename: String,
}

impl Config {
    fn new(args: &[String]) -> Result<Config, &'static str> {
        if args.len() < 3 {
            return Err("not enough arguments");
        }
        let query = args[1].clone();
        let filename = args[2].clone();

        Ok(Config { query, filename })
    }
}

迁移 模块化:

src/mian.rs 文件

use minigrep::Config;
use std::env;
use std::process;

fn main() {
    let args: Vec<String> = env::args().collect();
    let config = Config::new(&args).unwrap_or_else(|err| {
        println!("Problem parsing arguments: {}", err);
        process::exit(1);
    });
    if let Err(e) = minigrep::run(config) {
        println!("Application error: {}", e);
        process::exit(1);
    }
}

src/lib.rs 文件

use std::error::Error;
use std::fs;

pub fn run(config: Config) -> Result<(), Box<dyn Error>> {
    let contents = fs::read_to_string(config.filename)?;
    println!("With text:\n{}", contents);
    println!("query: {:?}", config.query);
    Ok(())
}

pub struct Config {
    pub query: String,
    pub filename: String,
}

impl Config {
    pub fn new(args: &[String]) -> Result<Config, &'static str> {
        if args.len() < 3 {
            return Err("not enough arguments");
        }
        let query = args[1].clone();
        let filename = args[2].clone();

        Ok(Config { query, filename })
    }
}

六、使用 TDD(测试驱动开发)编写库功能

测试驱动开发 TDD(Test-Driven Development)

  • 编写一个会失败的测试,运行该测试,确保它是按照预期的原因失败
  • 编写或修改刚好足够的代码,让新测试通过
  • 重构刚刚添加或修改的代码,确保测试会始终通过
  • 返回步骤 1 ,继续

src/lib.rs 文件

use std::error::Error;
use std::fs;

pub fn run(config: Config) -> Result<(), Box<dyn Error>> {
    let contents = fs::read_to_string(config.filename)?;
    for line in search(&config.query, &contents) {
        println!("line: {}", line);
    }
    // println!("With text:\n{}", contents);
    // println!("query: {:?}", config.query);
    Ok(())
}

pub struct Config {
    pub query: String,
    pub filename: String,
}

impl Config {
    pub fn new(args: &[String]) -> Result<Config, &'static str> {
        if args.len() < 3 {
            return Err("not enough arguments");
        }
        let query = args[1].clone();
        let filename = args[2].clone();

        Ok(Config { query, filename })
    }
}

pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {
    let mut results = Vec::new();

    for line in contents.lines() {
        if line.contains(query) {
            results.push(line);
        }
    }

    results
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn one_result() {
        let query = "duct";
        let contents = "\
Rust:
safe, fast, productive.
Pick three.";

        assert_eq!(vec!["safe, fast, productive."], search(query, contents))
    }
}

运行

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ cargo run frog poem.txt
   Compiling minigrep v0.1.0 (/Users/qiaopengjun/rust/minigrep)
    Finished dev [unoptimized + debuginfo] target(s) in 0.18s
     Running `target/debug/minigrep frog poem.txt`
line: How public, like a frog

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ cargo run body poem.txt
    Finished dev [unoptimized + debuginfo] target(s) in 0.00s
     Running `target/debug/minigrep body poem.txt`
line: I'm nobody! Who are you?
line: Are you nobody, too?
line: How dreary to be somebody!

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ cargo run 123 poem.txt 
    Finished dev [unoptimized + debuginfo] target(s) in 0.00s
     Running `target/debug/minigrep 123 poem.txt`

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ 

七、实例:使用环境变量

src/lib.rs 文件

use std::error::Error;
use std::fs;
use std::env;

pub fn run(config: Config) -> Result<(), Box<dyn Error>> {
    let contents = fs::read_to_string(config.filename)?;
    let results = if config.case_sensitive {
        search(&config.query,  &contents)
    } else {
        search_case_insensitive(&config.query, &contents)
    };
    for line in results {
        println!("line: {}", line);
    }
    // println!("With text:\n{}", contents);
    // println!("query: {:?}", config.query);
    Ok(())
}

pub struct Config {
    pub query: String,
    pub filename: String,
    pub case_sensitive: bool,
}

impl Config {
    pub fn new(args: &[String]) -> Result<Config, &'static str> {
        if args.len() < 3 {
            return Err("not enough arguments");
        }
        let query = args[1].clone();
        let filename = args[2].clone();
        let case_sensitive = env::var("CASE_INSENSITIVE").is_err();
        Ok(Config { query, filename, case_sensitive })
    }
}

pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {
    let mut results = Vec::new();

    for line in contents.lines() {
        if line.contains(query) {
            results.push(line);
        }
    }

    results
}

pub fn search_case_insensitive<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {
    let mut results = Vec::new();
    let query = query.to_lowercase();

    for line in contents.lines() {
        if line.to_lowercase().contains(&query) {
            results.push(line);
        }
    }

    results
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
//     fn one_result() {
//         let query = "duct";
//         let contents = "\
// Rust:
// safe, fast, productive.
// Pick three.";

//         assert_eq!(vec!["safe, fast, productive."], search(query, contents))
//     }

    fn case_sensitive() {
        let query = "duct";
        let contents = "\
Rust:
safe, fast, productive.
Pick three.
Duct tape.";

        assert_eq!(vec!["safe, fast, productive."], search(query, contents))
    }

    #[test]
    fn case_insensitive() {
        let query = "rUsT";
        let contents = "\
Rust:
safe, fase, productive.
Pick three.
Trust me.";

        assert_eq!(vec!["Rust:", "Trust me."], search_case_insensitive(query, contents))
    }
}

运行

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ cargo run to poem.txt 
   Compiling minigrep v0.1.0 (/Users/qiaopengjun/rust/minigrep)
    Finished dev [unoptimized + debuginfo] target(s) in 0.40s
     Running `target/debug/minigrep to poem.txt`
line: Are you nobody, too?
line: How dreary to be somebody!

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ CASE_INSENSITIVE=1 cargo run to poem.txt
    Finished dev [unoptimized + debuginfo] target(s) in 0.00s
     Running `target/debug/minigrep to poem.txt`
line: Are you nobody, too?
line: How dreary to be somebody!
line: To tell your name the livelong day
line: To an admiring bog!

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ 

八、实例:将错误信息输出到标准错误

标准输出 VS 标准错误

  • 标准输出:stdout
    • println!
  • 标准错误:stderr
    • eprintln!

src/main.rs 文件

use minigrep::Config;
use std::env;
use std::process;

fn main() {
    let args: Vec<String> = env::args().collect();
    let config = Config::new(&args).unwrap_or_else(|err| {
        eprintln!("Problem parsing arguments: {}", err);
        process::exit(1);
    });
    if let Err(e) = minigrep::run(config) {
        eprintln!("Application error: {}", e);
        process::exit(1);
    }
}

运行

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ cargo run > output.txt
   Compiling minigrep v0.1.0 (/Users/qiaopengjun/rust/minigrep)
    Finished dev [unoptimized + debuginfo] target(s) in 0.14s
     Running `target/debug/minigrep`
Problem parsing arguments: not enough arguments

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ cargo run to poem.txt > output.txt 
    Finished dev [unoptimized + debuginfo] target(s) in 0.00s
     Running `target/debug/minigrep to poem.txt`

minigrep on  master [?] is ? 0.1.0 via ? 1.67.1 
➜ 

有关Rust编程语言入门之项目实例:- 命令行程序的更多相关文章

  1. ruby - 在 Ruby 程序执行时阻止 Windows 7 PC 进入休眠状态 - 2

    我需要在客户计算机上运行Ruby应用程序。通常需要几天才能完成(复制大备份文件)。问题是如果启用sleep,它会中断应用程序。否则,计算机将持续运行数周,直到我下次访问为止。有什么方法可以防止执行期间休眠并让Windows在执行后休眠吗?欢迎任何疯狂的想法;-) 最佳答案 Here建议使用SetThreadExecutionStateWinAPI函数,使应用程序能够通知系统它正在使用中,从而防止系统在应用程序运行时进入休眠状态或关闭显示。像这样的东西:require'Win32API'ES_AWAYMODE_REQUIRED=0x0

  2. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  3. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时,rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

  4. ruby - 在 Ruby 中编写命令行实用程序 - 2

    我想用ruby​​编写一个小的命令行实用程序并将其作为gem分发。我知道安装后,Guard、Sass和Thor等某些gem可以从命令行自行运行。为了让gem像二进制文件一样可用,我需要在我的gemspec中指定什么。 最佳答案 Gem::Specification.newdo|s|...s.executable='name_of_executable'...endhttp://docs.rubygems.org/read/chapter/20 关于ruby-在Ruby中编写命令行实用程序

  5. ruby-on-rails - Rails 应用程序之间的通信 - 2

    我构建了两个需要相互通信和发送文件的Rails应用程序。例如,一个Rails应用程序会发送请求以查看其他应用程序数据库中的表。然后另一个应用程序将呈现该表的json并将其发回。我还希望一个应用程序将存储在其公共(public)目录中的文本文件发送到另一个应用程序的公共(public)目录。我从来没有做过这样的事情,所以我什至不知道从哪里开始。任何帮助,将不胜感激。谢谢! 最佳答案 无论Rails是什么,几乎所有Web应用程序都有您的要求,大多数现代Web应用程序都需要相互通信。但是有一个小小的理解需要你坚持下去,网站不应直接访问彼此

  6. ruby - 无法运行 Rails 2.x 应用程序 - 2

    我尝试运行2.x应用程序。我使用rvm并为此应用程序设置其他版本的ruby​​:$rvmuseree-1.8.7-head我尝试运行服务器,然后出现很多错误:$script/serverNOTE:Gem.source_indexisdeprecated,useSpecification.Itwillberemovedonorafter2011-11-01.Gem.source_indexcalledfrom/Users/serg/rails_projects_terminal/work_proj/spohelp/config/../vendor/rails/railties/lib/r

  7. ruby-on-rails - 如何使用 instance_variable_set 正确设置实例变量? - 2

    我正在查看instance_variable_set的文档并看到给出的示例代码是这样做的:obj.instance_variable_set(:@instnc_var,"valuefortheinstancevariable")然后允许您在类的任何实例方法中以@instnc_var的形式访问该变量。我想知道为什么在@instnc_var之前需要一个冒号:。冒号有什么作用? 最佳答案 我的第一直觉是告诉你不要使用instance_variable_set除非你真的知道你用它做什么。它本质上是一种元编程工具或绕过实例变量可见性的黑客攻击

  8. ruby 正则表达式 - 如何替换字符串中匹配项的第 n 个实例 - 2

    在我的应用程序中,我需要能够找到所有数字子字符串,然后扫描每个子字符串,找到第一个匹配范围(例如5到15之间)的子字符串,并将该实例替换为另一个字符串“X”。我的测试字符串s="1foo100bar10gee1"我的初始模式是1个或多个数字的任何字符串,例如,re=Regexp.new(/\d+/)matches=s.scan(re)给出["1","100","10","1"]如果我想用“X”替换第N个匹配项,并且只替换第N个匹配项,我该怎么做?例如,如果我想替换第三个匹配项“10”(匹配项[2]),我不能只说s[matches[2]]="X"因为它做了两次替换“1fooX0barXg

  9. ruby-on-rails - Rails 应用程序中的 Rails : How are you using application_controller. rb 是新手吗? - 2

    刚入门rails,开始慢慢理解。有人可以解释或给我一些关于在application_controller中编码的好处或时间和原因的想法吗?有哪些用例。您如何为Rails应用程序使用应用程序Controller?我不想在那里放太多代码,因为据我了解,每个请求都会调用此Controller。这是真的? 最佳答案 ApplicationController实际上是您应用程序中的每个其他Controller都将从中继承的类(尽管这不是强制性的)。我同意不要用太多代码弄乱它并保持干净整洁的态度,尽管在某些情况下ApplicationContr

  10. ruby-on-rails - 如何在我的 Rails 应用程序 View 中打印 ruby​​ 变量的内容? - 2

    我是一个Rails初学者,但我想从我的RailsView(html.haml文件)中查看Ruby变量的内容。我试图在ruby​​中打印出变量(认为它会在终端中出现),但没有得到任何结果。有什么建议吗?我知道Rails调试器,但更喜欢使用inspect来打印我的变量。 最佳答案 您可以在View中使用puts方法将信息输出到服务器控制台。您应该能够在View中的任何位置使用Haml执行以下操作:-puts@my_variable.inspect 关于ruby-on-rails-如何在我的R

随机推荐