프로젝트 구조

이 페이지는 영어에서 번역되었습니다. 영어 페이지 읽기

모든 Zeyn 앱은 같은 레이아웃을 가지므로 사람이나 에이전트가 모든 프로젝트에서 같은 위치에서 원하는 것을 찾습니다.

config/app.json          defaults; APP_* environment variables override them
locales/<lang>.json      every user facing text; all files have the same keys
src/main.rs              loads configuration and starts the app
src/app.rs               the App: services, features, security settings
src/features/<name>/     one folder per feature
    mod.rs               the Feature: route prefix, guards, screens, APIs, menu
    models.rs            #[entity] and #[model] types
    store.rs             services that read and write data
    actions.rs           #[action] functions
    screens.rs           #[screen] functions
tests/                   tests that drive the app through its router

앱

src/app.rs는 App을 만듭니다. 서비스, Feature, 모든 Screen에 적용되는 설정을 등록합니다.

pub fn app(config: Config) -> App {
    App::new(t!("app.name"))
        .config(config)
        .i18n(i18n())
        .service(NoteStore::default())
        .auth(ForwardAuth::new("x-forwarded-user").groups("x-forwarded-groups"))
        .rate_limit(RateLimit::per_ip(600, Duration::from_secs(60)))
        .home(features::home::home)
        .feature(features::home::feature())
        .feature(features::notes::feature())
}

App::serve(addr)는 앱을 검사하고 서버를 시작합니다. App::router()는 axum 라우터를 반환하며, 테스트에서 포트를 열지 않고 사용합니다.

Feature

Feature는 경로 접두사, 가드, Screen, API, 명령, 메뉴를 묶습니다.

pub fn feature() -> Feature {
    Feature::new("notes")
        .route_prefix("/notes")
        .guard(SignedIn)
        .screen(note_list)
        .screen(note_editor)
        .api(search_notes)
        .menu(|m| m.group(t!("menu.notes"), Icon::Edit).item(t!("notes.title"), note_list))
}

서비스

서비스는 복제 비용이 낮은 값이며 action과 Screen이 인수로 받습니다. App::service로 한 번 등록합니다. Screen이 아무도 등록하지 않은 서비스를 필요로 하면 앱은 시작을 거부합니다.

#[derive(Clone, Default)]
pub struct NoteStore(Arc<RwLock<Vec<Note>>>);

impl Service for NoteStore {}

설정

Config::load는 소스를 순서대로 읽으며 나중의 소스가 우선합니다. config.get("key")는 값을 반환하고 config.secret("key")는 출력되지 않는 Secret을 반환합니다.

let config = Config::load(vec![Box::new(JsonFileSource("config/app.json".into())), Box::new(EnvSource("APP"))]).await?;
let addr = config.get("server.addr").unwrap_or("127.0.0.1:3000").to_string();

테스트

테스트는 라우터를 만들고 메모리에서 호출합니다.

#[tokio::test]
async fn notes_open() {
    let router = app(Config::default()).router().unwrap();
    let res = router.oneshot(Request::get("/notes").body(Body::empty()).unwrap()).await.unwrap();
    assert_eq!(res.status(), StatusCode::OK);
}