Как найти вонючие части вашего кода [Часть XXXVIII]

Это пахнет, потому что, вероятно, есть много случаев, когда его можно отредактировать или улучшить.

Большинство этих запахов — просто намеки на то, что что-то может быть не так. Следовательно, их не обязательно исправлять как таковые… (Тем не менее, вы должны изучить это.)

Пахнет предыдущим кодом

Вы можете найти все предыдущие запахи кода (Часть I – XXXVII) здесь.

n Продолжим...

Code Smell 186 — Жестко прописанные бизнес-условия

Вы FTX, и ваш код допускает особые случаи

TL;DR: не добавляйте в код жестких бизнес-правил.

Проблемы

• Открытое/закрытое нарушение принципа
• Жесткое кодирование
• Тестируемость

Решения

1. Подтвердите условие.
2. Создайте параметры конфигурации и установите исключение для поведения конфигурации.
3. Не используйте Настройки/Конфигурации.

Контекст

Согласно Reuters< /a> во время недавнего скандала с FTX было жестко закодировано условие, позволяющее пропустить контроль рисков в собственном портфеле.

Код был явным, и разработчики знали об этом правиле.

Пример кода

Неверно

if (currentExposure > 0.15 && customer != "Alameda") {
  // Be extra careful not to liquidate
  liquidatePosition();
}

Правильно

  customer.liquidatePositionIfNecessary(0.15);

  // This follows the Tell, Don't ask principle

Обнаружение

• [x] Полуавтоматический

Мы можем искать первичные жестко заданные условия (связанные с примитивными типами).

У нас может быть больше ложных срабатываний, чем реальных проблем.

Теги

• Жесткое кодирование

Заключение

Если вы проводите проверку кода, обратите особое внимание на этот вид жесткого кодирования.

Отношения

Code Smell 133 — Жестко закодированные условия IF

Code Smell 29 — Настройки/Конфигурации

Подробнее

• Reuters о крахе FTX

Кредиты

Фото Александра Милса на странице Скрыть

Информатика инвертирует нормальное. В обычной науке вам дан мир, и ваша задача — выяснить правила. В информатике вы даете компьютеру правила, и он создает мир.

Алан Кей

Великие цитаты о разработке программного обеспечения

Код Запах 187 — Если/иначе наоборот

Первое, что мы читаем после условия if, это IF

TL;DR: у вас есть важное условие else для else.

Проблемы

• Читаемость

Решения

1. Поменять местами условия.

Контекст

Элегантно написать операторы IF не так просто, как кажется.

Есть много вариантов и вариантов.

Нам нужно обратить особое внимание на удобочитаемость.

Пример кода

Неверно

fun addToCart(item: Any) {
    if (!cartExists()) {
        // Condition is negated
        this.createCart();
        this.cart.addItem(Item);
        // Repeated Code
    }
    else {
        // Normal case is on the else clause
        this.cart.addItem(Item);
    }
}

Правильно

fun addToCart(item: Any) {
    if (cartExists()) {
        this.cart.addItem(Item);
    }
    else {      
        this.createCart();
        this.cart.addItem(Item);
    }
}   

fun addToCartShorter(item: Any) {
    if (!cartExists()) {
        this.createCart();
    }
    this.cart.addItem(Item);    
}

Обнаружение

• [x] Полуавтоматический

Мы можем найти отрицательные выражения для условий IF и проверить этот анти-шаблон.

Теги

• IF

Заключение

Нам нужно читать код как прозу.

Люди сначала читают стандартный случай, а затем исключительный.

Отношения

Code Smell 51 — Двойное отрицание

Code Smell 156 — Неявное прочее< /p>

Подробнее

• Знай код

Кредиты

Фото Карол Казаницки на Unsplash

Красота важнее в вычислительной технике, чем где-либо еще в технологии, потому что программное обеспечение очень сложное. Красота — это наилучшая защита от сложности.

Д. Гелернтер

Code Smell 188 – Повторяющиеся имена параметров

Используйте контекстные и локальные имена

TL;DR: не повторяйте названия параметров. Имена должны быть контекстными.

Проблемы

• Дублирование
• Читаемость

Решения

1. Удалить повторяющуюся часть имени

Контекст

При использовании имен мы часто упускаем из виду, что слова зависят от контекста и их нужно читать как целое предложение.

Пример кода

Неверно

class Employee
  def initialize(@employee_first_name : String, @employee_last_name : String, @employee_birthdate : Time)
  end
end

Правильно

class Employee
  def initialize(@first_name : String, @last_name : String, @birthdate : Time)
  end
end

Обнаружение

• [x] Полуавтоматический

Мы можем проверить имена параметров и попытаться найти дубликаты.

Теги

• Именование

Заключение

Используйте короткие и контекстные имена для параметров.

Отношения

Code Smell 174 — Имя класса в атрибутах

Code Smell 87 – Несогласованная сортировка параметров

Кредиты

Фото Вольфганга Хассельмана на Unsplash

Внедрение SQL – яркий пример угрозы.

Мы также можем добавить утверждения и инварианты для наших входных данных.

Более того, мы можем работать с объектами с ограниченным доступом< /а>.

Пример кода

Неверно

user_input = "abc123!@#"
# This content might not be very safe if we expect just alphanumeric characters

Правильно

import re

def sanitize(string):
  # Remove any characters that are not letters or numbers
  sanitized_string = re.sub(r'[^a-zA-Z0-9]', '', string)

  return sanitized_string

user_input = "abc123!@#"
print(sanitize(user_input))  # Output: "abc123"

Обнаружение

• [x] Полуавтоматический

Мы можем статически проверять все входные данные, а также использовать инструменты тестирования на проникновение.

Теги

• Безопасность

Заключение

Нам нужно быть очень осторожными с данными, которые мы не можем контролировать.

Отношения

Code Smell 121 — Проверка строк< /p>

Code Smell 178 — Нарушение подмножеств< /p>

Запах кода 15 – Пропущенные предварительные условия

Подробнее

• Википедия

Кредиты

Фото Джесс Зоерб на Unsplash

class PersonInQueue
  attr_accessor :name, :job

  def initialize(name, job)
    @name = name
    @job = job
  end
end

class PersonInQueue

  def moveForwardOnePosition
    # implement protocol
  end
end

Code Smell 144 — Взаимозаменяемые объекты< /p>

Code Smell 01 — Анемичные модели

Code Smell 40 — DTO

Code Smell 109 — Автоматические свойства< /p>

Кредиты

Фото Мелани Понграц на Unsplash