Czysty kod - metody

By -

Dzisiaj przedstawię jak sprawić, aby metody klas były czytelniejsze. Oczywiście czekam na komentarze, aby uzyskać jeszcze lepszą technikę pisania kodu. Mam nadzieję, że współpraca będzie owocna, a więc zaczynamy.

Co uważam za ważne dla czytelności funkcji?

  • Rozdzielenie poziomów abstrakcji

    • Przybliżę, co mam na myśli.

    Co uważam za poziomy abstrakcji?

    Jeden poziom abstrakcji to są opisy czynności jakie musimy wykonać uwzględniając identyczną szczegółowość. Najłatwiej będzie to pokazać na przykładzie.

    Z powodu, że jest już po świętach przydałoby się rozebrać choinkę :).

    1. Najbardziej ogólnym poziomem abstrakcji to będzie czynność "rozbieranie choinki".
    2. Kolejnym poziomem to będzie ściągnąć bombki, ściągnąć lampki oraz ściągnąć łańcuch.
    3. Następny to weź złap lampki od góry i okrężnym ruchem powoli je ściągaj, tak samo z łańcuchami.

    Mam nadzieję, że wyjaśniłem czym są poziomy abstrakcji.

    Dlaczego rozdzielenie tych poziomów się przydaje?

    Czytelnik takiego kodu łatwo interpretuje co robi dana funkcja, gdy nie jest pomieszany poziom abstrakcji. Na pewno każdemu z Was zdarzyło się czytać kod, gdzie wywoływane były metody z poziomu wysokiego, takie jak "wygeneruj coś" a potem pomieszane zapisywanie do bazy poszczególnych rzeczy na 20 linijek i następnie znowu jakieś "oblicz". Jak dla mnie taki kod jest nieczytelny, a na pewno niekorzystne jest skakanie po różnych szczegółach abstrakcji.

  • Pojedyncza odpowiedzialność

    • Tutaj sprawa jest prosta oraz stosowana w pisaniu wszystkiego (projektów, klas, interfejsów, metod). Chodzi o to, żeby funkcje robiły tylko jedną czynność. Pomaga to właśnie w rozdzieleniu poziomów abstrakcji, pisaniu czytelnych nazw funkcji oraz używaniu małej ilości parametrów.

    Przedstawię kilka rad oraz wskazówek jak tego dokonać:

    1. Myśl o poziomach abstrakcji.
    2. Parametr, który jest flagą prawie zawsze oznacza dwie odpowiedzialność.
    3. Nazwa metody powinna zawierać tylko jeden czasownik, który całkowicie opisuje co ona robi.

    Stosując wspomniane porady jesteśmy w stanie stworzyć metodę o pojedynczej odpowiedzialności.

  • Krótkie nazwy

    • Długie nazwy czasami nie są złe, ale powinniśmy robić je jak najbardziej krótkie. Czyta je się szybciej i są bardziej zrozumiałe. Gdy nazwa jest długa istnieje ryzyko, że metoda nie zachowuje pojedynczej odpowiedzialności. Najczęściej posiadają one też zbędne słowa, które są w nazwie klasy lub ogólnie nie mają znaczenia.

  • Mała ilość parametrów

    • Tutaj też istnieje ryzyko, że nie stosujemy pojedynczej odpowiedzialności. Czasami okazuje się, że parametry można ubrać w jedną strukturę lub obiekt, ponieważ razem tworzą jakąś rzeczywistość. Duża ilość parametrów funkcji zasłania nam jej funkcjonalność. To bardzo pogarsza jej czytelność.

  • Stosujmy ustalone standardy

    • Nic nie ułatwia czytanie funkcji jak zobaczenie znanej już składni. A nic bardziej nie pogarsza czytelności i ponadto przekłada się na błędy jak zmiana kolejności parametrów. Chodzi mi tutaj o to, że jeżeli raz użyliśmy jakiejś kolejności w parametrach stosujmy ją we wszystkich funkcjach. Jak nagle zmienimy kolejność to każdy czytelnik naszego kodu będzie musiał uważać, aby nie pomylić się w trakcie używania oraz czytania takiego kodu.

Podsumowując

Mam nadzieję, że wymieniłem tutaj główne czynniki, które powinny być stosowane w czystym kodzie. Zapraszam do dyskusji w komentarzach. I jeżeli wcześniej tego nie zrobiliście to do przeczytania poprzedniego wpisu o komentarzach.

Comments

Post a Comment

Popular posts from this blog

Why TDD is bad practice?

By -
Image
Did you listen that TDD is bad? What do you think about it? I have my opinion about it! TDD is bad because... We don't have time to write tests first - I think this is a good point. I sometimes don't have time for that. Why? Because I need to do quickly fix on our code and deploy it. In this case I don't have time to create test after wrote production code too. The even worse case is when we have tested this part of our code and test after change doesn't work. I don't like this, because I must read tests and thinking about repair tests for new logic. I really don't like this. I would like to create new test and remove old every time when I have that situation. What's wrong with the test first on this case? Nothing, because if you have time to write tests after create code, you have time to create test before it. Don't you think so? We know how will implement it, but we don't know how testing it - I think a lot of developers have this problem,
Read more >>

How correctly imitate dependencies?

By -
Image
This is continuous of my previous post about why we should imitate our dependencies. I did it not long ago. I though about how do it properly and when I can say that it is correct. Start from test and real dependencies I am starting from the tests. I wrote the simple tests which, I though, are correct. That was my learned about dependencies. I had the good situation that I had some prepared tests before. During the writing test I got a knowledge. A lot of time, I verified what the system return. After it, I got the full automated tests for my dependency. Now, I am sure that dependency works like I think. Like my test use it. I think this is a very good advantage. Extract the interface for communicating The implementation to communicate is implemented and tested. Our test, if you implement it like functionality test, not code test, should show us, how we want to use our dependency. We know what parameters we use, what methods. We know what we want. That is a place where we must extr
Read more >>

Software development using Angular 5 with Spring Boot

By -
Image
Hi everyone. My last the bigger post is about configuration Spring Boot and Angular 5 . After that instruction we have integrated both technology on one app. If you created it you know that development is very hard in this case. We must waiting for build a client and it isn't effective. We can use webpack-dev-server to speed up this process, so this post is just about it. Angular and webpack-dev-server I think I have to explain webpack and webpack-dev-server. The first tools let pack our angular app to one or more files. This files is bundles. It is for improve speed of our app. Why? Because one page application need all files on start by assumption. The better way is load it using only one connection and one file, because establishing connection taking time. This is a few information about webpack, but what is webpack-dev-server? This is the tool. It serve our that files which webpack compiled, but it working on memory, so we have quick result on our browser. This is a amazing
Read more >>