Занятие на спецкурсе в ОмГУ, 2014 год.

1. Спецкурс ОмГУ-2014
Абстракции, контракты,
соглашения
Занятие 3

2. Спецкурс ОмГУ-2014
There are only two hard things in
Computer science: cache
invalidation and naming things.
Phil Karlton
Зачем?

3. Спецкурс ОмГУ-2014
Абстракция данных – скрываем
детали структуры
Абстракция алгоритмов –
скрываем вспомогательные
функции
Принцип абстракции

4. Спецкурс ОмГУ-2014
Принцип абстракции
Основная цель – улучшить
понимание системы на
разных уровнях
Побочный эффект –
заменяемость
реализации

5. Спецкурс ОмГУ-2014
Абстрактный тип данных
(АТД) – описание данных и
алгоритмов (функций) для
манипулирования ими
Принцип абстракции

6. Спецкурс ОмГУ-2014
Примеры АТД:
Список (List)
Стек (Stack)
Очередь (Queue)
Дек (Deq)
Ассоциативный массив (Map)
Принцип абстракции

7. Спецкурс ОмГУ-2014
Движение программистской
мысли:
- Машинный код
- «Понятный» машинный код
(ассемблер)
- «Понятный» ассемблер (Си)
- Структурное программирование
Принцип абстракции

8. Спецкурс ОмГУ-2014
Движение программистской
мысли:
- Процедурное и функциональное
программирование
- Абстрактные типы данных
- Объектно-ориентированное
программирование
Принцип абстракции

9. Спецкурс ОмГУ-2014
Движение программистской
мысли:
- Функциональное
программирование (новый
уровень)
- Зарождающиеся подходы
(виртуализация)
Принцип абстракции

10. Спецкурс ОмГУ-2014
Контракт функции –
спецификация, предусловие,
постусловие и инвариант
Контракты

11. Спецкурс ОмГУ-2014
Спецификация функции –
наименование, входные и
выходные параметры,
выбрасываемые исключения
Контракты

12. Спецкурс ОмГУ-2014
Контракт –
один из способов реализации
абстракции
Контракты

13. Спецкурс ОмГУ-2014
Класс –
один из способов реализации
абстрактного типа данных
Метод класса –
функция, имеющая доступ ко
всем данным класса
ООП (Java)

14. Спецкурс ОмГУ-2014
Спецификация метода – то
же, что и спецификация
функции + уровень доступа
ООП (Java)

15. Спецкурс ОмГУ-2014
Контракт класса –
наименование, структура
наследования, набор
спецификаций публичных
методов
ООП (Java)

16. Спецкурс ОмГУ-2014
Интерфейс –
чистое описание контракта класса
В Java НЕТ множественного
наследования, есть реализация
нескольких интерфейсов
ООП (Java)

17. Спецкурс ОмГУ-2014
Пакет –
совокупность классов, либо
совместно решающих общую
задачу, либо дающих разные
реализации одного контракта
ООП (Java)

18. Спецкурс ОмГУ-2014
Принцип Единственной
обязанности (Single Responsibility)
– у контракта должно быть ровно
одно четкое предназначение
Признак нарушения –
невозможность подобрать
простое наименование
ООП (Java)

19. Спецкурс ОмГУ-2014
Сущности:
interface IFullName {
String getFirstName();
String getLastName();
}
interface IEmployee {
IFullName getFullName();
String getAddress();
String getWorkPhone();
String getHomePhone();
}
ООП (Java)

20. Спецкурс ОмГУ-2014
public class FullName implements IFullName {
private String firstName;
private String lastName;
public FullName(
final String firstName, final String lastName
) {
this.firstName = firstName;
this.lastName = lastName;
}
public String getFirstName() {
return firstName;
}
public String getLastName() {
return lastName;
}
public void setFirstName(
final String firstName
) {
this.firstName = firstName;
}
public void setLastName(
final String lastName
) {
this.lastName = lastName;
}
}
ООП (Java)

21. Спецкурс ОмГУ-2014
public class Employee implements IEmployee {
private FullName name;
private String address;
private String workPhone;
private String homePhone;
public Employee() {
}
public Employee (
final FullName name,
final String address,
final String workPhone,
final String homePhone,
) {
…
}
public IFullName getFullName() …
public String getAddress() …
public String getWorkPhone() …
public String getHomePhone() …
public void setFullName(final FullName name) …
public void setAddress(final String address) …
public void setWorkPhone(
final String workPhone
) …
public void setHomePhone(
final String homePhone
) …
}
ООП (Java)

22. Спецкурс ОмГУ-2014
Сервисы:
interface Program {
void InitializeCommandStack();
void PushCommand(Command command);
Command PopCommand();
void ShutdownCommandStack();
void InitializeReportFormatting();
void FormatReport(Report report);
void PrintReport(Report report);
void InitializeGlobalData();
void ShutdownGlobalData();
}
ООП (Java)

