DMVCFramework Gotcha #2: Active Record

Active Record è un design pattern architetturale introdotto da Martin Fowler e descritto qui: Martin Fowler - 2003 .

Alla base del pattern Active Record vi è l'idea di astrarre una tabella del database rappresentandola con una classe; la classe seguirà i principi che caratterizzano il paradigma OOP. In questo pattern, ogni istanza della classe rappresenta una singola riga della tabella, mentre la classe stessa è specializzata con metodi che implementano tutte le operazioni CRUD. Una classe così strutturata incapsula tutta la logica necessaria per le operazioni di interazione con il database, creando un'interfaccia orientata agli oggetti per la manipolazione dei dati. È importante notare che questo pattern, per sua natura, crea un accoppiamento tra la struttura della classe e quella della tabella del database sottostante.

Alcune caratteristiche:

1. Incapsulamento del database: Tutti i dettagli di connessione e query SQL sono nascosti all'interno della classe
2. Validazione dei dati: La classe può implementare regole di validazione prima di eseguire operazioni sul database
3. Proprietà dell'oggetto: Corrispondono direttamente alle colonne della tabella
4. Relazioni tra oggetti: Possono essere gestite attraverso metodi che implementano le relazioni del database (one-to-many, many-to-many, etc.)

Delphi ad oggi non implementa Active Record.
DMVCFramework, invece,  ( https://github.com/danieleteti/delphimvcframework ) porta con se l'implementazione di Active Record.

Active Record mi è stato molto utile qualche giorno fa: avevo l'esigenza di scrivere un piccolo applicativo che prendesse in input un JSON, lo parserizzasse e memorizzasse le informazioni in esso contenute, in un Database. Il JSON in questione è il JSON generato da Anthropic dopo aver richiesto il download delle conversazioni fatte con Claude.AI.

Dopo aver analizzato la struttura del JSON, ho creato le tabelle.
Qui non vi mostro tutto il processo ma una parte di esso che mi permetta di mostrarvi qualche caratteristica di Active Record.

La prima tabella che ho creato è stata quella per la 'testata' della Chat:

	CREATE TABLE public.chats (
	chat_uuid varchar(40) NOT NULL,
	chat_name varchar NULL,
	created_at timestamptz NULL,
	updated_at timestamptz NULL,
	CONSTRAINT chats_pk PRIMARY KEY (chat_uuid)
	);

view raw gistfile1.txt hosted with ❤ by GitHub

In Delphi ho definito una Entity che rappresentasse la tabella:

	[MVCNameCase(ncLowerCase)]
	[MVCTable('chats')]
	TChats = class(TMVCActiveRecord)
	private
	[MVCTableField('chat_uuid', [foPrimaryKey])]
	fChatUuid: String;
	[MVCTableField('chat_name')]
	fChatName: NullableString;
	[MVCTableField('created_at')]
	fCreatedAt: NullableTDateTime {dtDateTimeStamp};
	[MVCTableField('updated_at')]
	fUpdatedAt: NullableTDateTime {dtDateTimeStamp};
	public
	constructor Create; override;
	destructor Destroy; override;
	property ChatUuid: String read fChatUuid write fChatUuid;
	property ChatName: NullableString read fChatName write fChatName;
	property CreatedAt: NullableTDateTime {dtDateTimeStamp} read fCreatedAt write fCreatedAt;
	property UpdatedAt: NullableTDateTime {dtDateTimeStamp} read fUpdatedAt write fUpdatedAt;
	end;

view raw gistfile1.txt hosted with ❤ by GitHub

L'entity così definita è l'astrazione della tabella che abbiamo definito nel database.
Analizziamola:

dichiariamo una classe derivata da TMVCActiveRecord: 

TChats = class(TMVCActiveRecord)

TMVCActiveRecord è la classe base definita nel framework e che implementa tutti quei metodi utili alla

interazione con i dati.
La caratteristica principale che notiamo nella definizione della entity, riguarda i fields della classe. 

Ognuno di essi è 'decorato' con un Custom Attribute che ne determina il comportamento:

[MVCTable('chats')] :è il Custom Attribute che ci permette di definire il nome della tabella del DB di cui questa classe è astrazione;
[MVCTableField('chat_uuid', [foPrimaryKey])]: è il Custom Attribute utilizzato per 'legare' il field della classe all'attributo
della tabella fisica del database.

Per ogni tabella del database con la quale necessitiamo interagire, creeremo una entity.

A questo punto non ci resta che leggere il Json (utilizzo la libreria JsonDataObjects, anch'essa

disponibile in DMVCFramework), iterare su di esso e memorizzarlo nel DB:

	lChat := TChats.Create;
	try
	lChat.ChatUuid := AChat.S['uuid'];
	lChat.ChatName := AChat.S['name'];
	lChat.CreatedAt := ISO8601ToDate(AChat.S['created_at']);
	lChat.UpdatedAt := ISO8601ToDate(AChat.S['updated_at']);
	try
	if lFounded then
	lChat.Update(false)
	else
	lChat.Insert;
	except
	raise Exception.Create('Error Message 1');
	end;
	ExtractMessages(lChat.ChatUuid, AChat.A['chat_messages'])
	finally
	lChat.Free;
	end;

view raw gistfile1.txt hosted with ❤ by GitHub

Grazie a questo codice, avrò nel database un nuovo record.

Quel che mostrato sino ad ora è solo una semplice introduzione ad Active Record implementato in 

DMVCFramework.

E sicuramente non è esaustivo di tutte le peculiarità implementate.

Ad esempio: come faccio a sapere se la chat che sto analizzando è stata già elaborata precendentemente?

	var lQuery := format('eq(chat_uuid, %s)', [AChat.S['uuid'].QuotedString('"')]);
	var lChat := TMVCActiveRecord.SelectOneByRQL<TChats>(lQuery, false);
	var lFounded := Assigned(lChat);

view raw gistfile1.txt hosted with ❤ by GitHub

In questo esempio ho utilizzato l'RQL (Resources Query Language), ma avrei potuto anche utilizzare un 

metodo di Active Record che, ad esempio, mi permette di interrogare il db cercando per chiave primaria...

Questo esempio pratico dimostra come Active Record semplifichi notevolmente le operazioni di persistenza

dei dati, permettendoci di concentrarci sulla logica di business piuttosto che sui dettagli di implementazione

dell'accesso al database. 

La combinazione di DMVCFramework e il pattern Active Record ha reso il processo di importazione e 

gestione dei dati JSON estremamente fluido ed efficiente. È importante notare che, nonostante l'esempio mostrato sia relativamente semplice, Active Record 

in DMVCFramework supporta scenari molto più complessi, incluse relazioni tra entità, validazioni 

personalizzate e query avanzate.

Per chi volesse approfondire l'argomento, consiglio di esplorare la documentazione di DMVCFramework,

che offre molti altri esempi e casi d'uso avanzati del pattern Active Record.

La comprensione di questo pattern e la sua corretta implementazione possono significativamente migliorare

la produttività nello sviluppo di applicazioni Delphi che necessitano di interazione con database. #codinglikeacoder