Archiwum kategorii: Legacy code

Jak sobie radzić z gigantycznymi metodami

Jak sobie radzić z gigantycznymi metodami

Ile to razy otwieraliśmy jakiś kawałek kodu i nagle szok. Metoda ma 300 linijek i z 6 zmiennych. Jak sobie radzić z gigantycznymi metodami? Przedstawię kilka wypracowanych przepisów na radzenie sobie z legacy code. Nie będą one związane z jakimiś konkretnymi wzorcami itp…

Cały kod jest dostępny na GitHub.

Gigantyczne metody

Tak powiem w tajemnicy, że największa metoda z jaką miałem do tej pory do czynienia miała łącznie 9009 linijek i przyjmowała 25 parametrów. Podręcznikowy przykład clean code.

Według mnie metoda zaczyna się robić za duża gdy nie mieści się w 10 linijkach, oraz ilość parametrów jest większa niż 3.

Co z tym zrobić

Ogarnięcie wielu parametrów

Z parametrami możemy sobie dość łatwo poradzić tworząc prostą klasę POCO i przekazać jako parametr.

Poniżej przykład takiej metody. Do demonstracji specjalnie wybrałem VB.NET ze względu na znikome wsparcie dla refactor ze strony VS.

Function DoSuperComplicated(ByVal param1 As String, ByVal param2 As String, ByVal param4 As Boolean, ByVal param5 As Boolean, ByVal param6 As Integer, ByVal param7 As String, Optional ByVal param8 As String) As Boolean
        If param4 Then
            'Do something
            Select Case param2
                Case "Somevalue"
                    While continueValue
                        'Do Something
                        If param5 Then
                            'Do something
                        ElseIf param6 = 1 Then
                            'Do something
                        End If
                    End While
            End Select
        End If

        Return True
    End Function

A więc bierzemy się za poprawę takiego kodu. Tworzymy klasę POCO i zmieniamy sygnaturę naszej metody.

Public Class Parameters
    Public Property Param1() As String

    Public Property Param2() As String

    Public Property Param4() As Boolean

    Public Property Param5 As Boolean

    Public Property Param6 As Integer

    Public Property Param7 As String

    Public Property Param8 As String
End Class
...
    Function DoSuperComplicated(ByVal parameters As Parameters) As Boolean
        If parameters.Param4 Then
            'Do something
            Select Case parameters.Param2
                Case "Somevalue"
                    While continueValue
                        'Do Something
                        If parameters.Param5 Then
                            'Do something
                        ElseIf parameters.param6 = 1 Then
                            'Do something
                        End If
                    End While
            End Select
        End If

        Return True
    End Function
...

Co w sytuacji gdy dostajemy wymaganie od klienta ze zmianą logiki albo stworzenie nowej funkcjonalności? Nie wiemy co robi obecna metoda i biznes również nie jest nas w stanie na to naprowadzić.

Pierwsza myśl, która przychodzi do głowy to zaorać… Później w gąszczu przekleństw i złorzeczeń wobec innych programistów przychodzi inny pomysł do głowy.

Tworzymy coś nowego

W sytuacji jak powyższa staram się stworzyć bibliotekę w C# obok obecnego rozwiązania. Zyskujemy tym możliwość „panowania” nad kodem, oraz możliwości jego testowania.

Poniżej przykład jak można to osiągnąć.

    Private continueValue As Boolean = True

    Function DoSuperComplicated(ByVal parameters As Parameters) As Boolean
        Dim externalLogic As SomethingNew = New SomethingNew()

        If parameters.Param4 Then
            'Do something
            Select Case parameters.Param2
                Case "Somevalue"
                    While continueValue
                        'Do Something
                        externalLogic.DoSomethingNew(True)

                        If parameters.Param5 Then
                            'Do something
                        ElseIf parameters.Param6 = 1 Then
                            'Do something
                        End If
                    End While
            End Select
        End If

        Return True
    End Function

Definicja przykładowej logiki w C#

    public class SomethingNew
    {
        /// <summary>
        /// Do something new
        /// </summary>
        /// <param name="proceed">Mark process to execute some custome logic</param>
        public void DoSomethingNew(bool proceed)
        {
            //Do Something
        }
    }

Ulga

Jak widzicie można sobie poradzić z legacy code w całkiem prosty sposób. Nie ma sensu brnąć tygodniami w starym zabagnionym kodzie lepiej, szybciej i taniej będzie zrobić coś z boku.

A więc nie bądźcie przerażeni jak widzicie takie potworki w swojej pracy tylko do dzieła bo to jest proste.

Legacy code. Jak rozwijać i co można z nim zrobić?

Legacy code. Jak rozwijać i co można z nim zrobić?

Jak rozwijać legacy code, czyli jak dodawać nowe funkcjonalności w najmniej bolesny sposób. Opisuję tutaj swoje własne doświadczenia i przemyślenia na ten temat. A więc…

Czy jest legacy code

Według nomenklatury sprzedawców samochodów kod jest przestarzały po wyjechaniu za bramę salonu, a według Wikipedia przestarzały kod to

More recently, the software engineering communty has developed other interpretations for the term legacy code. Among the most prevalent are source code inherited from someone else and source code inherited from an older version of the software.

Jak rozwijać przestarzały kod?

Praca z zastanym kodem bywa często bardzo bolesna. Niestety w naszym dev-życiu najczęściej trafiamy w bagno aplikacji, którą dostaliśmy w utrzymanie od jakiegoś korporacyjnego klienta lub utrzymujemy nasz produkt napisany w czasach kiedy po świecie chodziły dinozaury. Co zrobić kiedy pojawia się wymaganie dodania nowej wypasionej funkcjonalności?

Można do tego podejść na kilka sposobów:

  • brnąć dalej w depresyjny kod napisany przez całe stado programistów
  • napisać bibliotekę/komponent/plugin (nie to może nie jest odpowiednie słowo :))

Brnięcie dalej

Kto z nas nie próbował pisać kolejnej funkcji w VB6? Ten nie wie jaki jest to czasami ból, a ten ból jest tym większy im więcej linijek kodu jest w funkcji w której musimy wywołać nasz nowy super kawałek kodu. Ot cała ta integracja oł jeee…

Napisać coś nowego

Można podejść do tego z drugiej strony i stworzyć jakiś komponent\moduł, który będzie posiadał zestaw funkcjonalności wymaganych przez aplikację.

Jest to według mnie lepsze podejście można użyć np. architektury micro-services i stworzyć komponent\moduł hostowany na IIS.

Podsumowanie

Technik radzenia sobie z legacy code jest tyle co programistów. Każdy ma jakieś swoje pomysły i sposoby. Dla mnie najciekawszym sposobem jest tworzenie komponentów w myśl architektury micro-services.

A wy jakie macie sposoby na radzenie sobie ze starymi systemami?