23. Спецкурс ОмГУ-2014
interface IEmployeeCensus {
void addEmployee(IEmployee employee);
void removeEmployee(IEmployee employee);
IEmployee nextltem();
IEmployee getFirstltem();
IEmployee getLastltem();
}
ООП (Java)

24. Спецкурс ОмГУ-2014
interface IEmployeeCensus {
void addEmployee(IEmployee employee);
void removeEmployee(IEmployee employee);
IEmployee getNextEmployee();
IEmployee getFirstEmployee();
IEmployee getLastEmployee();
}
public class EmployeeCensus implements IEmployeeCensus {
private IListContainer employeeList;
…
}
ООП (Java)

25. Спецкурс ОмГУ-2014
Соглашения (конвенции)
именования – правила
наименования всех элементов
разрабатываемой системы
Соглашения

26. Спецкурс ОмГУ-2014
Уровни соглашений (по
возрастанию важности):
язык
фреймворк (библиотека)
компания (команда)
проект
предметная область
Соглашения

27. Спецкурс ОмГУ-2014
Именование классов: –
не использовать слова-связки
порядок: объект, имя
существительное – суть
контракта, дополнения и
определения
Соглашения

28. Спецкурс ОмГУ-2014
«Идеальное» имя класса –
одно слово, отражающее суть
Соглашения

29. Спецкурс ОмГУ-2014
Для сущностей:
Employee, List, WebContext,
DataSource
Для сервисов:
ReportManager, ContextBuilder
Плохо:
AdderAndSubtracter, MyClass,
Program
Соглашения

30. Спецкурс ОмГУ-2014
Именование методов:
не использовать слова-связки,
порядок: глагол, объект
действия, дополнения и
определения
Соглашения

31. Спецкурс ОмГУ-2014
Именование переменных:
не использовать слова-связки,
объект, представляемый
переменной, возможно с
определением
Избегать: однобуквенных имен и
сильных сокращений слов
Соглашения

32. Спецкурс ОмГУ-2014
Разделение слов:
либо camelCased, либо символ
‘_’ – зависит от соглашений
языка
Соглашения

33. Спецкурс ОмГУ-2014
Классы в Java: CamelCased, с
большой буквы
Методы и переменные в Java:
camelCased, с маленькой буквы
Пакеты в Java: одно слово с
маленькой буквы, первые 2
уровня – развернутый домен
Соглашения

34. Спецкурс ОмГУ-2014
Форматирование кода –
правила записи операторов и
других конструкций языка,
расстановки пробельных
символов и скобок для
улучшения читабельности
Соглашения

35. Спецкурс ОмГУ-2014
Помните:
код пишется только 10%
времени, а 90% времени его
читают
Соглашения

36. Спецкурс ОмГУ-2014
Документирование кода –
написание комментариев к
классам, методам,
определениям и другим
конструкциям
Документирование

37. Спецкурс ОмГУ-2014
JavaDoc – утилита для сборки
документации к проекту в
формате HTML
Иногда так называют сами
комментарии к классам и методам
Документирование

38. Спецкурс ОмГУ-2014
Пример для класса:
/**
* Provides a company employee
* entity
*/
class Employee {
Документирование

39. Спецкурс ОмГУ-2014
Пример для метода:
/**
* Counts employees in a given container
* @param employeeContainer a container of employees
* @return a count of employees in a given container
*/
int countEmployees(
final EmployeeContainer employeeContainer
) {
Документирование

40. Спецкурс ОмГУ-2014
Самодокументирующийся код
– код, являющийся
документаций сам себе и не
требующий пояснений в виде
комментариев
Документирование

41. Спецкурс ОмГУ-2014
Хорошо документированный
код – контракты
документированы JavaDoc (или
аналогом), тела методов –
самодокументирующийся код
Документирование

42. Спецкурс ОмГУ-2014
Code review – практика оценки
качества кода другим
разработчиком или
техническим лидером
Анализ качества кода

43. Спецкурс ОмГУ-2014
Парное программирование –
один компьютер, клавиатура
передается от одного
разработчика к другому
Анализ качества кода

44. Спецкурс ОмГУ-2014
Статический анализ –
просмотр кода при помощи
автоматизированных средств,
может выполняться IDE «на
лету», по триггеру или по
запросу
Анализ качества кода

45. Спецкурс ОмГУ-2014
CheckStyle – средство
статического анализа кода для
Java
Анализ качества кода

46. Спецкурс ОмГУ-2014
Email: at@7bits.it
Skype: anna_tarasenko
Web: 7bits.ru
Вопросы?