Кава-брейк #152. Стандарти кодування Java. HashMap в Java - особливості використання та методи взаємодії

Стандарти кодування в Java

Джерело: Medium У цій статті ви дізнаєтеся, як правильно дотримуватися стандартів кодування Java. Java є однією з найбільш широко використовуваних мов та платформ програмування. Тому ймовірно, що ваш код читатиметься кількома людьми. З цього випливає, що код має бути легкочитаним і зрозумілим усіма — від новачків до senior-розробників. Наша мета — писати код таким чином, щоб читач коду його повністю розумів. Це вимагає знання та дотримання стандартів кодування.

Навіщо потрібні посібники з написання коду?

Рекомендації щодо кодування важливі, тому що значна частина вартості програмного забезпечення витрачається на обслуговування коду. Крім того, програмне забезпечення не завжди розробляється одним розробником. Отже, дотримання угоди про написання програмного забезпечення підвищує зручність читання програми. 1. Угоди про імена : ми зазвичай дотримуємося угоди про CamelCase (верблюжий регістр) у програмуванні на Java.

• Імена методів повинні починатися з маленької літери.
• Імена методів зазвичай є дієсловами.
• Якщо метод містить кілька слів, кожне внутрішнє слово має починатися з великої літери. приклад: toString() .
• Ім'я методу має бути комбінацією дієслова та іменника Приклад: getCarName() , getCarNumber() .
• Фігурні дужки: Вони використовуються для визначення тіл класів, методів та циклів. Існує два стандартні формати використання фігурних дужок.
• Порожні рядки не повинні знаходитися ні після дужки, що відкриває, ні перед закриває дужкою.
  

  class MountBlue{
     ... MountBlue(){
      // Конструктор
         ...
     }
  
     int Mountainain(int a, float b){
  
         ... for (int i = 0; i < Field; i++){
             ....
         }
     }
  }

• Фігурна дужка ставиться в кінці рядка, з якого починається клас, метод, цикл тощо. Закриваюча дужка знаходиться на окремому рядку.
  Кожна фігурна дужка додається на новий рядок і пара вирівнюється по вертикалі.

2. Відступ : одиницею відступу має бути 4 пробіли та 8 табуляцій.

• Використовуйте відступ до однакових елементів у вертикальному списку (наприклад, коментарі в кінці рядка та ідентифікатори в оголошеннях).
• Оточіть бінарні оператори (включаючи привласнення) пробілами.
• Після крапки з комою або комою слід пробіл.
• Додайте пробіл між ключовим словом (“if”, “while”, “return”, “catch”, “switch”, “for”) та наступною дужкою.
• Вставте порожні рядки, щоб розрізнити важливу частину коду.

3. Прогалини . Прогалини також відіграють важливу роль у зручності читання:

• Оператори мають бути оточені пропуском.
  

  Операторы следует писать так:
  a = (b + c) * d;
  А не так:
  a=(b+c)*d

• За зарезервованими словами Java повинен бути пробіл. Наприклад:
  

  Цикл нужно объявлять так:
  while (true) {...}
  А не так:
  while(true){...}

• За комами повинен слідувати пробіл. Наприклад:
  

  Функцию нужно объявлять так:
  fun(a, b, c, d);
  А не так:
  fun(a, b, c, d);

• Двокрапки повинні бути оточені пропуском. Наприклад:
  

  case нужно объявлять так:
  case 100 : break;
  А не так:
  case 100:break;

• За точками з комою в операторах for повинен йти символ пробілу. Наприклад:
  

  Цикл for нужно объявлять так:
  for (i = 0; i < n; i++)
  А не так:
  for(i=0;i<n;i++)

5. Коментарі : Java-програми можуть мати два типи коментарів.

• Коментарі до реалізації обмежені символом // . Для коментарів реалізації Java також дозволяє використовувати /*…*/ .
• Блокові коментарі використовуються для опису файлів, методів, структур даних та алгоритмів.
• Однорядкові коментарі можуть розташовуватися на одному рядку з відступом рівня наступного коду. Якщо коментар не може бути написаний в один рядок, він має відповідати формату блокового коментаря.
• Кінцеві (дуже короткі) коментарі можуть з'являтися у тому рядку коду, який вони описують, але мають бути відокремлені від коду на значній відстані.
• Коментарі до документації описують класи, інтерфейси, конструктори, методи та поля Java. Вони поділені /**…*/ . Зверніть увагу на подвійну зірочку ** на початку з одним коментарем для класу, інтерфейсу або члена. Цей коментар повинен стояти безпосередньо перед оголошенням без пробілу між коментарем та кодом, на який він посилається. Коментарі до документації можна отримати у файлух HTML за допомогою інструмента javadoc.

/** Это комментарий к Java документации */
private int comments_;

HashMap в Java - особливості використання та методи взаємодії

Джерело: FreeCodeCamp Сьогодні ви дізнаєтеся про особливості роботи з HashMap, про методи взаємодії з даними, що зберігаються в них, і ряд інших корисних рекомендацій.

Які особливості HashMap у Java?

Перш ніж працювати з HashMap, важливо зрозуміти деякі особливості:

• Елементи зберігаються в парах ключ/значення (key/value).
• Елементи не зберігають порядок під час додавання. Дані залишаються не впорядкованими.
• У разі наявності ключів, що повторюються, останній з них має пріоритет над іншим(і).
• Типи даних зазначаються з використанням класів-оболонок замість примітивних типів даних.

Як створити HashMap в Java

Щоб створити та використовувати HashMap, ви повинні спочатку імпортувати пакет java.util.HashMap :

import java.util.HashMap;

Синтаксис під час створення нового HashMap:

HashMap<KeyDataType, ValueDataType> HashMapName = new HashMap<>();

