Blog

Menata Codebase React Native

9 Februari 2023 7 menit baca

Praktik terbaik untuk menata dan menyusun aplikasi React Native berskala besar. Pelajari struktur folder, pengelompokan komponen, dan pola kode yang mudah dipelihara.

Menata Codebase React Native
React NativeArsitekturOrganisasi KodePraktik Terbaik

Menata Codebase React Native Kamu

Panduan Membuat Codebase yang Scalable dan Mudah Dipelihara

Di aplikasi React Native, menata codebase sangat penting untuk kemudahan pemeliharaan dan skalabilitas. Cara kamu menyusun file dan folder bisa sangat memengaruhi seberapa mudah kamu bekerja dengan codebase tersebut di masa depan.

Artikel ini akan membahas struktur folder berbasis fitur untuk aplikasi React Native beserta fungsi setiap foldernya.

Folder src

Folder src adalah direktori root untuk seluruh source code aplikasimu. Di dalam folder ini, kamu akan menemukan beberapa subfolder lain yang masing-masing punya fungsi tertentu.

Types

Folder types adalah tempat kamu mendefinisikan tipe global untuk aplikasimu. Ini mencakup tipe modul, definisi interface, dan tipe kustom lain yang perlu kamu pakai di seluruh aplikasi.

Memiliki satu lokasi pusat untuk semua tipe membuatnya lebih mudah dikelola dan dipelihara seiring aplikasi berkembang. Selain itu, cara ini memastikan tipe-tipe kamu dipakai secara konsisten di semua fitur, mengurangi risiko bug terkait tipe dan membuatnya lebih mudah ditangkap saat muncul.

Lib

Folder lib adalah tempat kamu menyimpan file khusus aplikasi yang dipakai secara global di seluruh aplikasi. Ini bisa mencakup instance axios untuk melakukan panggilan API, service penanganan error, konstanta, setup query client di react-query, dan sebagainya.

Menyimpan file-file ini di lokasi terpusat membuatnya lebih mudah dipelihara dan memastikan semuanya konsisten di seluruh aplikasi.

Components

Folder components adalah tempat kamu menyimpan semua komponen yang reusable. Komponen-komponen ini harus terisolasi dan tidak spesifik untuk fitur atau domain tertentu. Contoh komponen seperti ini adalah header, tombol, dan item list.

Memisahkan komponen-komponen ini dari komponen khusus fitur membuatnya lebih mudah dikelola dan dipakai ulang di seluruh aplikasi, serta mengurangi duplikasi di kode kamu.

Hooks

Folder hooks adalah tempat kamu menyimpan custom hook yang dipakai di seluruh aplikasi. Hook adalah jenis fungsi khusus di React yang memungkinkan kamu memakai ulang logika stateful di berbagai komponen.

Menyimpan semua custom hook yang reusable atau dipakai di banyak tempat di lokasi terpusat membuatnya lebih mudah dikelola dan dipelihara, sekaligus mengurangi risiko duplikasi kode dan memudahkan berbagi hook di berbagai bagian aplikasi.

Localization

Folder localization adalah tempat kamu menyimpan semua file yang berkaitan dengan internasionalisasi aplikasi. Ini mencakup file bahasa, konstanta string, dan resource lain yang dibutuhkan untuk mendukung banyak bahasa di aplikasimu.

Dengan menyimpan file-file ini di lokasi terpusat, semuanya lebih mudah dikelola dan dipelihara, sekaligus mengurangi risiko duplikasi kode dan memudahkan dukungan banyak bahasa di aplikasimu.

Navigation

Folder navigation adalah tempat kamu menyimpan semua kode yang berkaitan dengan navigasi di aplikasimu. Ini mencakup stack, tipe, route, dan komponen atau fungsi lain yang dibutuhkan untuk mendukung navigasi.

Dengan menyimpan semua kode navigasi di lokasi terpusat, kode tersebut lebih mudah dikelola dan dipelihara, sekaligus mengurangi risiko duplikasi kode dan memudahkan berbagi fungsi navigasi di berbagai bagian aplikasi.

Services

