La importancia del código limpio

Un análisis de CleanTechAPI en Java y .NET El desarrollo de software no solo se trata de hacer que las cosas funcionen, sino de hacerlo bien. El código limpio (Clean Code) es una filosofía que prioriza la legibilidad, mantenibilidad y escalabilidad del código, y en mis proyectos recientes, CleanTechAPI, he aplicado estos principios tanto en Java con Spring Boot como en C# con .NET 8. Ambos son APIs REST para gestionar un catálogo de gadgets futuristas, pero están diseñados con enfoques distintos: uno para desarrolladores experimentados y otro para principiantes. En este artículo, exploraremos por qué el código limpio importa, cómo se refleja en el código y las similitudes y diferencias entre estas dos tecnologías. ¿Por qué el código limpio es importante? El código limpio no es un lujo, es una necesidad. Un software bien escrito reduce errores, facilita la colaboración y ahorra tiempo a largo plazo. En CleanTechAPI, me basé en principios como YAGNI (You Aren’t Gonna Need It), KISS (Keep It Simple, Stupid), DRY (Don’t Repeat Yourself) y SOLID para asegurar que el código sea: Legible: Cualquiera puede entenderlo con un vistazo. Mantenible: Fácil de modificar sin romper todo. Escalable: Preparado para crecer sin volverse un caos. Estos principios no solo hacen mi vida más fácil como desarrollador, sino que también son un estándar que los arquitectos y líderes técnicos valoran en proyectos reales. CleanTechAPI: Dos enfoques, un mismo objetivo JavaCleanTechAPI (Spring Boot) Finalidad: Mostrar un ejemplo profesional de una API REST con Spring Boot, dirigido a desarrolladores avanzados y arquitectos. Características: Usa Clean Architecture, Maven, base de datos H2 en memoria y Swagger para documentación. Incluye un endpoint atractivo (/products/trending) con gadgets futuristas como "Drone Quantum X". AspCleanTechAPI (.NET 8) Finalidad: Enseñar a principiantes en C# cómo construir una API REST simple pero bien estructurada. Características: Implementa Entity Framework Core con InMemory, Visual Studio como IDE y Newtonsoft.Json para facilitar la serialización. Mantiene el mismo endpoint atractivo adaptado a un nivel básico. Ambos proyectos comparten un núcleo común: aplicar código limpio para resolver un caso de uso interesante y práctico. ¿Dónde se ve el código limpio en estos proyectos? El código limpio no es solo teoría; se refleja en decisiones concretas dentro del código. Aquí algunos ejemplos: 1. Separación de responsabilidades (Principio SOLID - SRP) Java: @RestController @RequestMapping("/products") public class ProductController { private final ProductService service; @Autowired public ProductController(ProductService service) { this.service = service; } @GetMapping public List getAll() { return service.getAllProducts(); } } El controlador solo maneja solicitudes HTTP, delegando la lógica al servicio. C#: [ApiController] [Route("products")] public class ProductController : ControllerBase { private readonly ProductService _service; public ProductController(ProductService service) => _service = service; [HttpGet] public ActionResult GetAll() => Ok(_service.GetAllProducts()); } Similar al Java, el controlador es ligero y la lógica vive en ProductService. 2. Nombres descriptivos y auto-documentados (KISS) Ambos usan nombres como Product, ProductService y getAllProducts, que explican su propósito sin comentarios redundantes. 3. Evitar duplicación (DRY) Java: La lógica de acceso a datos está centralizada en ProductRepository con Spring Data JPA. C#: ProductService reutiliza el contexto de EF Core para todas las operaciones. 4. Simplicidad (YAGNI) Ningún proyecto incluye autenticación o funcionalidades complejas innecesarias, manteniendo el foco en el catálogo de productos. Similitudes entre Java y .NET en CleanTechAPI A pesar de usar lenguajes y frameworks distintos, ambos proyectos comparten: Estructura: Siguen Clean Architecture con capas claras (modelos/dominio, servicios/aplicación, controladores/infraestructura). Inyección de dependencias: Facilitan el desacoplamiento entre componentes. Persistencia: Usan bases de datos en memoria para simplicidad (H2 y EF Core InMemory). Documentación: Integran Swagger para explorar endpoints como /products y /products/trending. Propósito atractivo: Ambos destacan con un caso de uso futurista que capta la atención. Diferencias clave entre Java y .NET Aunque el objetivo es el mismo, las implementaciones reflejan las filosofías de cada tecnología: Inyección de dependencias Spring Boot (Java): Usa @Autowired para inyectar dependencias automáticamente mediante el contenedor IoC de Spring. Ejemplo: @Autowired private ProductService service; Es más

Apr 9, 2025 - 22:04

Un análisis de CleanTechAPI en Java y .NET

El desarrollo de software no solo se trata de hacer que las cosas funcionen, sino de hacerlo bien. El código limpio (Clean Code) es una filosofía que prioriza la legibilidad, mantenibilidad y escalabilidad del código, y en mis proyectos recientes, CleanTechAPI, he aplicado estos principios tanto en Java con Spring Boot como en C# con .NET 8. Ambos son APIs REST para gestionar un catálogo de gadgets futuristas, pero están diseñados con enfoques distintos: uno para desarrolladores experimentados y otro para principiantes. En este artículo, exploraremos por qué el código limpio importa, cómo se refleja en el código y las similitudes y diferencias entre estas dos tecnologías.

¿Por qué el código limpio es importante?

