Как быстро изучаешь чужой код

Как быстро изучать чужой код

Система подхода к изучению

Изучение чужого кода — это важный навык в командной разработке. За 10+ лет я развил систематический подход, который значительно ускоряет процесс.

Шаг 1: Изучи архитектуру проекта

- Прочитай README.md
- Посмотри структуру папок (src/, test/, config/ и т.д.)
- Найди главные компоненты: servlets, controllers, services
- Определи использованные технологии: Spring, Hibernate, какие версии
- Посмотри pom.xml или build.gradle для зависимостей

Это займёт 10-15 минут и даст общее понимание.

Шаг 2: Запусти тесты

# Сначала тесты!
mvn clean test
# или
gradle test

Тесты — это лучшая документация. Они показывают:

• Как использовать код
• Какое поведение ожидается
• Граничные случаи

Прочитай test fixtures и assertions.

Шаг 3: Найди точку входа

Определи, с чего начинается выполнение:

• main() метод
• Spring @SpringBootApplication
• REST контроллер
• Job scheduler

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Шаг 4: Используй IDE для навигации

IntelliJ IDEA:
- Ctrl+Click на классе для перехода к определению
- Ctrl+Alt+H для просмотра иерархии вызовов (Call Hierarchy)
- Ctrl+Shift+F для поиска по всему проекту
- Alt+F7 для поиска использования (Find Usages)
- Ctrl+Shift+A для поиска actions

Эти инструменты экономят часы.

Шаг 5: Изучи основные классы層структурой вверх

Не начинай с деталей! Идёшь от абстракций к конкретике:

1. Контроллер/Endpoint
2. Service (бизнес-логика)
3. Repository (доступ к данным)
4. Entity/DTO (модели)
5. Utils (вспомогательные методы)

// Контроллер — точка входа
@RestController
@RequestMapping("/users")
public class UserController {
    @Autowired
    private UserService userService;
    
    @GetMapping("/{id}")
    public UserDto getUser(@PathVariable Long id) {
        return userService.getUserById(id);
    }
}

// Service — бизнес-логика
@Service
public class UserService {
    @Autowired
    private UserRepository repository;
    
    public UserDto getUserById(Long id) {
        User user = repository.findById(id)
            .orElseThrow(() -> new NotFoundException("User not found"));
        return mapper.toDto(user);
    }
}

// Repository — работа с БД
@Repository
public interface UserRepository extends JpaRepository<User, Long> {
    Optional<User> findByEmail(String email);
}

Шаг 6: Смотри логи при запуске

mvn spring-boot:run | grep -v DEBUG

Логи говорят о:

• Загруженные компоненты
• Конфигурация БД
• Ошибки инициализации

Шаг 7: Трассируй конкретный юс-кейс

Выбери одну функцию и проследи её полный путь:

Пользователь отправляет POST /users
  ↓
UserController.createUser()
  ↓
UserService.create()
  ↓
UserRepository.save()
  ↓
База данных

Это даст полное понимание архитектуры.

Шаг 8: Документируй себе

Пиши заметки о ключевых концепциях:

# User Creation Flow
1. POST /users с UserCreateRequest
2. Валидация через @Valid аннотации
3. Проверка email на уникальность (SELECT)
4. Хеширование пароля bcrypt
5. Сохранение в БД
6. Возврат UserDto без чувствительных данных

Шаг 9: Задавай вопросы разработчикам

• Почему выбран этот подход?
• Какие граничные случаи нужно знать?
• Есть ли известные проблемы?
• Какая часть кода критична?

Практический совет

Время на изучение среднего проекта (Java + Spring):

• Первое погружение: 2-3 часа
• Полное понимание: 1-2 недели регулярной работы
• Экспертиза: 1-2 месяца

Не пытайся понять всё сразу. Вначале выучи основной flow, остальное приходит с временем при работе с конкретными tickets.