Rocket 🚀을 사용하여 최소한의 RESTful 노래 요청 API 만들기

신청곡 시스템이란?

YouTube 및 Twitch와 같은 플랫폼에서 스트리머를 시청하는 경우 노래 요청 시스템을 접했을 수 있습니다. 노래 요청 시스템을 통해 시청자는 노래 대기열에 노래를 추가할 수 있습니다. 노래가 대기열 맨 앞에 도달하면 라이브 스트림을 통해 노래가 재생됩니다.

rocket 크레이트의 도움으로 Rust에서 이 시스템을 위한 API를 만드는 것은 매우 쉽습니다.

시작하기

이 프로젝트에서는 rocket 크레이트를 사용하여 RESTful API를 만들 것입니다.

프로젝트 초기화

새 Cargo 프로젝트를 초기화하려면 다음 명령을 실행하세요.

cargo init <YOUR_PROJECT_NAME>

종속성 추가

Cargo.toml에 종속 항목으로 rocket을 추가합니다.

[dependencies]

# NOTE: This is a pre-release version.
# Thus, It is suggested NOT to use this in production.
rocket = "0.5.0-rc.2"

주요 기능

Cargo 프로젝트가 준비되면 기본 기본 기능을 완전히 제거할 수 있습니다. 이렇게 하면 Rocket의 절차 매크로rocket에 기인한 새로운launch 방법을 위한 공간이 생깁니다.

이 함수는 기본적으로 기본 함수를 대체하며 시작 시 호출됩니다.

//main.rs

#[macro_use]
extern crate rocket;

use rocket::{Build, Rocket};

#[launch]
fn rocket() -> Rocket<Build> {
    Rocket::build()
        // Set the `/` route path as the base for our routes.
        // When we create our routes, we'll include them in the arguments for the `routes!` macro.
        .mount("/", routes![])
}

이것을 실행하면 다음과 같이 표시됩니다.

Configured for debug.
   >> address: 127.0.0.1
   >> port: 8000
   >> workers: 6
   >> ident: Rocket
   >> limits: bytes = 8KiB, data-form = 2MiB, file = 1MiB, form = 32KiB, json = 1MiB, msgpack = 1MiB, string = 8KiB
   >> temp dir: C:\Users\dev\AppData\Local\Temp\
   >> http/2: true
   >> keep-alive: 5s
   >> tls: disabled
   >> shutdown: ctrlc = true, force = true, grace = 2s, mercy = 3s
   >> log level: normal
   >> cli colors: true
Fairings:
   >> Shield (liftoff, response, singleton)
Shield:
   >> X-Content-Type-Options: nosniff
   >> Permissions-Policy: interest-cohort=()
   >> X-Frame-Options: SAMEORIGIN
Rocket has launched from http://127.0.0.1:8000

이제 rocket 함수가 있으므로 API용 기능 개발을 시작할 수 있습니다.

노래 대기열 저장

노래 대기열을 저장하기 위해 정적LinkedList을 사용합니다.
표준 라이브러리에 포함되어 있고 기본적으로 추가 기능이 있는 대기열 역할을 하기 때문에 LinkedList를 사용합니다.

그러나 목록을 정적으로 수정하려면 목록을 Mutex 로 래핑해야 합니다.

use std::collections::LinkedList;
use std::sync::Mutex;

static SONG_QUEUE: Mutex<LinkedList<String>> = Mutex::new(LinkedList::new());

Mutex에 대해 자세히 알아보려면 here을 클릭하십시오.

유틸리티 기능

우리는 다음 코드를 많이 반복할 것입니다.

let lock = SONG_QUEUE
    .lock()
    .expect("Unable to acquire lock on song queue because the Mutex was poisoned");

우리를 위해 이 작업을 수행하는 함수를 만드는 것이 좋습니다.

use std::sync::{Mutex, MutexGuard};

fn acquire_queue<'a>() -> MutexGuard<'a, LinkedList<String>> {
    SONG_QUEUE
        .lock()
        .expect("Unable to acquire lock on song queue because the Mutex was poisoned")
}

추가 경로 만들기

SONG_QUEUE 변수가 정의되면 경로 생성을 시작할 수 있습니다.
add 경로는 노래 이름이 포함된 POST 요청을 받은 다음 노래 대기열에 추가됩니다.

선택적으로 노래가 배치된 위치를 반환할 수 있습니다.

#[post("/add/<song_name>")]
fn add_song(song_name: String) -> String {
    let mut lock = acquire_queue();

    lock.push_back(song_name);

    format!("Song added. This song is in position {}.", lock.len())
}

이 새 경로를 routes! 매크로에 등록하는 것을 잊지 마십시오.

- .mount("/", routes![])

+ .mount("/", routes![add_song])

이 새로운 경로를 테스트하려면 프로그램을 실행한 다음 몇 가지 매개 변수를 사용하여 경로를 컬링해 보십시오.

결과

C:\Users\dev>curl -X POST http://localhost:8000/add/Hello
Song added. This song is in position 1.

C:\Users\dev>curl -X POST http://localhost:8000/add/Hello%20number%202
Song added. This song is in position 2.

보기 경로 만들기

이제 사용자는 노래를 추가할 수 있지만 현재 대기열에 있는 노래를 볼 수 없습니다.
걱정하지 마세요. 새 GET 경로를 만들 것입니다.

단 한 줄의 코드!

#[get("/view")]
fn view() -> String {
    format!("{:?}", acquire_queue())
}

이 새 경로를 routes! 매크로에 등록하는 것을 잊지 마십시오.

- .mount("/", routes![add_song])

+ .mount("/", routes![add_song, view])

결과

C:\Users\dev>curl -X POST http://localhost:8000/add/Hello%20World
Song added. This song is in position 1.

C:\Users\dev>curl http://localhost:8000/view
["Hello World"]

노래 제거

기사의 단순성을 위해 노래가 대기열 맨 앞에 도달하면 실제로 노래를 재생하지 않습니다. 대신 일정 시간이 지나면 노래를 삭제합니다.

이 경우 대기열 맨 앞에 도달한 후 60초 후에 노래를 제거합니다.

use std::thread;
use std::time::Duration;

fn remove_song_timer() {
    while !acquire_queue().is_empty() {
        thread::sleep(Duration::from_secs(60));
        acquire_queue().pop_front();
    }
}

노래가 빈 대기열에 추가되면 add_song 스레드가 생성되도록 remove_song_timer 경로를 수정해야 합니다.

#[post("/add/<song_name>")]
fn add_song(song_name: String) -> String {
    let mut lock = acquire_queue();

    if lock.is_empty() {
        thread::spawn(remove_song_timer);
    }
    lock.push_back(song_name);

    format!("Song added. This song is in position {}.", lock.len())
}

결과

C:\Users\dev>curl -X POST http://localhost:8000/add/Hello%20World
Song added. This song is in position 1.
C:\Users\dev>curl http://localhost:8000/view
["Hello World"]

60초 후...

C:\Users\dev>curl http://localhost:8000/view
[]

그게 다야! Rust에서 RESTful API를 작성하는 것은 rocket 크레이트를 사용하면 엄청나게 쉽습니다. 새 기사를 게시할 때마다 알림을 받으려면 dev.to에서 저를 팔로우하십시오.

읽어 주셔서 감사합니다!