Чистый код. Создание, анализ и рефакторинг — страница 35 из 94

Правильно написать многопоточный код непросто. Даже очевидный, хорошо понятный код превращается в сущий кошмар, когда в игру вступают множественные потоки и одновременный доступ к данным. Если вы столкнулись с задачей из области многопоточного программирования, вам придется приложить все усилия к написанию чистого кода или столкнуться с коварными, непредсказуемыми сбоями.

Прежде всего следуйте принципу единой ответственности. Разбейте систему на POJO-объекты, отделяющие многопоточный код от кода, с потоками никак не связанного. Проследите за тем, чтобы при тестировании многопоточного кода тестировался только этот код, и ничего лишнего. Из этого следует, что многопоточный код должен быть компактным и сконцентрированным в одном месте.

Знайте типичные источники многопоточных ошибок: работа с общими данными из нескольких программных потоков, использование пула общих ресурсов. Особенно непростыми оказываются пограничные случаи: корректное завершение работы, завершение итераций циклов и т.д.

Изучайте свои библиотеки и знайте фундаментальные алгоритмы. Разберитесь в том, как некоторые функции библиотек используются для решения проблем, сходных с проблемами фундаментальных алгоритмов.

Научитесь находить секции кода, которые должны защищаться блокировками, и защищайте их. Не устанавливайте блокировки для тех секций, которые защищать не нужно. Избегайте вызовов одной заблокированной секции из другой заблокированной секции — для них необходимо глубокое понимание того, какие ресурсы находятся в общем или монопольном доступе. Сведите к минимуму количество совместно используемых объектов и масштаб общего доступа. Измените архитектуру объектов с общими данными так, чтобы они поддерживали одновременные обращения со стороны клиентов, вместо того чтобы заставлять самих клиентов заниматься управлением состоянием общего доступа.

В ходе программирования неизбежно возникнут проблемы. Те из них, которые не проявляются на самой ранней стадии, часто списываются на случайности. Эти так называемые «несистематические» ошибки часто встречаются только при высокой нагрузке или вообще в случайные (на первый взгляд) моменты. Следовательно, вы должны позаботиться о том, чтобы ваш многопоточный код мог многократно запускаться в разных конфигурациях на многих платформах. Тестируемость, естественным образом проистекающая из трех законов TDD, подразумевает определенный уровень модульности, которая обеспечивает возможность выполнения кода в более широком диапазоне конфигураций.

Потратив немного времени на инструментовку кода, вы значительно повысите шансы обнаружения некорректного кода. Инструментовка может производиться как вручную, так и с применением технологий автоматизации. Начинайте с ранних стадий работы над продуктом. Многопоточный код должен отработать в течение как можно большего времени, прежде чем он будет включен в окончательную версию продукта.

Если вы будете стремиться к чистоте своего кода, вероятность того, что вам удастся правильно реализовать его, значительно возрастет.

Литература

[Lea99]: Concurrent Programming in Java: Design Principles and Patterns, 2d. ed., Doug Lea, Prentice Hall, 1999.

[PPP]: Agile Software Development: Principles, Patterns, and Practices, Robert C. Martin, Prentice Hall, 2002.

[PRAG]: The Pragmatic Programmer, Andrew Hunt, Dave Thomas, Addison-Wesley, 2000.


Глава 14. Последовательное очищение

Дело о разборе аргументов командной строки

В этой главе представлен вполне реальный сценарий последовательного очищения кода. Мы рассмотрим модуль, который внешне смотрелся вполне достойно, но плохо масштабировался. Вы увидите, как происходила переработка и очистка этого модуля.

Многим из нас время от времени приходится заниматься разбором аргументов командной строки. Если под рукой не окажется удобного инструмента, мы просто перебираем элементы массива строк, переданного функции main. Я знал немало хороших инструментов из разных источников, однако ни один из них не делал именно того, что мне было нужно. Разумеется, я решил написать собственную реализацию — назовем ее Args.

Класс Args очень прост в использовании. Вы конструируете экземпляр класса Args с входными аргументами и форматной строкой, а затем обращаетесь к нему за значениями аргументов. Рассмотрим простой пример.


Листинг 14.1. Простое использование Args

public static void main(String[] args) {

  try {

    Args arg = new Args("l,p#,d*", args);

    boolean logging = arg.getBoolean('l');

    int port = arg.getInt('p');

    String directory = arg.getString('d');

    executeApplication(logging, port, directory);

  } catch (ArgsException e) {

    System.out.printf("Argument error: %s\n", e.errorMessage());

  }

}

Вы и сами видите, что все действительно просто. Мы создаем экземпляр класса Args с двумя параметрами. Первый параметр задает форматную строку: "l,p#,d*.". Эта строка определяет три аргумента командной строки. Первый аргумент, –l, относится к логическому (булевскому) типу. Второй аргумент, -p, относится к целочисленному типу. Третий аргумент, -d, является строковым. Во втором параметре конструктора Args содержится массив аргументов командной строки, полученный main.

Если конструктор возвращает управление без выдачи исключения ArgsException, значит, разбор входной командной строки прошел успешно, и экземпляр Args готов к приему запросов. Методы getBoolean, getInteger, getString и т.д. используются для получения значений аргументов по именам.

При возникновении проблем (в форматной строке или в самих аргументах командной строки) инициируется исключение ArgsException. Для получения текстового описания проблемы следует вызвать метод errorMessage объекта исключения.

Реализация Args

Реализация класса Args приведена в листинге 14.2. Пожалуйста, очень внимательно прочитайте ее. Я основательно потрудился над стилем и структурой кода и надеюсь, что вы сочтете его достойным образцом для подражания.


Листинг 14.2. Args.java

package com.objectmentor.utilities.args;


import static com.objectmentor.utilities.args.ArgsException.ErrorCode.*;

import java.util.*;


public class Args {

  private Map marshalers;

  private Set argsFound;

  private ListIterator currentArgument;


  public Args(String schema, String[] args) throws ArgsException {

    marshalers = new HashMap();

    argsFound = new HashSet();

    parseSchema(schema);

    parseArgumentStrings(Arrays.asList(args));

  }


  private void parseSchema(String schema) throws ArgsException {

    for (String element : schema.split(","))

      if (element.length() > 0)

        parseSchemaElement(element.trim());

  }


  private void parseSchemaElement(String element) throws ArgsException {

    char elementId = element.charAt(0);

    String elementTail = element.substring(1);

    validateSchemaElementId(elementId);

    if (elementTail.length() == 0)

      marshalers.put(elementId, new BooleanArgumentMarshaler());

    else if (elementTail.equals("*"))

      marshalers.put(elementId, new StringArgumentMarshaler());

    else if (elementTail.equals("#"))

      marshalers.put(elementId, new IntegerArgumentMarshaler());

    else if (elementTail.equals("##"))

      marshalers.put(elementId, new DoubleArgumentMarshaler());

    else if (elementTail.equals("[*]"))

      marshalers.put(elementId, new StringArrayArgumentMarshaler());

    else

      throw new ArgsException(INVALID_ARGUMENT_FORMAT, elementId, elementTail);

  }

  private void validateSchemaElementId(char elementId) throws ArgsException {

    if (!Character.isLetter(elementId))

      throw new ArgsException(INVALID_ARGUMENT_NAME, elementId, null);

  }


  private void parseArgumentStrings(List argsList) throws ArgsException

  {

for (currentArgument = argsList.listIterator(); currentArgument.hasNext();)

    {

      String argString = currentArgument.next();