Files SDK

Mis on Files SDK?

Files SDK on ühtne salvestus-SDK, mis pakub ühtset ja järjepidevat API-t objekt- ja bloobsalvestuse taustasüsteemidega suhtlemiseks. Selle asemel, et õppida iga pilveteenuse pakkuja jaoks eraldi SDK-d, saad ühe väikese ja lihtsa liidese, mis töötab S3, Cloudflare R2, Google Cloud Storage, Azure Blob ja enam kui 30 teise pakkujaga. See kasutab veebistandarditele vastavat sisend-väljundit – aktsepteerides File, Blob, ReadableStream, ArrayBuffer ja string – ning töötab kõikjal, kus fetch töötab, sealhulgas Node, Bun, Workers ja Vercel.

Kellele see on mõeldud

• Täistarkvaraarendajad, kes peavad vahetama salvestusteenuse pakkujat ilma iga üles- ja allalaadimiskutset oma rakenduses ümber kirjutamata.
• Platvormiinsenerid, kes ehitavad mitme rentniku või mitme piirkonnaga süsteeme, mis peavad pakkujapõhised eripärad ühe klassi taha abstraheerima.
• Indie-häkkerid ja idufirmade meeskonnad, kes soovivad alustada lihtsa failisüsteemi adapteriga ja hiljem migreeruda S3-le või R2-le ilma rakenduse koodi muutmata.

Peamised omadused

Üks väike API kõigi pakkujate jaoks

Üleslaadimine, allalaadimine, loetlemine, kustutamine, päring, olemasolu kontroll, kopeerimine ja URL-i genereerimine – samad kümme meetodit töötavad identselt, olenemata sellest, kas kasutad S3, GCS, Azure või kohalikku failisüsteemi. Vaheta adapterit ja sinu kutsed jäävad samaks.

Veebistandarditele vastav sisend-väljund

SDK aktsepteerib ja tagastab natiivseid veebitüüpe nagu File, Blob ja ReadableStream. Puuduvad patenteeritud vooümbriseid ega puhvri teisendusi. See töötab igas käituskeskkonnas, mis toetab fetch API-t – Node, Bun, Cloudflare Workers, Vercel Edge ja paljud teised.

Pääs natiivsele kliendile atribuudi files.raw kaudu

Kui vajad pakkujapõhiseid funktsioone nagu versioonihaldus, elutsükli poliitikad, ACL-id või mitmeosalised üleslaadimised, on natiivne klient alati ühe atribuudi kaugusel. files.raw on tüübistatud iga adapteri jaoks, nii et saad täieliku automaatse täienduse aluseks oleva SDK jaoks ilma oma koodibaasist lahkumata.

Etteaimatavad vead

Iga pakkuja viga normaliseeritakse ühtseks FilesError-iks, millel on järjepidev code atribuut. Algne viga on lisatud kui cause, nii et saad tõrkeid ühtlaselt käsitleda, säilitades samal ajal täieliku konteksti silumiseks.

Mis paistab silma

"Üks väike API kõigi pakkujate jaoks. Vaheta oma salvestusteenuse pakkujat ilma kutsungeid ümber kirjutamata."

See on põhilubadus ja Files SDK täidab seda ilma järeleandmisteta. Kui teised abstraktsioonikihid lekivad pakkujapõhiseid üksikasju või sunnivad sind madalaima ühisnimetaja API-sse, siis Files SDK pakub puhast kümne meetodiga pinda, mis katab 95% kasutusjuhtudest – ja annab seejärel natiivse kliendi ülejäänud 5% jaoks. Ühilduvusmaatriks näitab täpselt, millised meetodid millise pakkuja puhul töötavad, koos selgete märkustega, kus käitumine erineb.

Tasub proovida, kui…

Oled väsinud adapterkoodi hooldamisest iga salvestusteenuse pakkuja jaoks, mida su rakendus puudutab, või plaanid migreeruda ühelt taustasüsteemilt teisele ja soovid vältida valusat ümberkirjutamist. Files SDK sobib hästi ka siis, kui ehitad teeki või raamistikku, mis peab aktsepteerima kasutaja pakutavat salvestust ilma pakkujat ette kirjutamata.