Ymmärtää rakentajan kuvion kanssa Directus

Rakennusmalli sisältää neljä avainkomponenttia:

• Tuote . .
• Rakentajaliittymä[ .
• Betonirakentajat[ .
• Johtaja[ ... .........................................................................................................................................................................................................................................

Directus-ohjelmalle rakennetussa yritysohjelmistossa johtaja voi hakea raakadataa Directus Items API:n kautta tai mukautetun päätetapahtuman kautta, syöttää sen sitten asianmukaiselle rakentajalle. Tämä erottelu pitää tiedonhankintalogiikan erillään muotoilulogiikasta.

Miksi Builder Pattern Fits Directus Reporting

Directus jo erinomainen sisällön mallintaminen, käyttöoikeudet, ja laaja. Kuitenkin, tuottaa monimutkainen moniosainen raportti (esim., neljännesvuosittainen liiketoiminnan katsaus kaavioita, taulukoita ja kertomuksia yhteenvetoja) usein edellyttää tietojen kokoamiseen useista kokoelmista, soveltamalla liiketoiminnan sääntöjä, ja muotoilun tuotos eri kuluttajille (PDF johtajat, CSV analyytikoille). Builder Pattern tarjoaa puuttuva rakenne kurinalaisuutta lukitsematta sinua jäykkä kehys.

Rakennusmallin edut suorassa selvityksessä

• Lähetyskelpoisuus[ ... .......................................................................................................................................................................................................................................
• Kestävyys[ . Jokainen raportti askel on eristetty. Jos alatunniste muotoilu muuttuu, voit muokata vain alatunnisteen menetelmiä eri rakentajille.
• Käytettävyys[ . Yhteiset vaiheet (, ) voidaan jakaa abstraktien perusrakentajien tai -koostumuksen kautta.
• Kirjallisuus[ . Johtaja näyttää selvästi toiminnan järjestyksen; uudet tiimin jäsenet voivat ymmärtää raportin tuottamisen virtausta ilman, että he tutkivat muotoilun yksityiskohtia.
• Testattavuus[] .Kaikki rakennusmenetelmät voidaan testata directus-laitteilla.

Dynaamisten raporttien rakennuksen mallin toteuttaminen

Alla on askel-askeleelta toteutus käyttäen TypeScript ja Directus SDK. Oletetaan meillä on tuoteluokka ja , joka orkestroi rakentamista.

1. Määrittele tuote

Tuote voi olla yksinkertainen säiliö osastoille (otsikko, runko, alatunniste), jotka on myöhemmin sarjaitu.

class Report {
 header: string;
 body: string;
 footer: string;
 constructor() {
 this.header = '';
 this.body = '';
 this.footer = '';
 }
 output(): string {
 return `${this.header}\n${this.body}\n${this.footer}`;
 }
}

2. Rakentajan käyttöliittymä

interface IReportBuilder {
 reset(): void;
 buildHeader(meta: any): void;
 buildBody(data: any[]): void;
 buildFooter(summary: any): void;
 getReport(): Report;
}

3. Betonirakentajat

CSV-raportti:

class CsvReportBuilder implements IReportBuilder {
 private report: Report;
 constructor() { this.report = new Report(); }
 reset(): void { this.report = new Report(); }
 buildHeader(meta: any): void {
 this.report.header = `Report generated: ${meta.generatedAt}`;
 }
 buildBody(data: any[]): void {
 const headers = Object.keys(data[0] || {}).join(',');
 const rows = data.map(row => Object.values(row).join(',')).join('\n');
 this.report.body = `${headers}\n${rows}`;
 }
 buildFooter(summary: any): void {
 this.report.footer = `Total records: ${summary.total}`;
 }
 getReport(): Report { return this.report; }
}

HTML-raportti:

class HtmlReportBuilder implements IReportBuilder {
 // Similar structure but builds HTML tags
 buildHeader(meta: any): void {
 this.report.header = `
Report
${meta.generatedAt}
`;
 }
 buildBody(data: any[]): void {
 let table = '' + Object.keys(data[0]).map(k => ``).join('') + '';
 data.forEach(item => {
 table += '' + Object.values(item).map(v => ``).join('') + '';
 });
 table += '
${k}
${v}
';
 this.report.body = table;
 }
 buildFooter(summary: any): void {
 this.report.footer = ``;
 }
 getReport(): Report { return this.report; }
}

4. Johtajaluokka

Johtaja hyväksyy rakentajan, hakee tietoja Directukselta ja tekee vaiheet järjestyksessä.

class ReportDirector {
 private builder: IReportBuilder;

 setBuilder(builder: IReportBuilder): void {
 this.builder = builder;
 }

 async constructReport(sdk: Directus, collection: string, filters: any): Promise<Report> {
 this.builder.reset();
 // Fetch metadata and data from Directus (simplified)
 const items = await sdk.items(collection).readByQuery({ filter: filters, limit: -1 });
 const meta = { generatedAt: new Date().toISOString() };
 const summary = { total: items.length };

 this.builder.buildHeader(meta);
 this.builder.buildBody(items);
 this.builder.buildFooter(summary);
 return this.builder.getReport();
 }
}

Huom: Oikeassa yrityssovelluksessa ruiskuttaisit Directus-asiakkaan ja käsittelisit sivuliikettä, roolipohjaista pääsyä ja virheiden käsittelyä.

Esimerkki käyttötapaus: Multi-Format Report Generation

Kuvittele yritys, joka käyttää Directusta myyntitietojen, asiakaspalautteen ja talousennusteiden tallentamiseen. Manageri valitsee päivämäärän ja muodon (CSV tai HTML).

async function generateReport(req, res) {
 const director = new ReportDirector();
 const builder = req.query.format === 'csv' ? new CsvReportBuilder() : new HtmlReportBuilder();
 director.setBuilder(builder);
 const report = await director.constructReport(sdk, 'sales', {
 date: { _between: [req.query.start, req.query.end] }
 });
 res.setHeader('Content-Type', req.query.format === 'csv' ? 'text/csv' : 'text/html');
 res.send(report.output());
}

Tämä lähestymistapaasteikko monimutkaisten raporttien käsittelyyn, jossa johtaja voi hakea lisätietoja useista Directus-kokoelmista (esim. , ) ja toimittaa ne tarvittaessa rakentajalle.

Lasketaan suoravirtaus ja mukautetut päätepisteet

Palvelinkyvyttömille tai ei-koodiskenaarioille voit rakentaa Directus ]Flow[] -toiminnon, joka käynnistää Webkookin tai mukautetun päätetapahtuman käyttäen Builder Pattern -logiikkaa. Johtaja juoksisi Directus-laajennuksen sisällä (esim. Custom Endpoint tai Hook). Tämä pitää raportin sukupolven Directus-ekosysteemissä käyttäen sen autentikointi- ja roolioikeuksia.

• Custom Endpoint ... Kirjoita tyyppiScript-moduuli, joka toteuttaa johtajan ja rakentajat, altistuen kautta.
• Flows[ ... .........................................................................................................................................................................................................................................
• Tiedoston lataus [ .Lopullinen raportti voidaan tallentaa Directus-tietolähteenä (Tietokokoelma) käyttäjien myöhempää lataamista varten.

Lisätietoja Directus-laajennuksista: Directus Extensions Documentation ja Builder-mallista itse: Refactoring Guru .

Lisätietoja on Directus Collections and Items API -oppaassa, jossa selvitetään, miten tiedot on jäsennelty raportteja varten, ja [Gang of Four book[ -kokoelmassa kanonisessa kuviossa.