Стажировка-2015. Разработка. Занятие 8. Абстракции,...

Стажировка-2015

Абстракции, контракты, соглашения

Занятие 8


There are only two hard things in Computer science: cache invalidation and naming things.

Phil Karlton

Зачем?


Абстракция данных – скрываем детали структуры

Абстракция алгоритмов – скрываем вспомогательные функции

Принцип абстракции



Основная цель – улучшить понимание системы на разных уровнях

Побочный эффект –заменяемостьреализации


Абстрактный тип данных (АТД) – описание данных и алгоритмов (функций) для манипулирования ими



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



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



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



Движение программистской мысли:- Функциональное программирование (новый уровень)- Зарождающиеся подходы (виртуализация)



Контракт функции – спецификация, предусловие, постусловие и инвариант

Контракты


Спецификация функции – наименование, входные и выходные параметры, выбрасываемые исключения

Контракты


Контракт –один из способов реализации абстракции

Контракты


Класс – один из способов реализации абстрактного типа данныхМетод класса – функция, имеющая доступ ко всем данным класса

ООП (Java)


Спецификация метода – то же, что и спецификация функции + уровень доступа

ООП (Java)


Контракт класса –наименование, структура наследования, набор спецификаций публичных методов

ООП (Java)


Интерфейс – чистое описание контракта класса

В Java НЕТ множественного наследования, есть реализация нескольких интерфейсов

ООП (Java)


Пакет – совокупность классов, либо совместно решающих общую задачу, либо дающих разные реализации одного контракта

ООП (Java)


Принцип Единственной обязанности (Single Responsibility) – у контракта должно быть ровно одно четкое предназначениеПризнак нарушения – невозможность подобрать простое наименование

ООП (Java)


Сущности:interface IFullName {

String getFirstName(); String getLastName(); }

interface IEmployee {

IFullName getFullName(); String getAddress(); String getWorkPhone(); String getHomePhone(); }

ООП (Java)


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)


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)


Сервисы: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)


interface IEmployeeCensus {

void addEmployee(IEmployee employee); void removeEmployee(IEmployee employee); IEmployee nextltem(); IEmployee getFirstltem(); IEmployee getLastltem(); }

ООП (Java)


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)


Соглашения (конвенции) именования – правила наименования всех элементов разрабатываемой системы

Соглашения


Уровни соглашений (по возрастанию важности):языкфреймворк (библиотека)компания (команда)проектпредметная область



Именование классов: –не использовать слова-связкипорядок: объект, имя существительное – суть контракта, дополнения и определения



«Идеальное» имя класса – одно слово, отражающее суть



Для сущностей:Employee, List, WebContext, DataSourceДля сервисов:ReportManager, ContextBuilderПлохо:AdderAndSubtracter, MyClass, Program



Именование методов:не использовать слова-связки,порядок: глагол, объект действия, дополнения и определения



Именование переменных:не использовать слова-связки,объект, представляемый переменной, возможно с определениемИзбегать: однобуквенных имен и сильных сокращений слов



Разделение слов:либо camelCased, либо символ ‘_’ – зависит от соглашений языка



Классы в Java: CamelCased, с большой буквыМетоды и переменные в Java:camelCased, с маленькой буквыПакеты в Java: одно слово с маленькой буквы, первые 2 уровня – развернутый домен



Форматирование кода –правила записи операторов и других конструкций языка, расстановки пробельных символов и скобок для улучшения читабельности



Помните:код пишется только 10% времени, а 90% времени его читают



Документирование кода –написание комментариев к классам, методам, определениям и другим конструкциям

Документирование


JavaDoc – утилита для сборки документации к проекту в формате HTML

Иногда так называют сами комментарии к классам и методам



Пример для класса:/** * Provides a company employee * entity */class Employee {



Пример для метода:/** * 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) {



Самодокументирующийся код – код, являющийся документаций сам себе и не требующий пояснений в виде комментариев



Хорошо документированный код – контракты документированы JavaDoc (или аналогом), тела методов – самодокументирующийся код



Code review – практика оценки качества кода другим разработчиком или техническим лидером

Анализ качества кода


Парное программирование – один компьютер, клавиатура передается от одного разработчика к другому



Статический анализ – просмотр кода при помощи автоматизированных средств, может выполняться IDE «на лету», по триггеру или по запросу



CheckStyle – средство статического анализа кода для Java



Email: [email protected]: anna_tarasenkoWeb: 7bits.ru

Вопросы?

http://7bits.ru/

Стажировка-2015. Разработка. Занятие 8. Абстракции,...

Education