Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Design Smell Refactoring in JavacTokens

Fechada
  • Algo errado?
#1,201 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
30/100
Tipo de issue
Refatoração
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
java
Domínio
tooling

Direção de pesquisa

Comece por JavacTokens.java em com.google.googlejavaformat.java e inspecione como JavacTokens, RawTok e CommentWithTextAndPosition gerenciam pos e endPos. Revise as responsabilidades propostas de TokenPosition e os testes existentes antes de alterar o design. O trabalho estará concluído quando o tratamento de posições estiver centralizado e encapsulado, a validação for consistente e todos os testes existentes continuarem passando sem alterações na API pública.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Overview

Several design smells were identified in the JavacTokens class of google-java-format project. The goal focused on improving code organization, maintainability, and encapsulation while preserving all functionality.

Location

  • Package: com.google.googlejavaformat.java
  • Class: JavacTokens
  • File: JavacTokens.java

Design Smells Identified

1. Position Management Issues
Smells:
  • Unnecessary Abstraction
  • Multifaceted Abstraction
Symptoms:
  • Position fields (pos, endPos) scattered across classes
  • Position-related logic mixed with other concerns
  • Duplicate position handling in RawTok and CommentWithTextAndPosition
2. Position Validation Logic Issues
Smells:
  • Multifaceted Abstraction
  • Feature Envy
Symptoms:
  • Position validation separated from position data
  • Validation logic duplicated or inconsistent
  • High coupling between classes for position validation
3. Field Organization Issues
Smells:
  • Leaky Encapsulation
  • Duplicate Abstraction
Symptoms:
  • Position fields not properly encapsulated
  • Same fields appearing in multiple classes
  • Inconsistent position field management

Possible Refactoring Solutions

1. Extract Class
  • Created new TokenPosition class to handle position management
  • Centralized all position-related functionality
  • Improved code organization and maintainability
  • Clear separation of responsibilities
2. Move Method
  • Moved position validation logic to TokenPosition class
  • Placed validation near the data it validates
  • Improved cohesion and reduced coupling
  • Ensured consistent validation across usage
3. Move Field
  • Consolidated position fields into TokenPosition class
  • Eliminated field duplication across classes
  • Enforced consistent position handling
  • Enhanced encapsulation of position data

Implementation Impact

Code Quality Improvements
  1. Organization
  • Clear separation of concerns
  • Logical grouping of related functionality
  • Reduced duplication
  1. Maintainability
  • Centralized position management
  • Single point for position-related changes
  • Better error handling
  1. Reliability
  • Consistent position validation
  • Reduced chance of position-related bugs
  • Better type safety
Verification
  • ✅ All existing tests pass
  • ✅ No public API changes
  • ✅ Original functionality preserved
  • ✅ Backward compatible
  • ✅ Follows project coding standards

Conclusion

The implemented refactorings address the identified design smells while maintaining functionality and compatibility. The code is now more maintainable, better organized, and less prone to position-related errors.

Labels

  • design-smells
  • refactoring
  • code-quality
  • java
  • google-java-format
Linguagem predominante
Java
Estrelas
6.2k
Forks
940
Merge médio
5min
PRs com merge (30d)
8

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de google/google-java-format

Todas as issues de google/google-java-format

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.