Folder services adalah tempat kamu menyimpan semua kode yang berkaitan dengan infrastruktur dasar aplikasimu. Ini mencakup kode untuk push notification, monitoring error, dan service lain yang dipakai untuk menyediakan fungsi dasar aplikasimu.

Theme

Folder theme adalah tempat kamu menyimpan styling aplikasi, misalnya tema gelap/terang. Menyimpan file styling dan tema di satu tempat membuatnya lebih mudah mengelola dan memperbarui tampilan dan nuansa aplikasi sesuai kebutuhan.

Utils

Fungsi utilitas bisa menjadi bagian penting dari aplikasi React Native, karena memberi cara untuk memakai ulang kode di banyak bagian aplikasi. Folder utils di aplikasimu adalah tempat yang tepat untuk menyimpan fungsi utilitas yang dipakai di seluruh aplikasi. Dengan memusatkan fungsi-fungsi ini di satu lokasi, kamu bisa memastikan fungsi tersebut mudah ditemukan dan dipakai di bagian lain kode kamu. Contohnya: fungsi utilitas yang berkaitan dengan layout react-native.

Features

Saat membangun aplikasi yang kompleks, penting untuk punya struktur folder yang jelas dan ringkas yang mengemas semua kode di satu tempat. Folder features membantu mencapai hal ini karena memisahkan setiap fitur aplikasi ke dalam kategori yang berbeda. Dengan begitu, developer bisa cepat menemukan dan mengubah fitur tertentu tanpa memengaruhi bagian lain dari aplikasi.

Selain itu, seiring aplikasi berkembang dan makin banyak fitur ditambahkan, struktur folder tetap rapi, sehingga developer baru lebih mudah ikut bergabung dan memahami cara kerja aplikasi. Pemisahan tanggung jawab yang jelas juga membantu mengurangi risiko bug dan meningkatkan performa aplikasi secara keseluruhan.

Berikut contoh tampilan folder auth:

    src/
    ├── ...
    └── features/
        ├── auth/
        |   ├── api/
        |   ├── helpers/
        |   ├── hooks/
        |   ├── screens/
        |   ├── services/
        |   └── store/
        └── ... (other features)

Pentingnya folder features terletak pada kemampuannya membantu membagi codebase menjadi bagian-bagian yang lebih kecil dan lebih mudah dikelola. Setiap fitur punya subfolder sendiri, seperti api, helpers (atau utils), hooks, screens, services, dan store, yang khusus untuk fitur tersebut. Ini membuat cara kerja setiap fitur lebih mudah dipahami, begitu juga cara fitur-fitur itu saling berinteraksi.

Folder api berisi semua kode terkait API yang khusus untuk autentikasi. Ini membuat panggilan API lebih mudah dikelola dan tetap rapi.

Folder helpers berisi method helper atau fungsi utilitas yang khusus untuk fitur autentikasi. Fungsi-fungsi ini bisa dipakai secara eksklusif di dalam fitur autentikasi dan tidak perlu dibagikan ke bagian lain aplikasi.

Folder hooks berisi hook yang berkaitan khusus dengan autentikasi. Karena React sangat bergantung pada hook, ini membuat hook lebih mudah dikelola dan tetap rapi.

Folder screens berisi semua layar untuk fitur autentikasi. Ini mencakup layar login, layar sign-up, layar lupa password, dan lainnya.

Folder services berisi service yang khusus untuk fitur autentikasi. Misalnya, kamu mungkin punya service autentikasi yang bertugas menangani login dan sign-up pengguna.

Terakhir, folder store berisi kode state management yang khusus untuk fitur autentikasi. Ini bisa berupa store Redux, store Zustand, atau library state management lain yang kamu sukai.

Dengan memecah aplikasi menjadi bagian-bagian yang lebih kecil dan tertata, kode jadi jauh lebih mudah dikelola dan diubah sesuai kebutuhan. Cara ini juga membantu menjaga kode tetap bersih dan mudah dibaca, sehingga developer lain lebih mudah memahami dan bekerja dengan kode tersebut.

