Javascript ES6 ile Temiz Kod Yazmak

Temiz kod sadece çalışan kod demek değildir. Aslında çalışan kod yazmak kolaydır. Mesela hepimiz tek bir JS dosyası açıp, dosyaları bile ayırmadan her yazacağımız kodu aynı dosyaya yazabiliriz. Function oluşturup, ismindeki harfleri bir büyük bir küçük şeklinde kafamıza göre tanımlayabiliriz. Metodları hiç kullanmayıp iç içe döngülerle filtreleme yapabiliriz. Genelde derleyiciler ve motorlar bu gibi şeyleri önemsemezler ama toplum önemser 🙂 İyi bir yazılımcı olmak isteyen veya olan hiç kimse “Önceki yazılımcı batırmış işleri” diye anılmak istemez. Etik olarak kod çalıştıktan sonra iyi yazılmış olması mesleki ahlak olarak yeterli midir? Orası ayrı bir tartışma konusu. Biz temiz kod ne demekmiş ona bakalım;
Temiz kod genel anlamıyla, diğer yazılımcılar tarafından kolayca okunabilen, güncellenebilen kod demektir. Bu kodu oluşturmak için sadece çalışan bir koda değil, topluluk kurallarına genel anlamda uyulmuş, tanımlanan değişken, sınıf ve fonksiyon isimlerinin kolayca anlaşılabildiği, anlamlı bir şekilde bölünmüş, kullanılan dilin hemen hemen tüm imkanlarını kullanarak oluşturulmuş bir koda ihtiyacımız var demektir.
Ben Javascript’le ilgili doğru temiz kod yöntemlerini aktarmaya çalışacağım fakat bu yöntemler genel olarak diğer dillerde de kullanılabilir.
1. Değişkenler (Variables)
Anlamlı isimlendirme yapın
Javascript’te temel kural, hemen hemen bütün isimlendirmelerin Camel Case (camelCase) olarak yapılmasıdır. Ayrıca JS dahil hiçbir programlama dilinde İngilizce dışında değişken, fonksiyon vb. isimlendirme yapılmamalıdır. (Düşünsene açıyorsun editörü japonca değişken? Düşüncesi bile titretiyor…)
// Yanlış ❌
const eposta = "berat@example.com";
const firstname = "Berat";
const IsActive = 21;
const aktifMi = true;
// Doğru ✅
const email = "berat@example.com";
const firstName = "Berat";
const age = 21;
const isActive = true;
Bir de boolean adlandırmalar yaparız. Bunlarda da İngilizce de ki soru ekleri kullanılır:
isActive;
didOnline;
hasSharePost;
İsimlerin önüne gereksiz bağlamlar eklemeyin
Buna en çok MySql’de kolon isimlendirmelerinde rastlıyorum. Tablonun adı zaten “user” neden altına tekrar “user_name, user_surname” yazılıyor? Bırakalım bu sululukları! 🤨
Aynı şekilde burada da objemiz user ise tekrar altındaki elemanlara user eki koymamıza gerek yok.
// Yanlış ❌
const user = {
userId: "1",
userEmail: "tayfun@example.com",
userFirstName: "Tayfun",
userLastName: "Erbilen",
};
user.userId;
// Doğru ✅
const user = {
id: "1",
email: "berat@example.com",
firstName: "Berat",
lastName: "Aras",
};
user.id;
Hardcode kullanmayın
Sabit değerler eklemek yerine, anlamlı ve güncellenebilen değerler oluşturmak daha iyidir.
// Yanlış ❌
setTimeout(clearSessionData, 900000);
// Doğru ✅
const duration = 15 * 60 * 1000;
setTimeout(clearSessionData, duration);
2. Fonksiyonlar (Functions)
Açıklayıcı ve gerekirse uzun adlandırmalar yapın
Fonksiyon isimleri uzun olabilir bunda hiçbir sakınca yok. Genellikle fonksiyon içindeki yapılan aksiyon tanımlanır. Örneğin Türkçe mantığı şu şekilde: “çayıOcağaKoy”, “arabayaBinMotoruÇalıştır”
Ayrıca fonksiyon isimlerinde de Camel Case kullanılır. (Kebab case gönlümüzdedir.)
// Yanlış ❌
function toggle() {
// ...
}
function agreed(user) {
// ...
}
// Doğru ✅
function toggleThemeSwitcher() {
// ...
}
function didAgreeToAllTerms(user) {
// ...
}
Değişkenlerde varsayılan değerler kullanın
Fonksiyon içerisinde fazladan bir kontrol eklemek yerine, parantez içerisinde tanımladığınız değişkene varsayılan (default) bir değer atayın.
// Yanlış ❌
function getFilesInDirectory(dir) {
const directory = dir || "./";
// ...
}
// Doğru ✅
function getFilesInDirectory(dir = "./") {
// ...
}
Değişken sayısını sınırlayın
Bir fonksiyon en fazla 3 argüman almalıdır. Bazen üç argüman bile aşırı kabul edilebilir ama üçten fazlaysa bunun 2 sebebi olabilir:
- Fonksiyon birden fazla iş yapıyordur ve ayrılması gerekiyordur.
- Fonksiyona iletilen veriler ilişkilidir ve bir obje veya array içine alınarak iletilebilir.
// Yanlış ❌
function sendPushNotification(title, message, image, isSilent, delayMs) {
// ...
}
sendPushNotification("New Message", "...", "http://...", false, 1000);
// Doğru ✅
function sendPushNotification(notification, user) {
const title = notification.title;
}
const notificationConfig = {
title: "New Message",
message: "...",
image: "http://...",
isSilent: false,
delayMs: 1000,
};
sendPushNotification(notificationConfig, userName);
Bir fonksiyon yalnızca bir iş yapmalı
Bir class oluşturduğumuzda veya fonksiyonel bir yapı kurduğumuzda bir fonksiyonun yalnızca tek bir görevi olmalıdır. Örnek olarak bir fonksiyonu, bir restoranttaki garson olarak ele alalım. Normalde isteklerinizi getiren garson, birden fazla şey getirebilir. Örneğin bir elinde içeceğiniz diğer elinde yemeğiniz olabilir. Ancak fonksiyonda bu olmamalı, fonksiyonda garson sadece yemeğinizi getirmeli. Bir fonksiyon yemeğinizi getirirken diğer fonksiyon içeceğinizi getirmeli. Böylece hangi fonksiyonun tam olarak ne yaptığını daha iyi anlamış oluruz.
// Yanlış ❌
function pingUsers(users) {
users.forEach((user) => {
const userRecord = database.lookup(user);
if (!userRecord.isActive()) {
ping(user);
}
});
}
// Doğru ✅
function pingInactiveUsers(users) {
users.filter(!isUserActive).forEach(ping);
}
function isUserActive(user) {
const userRecord = database.lookup(user);
return userRecord.isActive();
}
Kontrol argümanı kullanmayın
Eğer bir kontrol argümanı kullanmak zorunda kaldıysanız, bu fonksiyonun daha da bölünebileceği ve basitleştirilebileceği anlamına gelir.
Burada da görüldüğü gibi tek bir createFile fonksiyonu oluşturup public olup olmadığını isPublic ile kontrol etmek yerine createFile ve createPublicFile adında iki ayrı fonksiyon oluşturduk. Böylece bir fonksiyonumuzun sadece bir görevi olmuş oldu ve daha temiz bir yapı oluştu.
// Yanlış ❌
function createFile(name, isPublic) {
if (isPublic) {
fs.create(`./public/${name}`);
} else {
fs.create(name);
}
}
// Doğru ✅
function createFile(name) {
fs.create(name);
}
function createPublicFile(name) {
createFile(`./public/${name}`);
}
Tekrara düşme
Belkide yazılımcılar olarak en çok yaptığımız hata kodumuzu tekrar etmektir. Bir yerde bir kod tekrar ediyorsa yanlış giden bir şeyler var ve yapımızı doğru kuramadık demektir.
// Yanlış ❌
function renderCarsList(cars) {
cars.forEach((car) => {
const price = car.getPrice();
const make = car.getMake();
const brand = car.getBrand();
const nbOfDoors = car.getNbOfDoors();
render({ price, make, brand, nbOfDoors });
});
}
function renderMotorcyclesList(motorcycles) {
motorcycles.forEach((motorcycle) => {
const price = motorcycle.getPrice();
const make = motorcycle.getMake();
const brand = motorcycle.getBrand();
const seatHeight = motorcycle.getSeatHeight();
render({ price, make, brand, seatHeight });
});
}
// Doğru ✅
function renderVehiclesList(vehicles) {
vehicles.forEach((vehicle) => {
const price = vehicle.getPrice();
const make = vehicle.getMake();
const brand = vehicle.getBrand();
const data = { price, make, brand };
switch (vehicle.type) {
case "car":
data.nbOfDoors = vehicle.getNbOfDoors();
break;
case "motorcycle":
data.seatHeight = vehicle.getSeatHeight();
break;
}
render(data);
});
}
Burada yapılan gereksiz tekrarı görebildik mi? Kodu yazan yazılımcı sadece tek bir değişken farklı diye koca bir fonksiyonu kopyalayıp yenisini açmış 🙃 Halbuki switch-case yazılımda gördüğümüz en temel yapı. Bunu kullanarak o tek değişkenin kontrolünü sağlayabildik. Tabii burada istenirse if-else yapısı da kulanılabilir.
Genel bir sabitin yapısını değiştirmeyin
Buna İngilizce olarak “Avoid side effects” demişler. Bu kısaca şu; Örneğin belli bir tarihi tuttuğunuz date adında değişkeniniz var ve bu değişkendeki tarihi, gün, ay ve yıl olarak ayırmak istiyorsunuz. Ayırdınız fakat ayrılmış halini tekrar date değişkenine atmak yerine, newDate adında bir değişken oluştur, orjinal hali aynı şekilde kalsın.
// Yanlış ❌
let date = "23-01-2000";
function splitIntoDayMonthYear() {
date = date.split("-");
}
splitIntoDayMonthYear();
console.log(date); // ['23', '01', '2000'];
// Doğru ✅
function splitIntoDayMonthYear(date) {
return date.split("-");
}
const date = "21-8-2021";
const newDate = splitIntoDayMonthYear(date);
console.log(date); //date aynı şekilde kaldı.
console.log(newDate); //newDate ise böldüğümüz tarih şeklinde.
Aynı olay bir Array’in içerisine bir eleman eklemek istediğimizde de geçerli. Aynı Array’in içine atmak yerine yeni bir Array kopyalayıp atın. Bunu ECMAScript ile gelen spread operatörü ile kolayca yapabiliriz.
// Yanlış ❌
function enrollStudentInCourse(course, student) {
course.push({ student, enrollmentDate: Date.now() });
}
// Doğru ✅
function enrollStudentInCourse(course, student) {
return [...course, { student, enrollmentDate: Date.now() }];
}
//Gördüğünüz gibi burada course Array'ide kopyalanıp yeni bir Array oluşturuluyor.
3. Koşullar (Conditionals)
Negatif olmayan koşul ifadelerini kullanın
// Yanlış ❌
function isUserNotVerified(user) {
// ...
}
if (!isUserNotVerified(user)) {
// ...
}
// Doğru ✅
function isUserVerified(user) {
// ...
}
if (isUserVerified(user)) {
// ...
}
Mümkün olduğunca kısaltmaları kullanın
Burada dilin imkanlarını kullanmanın büyük önemi daha da beli oluyor.
// Yanlış ❌
if (isActive === true) {
// ...
}
if (firstName ! "" && firstName ! null && firstName !== undefined) {
// ...
}
const isUserEligible = user.isVerified() && user.didSubscribe() ? true : false;
// Doğru ✅
if (isActive) {
// ...
}
if (!!firstName) {
// ...
}
const isUserEligible = user.isVerified() && user.didSubscribe();
Gereksiz satırlar ve parantezler oluşturmayın
// Yanlış ❌
function addUserService(db, user) {
if (!db) {
if (!db.isConnected()) {
if (!user) {
return db.insert("users", user);
} else {
throw new Error("No user");
}
} else {
throw new Error("No database connection");
}
} else {
throw new Error("No database");
}
}
// Doğru ✅
function addUserService(db, user) {
if (!db) throw new Error("No database");
if (!db.isConnected()) throw new Error("No database connection");
if (!user) throw new Error("No user");
return db.insert("users", user);
}
Hatta ternary daha iyi olabilir:
function addUserService(db, user) {
!db && throw new Error("No database");
!db.isConnected() && throw new Error("No database connection");
!user && throw new Error("No user");
return db.insert("users", user);
}
Bazen Switch yerine Obje kullanmak daha iyidir
Böyle bir durumda nesneleri ve map’leri kullanmak performans ve kod okunabilirliliği açısından daha iyidir.
// Yanlış ❌
const getColorByStatus = (status) => {
switch (status) {
case "success":
return "green";
case "failure":
return "red";
case "warning":
return "yellow";
case "loading":
default:
return "blue";
}
};
// Doğru ✅
const statusColors = {
success: "green",
failure: "red",
warning: "yellow",
loading: "blue",
};
const getColorByStatus = (status) => statusColors[status] || "blue";
4. Eş Zamanlı İşlemler (Concurrency)
Callback ömür çürütür
Callback yerine yine ES6 ile gelen Promise’ı veya Async/Await söz dizimlerini kullanın.
// Yanlış ❌
getUser(function (err, user) {
getProfile(user, function (err, profile) {
getAccount(profile, function (err, account) {
getReports(account, function (err, reports) {
sendStatistics(reports, function (err) {
console.error(err);
});
});
});
});
});
// Doğru ✅
// Promise
getUser()
.then(getProfile)
.then(getAccount)
.then(getReports)
.then(sendStatistics)
.catch((err) => console.error(err));
// veya Async/Await ✅
async function sendUserStatistics() {
try {
const user = await getUser();
const profile = await getProfile(user);
const account = await getAccount(profile);
const reports = await getReports(account);
return sendStatistics(reports);
} catch (e) {
console.error(err);
}
}
5. Hata Raporlama (Error Handling)
Bunun neden son derece önemli bir kural olduğunu söylemeye gerek yok sanırım. Hataları doğru bir şekilde ele almak için şimdi zaman harcamak, sonraki zamanınızı kurtaracaktır.
// Yanlış ❌
try {
// olası hatalı kod
} catch (e) {
console.log(e);
}
// Doğru ✅
try {
// olası hatalı kod
} catch (e) {
// 1- eğer varsa kullanıcıya
alertUserOfError(e);
// 2- server'a raport et
reportErrorToServer(e);
// 3- özel hata işleme
throw new CustomError(e);
}
6. Yorum Satırları (Comments)
Sadece karışık mantıkları ve algoritmalarınızı anlatın
Temiz kod yazmak bizi fazla yorum satırlarından kurtarır. Sadece zorlanılacak kısımlarda yorum satırı kullanılabilir. Bu arada yorum satırlarıda mümkünse İngilizce olmalı. 🙃
// Yanlış ❌
function generateHash(str) {
// Hash variable
let hash = 0;
// Get the length of the string
let length = str.length;
// If the string is empty return
if (!length) {
return hash;
}
// Loop through every character in the string
for (let i = 0; i < length; i++) {
// Get character code.
const char = str.charCodeAt(i);
// Make the hash
hash = (hash << 5) - hash + char;
// Convert to 32-bit integer
hash &= hash;
}
}
// Doğru ✅
function generateHash(str) {
let hash = 0;
let length = str.length;
if (!length) {
return hash;
}
for (let i = 0; i < length; i++) {
const char = str.charCodeAt(i);
hash = (hash << 5) - hash + char;
hash = hash & hash; // Convert to 32bit integer
}
return hash;
}
Kod içinde versiyon kontrolü yapmayın
Gereksiz yorum satırlarıda kodu okunmaz hale getirir. Versiyon kontrol sistemleri hali hazırda varken ve bizler kullanıyorken kod içinde versiyon kontrol yapmayın.
// Yanlış ❌
/**
* 2021-7-21: Fixed corner case
* 2021-7-15: Improved performance
* 2021-7-10: Handled mutliple user types
*/
function generateCanonicalLink(user) {
// const session = getUserSession(user)
const session = user.getSession();
// ...
}
// Doğru ✅
function generateCanonicalLink(user) {
const session = user.getSession();
// ...
}
Mümkünse koda kısa dökümanlar oluşturun
Örneğin burada bir fonksiyona gelen argümanların ne olduğuna dair bir comment çalışılmış. Bu tarz comment’lara kullandığınız kütüphaneler de ve framework’lerde sık sık rastlarsınız. Aslında önemsiz gibi gözükse de başka biri kodunuza baktığında veya siz uzun zaman sonra kendi kodunuza döndüğünüzde nereden neyin geldiğini daha iyi anlarsınız.
/**
* Returns x raised to the n-th power.
*
* @param {number} x The number to raise.
* @param {number} n The power, should be a natural number.
* @return {number} x raised to the n-th power.
*/
function pow(x, n) {
// ...
}
ECMAScript ne nimetmiş be! Benim anlatacaklarım bu kadar. Eminim hatalarım olmuştur. Desteğe ve eleştiriye açığım. 😎 Temiz kodun bol olsun. 🤘🏻 Okuduğun için teşekkürler!
Kaynakça
Bu yazımda Jihad Al Khurfan’ın “Writing Clean JavaScript — ES6 Edition” adlı yazısından çok destek aldım. Kendisinin yazılarınıda okumanızı tavsiye ederim.