Sur-ingénierie cérébrale

J'ai eu une tâche divertissante simple: collecter des données sur les températures de l'eau et de l'air à partir de quelques pages HTML et renvoyer le résultat en JSON à partir de l'API. La tâche est triviale, elle est résolue par un code de lignes de 40 (environ) avec des commentaires. Bien sûr, si vous écrivez en suivant le principe Quick & Dirty. Ensuite, le code écrit sera malodorant et ne correspondra pas aux normes de programmation modernes.

---

Prenons une simple exécution comme base et voyons ce qui se passe si nous la refactorisons ( code avec commits )

public async Task<ActionResult<MeasurementSet>>
        Get([FromQuery]DateTime? from = null, 
            [FromQuery]DateTime? to = null)
{
	// Defaulting values
  from ??= DateTime.Today.AddDays(-1);
  to ??= DateTime.Today;
  // Defining URLs
  var query = $"beginn={from:dd.MM.yyyy}&ende={to:dd.MM.yyyy}";
  var baseUrl = new Uri("https://BaseURL/");
  using (var client = new HttpClient { BaseAddress = baseUrl })
  {
    // Collecting data
    return Ok(new MeasurementSet 
    { 
      Temperature = await GetMeasures(query, client, "wassertemperatur"), 
      Level = await GetMeasures(query, client, "wasserstand"), 
    });
  }
}

private static async Task<IEnumerable<Measurement>>
        GetMeasures(string query, HttpClient client, string apiName)
{
  // Retrieving the data
  var response = await client.GetAsync($"{apiName}/some/other/url/part/?{query}");
  var html = await response.Content.ReadAsStringAsync();
  // Parsing HTML response
  var bodyMatch = Regex.Match(html, "<tbody>(.*)<\\/tbody>");
  var rowsHtml = bodyMatch.Groups.Values.Last();
  return Regex.Matches(rowsHtml.Value, "<tr  class=\"row2?\"><td >([^<]*)<\\/td><td  class=\"whocares\">([^<]*)<\\/td>")
    // Building the results
    .Select(match => new Measurement
    {
      Date = DateTime.Parse(match.Groups[1].Value),
      Value = decimal.Parse(match.Groups[2].Value)
    });
}
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
    

1. Traitement des erreurs

- , .

if (response.IsSuccessStatusCode)
{
  throw new Exception($"{apiName} gathering failed with. [{response.StatusCode}] {html}");
}
// Parsing HTML response
var bodyMatch = Regex.Match(html, "<tbody>(.*)<\\/tbody>");
if (!bodyMatch.Success)
{
  throw new Exception($"Failed to define data table body. Content: {html}");
}
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
    

2.

, , , . , MeasureParser RawMeasuresCollector . , , .

3.

enum, , :

var apiName = measure switch
{
  MeasureType.Temperature => "wassertemperatur",
  MeasureType.Level => "wasserstand",
  _ => throw new NotImplementedException($"Measure type {measure} not implemented")
};
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
    

, . :

public class UrlQueryBuilder
{
  public DateTime From { get; set; } = DateTime.Today.AddDays(-1);
  public DateTime To { get; set; } = DateTime.Today;

  public string Build(MeasureType measure)
  {
    var query = $"beginn={From:dd.MM.yyyy}&ende={To:dd.MM.yyyy}";
    var apiName = measure switch
    {
      MeasureType.Temperature => "wassertemperatur",
      MeasureType.Level => "wasserstand",
      _ => throw new NotImplementedException($"Measure type {measure} not implemented")
    };
    return $"{apiName}/some/other/url/part/?{query}";
  }
}
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
    

4. (coupling)

. , , . URL :

var settings = Configuration.GetSection("AppSettings").Get<AppSettings>();
services.AddHttpClient(Constants.ClientName, client =>
{
  client.BaseAddress = new Uri(settings.BaseUrl);
});
services.AddTransient<IRawMeasuresCollector, RawMeasuresCollector>();
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
    

5.

. , :

    [TestMethod]
public async Task TestHtmlTemperatureParsing()
{
  var collector = new Mock<IRawMeasuresCollector>();
  collector
    .Setup(c => c.CollectRawMeasurement(MeasureType.Temperature))
    .Returns(Task.FromResult(_temperatureDataA));

  var actual = (await new MeasureParser(collector.Object)
    .GetMeasures(MeasureType.Temperature)
    ).ToArray();

  Assert.AreEqual(165, actual.Length);
  Assert.AreEqual(7.1M, actual
      .First(l => l.Date == DateTime.Parse("24.11.2020 10:15")).Value);
}
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
    

6.

, , . DOM , . .

:

public async Task<ActionResult<MeasurementSet>> Get
    ([FromQuery] DateTime? from = null, [FromQuery] DateTime? to = null)
{
  var parser = new MeasureParser(_collectorFactory.CreateCollector(from, to));
  return Ok(new MeasurementSet
  {
    Temperature = await parser.GetTemperature(),
    Level = await parser.GetLevel(),
  });
}
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
    

Les correctifs précédents ont conduit à l'inutilité de l'énumération avec le type de dimension et ont dû se débarrasser du code spécifié au point 3, ce qui est plutôt positif, car il réduit le degré de branchement du code et permet d'éviter les erreurs.

Résultat

En conséquence, la méthode d'une page est devenue un projet décent

Bien sûr, le projet est flexible, soutenu, etc., etc. Mais on a l'impression qu'il est trop gros. Selon VS analytics, sur 277 lignes de code, seules 67 sont exécutables.

Peut-être que l'exemple n'est pas correct, car la fonctionnalité n'est pas si large ou la refactorisation est effectuée de manière incorrecte, pas complètement.

Partagez votre expérience.