Contoh struktur folder fitur auth

    src/
    └── features/
        └── auth/
            ├── api/
            |   ├── login.ts
            |   ├── signup.ts
            |   └── refresh-token.ts
            ├── helpers/
            |   ├── validateToken.ts
            |   └── dataTransformer.ts
            ├── screens/
            |   ├── Login.tsx
            |   └── Signup.tsx
            ├── services/
            |   └── validation.ts
            └── store/
                └── auth.ts

Folder auth adalah subfolder yang didedikasikan untuk fitur autentikasi aplikasimu. File-file di folder ini menangani semua hal terkait autentikasi dan otorisasi, mulai dari API untuk login dan signup sampai layar UI tempat pengguna berinteraksi.

Folder api menyimpan API untuk fitur autentikasi, seperti file login.ts dan signup.ts, yang menangani request dan response untuk permintaan login dan signup pengguna. File refresh-token.ts menangani refresh token.

Folder helpers menyimpan fungsi helper yang dipakai dalam proses autentikasi. Misalnya, file validateToken.ts dipakai untuk memvalidasi token, dan file dataTransformer.ts mengubah data yang dikirim ke dan diterima dari API autentikasi.

Folder screens menyimpan komponen UI tempat pengguna berinteraksi. Misalnya, file Login.tsx dan Signup.tsx berisi komponen UI agar pengguna bisa login dan sign up.

Folder hooks menyimpan custom hook yang berkaitan dengan autentikasi. Misalnya, file useLoginAction.ts dan useSignupForm.ts berisi hook yang membantu mengelola state dan aksi yang berkaitan dengan form login dan signup.

Folder services menyimpan service yang berkaitan dengan autentikasi, seperti file validation.ts, yang berisi fungsi untuk memvalidasi input pengguna.

Folder store menyimpan state management yang berkaitan dengan autentikasi. File auth.ts menyimpan state dan aksi yang berkaitan dengan autentikasi, memakai library state management seperti Zustand, Redux, atau yang lain.

CATATAN

Penting untuk dicatat bahwa konvensi penamaan folder dan file bisa berbeda dari satu proyek ke proyek lain dan dari satu developer ke developer lain. Yang penting adalah struktur dan susunan foldernya, bukan nama persis yang dipakai untuk setiap folder. Misalnya, folder utils di root aplikasi juga bisa diberi nama helpers atau utilities, atau screens juga bisa dinamai pages atau nama lain yang masuk akal untuk proyek tersebut. Tujuannya adalah memiliki struktur yang jelas dan konsisten yang membantu developer memahami susunan kode serta memudahkan pemeliharaan dan pengembangan aplikasi.

Struktur folder berbasis tipe vs struktur folder berbasis fitur

Metode lain yang banyak dipakai untuk menata codebase proyek adalah struktur folder berbasis tipe, yang punya kelebihan dan kekurangannya sendiri. Di bagian berikut, kita akan membandingkan kedua struktur folder ini secara visual.

Perbandingan

    Feature-based folder structure:

    src/
    └── features/
        ├── auth/
        |   ├── api/
        |   │     ├── register.tsx
        |   │     ├── login.tsx
        |   │     ├── types.tsx
        |   │     └── helpers.tsx
        |   ├── helpers/
        |   ├── hooks/
        |   └── screens/
        |   │     ├── LoginScreen.tsx
        |   │     ├── SignupScreen.tsx
        |   │     ├── WelcomeScreen.tsx
        |   │     └── HomeScreen.tsx
        |   ├── services/
        |   └── store/
        ├── todo/
        |   └── screens/
        |   │    └── TodoListScreen.tsx
        |   ├── services/
        |   └── store/
        └── ... (other features)

    Type-based folder structure:

    src/
    ├── screens/
    |   ├── LoginScreen.tsx
    |   ├── SignupScreen.tsx
    |   ├── TodoListScreen.tsx
    |   ├── WelcomeScreen.tsx
    |   └── HomeScreen.tsx
    ├── api/
    |   └── auth/
    |       ├── register.ts
    |       ├── login.ts
    |       ├── types.ts
    |       └── helpers.ts

