Rust CLI 도구 만들기 | clap, 파일 처리, 에러 처리
이 글의 핵심
Rust CLI 도구 만들기: clap, 파일 처리, 에러 처리. 프로젝트 설정·clap으로 인자 파싱.
시리즈 안내
#11 | 📋 전체 목차 | 이전: #10 테스팅 · 다음: #12 C++ 비교
들어가며
단일 바이너리로 배포하기 쉽고, clap 등으로 인자 파싱·도움말을 정리하기 좋아 CLI 도구에 자주 쓰입니다. 파일·표준 입출력과 함께 Result로 오류를 전파하는 패턴이 일반적입니다.
1. 프로젝트 설정
Cargo.toml
[package]
name = "my-cli"
version = "0.1.0"
edition = "2021"
[dependencies]
clap = { version = "4.0", features = [derive] }2. clap으로 인자 파싱
기본 사용
use clap::Parser;
#[derive(Parser)]
#[command(name = "my-cli")]
#[command(about = "간단한 CLI 도구", long_about = None)]
struct Args {
#[arg(short, long)]
name: String,
#[arg(short, long, default_value_t = 1)]
count: u32,
}
fn main() {
let args = Args::parse();
for _ in 0..args.count {
println!("Hello, {}!", args.name);
}
}서브커맨드
use clap::{Parser, Subcommand};
#[derive(Parser)]
struct Cli {
#[command(subcommand)]
command: Commands,
}
#[derive(Subcommand)]
enum Commands {
Add { name: String },
Remove { id: u32 },
List,
}
fn main() {
let cli = Cli::parse();
match cli.command {
Commands::Add { name } => {
println!("추가: {}", name);
}
Commands::Remove { id } => {
println!("삭제: {}", id);
}
Commands::List => {
println!("목록 출력");
}
}
}3. 파일 처리
파일 읽기/쓰기
use std::fs;
use std::io::{self, BufRead, BufReader, Write};
use std::path::Path;
fn read_file(path: &str) -> io::Result<String> {
fs::read_to_string(path)
}
fn read_lines(path: &str) -> io::Result<Vec<String>> {
let file = fs::File::open(path)?;
let reader = BufReader::new(file);
let mut lines = Vec::new();
for line in reader.lines() {
lines.push(line?);
}
Ok(lines)
}
fn write_file(path: &str, content: &str) -> io::Result<()> {
fs::write(path, content)
}
fn append_file(path: &str, content: &str) -> io::Result<()> {
use std::fs::OpenOptions;
let mut file = OpenOptions::new()
.append(true)
.create(true)
.open(path)?;
writeln!(file, "{}", content)?;
Ok(())
}4. 실전 예제: 단어 카운터
use clap::Parser;
use std::fs;
use std::collections::HashMap;
#[derive(Parser)]
struct Args {
#[arg(help = "파일 경로")]
file: String,
#[arg(short, long, help = "대소문자 구분 안 함")]
ignore_case: bool,
}
fn count_words(text: &str, ignore_case: bool) -> HashMap<String, usize> {
let mut counts = HashMap::new();
for word in text.split_whitespace() {
let word = word.trim_matches(|c: char| !c.is_alphanumeric());
let word = if ignore_case {
word.to_lowercase()
} else {
word.to_string()
};
*counts.entry(word).or_insert(0) += 1;
}
counts
}
fn main() -> std::io::Result<()> {
let args = Args::parse();
let content = fs::read_to_string(&args.file)?;
let counts = count_words(&content, args.ignore_case);
let mut words: Vec<_> = counts.iter().collect();
words.sort_by(|a, b| b.1.cmp(a.1));
println!("단어 빈도:");
for (word, count) in words.iter().take(10) {
println!("{}: {}", word, count);
}
Ok(())
}실전 심화 보강
실전 예제: JSON 한 줄 포맷터 (stdin·파일·출력 경로)
단계: (1) 입력 소스 선택 (2) serde_json으로 파싱 (3) 예쁜 출력 또는 압축 출력 (4) 실패 시 비제로 종료 코드.
Cargo.toml에 다음을 추가합니다.
[dependencies]
clap = { version = "4", features = [derive] }
serde = { version = "1", features = [derive] }
serde_json = "1"
anyhow = "1"use anyhow::{Context, Result};
use clap::{Parser, Subcommand};
use std::fs;
use std::io::{self, Read};
use std::path::PathBuf;
use std::process;
#[derive(Parser)]
#[command(name = "jsonfmt")]
#[command(about = "stdin 또는 파일의 JSON을 포맷합니다.")]
struct Cli {
#[command(subcommand)]
command: Commands,
}
#[derive(Subcommand)]
enum Commands {
/// 파일을 읽어 stdout에 출력
File {
path: PathBuf,
#[arg(long, default_value_t = false)]
compact: bool,
},
/// stdin에서 읽기
Stdin {
#[arg(long, default_value_t = false)]
compact: bool,
},
}
fn format_json(text: &str, compact: bool) -> Result<String> {
let v: serde_json::Value =
serde_json::from_str(text).context("JSON 파싱 실패")?;
Ok(if compact {
serde_json::to_string(&v)?
} else {
serde_json::to_string_pretty(&v)?
})
}
fn main() {
let cli = Cli::parse();
let run = || -> Result<()> {
match cli.command {
Commands::File { path, compact } => {
let s = fs::read_to_string(&path)
.with_context(|| format!("파일 읽기 실패: {}", path.display()))?;
println!("{}", format_json(&s, compact)?);
}
Commands::Stdin { compact } => {
let mut buf = String::new();
io::stdin().read_to_string(&mut buf)?;
println!("{}", format_json(&buf.trim(), compact)?);
}
}
Ok(())
};
if let Err(e) = run() {
eprintln!("error: {:#}", e);
process::exit(1);
}
}자주 하는 실수
main에서Result를 쓰지 않고unwrap만 남발해 사용자에게 스택 트레이스가 그대로 노출되는 경우.- 상대 경로를 현재 작업 디렉터리에만 의존해 스크립트·CI에서 엉뚱한 파일을 읽는 경우.
- 바이너리 이름과 패키지 이름을 혼동해
cargo install후 실행 파일 이름을 문서에 잘못 안내하는 경우.
주의사항
- Windows·macOS·Linux에서 경로 구분자와 줄바꿈이 다릅니다. 가능하면
std::path::Path와read_to_string을 사용하세요. - CLI는 종료 코드 규약(성공 0, 실패 비0)을 지키는 것이 스크립트 연동에 필수입니다.
- 민감한 정보는 환경 변수나 설정 파일로 분리하고,
--help예시에 시크릿을 넣지 마세요.
실무에서는 이렇게
tracing+RUST_LOG로 디버그 로그를 켜고, 릴리스에서는 기본을info이상으로 둡니다.clap의env속성으로API_KEY같은 값을 플래그와 환경 변수 양쪽에서 받을 수 있게 하면 운영이 편합니다.- 배포는 cargo build —release 후 단일 바이너리를 GitHub Releases나 패키지 매니저에 올리고, 버전은
clap의version과Cargo.toml을 맞춥니다.
비교 및 대안
| 접근 | 장점 | 언제 쓸까 |
|---|---|---|
clap derive | 빠른 개발, 서브커맨드·검증 풍부 | 대부분의 팀 CLI |
clap builder API | 동적 인자 구성 | 플러그인형 도구 |
std::env::args만 | 의존성 제로 | 초소형 스크립트 대체 |
Python argparse 호출 래핑 | 기존 스크립트 재사용 | 점진적 Rust 이전 |
추가 리소스
정리
핵심 요약
- clap: CLI 인자 파싱, 서브커맨드
- std::fs: 파일 읽기/쓰기
- BufReader: 효율적인 파일 읽기
- Result: 에러 처리
- ?: 에러 전파
다음 단계
관련 글
심화 부록: 구현·운영 관점
이 부록은 앞선 본문에서 다룬 주제(「Rust CLI 도구 만들기 | clap, 파일 처리, 에러 처리」)를 구현·런타임·운영 관점에서 다시 압축합니다. 도메인별 세부 구현은 글마다 다르지만, 입력 검증 → 핵심 연산 → 부작용(I/O·네트워크·동시성) → 관측의 흐름으로 장애를 나누면 원인 추적이 빨라집니다.
내부 동작과 핵심 메커니즘
flowchart TD A[입력·요청·이벤트] --> B[파싱·검증·디코딩] B --> C[핵심 연산·상태 전이] C --> D[부작용: I/O·네트워크·동시성] D --> E[결과·관측·저장]
sequenceDiagram participant C as 클라이언트/호출자 participant B as 경계(런타임·게이트웨이·프로세스) participant D as 의존성(API·DB·큐·파일) C->>B: 요청/이벤트 B->>D: 조회·쓰기·RPC D-->>B: 지연·부분 실패·재시도 가능 B-->>C: 응답 또는 오류(코드·상관 ID)
- 불변 조건(Invariant): 버퍼 경계, 프로토콜 상태, 트랜잭션 격리, FD 상한 등 단계별로 문장으로 적어 두면 디버깅 비용이 줄어듭니다.
- 결정성: 순수 층과 시간·네트워크·스케줄에 의존하는 층을 분리해야 테스트와 장애 분석이 쉬워집니다.
- 경계 비용: 직렬화, 인코딩, syscall 횟수, 락 경합, 할당·GC, 캐시 미스를 의심 목록에 둡니다.
- 백프레셔: 생산자가 소비자보다 빠를 때 버퍼·큐·스트림에서 속도를 줄이는 신호를 어디에 둘지 정의합니다.
프로덕션 운영 패턴
| 영역 | 운영 관점 질문 |
|---|---|
| 관측성 | 요청 단위 상관 ID, 에러율·지연 p95/p99, 의존성 타임아웃·재시도가 대시보드에 보이는가 |
| 안전성 | 입력 검증·권한·비밀·감사 로그가 코드 경로마다 일관적인가 |
| 신뢰성 | 재시도는 멱등 연산에만 적용되는가, 서킷 브레이커·백오프·DLQ가 있는가 |
| 성능 | 캐시·배치 크기·커넥션 풀·인덱스·백프레셔가 데이터 규모에 맞는가 |
| 배포 | 롤백 룬북, 카나리/블루그린, 마이그레이션·피처 플래그가 문서화되어 있는가 |
| 용량 | 피크 트래픽·디스크·FD·스레드 풀 상한을 주기적으로 검증하는가 |
스테이징은 데이터 양·네트워크 RTT·동시성을 프로덕션에 가깝게 맞출수록 재현율이 올라갑니다.
확장 예시: 엔드투엔드 미니 시나리오
앞선 본문 주제(「Rust CLI 도구 만들기 | clap, 파일 처리, 에러 처리」)를 배포·운영 흐름에 맞춰 옮긴 체크리스트입니다. 도메인에 맞게 단계 이름만 바꿔 적용할 수 있습니다.
- 입력 계약 고정: 스키마·버전·최대 페이로드·타임아웃·에러 코드를 경계에 둔다.
- 핵심 경로 계측: 요청 ID, 단계별 지연, 외부 호출 결과 코드를 로그·메트릭·트레이스에서 한 흐름으로 본다.
- 실패 주입: 의존성 타임아웃·5xx·부분 데이터·락 대기를 스테이징에서 재현한다.
- 호환·롤백: 설정/마이그레이션/클라이언트 버전을 되돌릴 수 있는지 확인한다.
- 부하 후 검증: 피크 대비 p95/p99, 에러율, 리소스 상한, 알림 임계값을 점검한다.
handle(request):
ctx = newCorrelationId()
validated = validateSchema(request)
authorize(validated, ctx)
result = domainCore(validated)
persistOrEmit(result, idempotentKey)
recordMetrics(ctx, latency, outcome)
return result문제 해결(Troubleshooting)
| 증상 | 가능 원인 | 조치 |
|---|---|---|
| 간헐적 실패 | 레이스, 타임아웃, 외부 의존성, DNS | 최소 재현 스크립트, 분산 트레이스·로그 상관관계, 재시도·서킷 설정 점검 |
| 성능 저하 | N+1, 동기 I/O, 락 경합, 과도한 직렬화, 캐시 미스 | 프로파일러·APM으로 핫스팟 확인 후 한 가지씩 제거 |
| 메모리 증가 | 캐시 무제한, 구독/리스너 누수, 대용량 버퍼, 커넥션 미반납 | 상한·TTL·힙/FD 스냅샷 비교 |
| 빌드·배포만 실패 | 환경 변수, 권한, 플랫폼 차이, lockfile | CI 로그와 로컬 diff, 런타임·이미지 버전 핀 |
| 설정 불일치 | 프로필·시크릿·기본값, 리전 | 스키마 검증된 설정 단일 소스와 배포 매트릭스 표준화 |
| 데이터 불일치 | 비멱등 재시도, 부분 쓰기, 캐시 무효화 누락 | 멱등 키·아웃박스·트랜잭션 경계 재검토 |
권장 순서: (1) 최소 재현 (2) 최근 변경 범위 축소 (3) 환경·의존성 차이 (4) 관측으로 가설 검증 (5) 수정 후 회귀·부하 테스트.
배포 전에는 git add → git commit → git push 후 npm run deploy 순서를 권장합니다.
자주 묻는 질문 (FAQ)
Q. 이 내용을 실무에서 언제 쓰나요?
A. Rust CLI 도구 만들기: clap, 파일 처리, 에러 처리. 프로젝트 설정·clap으로 인자 파싱로 흐름을 잡고 원리·코드·실무 적용을 한글로 정리합니다. Rust·CLI·커맨드라인 중심으로 설명합니다. Sta… 실무에서는 위 본문의 예제와 선택 가이드를 참고해 적용하면 됩니다.
Q. 선행으로 읽으면 좋은 글은?
A. 각 글 하단의 이전 글 또는 관련 글 링크를 따라가면 순서대로 배울 수 있습니다. C++ 시리즈 목차에서 전체 흐름을 확인할 수 있습니다.
Q. 더 깊이 공부하려면?
A. cppreference와 해당 라이브러리 공식 문서를 참고하세요. 글 말미의 참고 자료 링크도 활용하면 좋습니다.
같이 보면 좋은 글 (내부 링크)
이 주제와 연결되는 다른 글입니다.
- Rust 테스팅 | 단위 테스트, 통합 테스트, 벤치마크
- C++ 개발자를 위한 Rust | 차이점과 전환 가이드
- Rust 소유권 | Ownership, Borrowing, Lifetime
이 글에서 다루는 키워드 (관련 검색어)
Rust, CLI, 커맨드라인, clap 등으로 검색하시면 이 글이 도움이 됩니다.