El código limpio no es un lujo, es una necesidad. Un software bien escrito reduce errores, facilita la colaboración y ahorra tiempo a largo plazo. En CleanTechAPI, me basé en principios como YAGNI (You Aren’t Gonna Need It), KISS (Keep It Simple, Stupid), DRY (Don’t Repeat Yourself) y SOLID para asegurar que el código sea:

Legible: Cualquiera puede entenderlo con un vistazo.
Mantenible: Fácil de modificar sin romper todo.
Escalable: Preparado para crecer sin volverse un caos.

Estos principios no solo hacen mi vida más fácil como desarrollador, sino que también son un estándar que los arquitectos y líderes técnicos valoran en proyectos reales.

CleanTechAPI: Dos enfoques, un mismo objetivo

JavaCleanTechAPI (Spring Boot)

Finalidad: Mostrar un ejemplo profesional de una API REST con Spring Boot, dirigido a desarrolladores avanzados y arquitectos.
Características: Usa Clean Architecture, Maven, base de datos H2 en memoria y Swagger para documentación. Incluye un endpoint atractivo (/products/trending) con gadgets futuristas como "Drone Quantum X".

AspCleanTechAPI (.NET 8)

Finalidad: Enseñar a principiantes en C# cómo construir una API REST simple pero bien estructurada.
Características: Implementa Entity Framework Core con InMemory, Visual Studio como IDE y Newtonsoft.Json para facilitar la serialización. Mantiene el mismo endpoint atractivo adaptado a un nivel básico.

Ambos proyectos comparten un núcleo común: aplicar código limpio para resolver un caso de uso interesante y práctico.

¿Dónde se ve el código limpio en estos proyectos?

El código limpio no es solo teoría; se refleja en decisiones concretas dentro del código. Aquí algunos ejemplos:

1. Separación de responsabilidades (Principio SOLID - SRP)

Java:

  @RestController
  @RequestMapping("/products")
  public class ProductController {
      private final ProductService service;

      @Autowired
      public ProductController(ProductService service) {
          this.service = service;
      }

      @GetMapping
      public List<Product> getAll() {
          return service.getAllProducts();
      }
  }

El controlador solo maneja solicitudes HTTP, delegando la lógica al servicio.
- C#:

  [ApiController]
  [Route("products")]
  public class ProductController : ControllerBase
  {
      private readonly ProductService _service;
      public ProductController(ProductService service) => _service = service;

      [HttpGet]
      public ActionResult<List<Product>> GetAll() => Ok(_service.GetAllProducts());
  }

Similar al Java, el controlador es ligero y la lógica vive en ProductService.

2. Nombres descriptivos y auto-documentados (KISS)

Ambos usan nombres como Product, ProductService y getAllProducts, que explican su propósito sin comentarios redundantes.

3. Evitar duplicación (DRY)

Java: La lógica de acceso a datos está centralizada en ProductRepository con Spring Data JPA.
C#: ProductService reutiliza el contexto de EF Core para todas las operaciones.

4. Simplicidad (YAGNI)

Ningún proyecto incluye autenticación o funcionalidades complejas innecesarias, manteniendo el foco en el catálogo de productos.

Similitudes entre Java y .NET en CleanTechAPI

A pesar de usar lenguajes y frameworks distintos, ambos proyectos comparten:

Estructura: Siguen Clean Architecture con capas claras (modelos/dominio, servicios/aplicación, controladores/infraestructura).
Inyección de dependencias: Facilitan el desacoplamiento entre componentes.
Persistencia: Usan bases de datos en memoria para simplicidad (H2 y EF Core InMemory).
Documentación: Integran Swagger para explorar endpoints como /products y /products/trending.
Propósito atractivo: Ambos destacan con un caso de uso futurista que capta la atención.

Diferencias clave entre Java y .NET

Aunque el objetivo es el mismo, las implementaciones reflejan las filosofías de cada tecnología:

Inyección de dependencias

Spring Boot (Java):
- Usa @Autowired para inyectar dependencias automáticamente mediante el contenedor IoC de Spring.
- Ejemplo:
```
@Autowired
private ProductService service;
```
- Es más "mágico" y flexible, pero requiere entender las anotaciones.
ASP.NET Core (C#):
- Registra servicios explícitamente con IServiceCollection en Program.cs.
- Ejemplo:
```
builder.Services.AddScoped<ProductService>();
```
Y en el controlador:
```
public ProductController(ProductService service) => _service = service;
```
- Más transparente y directo, ideal para principiantes.

Otras diferencias

Audiencia: Java apunta a profesionales; .NET a novatos.
Herramientas: Maven vs. .NET CLI; IntelliJ IDEA vs. Visual Studio.
Serialización: Jackson (Java) es automático; .NET requiere ajustes (como usar Newtonsoft.Json).
Complejidad: Java es más verboso y configurable; .NET es más integrado y simple.

Conclusión

El código limpio es el corazón de CleanTechAPI, ya sea en Java o .NET. Ambos proyectos demuestran que principios como SOLID y DRY no dependen del lenguaje, sino de cómo estructuramos nuestras soluciones. Java ofrece potencia y flexibilidad para proyectos complejos, mientras que .NET prioriza la simplicidad para quienes están empezando. Al final, lo importante es escribir código que no solo funcione, sino que inspire y sea fácil de mantener.

¿Quieres ver cómo lo hice? Revisa los proyectos en GitHub:

JavaCleanTechAPI: https://github.com/xsoto-developer/spring-clean-tech-api
AspCleanTechAPI: https://github.com/xsoto-developer/asp-clean-tech-api

¡Explora, aprende y comparte tus pensamientos!