Seperti terlihat di atas, pada struktur folder berbasis tipe, layar dipisahkan dari panggilan API dan helper, sehingga codebase bisa lebih sulit dipahami. Perhatikan bagaimana kita bisa saja menaruh layar yang tidak berhubungan seperti LoginScreen.tsx dan TodoListScreen.tsx di folder yang sama pada struktur folder berbasis tipe. Selain itu, kode juga bisa lebih sulit dipelihara karena kode yang saling berkaitan tidak dikelompokkan di satu tempat. Sementara pada struktur folder berbasis fitur, semua kode yang berkaitan dengan autentikasi, termasuk layar, panggilan API, helper, dan service, dikelompokkan bersama di satu folder auth. Ini membuat codebase lebih mudah dipahami, karena semua kode yang berkaitan berada di satu tempat. Pendekatan ini memungkinkan enkapsulasi kode yang lebih baik dan membuat proyek scalable serta fleksibel untuk perubahan di masa depan.

Gambaran akhir dengan struktur folder berbasis fitur

Berikut tampilan akhirnya dengan struktur folder berbasis fitur beserta file contoh:

    Feature-based folder structure:

    src/
    ├── components/
    │   ├── Button.tsx
    │   └── Header.tsx
    ├── hooks/
    │   └── useHeader.ts
    ├── localization/
    │   ├── languages.ts
    │   └── locales.ts
    ├── lib/
    │   ├── axios-instance.ts
    │   └── constants.ts
    ├── navigation/
    │   ├── root-navigator.tsx
    │   └── auth-stack.tsx
    ├── services/
    │   ├── notification.ts
    │   └── logging.ts
    ├── theme/
    │   └── index.ts
    ├── types/
    │   ├── env.d.ts
    │   └── react-augment.d.ts
    ├── utils/
    │   └── layout.ts
    └── features/
        ├── auth/
        │   ├── api/
        │   │   ├── login.ts
        │   │   ├── signup.ts
        │   │   └── refresh-token.ts
        │   ├── helpers/
        │   │   ├── validateToken.ts
        │   │   └── dataTransformer.ts
        │   ├── hooks/
        │   │   ├── useLoginAction.ts
        │   │   └── useSignupForm.ts
        │   ├── screens/
        │   │   ├── Login.tsx
        │   │   └── Signup.tsx
        │   ├── services/
        │   │   └── validation.ts
        │   └── store/
        │       └── auth.ts (zustand, redux, jotai etc.)
        └── ... (other features)

File-file yang ditambahkan ke berbagai folder di atas (misalnya button.tsx, header.tsx di folder components, useHeader.ts di folder hooks, dan seterusnya) hanya dimaksudkan sebagai contoh dan tidak boleh dianggap 100% akurat. Tujuan menyertakan file-file ini adalah memberikan gambaran visual tentang struktur folder dan membantu memahami susunan codebase dengan lebih baik. Implementasi sebenarnya bisa berbeda tergantung kebutuhan spesifik proyek. Fokus artikel ini adalah struktur folder berbasis fitur dan bagaimana struktur ini bisa membantu membangun codebase yang scalable dan tertata, bukan detail spesifik dari setiap file.


Kesimpulan

Menurut saya, struktur folder berbasis fitur adalah pendekatan yang berguna untuk menata proyek React/React Native. Dengan memecah kode menjadi fitur-fitur terpisah, saya merasa aplikasinya lebih mudah dipelihara, dipahami, dan dikembangkan. Struktur ini memungkinkan enkapsulasi kode yang lebih baik, membuat proyek scalable dan fleksibel untuk perubahan di masa depan. Tentu saja, ini bukan solusi yang cocok untuk semua kasus, dan struktur persisnya bisa berbeda tergantung ukuran dan kompleksitas proyek. Namun, ide utamanya adalah menjaga pemisahan yang jelas antara fitur-fitur yang berbeda beserta komponen, service, dan data masing-masing. Dari pengalaman saya, struktur ini membantu saya membangun dan memelihara proyek yang tertata rapi dan mampu menghadapi pertumbuhan serta perubahan dari waktu ke waktu. Saya ingin membagikan pendekatan ini kepada orang lain yang mungkin juga merasa terbantu.

Diterbitkan di

Artikel ini juga diterbitkan di: