Catatan Tutorials

Abstraksi dan penamaan

Abstraksi menyembunyikan detail supaya Anda bisa memikirkan satu hal pada satu waktu; nama adalah cara menunjuk apa yang disembunyikan. Seperti apa abstraksi yang baik, bagaimana nama membawa makna, konvensi di Python, JavaScript, Go, dan PHP, dan apa yang terjadi saat abstraksi bocor.

7 menit bacaTersedia juga dalam bahasa Inggris →

Di bagian 0, abstraksi adalah langkah ketiga dalam pemrograman: memberi nama pada sebuah pekerjaan lalu memakainya sebagai satu kesatuan. Sejak itu kita terus memakainya. Fungsi di bagian 7, fungsi-fungsi pembantu di bagian 9, bahkan sort() di bagian 10. Bagian ini membahas abstraksi secara langsung, beserta pasangannya sehari-hari: penamaan. Yang satu menyembunyikan detail; yang lain adalah cara menunjuk apa yang disembunyikan.

Apa itu abstraksi

Wikipedia merangkumnya dalam satu kalimat: “In software, an abstraction provides access while hiding details that otherwise might make access more challenging. It focuses attention on details of greater importance.” Abstraksi memberi akses sambil menyembunyikan detail yang bisa mempersulit, dan memusatkan perhatian pada hal yang lebih penting. Joel Spolsky menyebutnya “a simplification of something much more complicated that is going on under the covers”: penyederhanaan dari sesuatu yang jauh lebih rumit di baliknya.

Anda memakai abstraksi sepanjang hari tanpa memikirkannya. print("hi") menyembunyikan sistem operasi, terminal, dan encoding karakter dari bagian 2. Nama file menyembunyikan blok mana di disk yang menyimpan datanya. Query database menyembunyikan bagaimana baris-barisnya ditemukan. Masing-masing membuat Anda bisa memikirkan apa yang diinginkan, bukan bagaimana caranya.

Kotak hitam

Structure and Interpretation of Computer Programs menjelaskan ini dengan fungsi kecil, square. Begitu fungsi itu ada, Anda bisa memperlakukan square sebagai kotak hitam, yang oleh buku itu disebut procedural abstraction. Kalimat kuncinya: “A user should not need to know how the procedure is implemented in order to use it.” Pemakai tidak perlu tahu bagaimana fungsinya dibuat untuk bisa memakainya.

Itulah kesepakatan yang dibuat abstraksi yang baik. Di luar: sebuah nama, input, output, dan janji tentang apa yang dilakukannya. Di dalam: apa saja, selama janjinya ditepati. Bagian dalamnya bisa ditulis ulang, dipercepat, atau diperbaiki, dan tidak ada pemakainya yang perlu berubah.

Karena itu pula nama memikul beban yang besar. Saat bagian dalam disembunyikan, nama, parameter, dan mungkin satu baris docstring adalah satu-satunya yang didapat pembaca.

Logika sama, dua versi

Ini fungsi yang berjalan, dan hasilnya benar:

def calc(d, t):
    r = []
    for x in d:
        if x[3] == 1 and t - x[2] > 2592000:
            r.append(x[0])
    return r

Apa yang dilakukannya? Bisa ditebak, tapi hanya dengan membaca setiap baris dan menerka arti x[3], 1, dan 2592000. Ini logika yang sama dengan nama yang bekerja:

SECONDS_PER_DAY = 86_400
OVERDUE_AFTER_DAYS = 30
UNPAID = 1

def overdue_invoice_ids(invoices, now):
    """IDs of unpaid invoices issued more than 30 days before `now` (Unix seconds)."""
    limit = OVERDUE_AFTER_DAYS * SECONDS_PER_DAY
    return [
        inv_id
        for inv_id, customer, issued_at, status in invoices
        if status == UNPAID and now - issued_at > limit
    ]

Jalankan keduanya pada tiga invoice yang sama (umur 40 hari dan belum dibayar, 10 hari dan belum dibayar, 45 hari tapi sudah dibayar):

['INV-1']
['INV-1']

Hasilnya sama. Komputer tidak peduli soal nama. Manusia yang peduli. Versi kedua memberi tahu tujuannya sebelum Anda membaca isinya, dan pemanggilannya terbaca seperti kalimat: overdue_invoice_ids(invoices, now).

2592000 di versi pertama disebut magic number: “a numeric literal in source code whose meaning is unclear to the reader”, angka di kode yang artinya tidak jelas bagi pembaca. Memberinya nama (OVERDUE_AFTER_DAYS * SECONDS_PER_DAY) juga memberi satu tempat untuk mengubahnya saat bisnis memutuskan batasnya jadi 45 hari.

Fungsi yang sama di PHP:

const SECONDS_PER_DAY = 86_400;
const OVERDUE_AFTER_DAYS = 30;
const UNPAID = 1;

function overdueInvoiceIds(array $invoices, int $now): array {
    $limit = OVERDUE_AFTER_DAYS * SECONDS_PER_DAY;
    $ids = [];
    foreach ($invoices as [$id, $customer, $issuedAt, $status]) {
        if ($status === UNPAID && $now - $issuedAt > $limit) {
            $ids[] = $id;
        }
    }
    return $ids;
}
// → ["INV-1"]

Kenapa memberi nama itu sulit

Ada ungkapan lama yang biasanya dikaitkan dengan Phil Karlton: “There are only two hard things in Computer Science: cache invalidation and naming things.” Hanya ada dua hal sulit dalam ilmu komputer: invalidasi cache dan memberi nama. Ini lelucon, tapi bagian penamaannya nyata. Nama yang baik menuntut Anda tahu persis benda apa itu. Saat Anda tidak bisa menamai sebuah fungsi, sering kali itu tanda fungsinya mengerjakan dua hal, atau Anda belum paham betul gunanya. Ini ujian yang sama dengan aturan “satu kalimat, tanpa kata dan” dari bagian 9.

Ini penting karena, seperti kata PEP 8, “code is read much more often than it is written”: kode jauh lebih sering dibaca daripada ditulis.

Kebiasaan yang membuat nama bekerja

  • Sebut apa isinya, bukan cara menyimpannya. customers, bukan list1 atau arr. price_by_product, bukan dict2.
  • Masukkan satuan ke nama kalau ada. timeout_seconds, weight_kg, amount_rupiah. Banyak bug mahal berasal dari tertukarnya milidetik dan detik.
  • Boolean dibaca seperti pertanyaan ya/tidak. is_paid, has_stock, can_edit. Maka if is_paid: terbaca wajar.
  • Fungsi adalah tindakan atau pertanyaan. send_invoice(), parse_order(), is_overdue(). Fungsi bernama data() atau process() tidak memberi tahu apa-apa.
  • Panjang nama sesuai jangkauannya. i cukup untuk loop tiga baris. Nilai yang dipakai di seluruh file layak diberi nama lengkap.
  • Satu kata untuk satu gagasan. Kalau di satu tempat namanya customer, jangan sebut client di tempat lain dan user di tempat ketiga, kecuali memang benda yang berbeda.
  • Hindari nama yang mirip. PEP 8: “Never use the characters ‘l’ (lowercase letter el), ‘O’ (uppercase letter oh), or ‘I’ (uppercase letter eye) as single character variable names.”
  • Ganti nama saat maknanya berubah. Variabel total yang sekarang berisi total dikurangi diskon adalah jebakan bagi pembaca berikutnya. Editor bisa mengganti nama dengan aman; manfaatkan itu.

Tiap bahasa punya konvensinya sendiri

Kebiasaan di atas berlaku di mana saja. Cara menulis nama bergantung pada bahasanya, dan mengikuti konvensi setempat adalah bagian dari menulis kode yang mudah dibaca:

Variabel & fungsi Tipe / class Konstanta
Python (PEP 8) snake_case CapWords UPPER_CASE
JavaScript (kebiasaan umum) camelCase PascalCase UPPER_CASE atau camelCase
Go (Effective Go) mixedCaps MixedCaps MixedCaps / mixedCaps
PHP (PSR-1) method camelCase StudlyCaps konstanta class UPPER_CASE

Sumbernya menyatakan langsung. PEP 8: “Function names should be lowercase, with words separated by underscores as necessary to improve readability.” Effective Go: “the convention in Go is to use MixedCaps or mixedCaps rather than underscores to write multiword names.” PSR-1: “Class names MUST be declared in StudlyCaps” dan “Method names MUST be declared in camelCase.”

Go melangkah lebih jauh: nama adalah kontrol aksesnya. Di Go, “the visibility of a name outside a package is determined by whether its first character is upper case”, terlihat atau tidaknya sebuah nama dari luar package ditentukan oleh huruf pertamanya. Jadi field berhuruf kecil tersembunyi di balik abstraksi package:

package billing

type Invoice struct {
	ID     string // visible outside the package
	status int    // hidden
}

func (i Invoice) Status() int { return i.status }

Mencoba membaca inv.status dari package lain tidak bisa dikompilasi:

./main.go:11:18: inv.status undefined (type billing.Invoice has no field or method status, but does have method Status)

Perhatikan method-nya Status(), bukan GetStatus(): Effective Go menyebut “it’s neither idiomatic nor necessary to put Get into the getter’s name.” Detail kecil seperti ini yang membuat kode terasa memang ditulis untuk bahasanya.

Saat abstraksi bocor

Spolsky memberi nama pada masalahnya: “All non-trivial abstractions, to some degree, are leaky.” Semua abstraksi yang tidak sepele pasti sedikit bocor. Detail yang disembunyikan kadang menembus keluar, dan saat itu Anda perlu tahu apa yang ada di bawahnya.

Kita sudah bertemu beberapa kebocoran di seri ini:

  • Angka. Angka desimal di kode tampak pasti, tapi 0.1 + 0.2 mencetak 0.30000000000000004, karena representasi biner dari bagian 2.
  • Dictionary. Pencarian O(1) dari bagian 10 adalah rata-rata yang mengasumsikan sedikit tabrakan hash.
  • Database. Fungsi pembantu seperti customer_name(customer_id) menyembunyikan sebuah query. Tampak aman, sampai dipanggil di dalam loop:
names = [customer_name(cid) for cid in order_customer_ids]   # 500 orders
one call per order: 500 queries
one query for all: 1 query

Menghitung query dengan trace callback SQLite membuat kebocorannya terlihat: satu baris yang tampak rapi menjalankan 500 query, padahal satu query WHERE id IN (...) bisa melakukan hal yang sama. Ini pola “query di dalam loop” dari bagian 10, tersembunyi di balik nama yang bagus.

Kebocoran tidak berarti abstraksi itu buruk. Artinya fundamental tetap penting: Anda bisa memakai abstraksi tanpa tahu isinya, tapi saat ia berulah, jawabannya ada di dalam.

Abstraksi yang berlebihan

Kesalahan sebaliknya juga umum: menyembunyikan hal yang tidak perlu disembunyikan.

  • Pembungkus yang hanya mengganti nama. def get_user(id): return fetch_user(id) menambah satu lapisan dan satu nama untuk dipelajari, tanpa menyembunyikan apa pun.
  • Membuat abstraksi dari satu contoh. “Mesin laporan generik” yang dibuat untuk satu laporan biasanya tidak cocok untuk laporan kedua. Tunggu sampai polanya terlihat dua atau tiga kali.
  • Terlalu banyak lapisan. Kalau untuk menemukan di mana sesuatu benar-benar terjadi butuh enam lompatan antar-file, setiap lapisan harus benar-benar berguna.

Pemeriksaan yang berguna: apakah abstraksi ini membuat pembaca bisa berhenti memikirkan sesuatu? Kalau mereka tetap harus membukanya untuk memahami pemanggilnya, abstraksi itu belum banyak membantu.

Kenapa ini penting sehari-hari

  • Code review. Kebanyakan komentar review yang bukan soal bug adalah soal nama. Nama yang baik membuat review lebih cepat.
  • Debugging. Nama yang menyesatkan mengirim Anda ke tempat yang salah. total yang ternyata bukan total bisa menghabiskan berjam-jam.
  • Kebutuhan yang berubah. Konstanta bernama atau fungsi dengan batas yang jelas berarti satu perubahan, bukan dua puluh.
  • Bekerja dengan AI. Nama yang jelas adalah konteks. Fungsi bernama overdue_invoice_ids mendapat saran yang lebih baik daripada calc, dan kode hasil AI dengan nama yang samar adalah tanda untuk melambat dan membacanya dengan teliti.

Coba sendiri

  1. Cari fungsi di kode Anda yang namanya perlu dijelaskan. Ganti namanya sampai tidak perlu dijelaskan lagi.
  2. Cari magic number di sebuah proyek (86400, 3600, 1000, kode status seperti 1 dan 2). Beri nama pada dua di antaranya.
  3. Tulis satu fungsi kecil yang sama di Python dan di PHP atau Go, ikuti konvensi penamaan masing-masing bahasa.
  4. Pilih satu abstraksi yang Anda pakai setiap hari (ORM, helper fetch(), save() dari framework). Tuliskan satu situasi saat Anda perlu tahu apa yang dilakukannya di balik layar.

Ringkasan

  • Abstraksi menyembunyikan detail supaya Anda memikirkan apa, bukan bagaimana. Abstraksi yang baik adalah kotak hitam: nama, input, output, dan janji.
  • Nama adalah antarmuka ke semua yang disembunyikan; komputer mengabaikannya, manusia bergantung padanya.
  • Beri nama sesuai makna, sertakan satuan, jadikan boolean sebuah pertanyaan, dan sesuaikan panjang dengan jangkauan.
  • Ikuti konvensi bahasanya: PEP 8, Effective Go, PSR-1, dan kebiasaan umum JavaScript.
  • Abstraksi bocor (float, hash table, query di dalam loop); saat itu terjadi, fundamental di bawahnya yang menjelaskan sebabnya.
  • Jangan membuat abstraksi terlalu dini; abstraksi harus membuat pembaca bisa berhenti memikirkan sesuatu.

Referensi