Arquitetura

A divisão moderna entre app/public, a árvore completa do projeto, e como um pedido flui do browser até à base de dados e de volta.

Arquitetura

O CBGenesis segue a estrutura de template moderno do ColdBox: o código da aplicação está totalmente separado da raiz pública, pelo que nada em app/ é jamais acessível diretamente pela web.

Visão geral em camadas

flowchart TD
    A["Browser Request"] --> B

    subgraph B["public/ — Webroot"]
        B1["Application.bx — entry point, bootstraps ColdBox + ORM"]
        B2["index.bxm — front controller"]
        B3["includes/ — Vite compiled assets"]
    end

    B --> C

    subgraph C["app/ — Application code (not web-accessible)"]
        C1["config/ — ColdBox, Router, CacheBox, WireBox, Scheduler"]
        C2["handlers/ — Controllers, auth, admin, audit log"]
        C3["models/ — Entities, Services"]
        C4["views/ + layouts/ — BXM templates"]
        C5["email_templates/ — Token-based email bodies"]
        C6["interceptors/ — Audit logging hook"]
    end

    C --> D

    subgraph D["resources/ — Source assets"]
        D1["assets/js/ — Alpine components + stores"]
        D2["assets/scss/ — Bootstrap + custom SCSS"]
        D3["database/ — Migrations + seeders"]
    end

    D --> E

    subgraph E["lib/ — Dependencies (not source-controlled)"]
        E1["coldbox/, testbox/, modules/ — qb, cbsecurity, cborm, ..."]
    end

Ciclo de vida do pedido

Todos os pedidos entram através de public/Application.bx, que inicializa o ColdBox antes de o entregar ao router e, eventualmente, ao seu handler:

sequenceDiagram
    Browser->>+public/Application.bx: HTTP Request
    public/Application.bx->>+ColdBox Bootstrap: loadColdbox()
    ColdBox Bootstrap->>+Main Handler: onRequestStart
    Main Handler->>+Router: Match route
    Router->>+Target Handler: Dispatch event
    Target Handler->>+Service Layer: Business logic
    Service Layer->>+ORM / qb: Data access
    Target Handler->>+View / Layout: Render response
    View / Layout-->>-Browser: HTML + Vite assets

Main.bx (app/handlers/Main.bx) é o handler de eventos implícitos, ligado em app/config/Coldbox.bx:

• onAppInit - executa settingService.preFlightCheck(), semeando na base de dados quaisquer definições da aplicação em falta
• onRequestStart - carrega prc.settings e prc.authUser em cada pedido
• onException - o handler de exceções para toda a aplicação

Interceptors

app/config/Coldbox.bx regista três interceptors da aplicação, por esta ordem:

app/interceptors/AuditLogger.bx escreve no registo de auditoria em quatro pontos de interceção:

app/interceptors/RateLimiter.bx dispara em preProcess - antes do routing, antes de qualquer handler - e limita cinco ações não autenticadas de Auth (início de sessão, registo, esquecimento/reposição de palavra-passe, ativação de convite) por IP do cliente. Veja Limitação de taxa para as definições e como funciona.

app/interceptors/SSOAuthorization.bx trata o ponto de interceção CBSSOAuthorization do cbSSO. Liga uma identidade de fornecedor verificada ao modelo de utilizador local, aplica a política de início de sessão versus ligação de conta, cria utilizadores quando permitido, e cria a sessão cbauth. Veja Single sign-on para o fluxo de callback e a razão pela qual o cbGenesis utiliza um handler personalizado em vez da integração genérica do cbSSO com cbAuth.

Adicione os seus próprios ao array variables.interceptors em Coldbox.bx; disparam pela ordem em que são declarados.

Tarefas agendadas

app/config/Scheduler.bx regista três tarefas diárias em segundo plano, cada uma com onOneServer() e withNoOverlaps(), para que uma implantação com várias instâncias execute cada uma exatamente uma vez:

As três chamam um método purgeExpiredTokens()/purgeOlderThan() no serviço proprietário, em vez de consultar a tabela diretamente, para que a mesma lógica de purga seja acessível (e testável) fora do scheduler. Adicione uma nova tarefa da mesma forma - veja Estender a Aplicação.

Árvore completa do projeto

cbgenesis/
├── app/                      Application code
│   ├── Application.bx        Abort-only gate (prevents direct /app access)
│   ├── config/
│   │   ├── Coldbox.bx        Framework settings, environments, logging
│   │   ├── Router.bx         All application routes
│   │   ├── CacheBox.bx       Cache regions (default, template, sessions, rateLimit)
│   │   ├── WireBox.bx        DI container configuration
│   │   ├── Scheduler.bx      Scheduled tasks
│   │   └── modules/          Per-module settings (cbsecurity, cbauth, cborm, ...)
│   ├── handlers/              Controllers (Auth, Dashboard, Users, Roles, ...)
│   ├── layouts/                Admin, AuthCenter, AuthSplit, Main
│   ├── models/
│   │   ├── BaseEntity.bx      ORM base: timestamps, soft delete, memento
│   │   ├── BaseService.bx     Service base: cborm + qb + cache + validation
│   │   ├── security/            Role, Permission, APIToken, RememberToken,
│   │   │                        Passkey, UserActionToken, SecurityService, ...
│   │   └── system/              User, Setting, AuditLog + their services
│   ├── views/                  BXM templates, one folder per handler
│   │   └── _components/        Reusable UI partials (app, auth, ui)
│   ├── email_templates/       Token-based email body templates
│   ├── helpers/               ApplicationHelper.bxm — global view helpers
│   └── interceptors/           AuditLogger, RateLimiter, SSOAuthorization
├── public/
│   ├── Application.bx         Entry point — ColdBox + ORM bootstrap
│   ├── index.bxm               Front controller placeholder
│   └── includes/               Vite production build output
├── resources/
│   ├── assets/js/              Alpine entry, stores, components
│   ├── assets/scss/            Bootstrap + custom SCSS
│   └── database/
│       ├── migrations/         Schema migrations (cfmigrations)
│       └── seeds/              AdminData seeder
├── tests/
│   ├── specs/integration/      Full HTTP-level specs
│   └── specs/unit/             Entity + service specs
├── lib/                        Dependencies (gitignored, installed by `box install`)
├── runtime/                    BoxLang engine config (boxlang.json)
├── server.json                 CommandBox server config (engine, webroot, aliases)
├── box.json                    Package manifest — deps, scripts
├── package.json                 NPM — Alpine, Bootstrap, Vite, ESLint
├── vite.config.mjs              Vite + coldbox-vite-plugin
└── .env.example                  Environment template

O stack