крышка

Предисловие

Если число делится на 3, результат — Fizz. Если число делится на 5, результат — Buzz.

Если оба варианта удовлетворены одновременно, выводится FizzBuzz.

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

Первая версия бизнеса была простой, поэтому я быстро набрал код.

 public static String fizzBuzz(int num) {
        if (num % 3 == 0 && num % 5 == 0) {
            return "FizzBuzz";
        } else if (num % 3 == 0) {
            return "Fizz";
        } else if (num % 5 == 0) {
            return "Buzz";
        } else {
            return String.valueOf(num);
        }
    }

Затем бизнес меняется. При тех же условиях, что и раньше, если число содержит 3, возвращается Fizz, а если число содержит 5, возвращается Buzz. Поскольку я боюсь, что программисты могут неправильно понять, я добавил еще несколько репрезентативных данных.

Например, если вы введете 57, будет возвращено значение FizzBuzz, поскольку оно кратно 3 и также содержит 5.

Кажется очень просто, но чтобы пройти небольшую часть теста, я написал кучу if else для сохранения точности и едва выполнил задание.

В этом процессе TDD был завершен неосознанно.

Что такое ТДД

Говоря о TDD, его полное название — Test-Driven Development. Это можно понимать как разработку на основе тестовых сценариев, а можно понимать и более наглядно: тестировщики стимулируют разработчиков.

Зачем нужен TDD

Основная цель различных методов разработки программного обеспечения — решение сложных объектных задач. Концепция TDD — это решение, ориентированное на тестовые данные.

Например, при обслуживании старых систем мы часто сталкиваемся с устаревшими кодами, такими как «родовой код» и «ушедший в отставку код». Как TDD может нам помочь в этой ситуации?

①Прочитайте код и связанные с ним документы и поймите код.

②Добавить тестовые примеры.

③Маленькая итерация и постепенное улучшение.

Попробуйте это

Используя код в Предисловие, выполните три вышеуказанных шага, чтобы улучшить его.

Во-первых, понимание прочитанного, что больше всего раздражает. На данный момент вы можете попробовать использовать ИИ для понимания.

объяснить код

Добавление тестовых примеров и повторяющихся задач также можно передать Tencent Cloud AI Code Assistant.

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class FizzBuzzTest {

    @Test
    public void testFizzBuzz() {
        assertEquals("FizzBuzz", FizzBuzz.fizzBuzz(15));
        assertEquals("Fizz", FizzBuzz.fizzBuzz(3));
        assertEquals("Buzz", FizzBuzz.fizzBuzz(5));
        assertEquals("1", FizzBuzz.fizzBuzz(1));
        assertEquals("2", FizzBuzz.fizzBuzz(2));
        assertEquals("Fizz", FizzBuzz.fizzBuzz(6));
        assertEquals("Buzz", FizzBuzz.fizzBuzz(10));
        assertEquals("FizzBuzz", FizzBuzz.fizzBuzz(30));
        assertEquals("4", FizzBuzz.fizzBuzz(4));
        assertEquals("7", FizzBuzz.fizzBuzz(7));
    }
}

Небольшая пошаговая итерация фактически предназначена для реконструкции этой части логики.

Это первая версия кода после бизнес-улучшений.

    if ((String.valueOf(num).contains("3") || num % 3 == 0) && (String.valueOf(num).contains("5") || num % 5 == 0)) {
        return "FizzBuzz";
    } else if (String.valueOf(num).contains("3") || num % 3 == 0) {
        return "Fizz";
    } else if (String.valueOf(num).contains("5") || num % 5 == 0) {
        return "Buzz";
    } else {
        return String.valueOf(num);
    }

Без комментариев выше читабельность плохая. Чтобы реконструировать его, сначала поймите его характеристики.

Есть много повторяющихся суждений, поэтому постарайтесь их извлечь (Введение поля).

  public static String fizzBuzz(int num) {
    // Содержит 3
    boolean containsThree = String.valueOf(num).contains("3");
    // Делится на 3
    boolean divisibleByThree = num % 3 == 0;
    // Содержит 5
    boolean containsFive = String.valueOf(num).contains("5");
    // Делится на 5
    boolean divisibleByFive = num % 5 == 0;

    if ((containsThree || divisibleByThree) && (containsFive || divisibleByFive)) {
        return "FizzBuzz";
    } else if (containsThree || divisibleByThree) {
        return "Fizz";
    } else if (containsFive || divisibleByFive) {
        return "Buzz";
    } else {
        return String.valueOf(num);
    }
  }

Наконец, код полностью прошел тестовый пример. Вы остро чувствуете, что логику можно реструктурировать. Когда вы хотите превратить поля в функции, вас останавливает идея.

Первое правило программирования

Раздел

В разработке программного обеспечения не существует серебряной пули, и TDD — это просто выбор метода. Он снижает затраты на «оценку того, понимает ли человек требования» и затраты на «обнаружение требований, которых нелегко достичь с помощью текущего архитектурного видения». " Некоторые из включенных инструментов, модульное тестирование и рефакторинг, полезны где угодно.

Качество кода — это общий термин. Раньше код, который мог работать стабильно, считался хорошим. Теперь есть еще один: проверенный код — это хороший код!