А тепер давайте розберемо деякі з термінів у наведеному вище синтаксисі.

• KeyDataType позначає тип даних усіх ключів, які зберігатимуться у файлі HashMap.
• ValueDataType означає тип даних усіх значень, які зберігаються у файлі HashMap.
• HashMapName позначає назву HashMap.

Ось приклад для більш простого розуміння термінів:

HashMap<Integer, String> StudentInfo = new HashMap<>();

У цьому коді ми створабо HashMap під назвою StudentInfo . Усі ключі, що зберігаються в HashMap , будуть цілими числами (Integer), а значення будуть рядками (String). Зверніть увагу, що при вказівці типів даних для ключів і значень у HashMap ми працюємо з класами-оболонками (wrapper classes), а не з примітивними типами. Перш ніж ми заглибимося в приклади, ось список класів-оболонок та відповідних їм примітивних типів даних у Java:

Класи-оболонки та примітивні типи в Java

При роботі з HashMap ми використовуємо лише класи-оболонки.

Методи HashMap у Java

А зараз ми поговоримо про деякі корисні методи, які ви можете використовувати під час роботи з HashMap. Наприклад, ви дізнаєтесь, як додавати, отримувати доступ, видаляти та оновлювати елементи у файлі HashMap.

Як додати елементи HashMap до Java

Щоб додати елементи до HashMap, ми використовуємо метод put() . Він приймає два параметри - ключ і значення елемента, що додається. Ось приклад:

import java.util.HashMap;
class HashMapExample {
    public static void main(String[] args) {

        HashMap<Integer, String> StudentInfo = new HashMap<>();

        StudentInfo.put(1, "Ihechikara");
        StudentInfo.put(2, "Jane");
        StudentInfo.put(3, "John");

        System.out.println(StudentInfo);
        // {1=Ihechikara, 2=Jane, 3=John}
    }
}

У цьому уривку коду HashMap названий StudentInfo . Ми вказали ключі як цілі числа, а значення вказані рядками: HashMap<Integer, String> . Щоб додати елементи до HashMap, ми використовували метод put() :

StudentInfo.put(1, "Ihechikara");
StudentInfo.put(2, "Jane");
StudentInfo.put(3, "John");

Ми додали три елементи, кожен з яких має ціле число як ключ і рядок як значення.

Як отримати доступ до елементів у HashMap

Ви можете використовувати метод get() для доступу до елементів, які зберігаються у файлі HashMap. Він приймає один параметр - ключ елемента, до якого здійснюється доступ. Ось приклад:

import java.util.HashMap;
class HashMapExample {
    public static void main(String[] args) {
        HashMap<Integer, String> StudentInfo = new HashMap<>();

        StudentInfo.put(1, "Ihechikara");
        StudentInfo.put(2, "Jane");
        StudentInfo.put(3, "John");

        System.out.println(StudentInfo.get(2));
        // Jane
    }
}

У наведеному прикладі StudentInfo.get(2) повертає значення з ключем 2 . При виведенні консолі друкується "Jane".

Як змінити значення елементів у HashMap Java

Для зміни значення елементів у HashMap ми використовуємо метод replace() . Він приймає два параметри - ключ елемента, що змінюється, і нове значення, яке йому присвоюється.

import java.util.HashMap;
class HashMapExample {
    public static void main(String[] args) {
        HashMap<Integer, String> StudentInfo = new HashMap<>();

        StudentInfo.put(1, "Ihechikara");
        StudentInfo.put(2, "Jane");
        StudentInfo.put(3, "John");

        // UИзменить ключ 1
        StudentInfo.replace(1, "Doe");

        System.out.println(StudentInfo);
        // {1=Doe, 2=Jane, 3=John}
    }
}

Коли вказаному вище HashMap призначалися елементи, елемент ключа 1 мав значення “Ihechikara”. Ми змінабо його значення на Doe за допомогою методу replace(): StudentInfo.replace(1, "Doe"); .

Як видалити елементи в HashMap Java

Для видалення елемента з файлу HashMap можна використовувати remove() . Він приймає один параметр - ключ елемента, що видаляється.

import java.util.HashMap;
class HashMapExample {
    public static void main(String[] args) {
        HashMap<Integer, String> StudentInfo = new HashMap<>();

        StudentInfo.put(1, "Ihechikara");
        StudentInfo.put(2, "Jane");
        StudentInfo.put(3, "John");

        // Удалить ключ 1
        StudentInfo.remove(1);

        System.out.println(StudentInfo);
        // {2=Jane, 3=John}
    }
}

Тут, використовуючи метод remove() , видалабо елемент із ключем 1 . Якщо ви хочете видалити всі елементи HashMap відразу, тоді використовуйте метод clear() :

import java.util.HashMap;
class HashMapExample {
    public static void main(String[] args) {
        HashMap<Integer, String> StudentInfo = new HashMap<>();

        StudentInfo.put(1, "Ihechikara");
        StudentInfo.put(2, "Jane");
        StudentInfo.put(3, "John");

        // Удалить все элементы
        StudentInfo.clear();

        System.out.println(StudentInfo);
        // {}
    }
}

Ось ще кілька корисних методів, які ви можете використовувати під час роботи з HashMap:

• containsKey повертає true , якщо зазначений ключ існує у файлі HashMap .
• containsValue повертає true , якщо вказане значення існує в HashMap .
• size() повертає кількість елементів у HashMap .
• isEmpty() повертає true , якщо у HashMap немає елементів.

Висновок

У цій статті ми говорабо про HashMap Java. Спочатку ми розібрали особливості файлу HashMap і дізналися, як взаємодіяти з елементами та даними, що зберігаються. Також ми ознайомабося з прикладами коду та деякими методами для роботи з HashMap . Вдалого кодингу!